Event#
- class Event(*args, **kwargs)#
Subclasses: ButtonEvent
, CrossingEvent
, DNDEvent
, DeleteEvent
, FocusEvent
, GrabBrokenEvent
, KeyEvent
, MotionEvent
, PadEvent
, ProximityEvent
, ScrollEvent
, TouchEvent
, TouchpadEvent
GdkEvent
’s are immutable data structures, created by GDK to
represent windowing system events.
In GTK applications the events are handled automatically by toplevel
widgets and passed on to the event controllers of appropriate widgets,
so using GdkEvent
and its related API is rarely needed.
Methods#
- class Event
- get_axes() Tuple[bool, list[float]] #
Extracts all axis values from an event.
To find out which axes are used, use
get_axes
on the device tool returned byget_device_tool
.
- get_axis(axis_use: AxisUse) Tuple[bool, float] #
Extract the axis value for a particular axis use from an event structure.
To find out which axes are used, use
get_axes
on the device tool returned byget_device_tool
.- Parameters:
axis_use – the axis use to look for
- get_device_tool() DeviceTool | None #
Returns a
GdkDeviceTool
representing the tool that caused the event.If the was not generated by a device that supports different tools (such as a tablet), this function will return
None
.Note: the
GdkDeviceTool
will be constant during the application lifetime, if settings must be stored persistently across runs, seeget_serial
.
- get_event_sequence() EventSequence #
Returns the event sequence to which the event belongs.
Related touch events are connected in a sequence. Other events typically don’t have event sequence information.
- get_history() list[TimeCoord] | None #
Retrieves the history of the device that
event
is for, as a list of time and coordinates.The history includes positions that are not delivered as separate events to the application because they occurred in the same frame as
event
.Note that only motion and scroll events record history, and motion events do it only if one of the mouse buttons is down, or the device has a tool.
- get_modifier_state() ModifierType #
Returns the modifier state field of an event.
- get_pointer_emulated() bool #
Returns whether this event is an ‘emulated’ pointer event.
Emulated pointer events typically originate from a touch events.
- get_position() Tuple[bool, float, float] #
Extract the event surface relative x/y coordinates from an event.
This position is in surface coordinates.
- get_time() int #
Returns the timestamp of
event
.Not all events have timestamps. In that case, this function returns
CURRENT_TIME
.
Returns whether a
GdkEvent
should trigger a context menu, according to platform conventions.The right mouse button typically triggers context menus. On macOS, Control+left mouse button also triggers.
This function should always be used instead of simply checking for
event->button == GDK_BUTTON_SECONDARY