![]() |
![]() |
![]() |
GDK Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Properties | Signals |
#include <gdk/gdk.h> GdkDeviceManager; GdkDevice; enum GdkDeviceType; enum GdkInputSource; enum GdkInputMode; GdkDeviceKey; GdkDeviceAxis; enum GdkAxisUse; enum GdkGrabOwnership; void gdk_enable_multidevice (void
); GdkDisplay * gdk_device_manager_get_display (GdkDeviceManager *device_manager
); GList * gdk_device_manager_list_devices (GdkDeviceManager *device_manager
,GdkDeviceType type
); GdkDevice * gdk_device_manager_get_client_pointer (GdkDeviceManager *device_manager
); const gchar * gdk_device_get_name (GdkDevice *device
); void gdk_device_set_source (GdkDevice *device
,GdkInputSource source
); GdkInputSource gdk_device_get_source (GdkDevice *device
); gboolean gdk_device_set_mode (GdkDevice *device
,GdkInputMode mode
); GdkInputMode gdk_device_get_mode (GdkDevice *device
); void gdk_device_set_key (GdkDevice *device
,guint index_
,guint keyval
,GdkModifierType modifiers
); gboolean gdk_device_get_key (GdkDevice *device
,guint index_
,guint *keyval
,GdkModifierType *modifiers
); void gdk_device_set_axis_use (GdkDevice *device
,guint index_
,GdkAxisUse use
); GdkAxisUse gdk_device_get_axis_use (GdkDevice *device
,guint index_
); GdkDevice * gdk_device_get_associated_device (GdkDevice *device
); GdkDeviceType gdk_device_get_device_type (GdkDevice *device
); GdkDisplay * gdk_device_get_display (GdkDevice *device
); gboolean gdk_device_get_has_cursor (GdkDevice *device
); guint gdk_device_get_n_axes (GdkDevice *device
); GdkGrabStatus gdk_device_grab (GdkDevice *device
,GdkWindow *window
,GdkGrabOwnership grab_ownership
,gboolean owner_events
,GdkEventMask event_mask
,GdkCursor *cursor
,guint32 time_
); void gdk_device_ungrab (GdkDevice *device
,guint32 time_
); void gdk_device_get_state (GdkDevice *device
,GdkWindow *window
,gdouble *axes
,GdkModifierType *mask
); gboolean gdk_device_get_history (GdkDevice *device
,GdkWindow *window
,guint32 start
,guint32 stop
,GdkTimeCoord ***events
,guint *n_events
); void gdk_device_free_history (GdkTimeCoord **events
,gint n_events
); GdkTimeCoord; gboolean gdk_device_get_axis (GdkDevice *device
,gdouble *axes
,GdkAxisUse use
,gdouble *value
); GList * gdk_device_list_axes (GdkDevice *device
); gboolean gdk_device_get_axis_value (GdkDevice *device
,gdouble *axes
,GdkAtom axis_label
,gdouble *value
); void gdk_input_set_extension_events (GdkWindow *window
,gint mask
,GdkExtensionMode mode
); enum GdkExtensionMode; GList * gdk_devices_list (void
); GdkDevice * gdk_device_get_core_pointer (void
);
"display" GdkDisplay* : Read / Write / Construct Only "associated-device" GdkDevice* : Read "device-manager" GdkDeviceManager* : Read / Write / Construct Only "display" GdkDisplay* : Read / Write / Construct Only "has-cursor" gboolean : Read / Write / Construct Only "input-mode" GdkInputMode : Read / Write "input-source" GdkInputSource : Read / Write / Construct Only "n-axes" guint : Read "name" gchar* : Read / Write / Construct Only "type" GdkDeviceType : Read / Write / Construct Only
By default, GDK supports the traditional single keyboard/pointer input scheme (Plus additional
special input devices such as tablets. In short, backwards compatible with 2.X). Since version 3.0,
if gdk_enable_multidevice()
is called before gdk_display_open()
and the platform supports it, GDK
will be aware of multiple keyboard/pointer pairs interacting simultaneously with the user interface.
Conceptually, in multidevice mode there are 2 device types, virtual devices (or master devices) are represented by the pointer cursors and keyboard foci that are seen on the screen. physical devices (or slave devices) represent the hardware that is controlling the virtual devices, and thus has no visible cursor on the screen.
Virtual devices are always paired, there is a keyboard device for every pointer device,
associations between devices may be inspected through gdk_device_get_associated_device()
.
There may be several virtual devices, and several physical devices could be controlling each of these virtual devices. Physical devices may also be "floating", which means they are not attached to any virtual device.
By default, GDK will automatically listen for events coming from all master devices, setting the
GdkDevice for all events coming from input devices
[1]
, although gdk_window_set_support_multidevice()
has to be called on GdkWindow in order to
support additional features of multiple pointer interaction, such as multiple, per-device enter/leave
events. The default setting will emit just one enter/leave event pair for all devices on the window.
See gdk_window_set_support_multidevice()
documentation for more information.
In order to listen for events coming from other than a virtual device, gdk_window_set_device_events()
must be called. Generally, this function can be used to modify the event mask for any given device.
Input devices may also provide additional information besides X/Y. For example, graphics tablets may
also provide pressure and X/Y tilt information. This information is device-dependent, and may be
queried through gdk_device_get_axis()
. In multidevice mode, virtual devices will change axes in order
to always represent the physical device that is routing events through it. Whenever the physical device
changes, the "n-axes" property will be notified, and gdk_device_list_axes()
will return the
new device axes.
Devices may also have associated keys or macro buttons. Such keys can be
globally set to map into normal X keyboard events. The mapping is set using gdk_device_set_key()
.
In order to query the device hierarchy and be aware of changes in the device hierarchy (such as
virtual devices being created or removed, or physical devices being plugged or unplugged), GDK
provides GdkDeviceManager. On X11, multidevice support is implemented through XInput 2. If
gdk_enable_multidevice()
is called, the XInput 2.x GdkDeviceManager implementation will be used
as input source, else either the core or XInput 1.x implementations will be used.
typedef enum { GDK_DEVICE_TYPE_MASTER, GDK_DEVICE_TYPE_SLAVE, GDK_DEVICE_TYPE_FLOATING } GdkDeviceType;
Indicates the device type. See above for more information about the meaning of these device types.
typedef enum { GDK_SOURCE_MOUSE, GDK_SOURCE_PEN, GDK_SOURCE_ERASER, GDK_SOURCE_CURSOR, GDK_SOURCE_KEYBOARD } GdkInputSource;
An enumeration describing the type of an input device in general terms.
the device is a mouse. (This will be reported for the core pointer, even if it is something else, such as a trackball.) | |
the device is a stylus of a graphics tablet or similar device. | |
the device is an eraser. Typically, this would be the other end of a stylus on a graphics tablet. | |
the device is a graphics tablet "puck" or similar device. | |
the device is a keyboard. |
typedef enum { GDK_MODE_DISABLED, GDK_MODE_SCREEN, GDK_MODE_WINDOW } GdkInputMode;
An enumeration that describes the mode of an input device.
the device is disabled and will not report any events. | |
the device is enabled. The device's coordinate space maps to the entire screen. | |
the device is enabled. The device's coordinate space is mapped to a single window. The manner in which this window is chosen is undefined, but it will typically be the same way in which the focus window for key events is determined. |
typedef struct { guint keyval; GdkModifierType modifiers; } GdkDeviceKey;
The GdkDeviceKey structure contains information about the mapping of one device macro button onto a normal X key event.
guint |
the keyval to generate when the macro button is pressed. If this is 0, no keypress will be generated. |
GdkModifierType |
the modifiers set for the generated key event. |
typedef struct { GdkAxisUse use; gdouble min; gdouble max; } GdkDeviceAxis;
The GdkDeviceAxis structure contains information about the range and mapping of a device axis.
GdkAxisUse |
specifies how the axis is used. |
gdouble |
the minimal value that will be reported by this axis. |
gdouble |
the maximal value that will be reported by this axis. |
typedef enum { GDK_AXIS_IGNORE, GDK_AXIS_X, GDK_AXIS_Y, GDK_AXIS_PRESSURE, GDK_AXIS_XTILT, GDK_AXIS_YTILT, GDK_AXIS_WHEEL, GDK_AXIS_LAST } GdkAxisUse;
An enumeration describing the way in which a device axis (valuator) maps onto the predefined valuator types that GTK+ understands.
the axis is ignored. | |
the axis is used as the x axis. | |
the axis is used as the y axis. | |
the axis is used for pressure information. | |
the axis is used for x tilt information. | |
the axis is used for x tilt information. | |
the axis is used for wheel information. | |
a constant equal to the numerically highest axis value. |
typedef enum { GDK_OWNERSHIP_NONE, GDK_OWNERSHIP_WINDOW, GDK_OWNERSHIP_APPLICATION } GdkGrabOwnership;
Defines how device grabs interact with other devices.
void gdk_enable_multidevice (void
);
Enables multidevice support in GDK. This call must happen prior
to gdk_display_open()
, gtk_init()
, gtk_init_with_args()
or
gtk_init_check()
in order to take effect.
Note that individual GdkWindows still need to explicitly
enable multidevice awareness through gdk_window_set_support_multidevice()
.
This function must be called before initializing GDK.
Since 3.0
GdkDisplay * gdk_device_manager_get_display (GdkDeviceManager *device_manager
);
Gets the GdkDisplay associated to device_manager
.
|
a GdkDeviceManager |
Returns : |
the GdkDisplay to which device_manager is
associated to, or NULL.
|
Since 3.0
GList * gdk_device_manager_list_devices (GdkDeviceManager *device_manager
,GdkDeviceType type
);
Returns the list of devices of type type
currently attached to
device_manager
.
|
a GdkDeviceManager |
|
device type to get. |
Returns : |
a list of
GdkDevices. The returned list must be
freed with g_list_free() . The list elements are owned by
GTK+ and must not be freed or unreffed. [transfer container][element-type Gdk.Device]
|
Since 3.0
GdkDevice * gdk_device_manager_get_client_pointer
(GdkDeviceManager *device_manager
);
Returns the client pointer, that is, the master pointer that acts as the core pointer for this application. In X11, window managers may change this depending on the interaction pattern under the presence of several pointers.
You should use this function sheldomly, only in code that isn't triggered by a GdkEvent and there aren't other means to get a meaningful GdkDevice to operate on.
|
a GdkDeviceManager |
Returns : |
The client pointer. |
Since 3.0
const gchar * gdk_device_get_name (GdkDevice *device
);
Determines the name of the device.
|
a GdkDevice |
Returns : |
a name |
Since 2.20
void gdk_device_set_source (GdkDevice *device
,GdkInputSource source
);
Sets the source type for an input device.
|
a GdkDevice. |
|
the source type. |
GdkInputSource gdk_device_get_source (GdkDevice *device
);
Determines the type of the device.
|
a GdkDevice |
Returns : |
a GdkInputSource |
Since 2.20
gboolean gdk_device_set_mode (GdkDevice *device
,GdkInputMode mode
);
Sets a the mode of an input device. The mode controls if the device is active and whether the device's range is mapped to the entire screen or to a single window.
GdkInputMode gdk_device_get_mode (GdkDevice *device
);
Determines the mode of the device.
|
a GdkDevice |
Returns : |
a GdkInputSource |
Since 2.20
void gdk_device_set_key (GdkDevice *device
,guint index_
,guint keyval
,GdkModifierType modifiers
);
Specifies the X key event to generate when a macro button of a device is pressed.
|
a GdkDevice |
|
the index of the macro button to set |
|
the keyval to generate |
|
the modifiers to set |
gboolean gdk_device_get_key (GdkDevice *device
,guint index_
,guint *keyval
,GdkModifierType *modifiers
);
If index_
has a valid keyval, this function will return TRUE
and fill in keyval
and modifiers
with the keyval settings.
|
a GdkDevice. |
|
the index of the macro button to get. |
|
return value for the keyval. |
|
return value for modifiers. |
Returns : |
TRUE if keyval is set for index .
|
Since 2.20
void gdk_device_set_axis_use (GdkDevice *device
,guint index_
,GdkAxisUse use
);
Specifies how an axis of a device is used.
|
a GdkDevice |
|
the index of the axis |
|
specifies how the axis is used |
GdkAxisUse gdk_device_get_axis_use (GdkDevice *device
,guint index_
);
Returns the axis use for index_
.
|
a GdkDevice. |
|
the index of the axis. |
Returns : |
a GdkAxisUse specifying how the axis is used. |
Since 2.20
GdkDevice * gdk_device_get_associated_device (GdkDevice *device
);
Returns the associated device to device
, if device
is of type
GDK_DEVICE_TYPE_MASTER
, it will return the paired pointer or
keyboard.
If device
is of type GDK_DEVICE_TYPE_SLAVE
, it will return
the master device to which device
is attached to.
If device
is of type GDK_DEVICE_TYPE_FLOATING
, NULL
will be
returned, as there is no associated device.
Since 3.0
GdkDeviceType gdk_device_get_device_type (GdkDevice *device
);
Returns the device type for device
.
|
a GdkDevice |
Returns : |
the GdkDeviceType for device .
|
Since 3.0
GdkDisplay * gdk_device_get_display (GdkDevice *device
);
Returns the GdkDisplay to which device
pertains.
|
a GdkDevice |
Returns : |
a GdkDisplay. This memory is owned by GTK+, and must not be freed or unreffed. |
Since 3.0
gboolean gdk_device_get_has_cursor (GdkDevice *device
);
Determines whether the pointer follows device motion.
Since 2.20
guint gdk_device_get_n_axes (GdkDevice *device
);
Returns the number of axes the device currently has.
|
a GdkDevice |
Returns : |
the number of axes. |
Since 3.0
GdkGrabStatus gdk_device_grab (GdkDevice *device
,GdkWindow *window
,GdkGrabOwnership grab_ownership
,gboolean owner_events
,GdkEventMask event_mask
,GdkCursor *cursor
,guint32 time_
);
Grabs the device so that all events coming from this device are passed to
this application until the device is ungrabbed with gdk_device_ungrab()
,
or the window becomes unviewable. This overrides any previous grab on the device
by this client.
Device grabs are used for operations which need complete control over the given device events (either pointer or keyboard). For example in GTK+ this is used for Drag and Drop operations, popup menus and such.
Note that if the event mask of an X window has selected both button press
and button release events, then a button press event will cause an automatic
pointer grab until the button is released. X does this automatically since
most applications expect to receive button press and release events in pairs.
It is equivalent to a pointer grab on the window with owner_events
set to
TRUE
.
If you set up anything at the time you take the grab that needs to be cleaned up when the grab ends, you should handle the GdkEventGrabBroken events that are emitted when the grab ends unvoluntarily.
|
a GdkDevice |
|
the GdkWindow which will own the grab (the grab window) |
|
specifies the grab ownership. |
|
if FALSE then all device events are reported with respect to
window and are only reported if selected by event_mask . If
TRUE then pointer events for this application are reported
as normal, but pointer events outside this application are
reported with respect to window and only if selected by
event_mask . In either mode, unreported events are discarded.
|
|
specifies the event mask, which is used in accordance with
owner_events .
|
|
the cursor to display while the grab is active if the device is
a pointer. If this is NULL then the normal cursors are used for
window and its descendants, and the cursor for window is used
elsewhere.
|
|
the timestamp of the event which led to this pointer grab. This
usually comes from the GdkEvent struct, though GDK_CURRENT_TIME
can be used if the time isn't known.
|
Returns : |
GDK_GRAB_SUCCESS if the grab was successful.
|
Since 3.0
void gdk_device_ungrab (GdkDevice *device
,guint32 time_
);
Release any grab on device
.
|
a GdkDevice |
|
a timestap (e.g. GDK_CURRENT_TIME ).
|
Since 3.0
void gdk_device_get_state (GdkDevice *device
,GdkWindow *window
,gdouble *axes
,GdkModifierType *mask
);
Gets the current state of a device relative to window
.
gboolean gdk_device_get_history (GdkDevice *device
,GdkWindow *window
,guint32 start
,guint32 stop
,GdkTimeCoord ***events
,guint *n_events
);
Obtains the motion history for a device; given a starting and
ending timestamp, return all events in the motion history for
the device in the given range of time. Some windowing systems
do not support motion history, in which case, FALSE
will
be returned. (This is not distinguishable from the case where
motion history is supported and no events were found.)
|
a GdkDevice |
|
the window with respect to which which the event coordinates will be reported |
|
starting timestamp for range of events to return |
|
ending timestamp for the range of events to return |
|
location to store a newly-allocated array of GdkTimeCoord, or NULL . [array length=n_events][out length=n_events][transfer none length=n_events]
|
|
location to store the length of events , or NULL
|
Returns : |
TRUE if the windowing system supports motion history and
at least one event was found.
|
void gdk_device_free_history (GdkTimeCoord **events
,gint n_events
);
Frees an array of GdkTimeCoord that was returned by gdk_device_get_history()
.
|
an array of GdkTimeCoord. [inout][transfer none] |
|
the length of the array. |
typedef struct { guint32 time; gdouble axes[GDK_MAX_TIMECOORD_AXES]; } GdkTimeCoord;
The GdkTimeCoord structure stores a single event in a motion history.
gboolean gdk_device_get_axis (GdkDevice *device
,gdouble *axes
,GdkAxisUse use
,gdouble *value
);
Interprets an array of double as axis values for a given device, and locates the value in the array for a given axis use.
GList * gdk_device_list_axes (GdkDevice *device
);
Returns a GList of GdkAtoms, containing the labels for
the axes that device
currently has.
|
a GdkDevice |
Returns : |
A GList of GdkAtoms, free with g_list_free() . [transfer container][element-type GdkAtom]
|
Since 3.0
gboolean gdk_device_get_axis_value (GdkDevice *device
,gdouble *axes
,GdkAtom axis_label
,gdouble *value
);
Interprets an array of double as axis values for a given device,
and locates the value in the array for a given axis label, as returned
by gdk_device_list_axes()
|
a GdkDevice. |
|
pointer to an array of axes |
|
GdkAtom with the axis label. |
|
location to store the found value. |
Returns : |
TRUE if the given axis use was found, otherwise FALSE .
|
Since 3.0
void gdk_input_set_extension_events (GdkWindow *window
,gint mask
,GdkExtensionMode mode
);
gdk_input_set_extension_events
has been deprecated since version 3.0 and should not be used in newly-written code. Use gdk_window_set_device_events()
instead.
Turns extension events on or off for a particular window, and specifies the event mask for extension events.
|
a GdkWindow. |
|
the event mask |
|
the type of extension events that are desired. |
typedef enum { GDK_EXTENSION_EVENTS_NONE, GDK_EXTENSION_EVENTS_ALL, GDK_EXTENSION_EVENTS_CURSOR } GdkExtensionMode;
An enumeration used to specify which extension events are desired for a particular widget.
GList * gdk_devices_list (void
);
gdk_devices_list
has been deprecated since version 3.0 and should not be used in newly-written code. Use gdk_device_manager_list_devices()
instead.
Returns the list of available input devices for the default display. The list is statically allocated and should not be freed.
Returns : |
a list of GdkDevice. [transfer none][element-type GdkDevice] |
GdkDevice * gdk_device_get_core_pointer (void
);
gdk_device_get_core_pointer
has been deprecated since version 3.0 and should not be used in newly-written code. Use gdk_device_manager_get_client_pointer()
instead, or
gdk_event_get_device()
if a GdkEvent with pointer device
information is available.
Returns the core pointer device for the default display.
Returns : |
the core pointer device; this is owned by the display and should not be freed. |
"display"
property"display" GdkDisplay* : Read / Write / Construct Only
Display for the device manager.
"associated-device"
property"associated-device" GdkDevice* : Read
Associated pointer or keyboard with this device, if any. Devices of type GDK_DEVICE_TYPE_MASTER
always come in keyboard/pointer pairs. Other device types will have a NULL
associated device.
Since 3.0
"device-manager"
property"device-manager" GdkDeviceManager* : Read / Write / Construct Only
The GdkDeviceManager the GdkDevice pertains to.
Since 3.0
"display"
property"display" GdkDisplay* : Read / Write / Construct Only
The GdkDisplay the GdkDevice pertains to.
Since 3.0
"has-cursor"
property"has-cursor" gboolean : Read / Write / Construct Only
Whether the device is represented by a cursor on the screen. Devices of type
GDK_DEVICE_TYPE_MASTER
will have TRUE
here.
Default value: FALSE
Since 3.0
"input-mode"
property"input-mode" GdkInputMode : Read / Write
Input mode for the device.
Default value: GDK_MODE_DISABLED
Since 3.0
"input-source"
property"input-source" GdkInputSource : Read / Write / Construct Only
Source type for the device.
Default value: GDK_SOURCE_MOUSE
Since 3.0
"n-axes"
property"n-axes" guint : Read
Number of axes in the device.
Default value: 0
Since 3.0
"name"
property"name" gchar* : Read / Write / Construct Only
The device name.
Default value: NULL
Since 3.0
"type"
property"type" GdkDeviceType : Read / Write / Construct Only
Device role in the device manager.
Default value: GDK_DEVICE_TYPE_MASTER
Since 3.0
"device-added"
signalvoid user_function (GdkDeviceManager *device_manager, GdkDevice *device, gpointer user_data) : Run Last
The ::device-added signal is emitted either when a new master pointer is created, or when a slave (Hardware) input device is plugged in.
|
the object on which the signal is emitted |
|
the newly added GdkDevice. |
|
user data set when the signal handler was connected. |
"device-changed"
signalvoid user_function (GdkDeviceManager *device_manager, GdkDevice *device, gpointer user_data) : Run Last
The ::device-changed signal is emitted either when some GdkDevice has changed the number of either axes or keys. For example In X this will normally happen when the slave device routing events through the master device changes, in that case the master device will change to reflect the new slave device axes and keys.
|
the object on which the signal is emitted |
|
the GdkDevice that changed. |
|
user data set when the signal handler was connected. |
"device-removed"
signalvoid user_function (GdkDeviceManager *device_manager, GdkDevice *device, gpointer user_data) : Run Last
The ::device-removed signal is emitted either when a master pointer is removed, or when a slave (Hardware) input device is unplugged.
|
the object on which the signal is emitted |
|
the just removed GdkDevice. |
|
user data set when the signal handler was connected. |