Top |
Types and Values
union | GdkEvent |
struct | GdkEventAny |
struct | GdkEventKey |
struct | GdkEventButton |
struct | GdkEventTouch |
struct | GdkEventScroll |
struct | GdkEventMotion |
struct | GdkEventExpose |
struct | GdkEventVisibility |
struct | GdkEventCrossing |
struct | GdkEventFocus |
struct | GdkEventConfigure |
struct | GdkEventProperty |
struct | GdkEventSelection |
struct | GdkEventDND |
struct | GdkEventProximity |
struct | GdkEventWindowState |
struct | GdkEventSetting |
struct | GdkEventOwnerChange |
struct | GdkEventGrabBroken |
enum | GdkScrollDirection |
enum | GdkVisibilityState |
enum | GdkCrossingMode |
enum | GdkNotifyType |
enum | GdkPropertyState |
enum | GdkWindowState |
enum | GdkSettingAction |
enum | GdkOwnerChange |
Description
The event structures contain data specific to each type of event in GDK.
A common mistake is to forget to set the event mask of a widget so that the required events are received. See
gtk_widget_set_events()
.
Types and Values
union GdkEvent
A GdkEvent contains a union of all of the event types, and allows access to the data fields in a number of ways.
The event type is always the first field in all of the event types, and can always be accessed with the following code, no matter what type of event it is:
1 2 3 4 |
GdkEvent *event; GdkEventType type; type = event->type; |
To access other fields of the event, the pointer to the event
can be cast to the appropriate event type, or the union member
name can be used. For example if the event type is GDK_BUTTON_PRESS
then the x coordinate of the button press can be accessed with:
1 2 3 4 |
GdkEvent *event; gdouble x; x = ((GdkEventButton*)event)->x; |
or:
1 2 3 4 |
GdkEvent *event; gdouble x; x = event->button.x; |
Members
GdkEventType |
the GdkEventType |
|
GdkEventAny |
||
GdkEventExpose |
||
GdkEventVisibility |
||
GdkEventMotion |
||
GdkEventButton |
||
GdkEventTouch |
||
GdkEventScroll |
||
GdkEventKey |
||
GdkEventCrossing |
||
GdkEventFocus |
||
GdkEventConfigure |
||
GdkEventProperty |
||
GdkEventSelection |
||
GdkEventOwnerChange |
||
GdkEventProximity |
||
GdkEventDND |
||
GdkEventWindowState |
||
GdkEventSetting |
||
GdkEventGrabBroken |
struct GdkEventAny
struct GdkEventAny { GdkEventType type; GdkWindow *window; gint8 send_event; };
Contains the fields which are common to all event structs. Any event pointer can safely be cast to a pointer to a GdkEventAny to access these fields.
Members
GdkEventType |
the type of the event. |
|
GdkWindow * |
the window which received the event. |
|
gint8 |
|
struct GdkEventKey
struct GdkEventKey { GdkEventType type; GdkWindow *window; gint8 send_event; guint32 time; guint state; guint keyval; gint length; gchar *string; guint16 hardware_keycode; guint8 group; guint is_modifier : 1; };
Describes a key press or key release event.
Members
GdkEventType |
the type of the event ( |
|
GdkWindow * |
the window which received the event. |
|
gint8 |
|
|
guint32 |
the time of the event in milliseconds. |
|
guint |
a bit-mask representing the state of the modifier keys (e.g. Control, Shift and Alt) and the pointer buttons. See GdkModifierType. |
[type GdkModifierType] |
guint |
the key that was pressed or released. See the
|
|
gint |
the length of |
|
gchar * |
a string containing an approximation of the text that
would result from this keypress. The only correct way to handle text
input of text is using input methods (see GtkIMContext), so this
field is deprecated and should never be used.
( |
|
guint16 |
the raw code of the key that was pressed or released. |
|
guint8 |
the keyboard group. |
|
guint |
a flag that indicates if |
struct GdkEventButton
struct GdkEventButton { GdkEventType type; GdkWindow *window; gint8 send_event; guint32 time; gdouble x; gdouble y; gdouble *axes; guint state; guint button; GdkDevice *device; gdouble x_root, y_root; };
Used for button press and button release events. The
type
field 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:
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:
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.
Members
GdkEventType |
the type of the event ( |
|
GdkWindow * |
the window which received the event. |
|
gint8 |
|
|
guint32 |
the time of the event in milliseconds. |
|
gdouble |
the x coordinate of the pointer relative to the window. |
|
gdouble |
the y coordinate of the pointer relative to the window. |
|
gdouble * |
|
|
guint |
a bit-mask representing the state of the modifier keys (e.g. Control, Shift and Alt) and the pointer buttons. See GdkModifierType. |
[type GdkModifierType] |
guint |
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. |
|
GdkDevice * |
the master device that the event originated from. Use
|
|
gdouble |
the x coordinate of the pointer relative to the root of the screen. |
|
gdouble |
the y coordinate of the pointer relative to the root of the screen. |
struct GdkEventTouch
struct GdkEventTouch { GdkEventType type; GdkWindow *window; gint8 send_event; guint32 time; gdouble x; gdouble y; gdouble *axes; guint state; GdkEventSequence *sequence; gboolean emulating_pointer; GdkDevice *device; gdouble x_root, y_root; };
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.
Members
GdkEventType |
the type of the event ( |
|
GdkWindow * |
the window which received the event |
|
gint8 |
|
|
guint32 |
the time of the event in milliseconds. |
|
gdouble |
the x coordinate of the pointer relative to the window |
|
gdouble |
the y coordinate of the pointer relative to the window |
|
gdouble * |
|
|
guint |
a bit-mask representing the state of the modifier keys (e.g. Control, Shift and Alt) and the pointer buttons. See GdkModifierType. |
[type GdkModifierType] |
GdkEventSequence * |
the event sequence that the event belongs to |
|
gboolean |
whether the event should be used for emulating pointer event |
|
GdkDevice * |
the master device that the event originated from. Use
|
|
gdouble |
the x coordinate of the pointer relative to the root of the screen |
|
gdouble |
the y coordinate of the pointer relative to the root of the screen |
struct GdkEventScroll
struct GdkEventScroll { GdkEventType type; GdkWindow *window; gint8 send_event; guint32 time; gdouble x; gdouble y; guint state; GdkScrollDirection direction; GdkDevice *device; gdouble x_root, y_root; gdouble delta_x; gdouble delta_y; };
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()
.
Members
GdkEventType |
the type of the event ( |
|
GdkWindow * |
the window which received the event. |
|
gint8 |
|
|
guint32 |
the time of the event in milliseconds. |
|
gdouble |
the x coordinate of the pointer relative to the window. |
|
gdouble |
the y coordinate of the pointer relative to the window. |
|
guint |
a bit-mask representing the state of the modifier keys (e.g. Control, Shift and Alt) and the pointer buttons. See GdkModifierType. |
[type GdkModifierType] |
GdkScrollDirection |
the direction to scroll to (one of |
|
GdkDevice * |
the master device that the event originated from. Use
|
|
gdouble |
the x coordinate of the pointer relative to the root of the screen. |
|
gdouble |
the y coordinate of the pointer relative to the root of the screen. |
|
gdouble |
the x coordinate of the scroll delta |
|
gdouble |
the y coordinate of the scroll delta |
struct GdkEventMotion
struct GdkEventMotion { GdkEventType type; GdkWindow *window; gint8 send_event; guint32 time; gdouble x; gdouble y; gdouble *axes; guint state; gint16 is_hint; GdkDevice *device; gdouble x_root, y_root; };
Generated when the pointer moves.
Members
GdkEventType |
the type of the event. |
|
GdkWindow * |
the window which received the event. |
|
gint8 |
|
|
guint32 |
the time of the event in milliseconds. |
|
gdouble |
the x coordinate of the pointer relative to the window. |
|
gdouble |
the y coordinate of the pointer relative to the window. |
|
gdouble * |
|
|
guint |
a bit-mask representing the state of the modifier keys (e.g. Control, Shift and Alt) and the pointer buttons. See GdkModifierType. |
[type GdkModifierType] |
gint16 |
set to 1 if this event is just a hint, see the
|
|
GdkDevice * |
the master device that the event originated from. Use
|
|
gdouble |
the x coordinate of the pointer relative to the root of the screen. |
|
gdouble |
the y coordinate of the pointer relative to the root of the screen. |
struct GdkEventExpose
struct GdkEventExpose { GdkEventType type; GdkWindow *window; gint8 send_event; GdkRectangle area; cairo_region_t *region; gint count; /* If non-zero, how many more events follow. */ };
Generated when all or part of a window becomes visible and needs to be redrawn.
Members
GdkEventType |
the type of the event ( |
|
GdkWindow * |
the window which received the event. |
|
gint8 |
|
|
GdkRectangle |
bounding box of |
|
the region that needs to be redrawn. |
||
gint |
the number of contiguous |
struct GdkEventVisibility
struct GdkEventVisibility { GdkEventType type; GdkWindow *window; gint8 send_event; GdkVisibilityState state; };
GdkEventVisibility
has been deprecated since version 3.12 and should not be used in newly-written code.
Modern composited windowing systems with pervasive transparency make it impossible to track the visibility of a window reliably, so this event can not be guaranteed to provide useful information.
Generated when the window visibility status has changed.
Members
GdkEventType |
the type of the event ( |
|
GdkWindow * |
the window which received the event. |
|
gint8 |
|
|
GdkVisibilityState |
the new visibility state ( |
struct GdkEventCrossing
struct GdkEventCrossing { GdkEventType type; GdkWindow *window; gint8 send_event; GdkWindow *subwindow; guint32 time; gdouble x; gdouble y; gdouble x_root; gdouble y_root; GdkCrossingMode mode; GdkNotifyType detail; gboolean focus; guint state; };
Generated when the pointer enters or leaves a window.
Members
GdkEventType |
the type of the event ( |
|
GdkWindow * |
the window which received the event. |
|
gint8 |
|
|
GdkWindow * |
the window that was entered or left. |
|
guint32 |
the time of the event in milliseconds. |
|
gdouble |
the x coordinate of the pointer relative to the window. |
|
gdouble |
the y coordinate of the pointer relative to the window. |
|
gdouble |
the x coordinate of the pointer relative to the root of the screen. |
|
gdouble |
the y coordinate of the pointer relative to the root of the screen. |
|
GdkCrossingMode |
the crossing mode ( |
|
GdkNotifyType |
the kind of crossing that happened ( |
|
gboolean |
|
|
guint |
a bit-mask representing the state of the modifier keys (e.g. Control, Shift and Alt) and the pointer buttons. See GdkModifierType. |
[type GdkModifierType] |
struct GdkEventFocus
struct GdkEventFocus { GdkEventType type; GdkWindow *window; gint8 send_event; gint16 in; };
Describes a change of keyboard focus.
Members
GdkEventType |
the type of the event ( |
|
GdkWindow * |
the window which received the event. |
|
gint8 |
|
|
gint16 |
|
struct GdkEventConfigure
struct GdkEventConfigure { GdkEventType type; GdkWindow *window; gint8 send_event; gint x, y; gint width; gint height; };
Generated when a window size or position has changed.
Members
GdkEventType |
the type of the event ( |
|
GdkWindow * |
the window which received the event. |
|
gint8 |
|
|
gint |
the new x coordinate of the window, relative to its parent. |
|
gint |
the new y coordinate of the window, relative to its parent. |
|
gint |
the new width of the window. |
|
gint |
the new height of the window. |
struct GdkEventProperty
struct GdkEventProperty { GdkEventType type; GdkWindow *window; gint8 send_event; GdkAtom atom; guint32 time; guint state; };
Describes a property change on a window.
Members
GdkEventType |
the type of the event ( |
|
GdkWindow * |
the window which received the event. |
|
gint8 |
|
|
GdkAtom |
the property that was changed. |
|
guint32 |
the time of the event in milliseconds. |
|
guint |
whether the property was changed
( |
[type GdkPropertyState] |
struct GdkEventSelection
struct GdkEventSelection { GdkEventType type; GdkWindow *window; gint8 send_event; GdkAtom selection; GdkAtom target; GdkAtom property; guint32 time; GdkWindow *requestor; };
Generated when a selection is requested or ownership of a selection is taken over by another client application.
Members
GdkEventType |
the type of the event ( |
|
GdkWindow * |
the window which received the event. |
|
gint8 |
|
|
GdkAtom |
the selection. |
|
GdkAtom |
the target to which the selection should be converted. |
|
GdkAtom |
the property in which to place the result of the conversion. |
|
guint32 |
the time of the event in milliseconds. |
|
GdkWindow * |
the window on which to place |
struct GdkEventDND
struct GdkEventDND { GdkEventType type; GdkWindow *window; gint8 send_event; GdkDragContext *context; guint32 time; gshort x_root, y_root; };
Generated during DND operations.
Members
GdkEventType |
the type of the event ( |
|
GdkWindow * |
the window which received the event. |
|
gint8 |
|
|
GdkDragContext * |
the GdkDragContext for the current DND operation. |
|
guint32 |
the time of the event in milliseconds. |
|
gshort |
the x coordinate of the pointer relative to the root of the
screen, only set for |
|
gshort |
the y coordinate of the pointer relative to the root of the
screen, only set for |
struct GdkEventProximity
struct GdkEventProximity { GdkEventType type; GdkWindow *window; gint8 send_event; guint32 time; GdkDevice *device; };
Proximity events are generated when using GDK’s wrapper for the XInput extension. The XInput extension is an add-on for standard X that allows you to use nonstandard devices such as graphics tablets. A proximity event indicates that the stylus has moved in or out of contact with the tablet, or perhaps that the user’s finger has moved in or out of contact with a touch screen.
This event type will be used pretty rarely. It only is important for XInput aware programs that are drawing their own cursor.
Members
GdkEventType |
the type of the event ( |
|
GdkWindow * |
the window which received the event. |
|
gint8 |
|
|
guint32 |
the time of the event in milliseconds. |
|
GdkDevice * |
the master device that the event originated from. Use
|
struct GdkEventWindowState
struct GdkEventWindowState { GdkEventType type; GdkWindow *window; gint8 send_event; GdkWindowState changed_mask; GdkWindowState new_window_state; };
Generated when the state of a toplevel window changes.
Members
GdkEventType |
the type of the event ( |
|
GdkWindow * |
the window which received the event. |
|
gint8 |
|
|
GdkWindowState |
mask specifying what flags have changed. |
|
GdkWindowState |
the new window state, a combination of GdkWindowState bits. |
struct GdkEventSetting
struct GdkEventSetting { GdkEventType type; GdkWindow *window; gint8 send_event; GdkSettingAction action; char *name; };
Generated when a setting is modified.
Members
GdkEventType |
the type of the event ( |
|
GdkWindow * |
the window which received the event. |
|
gint8 |
|
|
GdkSettingAction |
what happened to the setting ( |
|
the name of the setting. |
struct GdkEventOwnerChange
struct GdkEventOwnerChange { GdkEventType type; GdkWindow *window; gint8 send_event; GdkWindow *owner; GdkOwnerChange reason; GdkAtom selection; guint32 time; guint32 selection_time; };
Generated when the owner of a selection changes. On X11, this information is only available if the X server supports the XFIXES extension.
Members
GdkEventType |
the type of the event ( |
|
GdkWindow * |
the window which received the event |
|
gint8 |
|
|
GdkWindow * |
the new owner of the selection, or |
|
GdkOwnerChange |
the reason for the ownership change as a GdkOwnerChange value |
|
GdkAtom |
the atom identifying the selection |
|
guint32 |
the timestamp of the event |
|
guint32 |
the time at which the selection ownership was taken over |
Since 2.6
struct GdkEventGrabBroken
struct GdkEventGrabBroken { GdkEventType type; GdkWindow *window; gint8 send_event; gboolean keyboard; gboolean implicit; GdkWindow *grab_window; };
Generated when a pointer or keyboard grab is broken. On X11, this happens when the grab window becomes unviewable (i.e. it or one of its ancestors is unmapped), or if the same application grabs the pointer or keyboard again. Note that implicit grabs (which are initiated by button presses) can also cause GdkEventGrabBroken events.
Members
GdkEventType |
the type of the event ( |
|
GdkWindow * |
the window which received the event, i.e. the window that previously owned the grab |
|
gint8 |
|
|
gboolean |
|
|
gboolean |
|
|
GdkWindow * |
If this event is caused by another grab in the same
application, |
Since 2.8
enum GdkScrollDirection
Specifies the direction for GdkEventScroll.
Members
the window is scrolled up. |
||
the window is scrolled down. |
||
the window is scrolled to the left. |
||
the window is scrolled to the right. |
||
the scrolling is determined by the delta values
in GdkEventScroll. See |
enum GdkCrossingMode
Specifies the crossing mode for GdkEventCrossing.
Members
crossing because of pointer motion. |
||
crossing because a grab is activated. |
||
crossing because a grab is deactivated. |
||
crossing because a GTK+ grab is activated. |
||
crossing because a GTK+ grab is deactivated. |
||
crossing because a GTK+ widget changed state (e.g. sensitivity). |
||
crossing because a touch sequence has begun, this event is synthetic as the pointer might have not left the window. |
||
crossing because a touch sequence has ended, this event is synthetic as the pointer might have not left the window. |
||
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. |
enum GdkNotifyType
Specifies the kind of crossing for GdkEventCrossing.
See the X11 protocol specification of LeaveNotify for full details of crossing event generation.
Members
the window is entered from an ancestor or left towards an ancestor. |
||
the pointer moves between an ancestor and an inferior of the window. |
||
the window is entered from an inferior or left towards an inferior. |
||
the window is entered from or left towards a window which is neither an ancestor nor an inferior. |
||
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. |
||
an unknown type of enter/leave event occurred. |
enum GdkWindowState
Specifies the state of a toplevel window.
Members
the window is not shown. |
||
the window is minimized. |
||
the window is maximized. |
||
the window is sticky. |
||
the window is maximized without decorations. |
||
the window is kept above other windows. |
||
the window is kept below other windows. |
||
the window is presented as focused (with active decorations). |
||
the window is in a tiled state, Since 3.10 |