1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270 | /* CDK - The GIMP Drawing Kit
* Copyright (C) 2009 Carlos Garnacho <carlosg@gnome.org>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef __CDK_DEVICE_H__
#define __CDK_DEVICE_H__
#if !defined (__CDK_H_INSIDE__) && !defined (CDK_COMPILATION)
#error "Only <cdk/cdk.h> can be included directly."
#endif
#include <cdk/cdkversionmacros.h>
#include <cdk/cdktypes.h>
G_BEGIN_DECLS
#define CDK_TYPE_DEVICE (cdk_device_get_type ())
#define CDK_DEVICE(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), CDK_TYPE_DEVICE, CdkDevice))
#define CDK_IS_DEVICE(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), CDK_TYPE_DEVICE))
typedef struct _CdkTimeCoord CdkTimeCoord;
/**
* CdkInputSource:
* @CDK_SOURCE_MOUSE: the device is a mouse. (This will be reported for the core
* pointer, even if it is something else, such as a trackball.)
* @CDK_SOURCE_PEN: the device is a stylus of a graphics tablet or similar device.
* @CDK_SOURCE_ERASER: the device is an eraser. Typically, this would be the other end
* of a stylus on a graphics tablet.
* @CDK_SOURCE_CURSOR: the device is a graphics tablet “puck” or similar device.
* @CDK_SOURCE_KEYBOARD: the device is a keyboard.
* @CDK_SOURCE_TOUCHSCREEN: the device is a direct-input touch device, such
* as a touchscreen or tablet. This device type has been added in 3.4.
* @CDK_SOURCE_TOUCHPAD: the device is an indirect touch device, such
* as a touchpad. This device type has been added in 3.4.
* @CDK_SOURCE_TRACKPOINT: the device is a trackpoint. This device type has been
* added in 3.22
* @CDK_SOURCE_TABLET_PAD: the device is a "pad", a collection of buttons,
* rings and strips found in drawing tablets. This device type has been
* added in 3.22.
*
* An enumeration describing the type of an input device in general terms.
*/
typedef enum
{
CDK_SOURCE_MOUSE,
CDK_SOURCE_PEN,
CDK_SOURCE_ERASER,
CDK_SOURCE_CURSOR,
CDK_SOURCE_KEYBOARD,
CDK_SOURCE_TOUCHSCREEN,
CDK_SOURCE_TOUCHPAD,
CDK_SOURCE_TRACKPOINT,
CDK_SOURCE_TABLET_PAD
} CdkInputSource;
/**
* CdkInputMode:
* @CDK_MODE_DISABLED: the device is disabled and will not report any events.
* @CDK_MODE_SCREEN: the device is enabled. The device’s coordinate space
* maps to the entire screen.
* @CDK_MODE_WINDOW: 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.
*
* An enumeration that describes the mode of an input device.
*/
typedef enum
{
CDK_MODE_DISABLED,
CDK_MODE_SCREEN,
CDK_MODE_WINDOW
} CdkInputMode;
/**
* CdkDeviceType:
* @CDK_DEVICE_TYPE_MASTER: Device is a master (or virtual) device. There will
* be an associated focus indicator on the screen.
* @CDK_DEVICE_TYPE_SLAVE: Device is a slave (or physical) device.
* @CDK_DEVICE_TYPE_FLOATING: Device is a physical device, currently not attached to
* any virtual device.
*
* Indicates the device type. See [above][CdkDeviceManager.description]
* for more information about the meaning of these device types.
*/
typedef enum {
CDK_DEVICE_TYPE_MASTER,
CDK_DEVICE_TYPE_SLAVE,
CDK_DEVICE_TYPE_FLOATING
} CdkDeviceType;
/* We don't allocate each coordinate this big, but we use it to
* be ANSI compliant and avoid accessing past the defined limits.
*/
#define CDK_MAX_TIMECOORD_AXES 128
/**
* CdkTimeCoord:
* @time: The timestamp for this event.
* @axes: the values of the device’s axes.
*
* A #CdkTimeCoord stores a single event in a motion history.
*/
struct _CdkTimeCoord
{
guint32 time;
gdouble axes[CDK_MAX_TIMECOORD_AXES];
};
CDK_AVAILABLE_IN_ALL
GType cdk_device_get_type (void) G_GNUC_CONST;
CDK_AVAILABLE_IN_ALL
const gchar * cdk_device_get_name (CdkDevice *device);
CDK_AVAILABLE_IN_ALL
gboolean cdk_device_get_has_cursor (CdkDevice *device);
/* Functions to configure a device */
CDK_AVAILABLE_IN_ALL
CdkInputSource cdk_device_get_source (CdkDevice *device);
CDK_AVAILABLE_IN_ALL
CdkInputMode cdk_device_get_mode (CdkDevice *device);
CDK_AVAILABLE_IN_ALL
gboolean cdk_device_set_mode (CdkDevice *device,
CdkInputMode mode);
CDK_AVAILABLE_IN_ALL
gint cdk_device_get_n_keys (CdkDevice *device);
CDK_AVAILABLE_IN_ALL
gboolean cdk_device_get_key (CdkDevice *device,
guint index_,
guint *keyval,
CdkModifierType *modifiers);
CDK_AVAILABLE_IN_ALL
void cdk_device_set_key (CdkDevice *device,
guint index_,
guint keyval,
CdkModifierType modifiers);
CDK_AVAILABLE_IN_ALL
CdkAxisUse cdk_device_get_axis_use (CdkDevice *device,
guint index_);
CDK_AVAILABLE_IN_ALL
void cdk_device_set_axis_use (CdkDevice *device,
guint index_,
CdkAxisUse use);
CDK_AVAILABLE_IN_ALL
void cdk_device_get_state (CdkDevice *device,
CdkWindow *window,
gdouble *axes,
CdkModifierType *mask);
CDK_AVAILABLE_IN_ALL
void cdk_device_get_position (CdkDevice *device,
CdkScreen **screen,
gint *x,
gint *y);
CDK_AVAILABLE_IN_ALL
CdkWindow *
cdk_device_get_window_at_position
(CdkDevice *device,
gint *win_x,
gint *win_y);
CDK_AVAILABLE_IN_3_10
void cdk_device_get_position_double (CdkDevice *device,
CdkScreen **screen,
gdouble *x,
gdouble *y);
CDK_AVAILABLE_IN_3_10
CdkWindow *
cdk_device_get_window_at_position_double
(CdkDevice *device,
gdouble *win_x,
gdouble *win_y);
CDK_AVAILABLE_IN_ALL
gboolean cdk_device_get_history (CdkDevice *device,
CdkWindow *window,
guint32 start,
guint32 stop,
CdkTimeCoord ***events,
gint *n_events);
CDK_AVAILABLE_IN_ALL
void cdk_device_free_history (CdkTimeCoord **events,
gint n_events);
CDK_AVAILABLE_IN_ALL
gint cdk_device_get_n_axes (CdkDevice *device);
CDK_AVAILABLE_IN_ALL
GList * cdk_device_list_axes (CdkDevice *device);
CDK_AVAILABLE_IN_ALL
gboolean cdk_device_get_axis_value (CdkDevice *device,
gdouble *axes,
CdkAtom axis_label,
gdouble *value);
CDK_AVAILABLE_IN_ALL
gboolean cdk_device_get_axis (CdkDevice *device,
gdouble *axes,
CdkAxisUse use,
gdouble *value);
CDK_AVAILABLE_IN_ALL
CdkDisplay * cdk_device_get_display (CdkDevice *device);
CDK_AVAILABLE_IN_ALL
CdkDevice * cdk_device_get_associated_device (CdkDevice *device);
CDK_AVAILABLE_IN_ALL
GList * cdk_device_list_slave_devices (CdkDevice *device);
CDK_AVAILABLE_IN_ALL
CdkDeviceType cdk_device_get_device_type (CdkDevice *device);
CDK_DEPRECATED_IN_3_20_FOR(cdk_seat_grab)<--- There is an unknown macro here somewhere. Configuration is required. If CDK_DEPRECATED_IN_3_20_FOR is a macro then please configure it.
CdkGrabStatus cdk_device_grab (CdkDevice *device,
CdkWindow *window,
CdkGrabOwnership grab_ownership,
gboolean owner_events,
CdkEventMask event_mask,
CdkCursor *cursor,
guint32 time_);
CDK_DEPRECATED_IN_3_20_FOR(cdk_seat_ungrab)
void cdk_device_ungrab (CdkDevice *device,
guint32 time_);
CDK_AVAILABLE_IN_ALL
void cdk_device_warp (CdkDevice *device,
CdkScreen *screen,
gint x,
gint y);
CDK_DEPRECATED_IN_3_16
gboolean cdk_device_grab_info_libctk_only (CdkDisplay *display,
CdkDevice *device,
CdkWindow **grab_window,
gboolean *owner_events);
CDK_AVAILABLE_IN_3_12
CdkWindow *cdk_device_get_last_event_window (CdkDevice *device);
CDK_AVAILABLE_IN_3_16
const gchar *cdk_device_get_vendor_id (CdkDevice *device);
CDK_AVAILABLE_IN_3_16
const gchar *cdk_device_get_product_id (CdkDevice *device);
CDK_AVAILABLE_IN_3_20
CdkSeat *cdk_device_get_seat (CdkDevice *device);
CDK_AVAILABLE_IN_3_22
CdkAxisFlags cdk_device_get_axes (CdkDevice *device);
G_END_DECLS
#endif /* __CDK_DEVICE_H__ */
|