Details
union GdkEvent
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:
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:
or:
GdkEventAny
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 ).
|
GdkEventKey
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
|
GdkEventButton
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.
|
GdkEventScroll
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.
|
GdkEventMotion
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.
|
GdkEventExpose
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.
|
GdkEventVisibility
typedef struct {
GdkEventType type;
GdkWindow *window;
gint8 send_event;
GdkVisibilityState state;
} GdkEventVisibility;
Generated when the window visibility status has changed.
GdkEventCrossing
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.
|
GdkEventFocus
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.
|
GdkEventConfigure
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.
|
GdkEventProperty
typedef struct {
GdkEventType type;
GdkWindow *window;
gint8 send_event;
GdkAtom atom;
guint32 time;
guint state;
} GdkEventProperty;
Describes a property change on a window.
GdkEventSelection
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.
GdkNativeWindow
Used to represent native windows (Windows for the X11 backend,
HWNDs for Win32).
GdkEventDND
typedef struct {
GdkEventType type;
GdkWindow *window;
gint8 send_event;
GdkDragContext *context;
guint32 time;
gshort x_root, y_root;
} GdkEventDND;
Generated during DND operations.
GdkEventProximity
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.
|
GdkEventClient
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.
|
GdkEventNoExpose
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 ).
|
GdkEventWindowState
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.
GdkEventSetting
typedef struct {
GdkEventType type;
GdkWindow *window;
gint8 send_event;
GdkSettingAction action;
char *name;
} GdkEventSetting;
Generated when a setting is modified.
GdkEventOwnerChange
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
GdkEventGrabBroken
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
enum GdkScrollDirection
typedef enum
{
GDK_SCROLL_UP,
GDK_SCROLL_DOWN,
GDK_SCROLL_LEFT,
GDK_SCROLL_RIGHT
} GdkScrollDirection;
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.
|
enum GdkVisibilityState
typedef enum
{
GDK_VISIBILITY_UNOBSCURED,
GDK_VISIBILITY_PARTIAL,
GDK_VISIBILITY_FULLY_OBSCURED
} GdkVisibilityState;
Specifies the visiblity status of a window for a GdkEventVisibility.
GDK_VISIBILITY_UNOBSCURED
|
the window is completely visible.
|
GDK_VISIBILITY_PARTIAL
|
the window is partially visible.
|
GDK_VISIBILITY_FULLY_OBSCURED
|
the window is not visible at all.
|
enum GdkCrossingMode
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.
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).
|
enum GdkNotifyType
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.
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.
|
enum GdkPropertyState
typedef enum
{
GDK_PROPERTY_NEW_VALUE,
GDK_PROPERTY_DELETE
} GdkPropertyState;
Specifies the type of a property change for a GdkEventProperty.
GDK_PROPERTY_NEW_VALUE
|
the property value was changed.
|
GDK_PROPERTY_DELETE
|
the property was deleted.
|
enum GdkWindowState
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.
GDK_WINDOW_STATE_WITHDRAWN
|
the window is not shown.
|
GDK_WINDOW_STATE_ICONIFIED
|
the window is minimized.
|
GDK_WINDOW_STATE_MAXIMIZED
|
the window is maximized.
|
GDK_WINDOW_STATE_STICKY
|
the window is sticky.
|
GDK_WINDOW_STATE_FULLSCREEN
|
the window is maximized without decorations.
|
GDK_WINDOW_STATE_ABOVE
|
the window is kept above other windows.
|
GDK_WINDOW_STATE_BELOW
|
the window is kept below other windows.
|
enum GdkSettingAction
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.
GDK_SETTING_ACTION_NEW
|
a setting was added.
|
GDK_SETTING_ACTION_CHANGED
|
a setting was changed.
|
GDK_SETTING_ACTION_DELETED
|
a setting was deleted.
|
enum GdkOwnerChange
typedef enum
{
GDK_OWNER_CHANGE_NEW_OWNER,
GDK_OWNER_CHANGE_DESTROY,
GDK_OWNER_CHANGE_CLOSE
} GdkOwnerChange;
Specifies why a selection ownership was changed.
GDK_OWNER_CHANGE_NEW_OWNER
|
some other app claimed the ownership
|
GDK_OWNER_CHANGE_DESTROY
|
the window was destroyed
|
GDK_OWNER_CHANGE_CLOSE
|
the client was closed
|