Classes used for blocking interaction with figure windows:
BlockingInput
Creates a callable object to retrieve events in a blocking way for interactive sessions. Base class of the other classes listed here.
BlockingKeyMouseInput
Creates a callable object to retrieve key or mouse clicks in a blocking way for interactive sessions. Used by waitforbuttonpress
.
BlockingMouseInput
Creates a callable object to retrieve mouse clicks in a blocking way for interactive sessions. Used by ginput
.
BlockingContourLabeler
Creates a callable object to retrieve mouse clicks in a blocking way that will then be used to place labels on a ContourSet
. Used by clabel
.
Bases: matplotlib.blocking_input.BlockingMouseInput
Callable for retrieving mouse clicks and key presses in a blocking way.
Used to place contour labels.
Add the coordinates of an event to the list of clicks.
MouseEvent
Process an button-1 event (add a label to a contour).
MouseEvent
Process an button-3 event (remove a label if not in inline mode).
Unfortunately, if one is doing inline labels, then there is currently no way to fix the broken contour - once humpty-dumpty is broken, he can't be put back together. In inline mode, this does nothing.
MouseEvent
Remove a click (by default, the last) from the list of clicks.
MouseEvent
Bases: object
Callable for retrieving events in a blocking way.
For base class, this just appends an event to events.
Disconnect all callbacks.
Event handler; will be passed to the current figure to retrieve events.
Remove an event from the event list -- by default, the last.
Note that this does not check that there are events, much like the normal pop method. If no events exist, this will throw an exception.
Remove an event from the event list -- by default, the last.
Note that this does not check that there are events, much like the normal pop method. If no events exist, this will throw an exception.
For baseclass, do nothing but collect events.
Bases: matplotlib.blocking_input.BlockingInput
Callable for retrieving mouse clicks and key presses in a blocking way.
Determine if it is a key event.
Bases: matplotlib.blocking_input.BlockingInput
Callable for retrieving mouse clicks in a blocking way.
This class will also retrieve keypresses and map them to mouse clicks: delete and backspace are a right click, enter is like a middle click, and all others are like a left click.
Add the coordinates of an event to the list of clicks.
MouseEvent
MouseEvent
, optional
Not used
Process a key press event, mapping keys to appropriate mouse clicks.
Process a mouse click event.
Process an button-1 event (add a click if inside axes).
MouseEvent
Process an button-3 event (remove the last click).
MouseEvent
Process an button-2 event (end blocking input).
MouseEvent
Remove a click and the associated event from the list of clicks.
Defaults to the last click.
Remove a click (by default, the last) from the list of clicks.
MouseEvent
Process an event.
© 2012–2021 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/3.5.1/api/blocking_input_api.html