Gnome::Gdk3::EventsGnome::Gdk3::EventsEvent Structures — Data structures specific to each type of event
my Gnome::Gtk3::Window $top-window .= new(:empty);
$top-window.set-title('Hello GTK!');
# ... etcetera ...
# Register a signal handler for a window event
$top-window.register-signal( self, 'handle-keypress', 'key-press-event');
method handle-keypress ( :$widget, GdkEvent :$event ) {
if $event.event-any.type ~~ GDK_KEY_PRESS and
$event.event-key.keyval eq 's' {
# key 's' pressed, stop process ...
}
}
The handler signature can also be defined as
method handle-keypress ( :$widget, GdkEventKey :$event ) {
if $event.type ~~ GDK_KEY_PRESS and $event.keyval eq 's' {
# key 's' pressed, stop process ...
}
}
Do not confuse these events with the signals that GTK+ widgets emit. Although many of these events result in corresponding signals being emitted, the events are often transformed or filtered along the way.
In some language bindings, the values GDK_2BUTTON_PRESS and GDK_3BUTTON_PRESS would translate into something syntactically invalid (eg Gdk.EventType.2ButtonPress, where a symbol is not allowed to start with a number). In that case, the aliases GDK_DOUBLE_BUTTON_PRESS and GDK_TRIPLE_BUTTON_PRESS can be used instead.
GDK_NOTHING; a special code to indicate a null event.
GDK_DELETE; the window manager has requested that the toplevel window be hidden or destroyed, usually when the user clicks on a special icon in the title bar.
GDK_DESTROY; the window has been destroyed.
GDK_EXPOSE; all or part of the window has become visible and needs to be redrawn.
GDK_MOTION_NOTIFY; the pointer (usually a mouse) has moved.
GDK_BUTTON_PRESS; a mouse button has been pressed.
GDK_2BUTTON_PRESS; a mouse button has been double-clicked (clicked twice within a short period of time). Note that each click also generates a GDK_BUTTON_PRESS event.
GDK_DOUBLE_BUTTON_PRESS; alias for GDK_2BUTTON_PRESS, added in 3.6.
GDK_3BUTTON_PRESS; a mouse button has been clicked 3 times in a short period of time. Note that each click also generates a GDK_BUTTON_PRESS event.
GDK_TRIPLE_BUTTON_PRESS; alias for GDK_3BUTTON_PRESS, added in 3.6.
GDK_BUTTON_RELEASE; a mouse button has been released.
GDK_KEY_PRESS; a key has been pressed.
GDK_KEY_RELEASE; a key has been released.
GDK_ENTER_NOTIFY; the pointer has entered the window.
GDK_LEAVE_NOTIFY; the pointer has left the window.
GDK_FOCUS_CHANGE; the keyboard focus has entered or left the window.
GDK_CONFIGURE; the size, position or stacking order of the window has changed. Note that GTK+ discards these events for GDK_WINDOW_CHILD windows.
GDK_MAP; the window has been mapped.
GDK_UNMAP; the window has been unmapped.
GDK_PROPERTY_NOTIFY; a property on the window has been changed or deleted.
GDK_SELECTION_CLEAR; the application has lost ownership of a selection.
GDK_SELECTION_REQUEST; another application has requested a selection.
GDK_SELECTION_NOTIFY; a selection has been received.
GDK_PROXIMITY_IN; an input device has moved into contact with a sensing surface (e.g. a touchscreen or graphics tablet).
GDK_PROXIMITY_OUT; an input device has moved out of contact with a sensing surface.
GDK_DRAG_ENTER; the mouse has entered the window while a drag is in progress.
GDK_DRAG_LEAVE; the mouse has left the window while a drag is in progress.
GDK_DRAG_MOTION; the mouse has moved in the window while a drag is in progress.
GDK_DRAG_STATUS; the status of the drag operation initiated by the window has changed.
GDK_DROP_START; a drop operation onto the window has started.
GDK_DROP_FINISHED; the drop operation initiated by the window has completed.
GDK_CLIENT_EVENT; a message has been received from another application.
GDK_VISIBILITY_NOTIFY; the window visibility status has changed.
GDK_SCROLL; the scroll wheel was turned.
GDK_WINDOW_STATE; the state of a window has changed. See GdkWindowState for the possible window states.
GDK_SETTING. a setting has been modified.
GDK_OWNER_CHANGE; the owner of a selection has changed. This event type was added in 2.6
GDK_GRAB_BROKEN; a pointer or keyboard grab was broken. This event type was added in 2.8.
GDK_DAMAGE; the content of the window has been changed. This event type was added in 2.14.
GDK_TOUCH_BEGIN; A new touch event sequence has just started. This event type was added in 3.4.
GDK_TOUCH_UPDATE; A touch event sequence has been updated. This event type was added in 3.4.
GDK_TOUCH_END; A touch event sequence has finished. This event type was added in 3.4.
GDK_TOUCH_CANCEL; A touch event sequence has been canceled. This event type was added in 3.4.
GDK_TOUCHPAD_SWIPE; A touchpad swipe gesture event, the current state is determined by its phase field. This event type was added in 3.18.
GDK_TOUCHPAD_PINCH; A touchpad pinch gesture event, the current state is determined by its phase field. This event type was added in 3.18.
GDK_PAD_BUTTON_PRESS; A tablet pad button press event. This event type was added in 3.22.
GDK_PAD_BUTTON_RELEASE; A tablet pad button release event. This event type was added in 3.22.
GDK_PAD_RING; A tablet pad axis event from a "ring". This event type was added in 3.22.
GDK_PAD_STRIP; A tablet pad axis event from a "strip". This event type was added in 3.22.
GDK_PAD_GROUP_MODE; A tablet pad group mode change. This event type was added in 3.22.
GDK_EVENT_LAST; Marks the end of the GdkEventType enumeration. Added in 2.18
Specifies the direction for GdkEventScroll.
GDK_SCROLL_UP: the window is scrolled up.
GDK_SCROLL_DOWN: the window is scrolled down.
GDK_SCROLL_LEFT: the window is scrolled to the left.
GDK_SCROLL_RIGHT: the window is scrolled to the right.
GDK_SCROLL_SMOOTH: the scrolling is determined by the delta values in GdkEventScroll.
Specifies the crossing mode for GdkEventCrossing.
GDK_CROSSING_NORMAL: crossing because of pointer motion.
GDK_CROSSING_GRAB: crossing because a grab is activated.
GDK_CROSSING_UNGRAB: crossing because a grab is deactivated.
GDK_CROSSING_GTK_GRAB: crossing because a GTK+ grab is activated.
GDK_CROSSING_GTK_UNGRAB: crossing because a GTK+ grab is deactivated.
GDK_CROSSING_STATE_CHANGED: crossing because a GTK+ widget changed state (e.g. sensitivity).
GDK_CROSSING_TOUCH_BEGIN: crossing because a touch sequence has begun, this event is synthetic as the pointer might have not left the window.
GDK_CROSSING_TOUCH_END: crossing because a touch sequence has ended, this event is synthetic as the pointer might have not left the window.
GDK_CROSSING_DEVICE_SWITCH: crossing because of a device switch (i.e. a mouse taking control of the pointer after a touch device), this event is synthetic as the pointer didn’t leave the window.
Specifies the kind of crossing for #GdkEventCrossing. See the X11 protocol specification of LeaveNotify for full details of crossing event generation.
GDK_NOTIFY_ANCESTOR: the window is entered from an ancestor or left towards an ancestor.
GDK_NOTIFY_VIRTUAL: the pointer moves between an ancestor and an inferior of the window.
GDK_NOTIFY_INFERIOR: the window is entered from an inferior or left towards an inferior.
GDK_NOTIFY_NONLINEAR: the window is entered from or left towards a window which is neither an ancestor nor an inferior.
GDK_NOTIFY_NONLINEAR_VIRTUAL: the pointer moves between two windows which are not ancestors of each other and the window is part of the ancestor chain between one of these windows and their least common ancestor.
GDK_NOTIFY_UNKNOWN: an unknown type of enter/leave event occurred.
Contains the fields which are common to all event classes. This comes in handy to check its type for instance.
UInt $.type; the type of the event.
N-GObject $.window; the window which received the event.
Int $.send_event; 1 if the event was sent explicitly.
Describes a key press or key release event. The type of the event will be one of GDK_KEY_PRESS or GDK_KEY_RELEASE.
UInt $.type; the type of the event.
N-GObject $.window; the window which received the event.
Int $.send_event; 1 if the event was sent explicitly.
UInt $.time; the time of the event in milliseconds.
UInt $.state; a bit-mask representing the state of the modifier keys (e.g. Control, Shift and Alt) and the pointer buttons. See GdkModifierType. [type GdkModifierType].
UInt $.keyval; the key that was pressed or released. See the gdk/gdkkeysyms.h header file for a complete list of GDK key codes.
Int $.length; the length of string.
Str $.string; deprecated.
UInt $.hardware_keycode; the raw code of the key that was pressed or released.
UInt $.group; the keyboard group.
UInt $.is_modifier; a flag that indicates if hardware_keycode is mapped to a modifier. Since 2.10
Used for mouse button press and button release events. The type will be one of GDK_BUTTON_PRESS, GDK_2BUTTON_PRESS, GDK_3BUTTON_PRESS or GDK_BUTTON_RELEASE,
Double and triple-clicks result in a sequence of events being received. For double-clicks the order of events will be: GDK_BUTTON_PRESS, GDK_BUTTON_RELEASE, GDK_BUTTON_PRESS, GDK_2BUTTON_PRESS and GDK_BUTTON_RELEASE.
Note that the first click is received just like a normal button press, while the second click results in a GDK_2BUTTON_PRESS being received just after the GDK_BUTTON_PRESS.
Triple-clicks are very similar to double-clicks, except that GDK_3BUTTON_PRESS is inserted after the third click. The order of the events is: GDK_BUTTON_PRESS, GDK_BUTTON_RELEASE, GDK_BUTTON_PRESS, GDK_2BUTTON_PRESS, GDK_BUTTON_RELEASE, GDK_BUTTON_PRESS, GDK_3BUTTON_PRESS and GDK_BUTTON_RELEASE.
For a double click to occur, the second button press must occur within 1/4 of a second of the first. For a triple click to occur, the third button press must also occur within 1/2 second of the first button press.
To handle e.g. a triple mouse button presses, all events can be ignored except GDK_3BUTTON_PRESS
method handle-keypress ( :$widget, GdkEventButton :$event ) {
# check if left mouse button was pressed three times
if $event.type ~~ GDK_3BUTTON_PRESS and $event.button == 1 {
...
}
}
UInt $.type; the type of the event.
N-GObject $.window; the window which received the event.
Int $.send_event;
UInt $.time; the time of the event in milliseconds.
Num $.x; the x coordinate of the pointer relative to the window.
Num $.y; the y coordinate of the pointer relative to the window.
Pointer[Num] $.axes; x , y translated to the axes of device , or NULL if device is the mouse.
UInt $.state; a bit-mask representing the state of the modifier keys (e.g. Control, Shift and Alt) and the pointer buttons. See GdkModifierType.
UInt $.button; the button which was pressed or released, numbered from 1 to 5. Normally button 1 is the left mouse button, 2 is the middle button, and 3 is the right button. On 2-button mice, the middle button can often be simulated by pressing both mouse buttons together.
N-GObject $.device; the master device that the event originated from. Use gdk_event_get_source_device() to get the slave device.
Num $.x_root; the x coordinate of the pointer relative to the root of the screen.
Num $.y_root; the y coordinate of the pointer relative to the root of the screen.
Used for touch events. type field will be one of GDK_TOUCH_BEGIN, GDK_TOUCH_UPDATE, GDK_TOUCH_END or GDK_TOUCH_CANCEL.
Touch events are grouped into sequences by means of the sequence field, which can also be obtained with gdk_event_get_event_sequence(). Each sequence begins with a GDK_TOUCH_BEGIN event, followed by any number of GDK_TOUCH_UPDATE events, and ends with a GDK_TOUCH_END (or GDK_TOUCH_CANCEL) event. With multitouch devices, there may be several active sequences at the same time.
UInt $.type; the type of the event (GDK_TOUCH_BEGIN, GDK_TOUCH_UPDATE, GDK_TOUCH_END, GDK_TOUCH_CANCEL)
N-GObject $.window; the window which received the event.
Int $.send_event;
UInt $.time; the time of the event in milliseconds.
Num $.x; the x coordinate of the pointer relative to the window
Num $.y; the y coordinate of the pointer relative to the window
Pointer[num64] $.axes; x , y translated to the axes of device , or NULL if device is the mouse
Num state; a bit-mask representing the state of the modifier keys (e.g. Control, Shift and Alt) and the pointer buttons. See GdkModifierType.
Pointer $.sequence; the event sequence that the event belongs to
Num emulating_pointer; whether the event should be used for emulating pointer event (0 or 1)
N-GObject $.device; the master device that the event originated from. Use gdk_event_get_source_device() to get the slave device.
Num $.x_root; the x coordinate of the pointer relative to the root of the screen
Num $.y_root; the y coordinate of the pointer relative to the root of the screen
Generated from button presses for the buttons 4 to 7. Wheel mice are usually configured to generate button press events for buttons 4 and 5 when the wheel is turned.
Some GDK backends can also generate “smooth” scroll events, which can be recognized by the GDK_SCROLL_SMOOTH scroll direction. For these, the scroll deltas can be obtained with gdk_event_get_scroll_deltas().
UInt $.type: the type of the event (GDK_SCROLL).
N-GObject $.window: the window which received the event.
UInt $.send_event: 1 if the event was sent explicitly.
UInt $.time: the time of the event in milliseconds.
Num $.x: the x coordinate of the pointer relative to the window.
Num $.y: the y coordinate of the pointer relative to the window.
GdkModifierType $.state: a bit-mask representing the state of the modifier keys (e.g. Control, Shift and Alt) and the pointer buttons. See GdkModifierType.
GdkScrollDirection $.direction: the direction to scroll to (one of GDK_SCROLL_UP, GDK_SCROLL_DOWN, GDK_SCROLL_LEFT, GDK_SCROLL_RIGHT or GDK_SCROLL_SMOOTH).
N-GObject $.device: the master device that the event originated from. Use gdk_event_get_source_device() to get the slave device.
Num $.x_root: the x coordinate of the pointer relative to the root of the screen.
Num $.y_root: the y coordinate of the pointer relative to the root of the screen.
Num $.delta_x: the x coordinate of the scroll delta
Num $.delta_y: the y coordinate of the scroll delta
Generated when the pointer moves.
UInt $.type: the type of the event.
N-GObject $.window: the window which received the event.
UInt $.send_event: %TRUE if the event was sent explicitly.
UInt $.time: the time of the event in milliseconds.
Num $.x: the x coordinate of the pointer relative to the window.
Num $.y: the y coordinate of the pointer relative to the window.
Pointer[Num] $.axes: x, y translated to the axes of @device, or NULL if device is the mouse.
UInt $.state: (type GdkModifierType): a bit-mask representing the state of the modifier keys (e.g. Control, Shift and Alt) and the pointer buttons. See GdkModifierType.
Int $.is_hint: set to 1 if this event is just a hint, see the GDK_POINTER_MOTION_HINT_MASK value of GdkEventMask.
N-GObject $.device: the master device that the event originated from. Use gdk_event_get_source_device() to get the slave device.
Num $.x_root: the x coordinate of the pointer relative to the root of the screen.
Num $.y_root: the y coordinate of the pointer relative to the root of the screen.
Generated when all or part of a window becomes visible and needs to be redrawn.
UInt $.type: the type of the event (GDK_EXPOSE or GDK_DAMAGE).
N-GObject $.window: the window which received the event.
UInt $.send_event: 1 if the event was sent explicitly.
GdkRectangle $.area: bounding box of @egion.
Pointer $.region: the region that needs to be redrawn. A region is of type cairo_region_t and represents a set of integer-aligned rectangles. It allows set-theoretical operations like cairo_region_union() and cairo_region_intersect() to be performed on them.
Int $.count: the number of contiguous GDK_EXPOSE events following this one. The only use for this is “exposure compression”, i.e. handling all contiguous GDK_EXPOSE events in one go, though GDK performs some exposure compression so this is not normally needed.
Generated when the pointer enters or leaves a window.
UInt $.type: the type of the event (GDK_ENTER_NOTIFY or GDK_LEAVE_NOTIFY).
N-GObject $.window: the window which received the event.
UInt $.send_event: 1 if the event was sent explicitly.
N-GObject $.subwindow: the window that was entered or left.
UInt $.time: the time of the event in milliseconds.
Num $.x: the x coordinate of the pointer relative to the window.
Num $.y: the y coordinate of the pointer relative to the window.
Num $.x_root: the x coordinate of the pointer relative to the root of the screen.
Num $.y_root: the y coordinate of the pointer relative to the root of the screen.
GdkCrossingMode $.mode: the crossing mode (GDK_CROSSING_NORMAL, GDK_CROSSING_GRAB, GDK_CROSSING_UNGRAB, GDK_CROSSING_GTK_GRAB, GDK_CROSSING_GTK_UNGRAB or GDK_CROSSING_STATE_CHANGED). GDK_CROSSING_GTK_GRAB, GDK_CROSSING_GTK_UNGRAB, GDK_CROSSING_STATE_CHANGED were added in 2.14 and are always synthesized, never native.
GdkNotifyType $.detail: the kind of crossing that happened (GDK_NOTIFY_INFERIOR, GDK_NOTIFY_ANCESTOR, GDK_NOTIFY_VIRTUAL, GDK_NOTIFY_NONLINEAR or GDK_NOTIFY_NONLINEAR_VIRTUAL).
Int $.focus: 1 if window is the focus window or an inferior.
UInt $.state: (type GdkModifierType): a bit-mask representing the state of the modifier keys (e.g. Control, Shift and Alt) and the pointer buttons. See GdkModifierType.
Describes a change of keyboard focus.
UInt $.type: the type of the event (GDK_FOCUS_CHANGE).
N-GObject $.window: the window which received the event.
UInt $.send_event: %TRUE if the event was sent explicitly.
Int $.in: 1 if the window has gained the keyboard focus, 0 if it has lost the focus.
Generated when a window size or position has changed.
GdkEventType $.type: the type of the event (GDK_CONFIGURE).
N-GObject $.window: the window which received the event.
Int $.send_event: 1 if the event was sent explicitly.
Int $.x: the new x coordinate of the window, relative to its parent.
Int $.y: the new y coordinate of the window, relative to its parent.
Int $.width: the new width of the window.
Int $.height: the new height of the window.
The event structures contain data specific to each type of event in GDK. The type is a union of all structures explained above.