Skip to content

Backport PR #15535 on branch v3.2.x (Avoid really long lines in event handling docs.) #15538

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 27, 2019
Merged

Backport PR #15535 on branch v3.2.x (Avoid really long lines in event handling docs.) #15538

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 18 additions & 18 deletions doc/users/event_handling.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,24 +59,24 @@ Here are the events that you can connect to, the class instances that
are sent back to you when the event occurs, and the event descriptions:


======================= =============================================================================================
Event name Class and description
======================= =============================================================================================
'button_press_event' :class:`~matplotlib.backend_bases.MouseEvent` - mouse button is pressed
'button_release_event' :class:`~matplotlib.backend_bases.MouseEvent` - mouse button is released
'close_event' :class:`~matplotlib.backend_bases.CloseEvent` - a figure is closed
'draw_event' :class:`~matplotlib.backend_bases.DrawEvent` - canvas draw (but before screen update)
'key_press_event' :class:`~matplotlib.backend_bases.KeyEvent` - key is pressed
'key_release_event' :class:`~matplotlib.backend_bases.KeyEvent` - key is released
'motion_notify_event' :class:`~matplotlib.backend_bases.MouseEvent` - mouse motion
'pick_event' :class:`~matplotlib.backend_bases.PickEvent` - an object in the canvas is selected
'resize_event' :class:`~matplotlib.backend_bases.ResizeEvent` - figure canvas is resized
'scroll_event' :class:`~matplotlib.backend_bases.MouseEvent` - mouse scroll wheel is rolled
'figure_enter_event' :class:`~matplotlib.backend_bases.LocationEvent` - mouse enters a new figure
'figure_leave_event' :class:`~matplotlib.backend_bases.LocationEvent` - mouse leaves a figure
'axes_enter_event' :class:`~matplotlib.backend_bases.LocationEvent` - mouse enters a new axes
'axes_leave_event' :class:`~matplotlib.backend_bases.LocationEvent` - mouse leaves an axes
======================= =============================================================================================
====================== ================ ======================================
Event name Class Description
====================== ================ ======================================
'button_press_event' `.MouseEvent` mouse button is pressed
'button_release_event' `.MouseEvent` mouse button is released
'close_event' `.CloseEvent` a figure is closed
'draw_event' `.DrawEvent` canvas draw (but before screen update)
'key_press_event' `.KeyEvent` key is pressed
'key_release_event' `.KeyEvent` key is released
'motion_notify_event' `.MouseEvent` mouse motion
'pick_event' `.PickEvent` an object in the canvas is selected
'resize_event' `.ResizeEvent` figure canvas is resized
'scroll_event' `.MouseEvent` mouse scroll wheel is rolled
'figure_enter_event' `.LocationEvent` mouse enters a new figure
'figure_leave_event' `.LocationEvent` mouse leaves a figure
'axes_enter_event' `.LocationEvent` mouse enters a new axes
'axes_leave_event' `.LocationEvent` mouse leaves an axes
====================== ================ ======================================

.. _event-attributes:

Expand Down