gdkdevice.h 10 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14
/* GDK - 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
Javier Jardon's avatar
Javier Jardon committed
15
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
16 17
 */

18 19 20
#ifndef __GDK_DEVICE_H__
#define __GDK_DEVICE_H__

21
#if !defined (__GDK_H_INSIDE__) && !defined (GDK_COMPILATION)
22 23 24
#error "Only <gdk/gdk.h> can be included directly."
#endif

25
#include <gdk/gdkversionmacros.h>
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45
#include <gdk/gdktypes.h>


G_BEGIN_DECLS

#define GDK_TYPE_DEVICE         (gdk_device_get_type ())
#define GDK_DEVICE(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), GDK_TYPE_DEVICE, GdkDevice))
#define GDK_IS_DEVICE(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), GDK_TYPE_DEVICE))

typedef struct _GdkTimeCoord GdkTimeCoord;

/**
 * GdkInputSource:
 * @GDK_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.)
 * @GDK_SOURCE_PEN: the device is a stylus of a graphics tablet or similar device.
 * @GDK_SOURCE_ERASER: the device is an eraser. Typically, this would be the other end
 *                     of a stylus on a graphics tablet.
 * @GDK_SOURCE_CURSOR: the device is a graphics tablet "puck" or similar device.
 * @GDK_SOURCE_KEYBOARD: the device is a keyboard.
46 47 48 49
 * @GDK_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.
 * @GDK_SOURCE_TOUCHPAD: the device is an indirect touch device, such
 *     as a touchpad. This device type has been added in 3.4.
50 51 52 53 54 55 56 57 58
 *
 * An enumeration describing the type of an input device in general terms.
 */
typedef enum
{
  GDK_SOURCE_MOUSE,
  GDK_SOURCE_PEN,
  GDK_SOURCE_ERASER,
  GDK_SOURCE_CURSOR,
59 60 61
  GDK_SOURCE_KEYBOARD,
  GDK_SOURCE_TOUCHSCREEN,
  GDK_SOURCE_TOUCHPAD
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
} GdkInputSource;

/**
 * GdkInputMode:
 * @GDK_MODE_DISABLED: the device is disabled and will not report any events.
 * @GDK_MODE_SCREEN: the device is enabled. The device's coordinate space
 *                   maps to the entire screen.
 * @GDK_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
{
  GDK_MODE_DISABLED,
  GDK_MODE_SCREEN,
  GDK_MODE_WINDOW
} GdkInputMode;

/**
 * GdkAxisUse:
 * @GDK_AXIS_IGNORE: the axis is ignored.
 * @GDK_AXIS_X: the axis is used as the x axis.
 * @GDK_AXIS_Y: the axis is used as the y axis.
 * @GDK_AXIS_PRESSURE: the axis is used for pressure information.
 * @GDK_AXIS_XTILT: the axis is used for x tilt information.
90
 * @GDK_AXIS_YTILT: the axis is used for y tilt information.
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
 * @GDK_AXIS_WHEEL: the axis is used for wheel information.
 * @GDK_AXIS_LAST: a constant equal to the numerically highest axis value.
 *
 * An enumeration describing the way in which a device
 * axis (valuator) maps onto the predefined valuator
 * types that GTK+ understands.
 */
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;

/**
 * GdkDeviceType:
 * @GDK_DEVICE_TYPE_MASTER: Device is a master (or virtual) device. There will
 *                          be an associated focus indicator on the screen.
 * @GDK_DEVICE_TYPE_SLAVE: Device is a slave (or physical) device.
 * @GDK_DEVICE_TYPE_FLOATING: Device is a physical device, currently not attached to
 *                            any virtual device.
 *
 * Indicates the device type. See <link linkend="GdkDeviceManager.description">above</link>
 * for more information about the meaning of these device types.
 */
typedef enum {
  GDK_DEVICE_TYPE_MASTER,
  GDK_DEVICE_TYPE_SLAVE,
  GDK_DEVICE_TYPE_FLOATING
} GdkDeviceType;

/* We don't allocate each coordinate this big, but we use it to
 * be ANSI compliant and avoid accessing past the defined limits.
 */
#define GDK_MAX_TIMECOORD_AXES 128

/**
 * GdkTimeCoord:
 * @time: The timestamp for this event.
 * @axes: the values of the device's axes.
 *
 * The #GdkTimeCoord structure stores a single event in a motion history.
 */
struct _GdkTimeCoord
{
  guint32 time;
  gdouble axes[GDK_MAX_TIMECOORD_AXES];
};

145
GDK_AVAILABLE_IN_ALL
146
GType                 gdk_device_get_type       (void) G_GNUC_CONST;
147

148
GDK_AVAILABLE_IN_ALL
149
const gchar *         gdk_device_get_name       (GdkDevice *device);
150
GDK_AVAILABLE_IN_ALL
151 152 153
gboolean              gdk_device_get_has_cursor (GdkDevice *device);

/* Functions to configure a device */
154
GDK_AVAILABLE_IN_ALL
155 156
GdkInputSource gdk_device_get_source    (GdkDevice      *device);

157
GDK_AVAILABLE_IN_ALL
158
GdkInputMode   gdk_device_get_mode      (GdkDevice      *device);
159
GDK_AVAILABLE_IN_ALL
160
gboolean       gdk_device_set_mode      (GdkDevice      *device,
Matthias Clasen's avatar
Matthias Clasen committed
161
                                         GdkInputMode    mode);
162

163
GDK_AVAILABLE_IN_ALL
164
gint           gdk_device_get_n_keys    (GdkDevice       *device);
165
GDK_AVAILABLE_IN_ALL
166 167 168 169
gboolean       gdk_device_get_key       (GdkDevice       *device,
                                         guint            index_,
                                         guint           *keyval,
                                         GdkModifierType *modifiers);
170
GDK_AVAILABLE_IN_ALL
171
void           gdk_device_set_key       (GdkDevice      *device,
Matthias Clasen's avatar
Matthias Clasen committed
172 173 174
                                         guint           index_,
                                         guint           keyval,
                                         GdkModifierType modifiers);
175

176
GDK_AVAILABLE_IN_ALL
177 178
GdkAxisUse     gdk_device_get_axis_use  (GdkDevice         *device,
                                         guint              index_);
179
GDK_AVAILABLE_IN_ALL
180 181 182 183 184
void           gdk_device_set_axis_use  (GdkDevice         *device,
                                         guint              index_,
                                         GdkAxisUse         use);


185
GDK_AVAILABLE_IN_ALL
186
void     gdk_device_get_state    (GdkDevice         *device,
Matthias Clasen's avatar
Matthias Clasen committed
187 188 189
                                  GdkWindow         *window,
                                  gdouble           *axes,
                                  GdkModifierType   *mask);
190
GDK_AVAILABLE_IN_ALL
191 192 193 194
void     gdk_device_get_position (GdkDevice         *device,
                                  GdkScreen        **screen,
                                  gint              *x,
                                  gint              *y);
195
GDK_AVAILABLE_IN_ALL
196 197 198 199 200
GdkWindow *
         gdk_device_get_window_at_position
                                 (GdkDevice         *device,
                                  gint              *win_x,
                                  gint              *win_y);
201
GDK_AVAILABLE_IN_ALL
202
gboolean gdk_device_get_history  (GdkDevice         *device,
Matthias Clasen's avatar
Matthias Clasen committed
203 204 205 206 207
                                  GdkWindow         *window,
                                  guint32            start,
                                  guint32            stop,
                                  GdkTimeCoord    ***events,
                                  gint              *n_events);
208
GDK_AVAILABLE_IN_ALL
209
void     gdk_device_free_history (GdkTimeCoord     **events,
Matthias Clasen's avatar
Matthias Clasen committed
210
                                  gint               n_events);
211

212
GDK_AVAILABLE_IN_ALL
213
gint     gdk_device_get_n_axes     (GdkDevice       *device);
214
GDK_AVAILABLE_IN_ALL
215
GList *  gdk_device_list_axes      (GdkDevice       *device);
216
GDK_AVAILABLE_IN_ALL
217 218 219 220 221
gboolean gdk_device_get_axis_value (GdkDevice       *device,
                                    gdouble         *axes,
                                    GdkAtom          axis_label,
                                    gdouble         *value);

222
GDK_AVAILABLE_IN_ALL
223
gboolean gdk_device_get_axis     (GdkDevice         *device,
Matthias Clasen's avatar
Matthias Clasen committed
224 225 226
                                  gdouble           *axes,
                                  GdkAxisUse         use,
                                  gdouble           *value);
227
GDK_AVAILABLE_IN_ALL
228 229
GdkDisplay * gdk_device_get_display (GdkDevice      *device);

230
GDK_AVAILABLE_IN_ALL
231
GdkDevice  * gdk_device_get_associated_device (GdkDevice     *device);
232
GDK_AVAILABLE_IN_ALL
233
GList *      gdk_device_list_slave_devices    (GdkDevice     *device);
234

235
GDK_AVAILABLE_IN_ALL
236 237
GdkDeviceType gdk_device_get_device_type (GdkDevice *device);

238
GDK_AVAILABLE_IN_ALL
239 240 241 242 243 244 245 246
GdkGrabStatus gdk_device_grab        (GdkDevice        *device,
                                      GdkWindow        *window,
                                      GdkGrabOwnership  grab_ownership,
                                      gboolean          owner_events,
                                      GdkEventMask      event_mask,
                                      GdkCursor        *cursor,
                                      guint32           time_);

247
GDK_AVAILABLE_IN_ALL
248 249 250
void          gdk_device_ungrab      (GdkDevice        *device,
                                      guint32           time_);

251
GDK_AVAILABLE_IN_ALL
252 253 254 255 256
void          gdk_device_warp        (GdkDevice        *device,
                                      GdkScreen        *screen,
                                      gint              x,
                                      gint              y);

257
GDK_AVAILABLE_IN_ALL
258 259 260 261 262 263 264 265 266
gboolean gdk_device_grab_info_libgtk_only (GdkDisplay  *display,
                                           GdkDevice   *device,
                                           GdkWindow  **grab_window,
                                           gboolean    *owner_events);


G_END_DECLS

#endif /* __GDK_DEVICE_H__ */