![]() |
![]() |
![]() |
GDK Reference Manual | ![]() |
---|---|---|---|---|
#include <gdk/gdk.h> union GdkEvent; GdkEventAny; GdkEventKey; GdkEventButton; GdkEventScroll; GdkEventMotion; GdkEventExpose; GdkEventVisibility; GdkEventCrossing; GdkEventFocus; GdkEventConfigure; GdkEventProperty; GdkEventSelection; typedef GdkNativeWindow; GdkEventDND; GdkEventProximity; GdkEventClient; GdkEventNoExpose; GdkEventWindowState; GdkEventSetting; GdkEventOwnerChange; GdkEventGrabBroken; enum GdkScrollDirection; enum GdkVisibilityState; enum GdkCrossingMode; enum GdkNotifyType; enum GdkPropertyState; enum GdkWindowState; enum GdkSettingAction; enum GdkOwnerChange;
The event structs 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()
.
union GdkEvent { GdkEventType type; GdkEventAny any; GdkEventExpose expose; GdkEventNoExpose no_expose; GdkEventVisibility visibility; GdkEventMotion motion; GdkEventButton button; GdkEventScroll scroll; GdkEventKey key; GdkEventCrossing crossing; GdkEventFocus focus_change; GdkEventConfigure configure; GdkEventProperty property; GdkEventSelection selection; GdkEventOwnerChange owner_change; GdkEventProximity proximity; GdkEventClient client; GdkEventDND dnd; GdkEventWindowState window_state; GdkEventSetting setting; GdkEventGrabBroken grab_broken; };
The GdkEvent struct contains a union of all of the event structs, 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 structs, and can always be accessed with the following code, no matter what type of event it is:
GdkEvent *event; GdkEventType type; type = event->type;
To access other fields of the event structs, the pointer to the event can be
cast to the appropriate event struct pointer, 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:
GdkEvent *event; gdouble x; x = ((GdkEventButton*)event)->x;
or:
GdkEvent *event; gdouble x; x = event->button.x;
typedef struct { GdkEventType type; GdkWindow *window; gint8 send_event; } GdkEventAny;
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.
GdkEventType type ; |
the type of the event. |
GdkWindow *window ; |
the window which received the event. |
gint8 send_event ; |
TRUE if the event was sent explicitly (e.g. using
XSendEvent ).
|
typedef struct { 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; } GdkEventKey;
Describes a key press or key release event.
GdkEventType type ; |
the type of the event (GDK_KEY_PRESS or GDK_KEY_RELEASE ).
|
GdkWindow *window ; |
the window which received the event. |
gint8 send_event ; |
TRUE if the event was sent explicitly (e.g. using
XSendEvent ).
|
guint32 time ; |
the time of the event in milliseconds. |
guint state ; |
a bit-mask representing the state of the modifier keys (e.g. Control, Shift and Alt) and the pointer buttons. See GdkModifierType. |
guint keyval ; |
the key that was pressed or released. See the
<gdk/gdkkeysyms.h>
header file for a complete list of GDK key codes.
|
gint length ; |
the length of string .
|
gchar *string ; |
a string containing the 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.
(gdk_unicode_to_keyval() provides a non-deprecated way of getting
an approximate translation for a key.) The string is encoded in the encoding
of the current locale (Note: this for backwards compatibility:
strings in GTK+ and GDK are typically in UTF-8.) and NUL-terminated.
In some cases, the translation of the key code will be a single
NUL byte, in which case looking at length is necessary to distinguish
it from the an empty translation.
|
guint16 hardware_keycode ; |
the raw code of the key that was pressed or released. |
guint8 group ; |
the keyboard group. |
guint is_modifier : 1; |
a flag that indicates if hardware_keycode is mapped to a
modifier. Since 2.10
|
typedef struct { 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; } GdkEventButton;
Used for button press and button release events. The
type
field will be one of GDK_BUTTON_PRESS
,
GDK_2BUTTON_PRESS
, GDK_3BUTTON_PRESS
, and 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.
GdkEventType type ; |
the type of the event (GDK_BUTTON_PRESS , GDK_2BUTTON_PRESS ,
GDK_3BUTTON_PRESS or GDK_BUTTON_RELEASE ).
|
GdkWindow *window ; |
the window which received the event. |
gint8 send_event ; |
TRUE if the event was sent explicitly (e.g. using
XSendEvent ).
|
guint32 time ; |
the time of the event in milliseconds. |
gdouble x ; |
the x coordinate of the pointer relative to the window. |
gdouble y ; |
the y coordinate of the pointer relative to the window. |
gdouble *axes ; |
x , y translated to the axes of device , or NULL if device is
the mouse.
|
guint state ; |
a bit-mask representing the state of the modifier keys (e.g. Control, Shift and Alt) and the pointer buttons. See GdkModifierType. |
guint 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. |
GdkDevice *device ; |
the device where the event originated. |
gdouble x_root ; |
the x coordinate of the pointer relative to the root of the screen. |
gdouble y_root ; |
the y coordinate of the pointer relative to the root of the screen. |
typedef struct { GdkEventType type; GdkWindow *window; gint8 send_event; guint32 time; gdouble x; gdouble y; guint state; GdkScrollDirection direction; GdkDevice *device; gdouble x_root, y_root; } GdkEventScroll;
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.
GdkEventType type ; |
the type of the event (GDK_SCROLL ).
|
GdkWindow *window ; |
the window which received the event. |
gint8 send_event ; |
TRUE if the event was sent explicitly (e.g. using
XSendEvent ).
|
guint32 time ; |
the time of the event in milliseconds. |
gdouble x ; |
the x coordinate of the pointer relative to the window. |
gdouble y ; |
the y coordinate of the pointer relative to the window. |
guint 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 and GDK_SCROLL_RIGHT ).
|
GdkDevice *device ; |
the device where the event originated. |
gdouble x_root ; |
the x coordinate of the pointer relative to the root of the screen. |
gdouble y_root ; |
the y coordinate of the pointer relative to the root of the screen. |
typedef struct { 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; } GdkEventMotion;
Generated when the pointer moves.
GdkEventType type ; |
the type of the event. |
GdkWindow *window ; |
the window which received the event. |
gint8 send_event ; |
TRUE if the event was sent explicitly (e.g. using
XSendEvent ).
|
guint32 time ; |
the time of the event in milliseconds. |
gdouble x ; |
the x coordinate of the pointer relative to the window. |
gdouble y ; |
the y coordinate of the pointer relative to the window. |
gdouble *axes ; |
x , y translated to the axes of device , or NULL if device is
the mouse.
|
guint state ; |
a bit-mask representing the state of the modifier keys (e.g. Control, Shift and Alt) and the pointer buttons. See GdkModifierType. |
gint16 is_hint ; |
set to 1 if this event is just a hint, see the GDK_POINTER_MOTION_HINT_MASK
value of GdkEventMask.
|
GdkDevice *device ; |
the device where the event originated. |
gdouble x_root ; |
the x coordinate of the pointer relative to the root of the screen. |
gdouble y_root ; |
the y coordinate of the pointer relative to the root of the screen. |
typedef struct { GdkEventType type; GdkWindow *window; gint8 send_event; GdkRectangle area; GdkRegion *region; gint count; /* If non-zero, how many more events follow. */ } GdkEventExpose;
Generated when all or part of a window becomes visible and needs to be redrawn.
GdkEventType type ; |
the type of the event (GDK_EXPOSE ).
|
GdkWindow *window ; |
the window which received the event. |
gint8 send_event ; |
TRUE if the event was sent explicitly (e.g. using
XSendEvent ).
|
GdkRectangle area ; |
bounding box of region .
|
GdkRegion *region ; |
the region that needs to be redrawn. |
gint 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.
|
typedef struct { GdkEventType type; GdkWindow *window; gint8 send_event; GdkVisibilityState state; } GdkEventVisibility;
Generated when the window visibility status has changed.
GdkEventType type ; |
the type of the event (GDK_VISIBILITY_NOTIFY ).
|
GdkWindow *window ; |
the window which received the event. |
gint8 send_event ; |
TRUE if the event was sent explicitly (e.g. using
XSendEvent ).
|
GdkVisibilityState state ; |
the new visibility state (GDK_VISIBILITY_FULLY_OBSCURED ,
GDK_VISIBILITY_PARTIAL or GDK_VISIBILITY_UNOBSCURED ).
|
typedef struct { 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; } GdkEventCrossing;
Generated when the pointer enters or leaves a window.
GdkEventType type ; |
the type of the event (GDK_ENTER_NOTIFY or GDK_LEAVE_NOTIFY ).
|
GdkWindow *window ; |
the window which received the event. |
gint8 send_event ; |
TRUE if the event was sent explicitly (e.g. using
XSendEvent ).
|
GdkWindow *subwindow ; |
the window that was entered or left. |
guint32 time ; |
the time of the event in milliseconds. |
gdouble x ; |
the x coordinate of the pointer relative to the window. |
gdouble y ; |
the y coordinate of the pointer relative to the window. |
gdouble x_root ; |
the x coordinate of the pointer relative to the root of the screen. |
gdouble 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 ,
and 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 ).
|
gboolean focus ; |
TRUE if window is the focus window or an inferior.
|
guint state ; |
a bit-mask representing the state of the modifier keys (e.g. Control, Shift and Alt) and the pointer buttons. See GdkModifierType. |
typedef struct { GdkEventType type; GdkWindow *window; gint8 send_event; gint16 in; } GdkEventFocus;
Describes a change of keyboard focus.
GdkEventType type ; |
the type of the event (GDK_FOCUS_CHANGE ).
|
GdkWindow *window ; |
the window which received the event. |
gint8 send_event ; |
TRUE if the event was sent explicitly (e.g. using XSendEvent ).
|
gint16 in ; |
TRUE if the window has gained the keyboard focus, FALSE if it has lost
the focus.
|
typedef struct { GdkEventType type; GdkWindow *window; gint8 send_event; gint x, y; gint width; gint height; } GdkEventConfigure;
Generated when a window size or position has changed.
GdkEventType type ; |
the type of the event (GDK_CONFIGURE ).
|
GdkWindow *window ; |
the window which received the event. |
gint8 send_event ; |
TRUE if the event was sent explicitly (e.g. using XSendEvent ).
|
gint x ; |
the new x coordinate of the window, relative to its parent. |
gint y ; |
the new y coordinate of the window, relative to its parent. |
gint width ; |
the new width of the window. |
gint height ; |
the new height of the window. |
typedef struct { GdkEventType type; GdkWindow *window; gint8 send_event; GdkAtom atom; guint32 time; guint state; } GdkEventProperty;
Describes a property change on a window.
GdkEventType type ; |
the type of the event (GDK_PROPERTY_NOTIFY ).
|
GdkWindow *window ; |
the window which received the event. |
gint8 send_event ; |
TRUE if the event was sent explicitly (e.g. using XSendEvent ).
|
GdkAtom atom ; |
the property that was changed. |
guint32 time ; |
the time of the event in milliseconds. |
guint state ; |
whether the property was changed (GDK_PROPERTY_NEW_VALUE ) or
deleted (GDK_PROPERTY_DELETE ).
|
typedef struct { GdkEventType type; GdkWindow *window; gint8 send_event; GdkAtom selection; GdkAtom target; GdkAtom property; guint32 time; GdkNativeWindow requestor; } GdkEventSelection;
Generated when a selection is requested or ownership of a selection is taken over by another client application.
GdkEventType type ; |
the type of the event (GDK_SELECTION_CLEAR , GDK_SELECTION_NOTIFY or
GDK_SELECTION_REQUEST ).
|
GdkWindow *window ; |
the window which received the event. |
gint8 send_event ; |
TRUE if the event was sent explicitly (e.g. using XSendEvent ).
|
GdkAtom selection ; |
the selection. |
GdkAtom target ; |
the target to which the selection should be converted. |
GdkAtom property ; |
the property in which to place the result of the conversion. |
guint32 time ; |
the time of the event in milliseconds. |
GdkNativeWindow requestor ; |
the native window on which to place property .
|
typedef struct { GdkEventType type; GdkWindow *window; gint8 send_event; GdkDragContext *context; guint32 time; gshort x_root, y_root; } GdkEventDND;
Generated during DND operations.
GdkEventType type ; |
the type of the event (GDK_DRAG_ENTER , GDK_DRAG_LEAVE ,
GDK_DRAG_MOTION , GDK_DRAG_STATUS , GDK_DROP_START or GDK_DROP_FINISHED ).
|
GdkWindow *window ; |
the window which received the event. |
gint8 send_event ; |
TRUE if the event was sent explicitly (e.g. using XSendEvent ).
|
GdkDragContext *context ; |
the GdkDragContext for the current DND operation. |
guint32 time ; |
the time of the event in milliseconds. |
gshort x_root ; |
the x coordinate of the pointer relative to the root of the screen,
only set for GDK_DRAG_MOTION and GDK_DROP_START .
|
gshort y_root ; |
the y coordinate of the pointer relative to the root of the screen,
only set for GDK_DRAG_MOTION and GDK_DROP_START .
|
typedef struct { GdkEventType type; GdkWindow *window; gint8 send_event; guint32 time; GdkDevice *device; } GdkEventProximity;
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.
GdkEventType type ; |
the type of the event (GDK_PROXIMITY_IN or GDK_PROXIMITY_OUT ).
|
GdkWindow *window ; |
the window which received the event. |
gint8 send_event ; |
TRUE if the event was sent explicitly (e.g. using XSendEvent ).
|
guint32 time ; |
the time of the event in milliseconds. |
GdkDevice *device ; |
the device where the event originated. |
typedef struct { GdkEventType type; GdkWindow *window; gint8 send_event; GdkAtom message_type; gushort data_format; union { char b[20]; short s[10]; long l[5]; } data; } GdkEventClient;
An event sent by another client application.
GdkEventType type ; |
the type of the event (GDK_CLIENT_EVENT ).
|
GdkWindow *window ; |
the window which received the event. |
gint8 send_event ; |
TRUE if the event was sent explicitly (e.g. using XSendEvent ).
|
GdkAtom message_type ; |
the type of the message, which can be defined by the application. |
gushort data_format ; |
the format of the data, given as the number of bits in each data element, i.e. 8, 16, or 32. 8-bit data uses the b array of the data union, 16-bit data uses the s array, and 32-bit data uses the l array. |
typedef struct { GdkEventType type; GdkWindow *window; gint8 send_event; } GdkEventNoExpose;
Generated when the area of a GdkDrawable being copied, with gdk_draw_drawable()
or gdk_window_copy_area()
, was completely available.
FIXME: add more here.
GdkEventType type ; |
the type of the event (GDK_NO_EXPOSE ).
|
GdkWindow *window ; |
the window which received the event. |
gint8 send_event ; |
TRUE if the event was sent explicitly (e.g. using XSendEvent ).
|
typedef struct { GdkEventType type; GdkWindow *window; gint8 send_event; GdkWindowState changed_mask; GdkWindowState new_window_state; } GdkEventWindowState;
Generated when the state of a toplevel window changes.
GdkEventType type ; |
the type of the event (GDK_WINDOW_STATE ).
|
GdkWindow *window ; |
the window which received the event. |
gint8 send_event ; |
TRUE if the event was sent explicitly (e.g. using XSendEvent ).
|
GdkWindowState changed_mask ; |
mask specifying what flags have changed. |
GdkWindowState new_window_state ; |
the new window state, a combination of GdkWindowState bits. |
typedef struct { GdkEventType type; GdkWindow *window; gint8 send_event; GdkSettingAction action; char *name; } GdkEventSetting;
Generated when a setting is modified.
GdkEventType type ; |
the type of the event (GDK_SETTING ).
|
GdkWindow *window ; |
the window which received the event. |
gint8 send_event ; |
TRUE if the event was sent explicitly (e.g. using XSendEvent ).
|
GdkSettingAction action ; |
what happened to the setting (GDK_SETTING_ACTION_NEW ,
GDK_SETTING_ACTION_CHANGED or GDK_SETTING_ACTION_DELETED ).
|
char *name ; |
the name of the setting. |
typedef struct { GdkEventType type; GdkWindow *window; gint8 send_event; GdkNativeWindow owner; GdkOwnerChange reason; GdkAtom selection; guint32 time; guint32 selection_time; } GdkEventOwnerChange;
Generated when the owner of a selection changes. On X11, this information is only available if the X server supports the XFIXES extension.
GdkEventType type ; |
the type of the event (GDK_OWNER_CHANGE ).
|
GdkWindow *window ; |
the window which received the event |
gint8 send_event ; |
TRUE if the event was sent explicitly (e.g. using XSendEvent ).
|
GdkNativeWindow owner ; |
the new owner of the selection |
GdkOwnerChange reason ; |
the reason for the ownership change as a GdkOwnerChange value |
GdkAtom selection ; |
the atom identifying the selection |
guint32 time ; |
the timestamp of the event |
guint32 selection_time ; |
the time at which the selection ownership was taken over |
Since 2.6
typedef struct { GdkEventType type; GdkWindow *window; gint8 send_event; gboolean keyboard; gboolean implicit; GdkWindow *grab_window; } GdkEventGrabBroken;
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.
GdkEventType type ; |
the type of the event (GDK_GRAB_BROKEN )
|
GdkWindow *window ; |
the window which received the event, i.e. the window that previously owned the grab |
gint8 send_event ; |
TRUE if the event was sent explicitly (e.g. using XSendEvent ).
|
gboolean keyboard ; |
TRUE if a keyboard grab was broken, FALSE if a pointer
grab was broken
|
gboolean implicit ; |
TRUE if the broken grab was implicit
|
GdkWindow *grab_window ; |
If this event is caused by another grab in the same
application, grab_window contains the new grab window. Otherwise
grab_window is NULL .
|
Since 2.8
typedef enum { GDK_SCROLL_UP, GDK_SCROLL_DOWN, GDK_SCROLL_LEFT, GDK_SCROLL_RIGHT } GdkScrollDirection;
Specifies the direction for GdkEventScroll.
typedef enum { GDK_VISIBILITY_UNOBSCURED, GDK_VISIBILITY_PARTIAL, GDK_VISIBILITY_FULLY_OBSCURED } GdkVisibilityState;
Specifies the visiblity status of a window for a GdkEventVisibility.
typedef enum { GDK_CROSSING_NORMAL, GDK_CROSSING_GRAB, GDK_CROSSING_UNGRAB, GDK_CROSSING_GTK_GRAB, GDK_CROSSING_GTK_UNGRAB, GDK_CROSSING_STATE_CHANGED } GdkCrossingMode;
Specifies the crossing mode for GdkEventCrossing.
typedef enum { GDK_NOTIFY_ANCESTOR = 0, GDK_NOTIFY_VIRTUAL = 1, GDK_NOTIFY_INFERIOR = 2, GDK_NOTIFY_NONLINEAR = 3, GDK_NOTIFY_NONLINEAR_VIRTUAL = 4, GDK_NOTIFY_UNKNOWN = 5 } GdkNotifyType;
Specifies the kind of crossing for GdkEventCrossing.
See the X11 protocol specification of LeaveNotify for full details of crossing event generation.
typedef enum { GDK_PROPERTY_NEW_VALUE, GDK_PROPERTY_DELETE } GdkPropertyState;
Specifies the type of a property change for a GdkEventProperty.
typedef enum { GDK_WINDOW_STATE_WITHDRAWN = 1 << 0, GDK_WINDOW_STATE_ICONIFIED = 1 << 1, GDK_WINDOW_STATE_MAXIMIZED = 1 << 2, GDK_WINDOW_STATE_STICKY = 1 << 3, GDK_WINDOW_STATE_FULLSCREEN = 1 << 4, GDK_WINDOW_STATE_ABOVE = 1 << 5, GDK_WINDOW_STATE_BELOW = 1 << 6 } GdkWindowState;
Specifies the state of a toplevel window.
typedef enum { GDK_SETTING_ACTION_NEW, GDK_SETTING_ACTION_CHANGED, GDK_SETTING_ACTION_DELETED } GdkSettingAction;
Specifies the kind of modification applied to a setting in a GdkEventSetting.