1 /* GDK - The GIMP Drawing Kit
2 * Copyright (C) 2009 Carlos Garnacho <carlosg@gnome.org>
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
20 #if !defined (__GDK_H_INSIDE__) && !defined (GDK_COMPILATION)
21 #error "Only <gdk/gdk.h> can be included directly."
24 #ifndef __GDK_DEVICE_H__
25 #define __GDK_DEVICE_H__
27 #include <gdk/gdktypes.h>
32 #define GDK_TYPE_DEVICE (gdk_device_get_type ())
33 #define GDK_DEVICE(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), GDK_TYPE_DEVICE, GdkDevice))
34 #define GDK_IS_DEVICE(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), GDK_TYPE_DEVICE))
36 typedef struct _GdkDevice GdkDevice;
37 typedef struct _GdkDevicePrivate GdkDevicePrivate;
38 typedef struct _GdkTimeCoord GdkTimeCoord;
42 * @GDK_EXTENSION_EVENTS_NONE: no extension events are desired.
43 * @GDK_EXTENSION_EVENTS_ALL: all extension events are desired.
44 * @GDK_EXTENSION_EVENTS_CURSOR: extension events are desired only if a cursor
45 * will be displayed for the device.
47 * An enumeration used to specify which extension events
48 * are desired for a particular widget.
52 GDK_EXTENSION_EVENTS_NONE,
53 GDK_EXTENSION_EVENTS_ALL,
54 GDK_EXTENSION_EVENTS_CURSOR
59 * @GDK_SOURCE_MOUSE: the device is a mouse. (This will be reported for the core
60 * pointer, even if it is something else, such as a trackball.)
61 * @GDK_SOURCE_PEN: the device is a stylus of a graphics tablet or similar device.
62 * @GDK_SOURCE_ERASER: the device is an eraser. Typically, this would be the other end
63 * of a stylus on a graphics tablet.
64 * @GDK_SOURCE_CURSOR: the device is a graphics tablet "puck" or similar device.
65 * @GDK_SOURCE_KEYBOARD: the device is a keyboard.
67 * An enumeration describing the type of an input device in general terms.
80 * @GDK_MODE_DISABLED: the device is disabled and will not report any events.
81 * @GDK_MODE_SCREEN: the device is enabled. The device's coordinate space
82 * maps to the entire screen.
83 * @GDK_MODE_WINDOW: the device is enabled. The device's coordinate space
84 * is mapped to a single window. The manner in which this window
85 * is chosen is undefined, but it will typically be the same
86 * way in which the focus window for key events is determined.
88 * An enumeration that describes the mode of an input device.
99 * @GDK_AXIS_IGNORE: the axis is ignored.
100 * @GDK_AXIS_X: the axis is used as the x axis.
101 * @GDK_AXIS_Y: the axis is used as the y axis.
102 * @GDK_AXIS_PRESSURE: the axis is used for pressure information.
103 * @GDK_AXIS_XTILT: the axis is used for x tilt information.
104 * @GDK_AXIS_YTILT: the axis is used for x tilt information.
105 * @GDK_AXIS_WHEEL: the axis is used for wheel information.
106 * @GDK_AXIS_LAST: a constant equal to the numerically highest axis value.
108 * An enumeration describing the way in which a device
109 * axis (valuator) maps onto the predefined valuator
110 * types that GTK+ understands.
126 * @GDK_DEVICE_TYPE_MASTER: Device is a master (or virtual) device. There will
127 * be an associated focus indicator on the screen.
128 * @GDK_DEVICE_TYPE_SLAVE: Device is a slave (or physical) device.
129 * @GDK_DEVICE_TYPE_FLOATING: Device is a physical device, currently not attached to
130 * any virtual device.
132 * Indicates the device type. See <link linkend="GdkDeviceManager.description">above</link>
133 * for more information about the meaning of these device types.
136 GDK_DEVICE_TYPE_MASTER,
137 GDK_DEVICE_TYPE_SLAVE,
138 GDK_DEVICE_TYPE_FLOATING
141 /* We don't allocate each coordinate this big, but we use it to
142 * be ANSI compliant and avoid accessing past the defined limits.
144 #define GDK_MAX_TIMECOORD_AXES 128
148 * @time: The timestamp for this event.
149 * @axes: the values of the device's axes.
151 * The #GdkTimeCoord structure stores a single event in a motion history.
156 gdouble axes[GDK_MAX_TIMECOORD_AXES];
159 GType gdk_device_get_type (void) G_GNUC_CONST;
161 G_CONST_RETURN gchar *gdk_device_get_name (GdkDevice *device);
162 gboolean gdk_device_get_has_cursor (GdkDevice *device);
164 /* Functions to configure a device */
165 GdkInputSource gdk_device_get_source (GdkDevice *device);
166 void gdk_device_set_source (GdkDevice *device,
167 GdkInputSource source);
169 GdkInputMode gdk_device_get_mode (GdkDevice *device);
170 gboolean gdk_device_set_mode (GdkDevice *device,
173 gint gdk_device_get_n_keys (GdkDevice *device);
174 gboolean gdk_device_get_key (GdkDevice *device,
177 GdkModifierType *modifiers);
178 void gdk_device_set_key (GdkDevice *device,
181 GdkModifierType modifiers);
183 GdkAxisUse gdk_device_get_axis_use (GdkDevice *device,
185 void gdk_device_set_axis_use (GdkDevice *device,
190 void gdk_device_get_state (GdkDevice *device,
193 GdkModifierType *mask);
194 gboolean gdk_device_get_history (GdkDevice *device,
198 GdkTimeCoord ***events,
200 void gdk_device_free_history (GdkTimeCoord **events,
203 gint gdk_device_get_n_axes (GdkDevice *device);
204 GList * gdk_device_list_axes (GdkDevice *device);
205 gboolean gdk_device_get_axis_value (GdkDevice *device,
210 gboolean gdk_device_get_axis (GdkDevice *device,
214 GdkDisplay * gdk_device_get_display (GdkDevice *device);
216 GdkDevice * gdk_device_get_associated_device (GdkDevice *device);
217 GList * gdk_device_list_slave_devices (GdkDevice *device);
219 GdkDeviceType gdk_device_get_device_type (GdkDevice *device);
221 GdkGrabStatus gdk_device_grab (GdkDevice *device,
223 GdkGrabOwnership grab_ownership,
224 gboolean owner_events,
225 GdkEventMask event_mask,
229 void gdk_device_ungrab (GdkDevice *device,
232 gboolean gdk_device_grab_info_libgtk_only (GdkDisplay *display,
234 GdkWindow **grab_window,
235 gboolean *owner_events);
240 #endif /* __GDK_DEVICE_H__ */