summaryrefslogtreecommitdiff
path: root/clutter/clutter/clutter-input-device.h
blob: 5e377cdcc193ebffa0c963c5d116f3b1728d9170 (plain)
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
/*
 * Clutter.
 *
 * An OpenGL based 'interactive canvas' library.
 *
 * Copyright © 2009, 2010, 2011  Intel Corp.
 *
 * 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/>.
 *
 * Author: Emmanuele Bassi <ebassi@linux.intel.com>
 */

#ifndef __CLUTTER_INPUT_DEVICE_H__
#define __CLUTTER_INPUT_DEVICE_H__

#if !defined(__CLUTTER_H_INSIDE__) && !defined(CLUTTER_COMPILATION)
#error "Only <clutter/clutter.h> can be included directly."
#endif

#include <clutter/clutter-backend.h>
#include <clutter/clutter-types.h>
#include <clutter/clutter-seat.h>

G_BEGIN_DECLS

struct _ClutterInputDeviceClass
{
  GObjectClass parent_class;

  gboolean (* is_mode_switch_button) (ClutterInputDevice *device,
                                      guint               group,
                                      guint               button);
  gint (* get_group_n_modes) (ClutterInputDevice *device,
                              gint                group);

  gboolean (* is_grouped) (ClutterInputDevice *device,
                           ClutterInputDevice *other_device);

  int (* get_pad_feature_group) (ClutterInputDevice           *device,
                                 ClutterInputDevicePadFeature  feature,
                                 int                           n_feature);
};

#define CLUTTER_TYPE_INPUT_DEVICE               (clutter_input_device_get_type ())
#define CLUTTER_INPUT_DEVICE(obj)               (G_TYPE_CHECK_INSTANCE_CAST ((obj), CLUTTER_TYPE_INPUT_DEVICE, ClutterInputDevice))
#define CLUTTER_IS_INPUT_DEVICE(obj)            (G_TYPE_CHECK_INSTANCE_TYPE ((obj), CLUTTER_TYPE_INPUT_DEVICE))
#define CLUTTER_INPUT_DEVICE_CLASS(klass)       (G_TYPE_CHECK_CLASS_CAST ((klass), CLUTTER_TYPE_INPUT_DEVICE, ClutterInputDeviceClass))
#define CLUTTER_IS_INPUT_DEVICE_CLASS(klass)    (G_TYPE_CHECK_CLASS_TYPE ((klass), CLUTTER_TYPE_INPUT_DEVICE))
#define CLUTTER_INPUT_DEVICE_GET_CLASS(obj)     (G_TYPE_INSTANCE_GET_CLASS ((obj), CLUTTER_TYPE_INPUT_DEVICE, ClutterInputDeviceClass))

/**
 * ClutterInputDevice:
 *
 * Generic representation of an input device. The actual contents of this
 * structure depend on the backend used.
 */
typedef struct _ClutterInputDeviceClass ClutterInputDeviceClass;

CLUTTER_EXPORT
GType clutter_input_device_get_type (void) G_GNUC_CONST;

CLUTTER_EXPORT
ClutterInputDeviceType  clutter_input_device_get_device_type    (ClutterInputDevice  *device);

CLUTTER_EXPORT
ClutterActor *          clutter_input_device_get_actor (ClutterInputDevice   *device,
                                                        ClutterEventSequence *sequence);
CLUTTER_EXPORT
const gchar *           clutter_input_device_get_device_name    (ClutterInputDevice  *device);
CLUTTER_EXPORT
ClutterInputMode        clutter_input_device_get_device_mode    (ClutterInputDevice  *device);
CLUTTER_EXPORT
gboolean                clutter_input_device_get_has_cursor     (ClutterInputDevice  *device);

CLUTTER_EXPORT
guint                   clutter_input_device_get_n_axes         (ClutterInputDevice  *device);
CLUTTER_EXPORT
ClutterInputAxis        clutter_input_device_get_axis           (ClutterInputDevice  *device,
                                                                 guint                index_);
CLUTTER_EXPORT
gboolean                clutter_input_device_get_axis_value     (ClutterInputDevice  *device,
                                                                 gdouble             *axes,
                                                                 ClutterInputAxis     axis,
                                                                 gdouble             *value);

CLUTTER_EXPORT
void                    clutter_input_device_grab               (ClutterInputDevice  *device,
                                                                 ClutterActor        *actor);
CLUTTER_EXPORT
void                    clutter_input_device_ungrab             (ClutterInputDevice  *device);
CLUTTER_EXPORT
ClutterActor *          clutter_input_device_get_grabbed_actor  (ClutterInputDevice  *device);

CLUTTER_EXPORT
void                    clutter_input_device_sequence_grab      (ClutterInputDevice   *device,
                                                                 ClutterEventSequence *sequence,
                                                                 ClutterActor         *actor);
CLUTTER_EXPORT
void                    clutter_input_device_sequence_ungrab    (ClutterInputDevice   *device,
                                                                 ClutterEventSequence *sequence);
CLUTTER_EXPORT
ClutterActor *          clutter_input_device_sequence_get_grabbed_actor (ClutterInputDevice   *device,
                                                                         ClutterEventSequence *sequence);

CLUTTER_EXPORT
const gchar *           clutter_input_device_get_vendor_id      (ClutterInputDevice *device);
CLUTTER_EXPORT
const gchar *           clutter_input_device_get_product_id     (ClutterInputDevice *device);

CLUTTER_EXPORT
gint                    clutter_input_device_get_n_rings        (ClutterInputDevice *device);
CLUTTER_EXPORT
gint                    clutter_input_device_get_n_strips       (ClutterInputDevice *device);
CLUTTER_EXPORT
gint                    clutter_input_device_get_n_mode_groups  (ClutterInputDevice *device);
CLUTTER_EXPORT
int                     clutter_input_device_get_n_buttons (ClutterInputDevice *device);


CLUTTER_EXPORT
gint                    clutter_input_device_get_group_n_modes  (ClutterInputDevice *device,
                                                                 gint                group);

CLUTTER_EXPORT
gboolean                clutter_input_device_is_mode_switch_button (ClutterInputDevice *device,
                                                                    guint               group,
								    guint               button);
CLUTTER_EXPORT
gint                    clutter_input_device_get_mode_switch_button_group (ClutterInputDevice *device,
                                                                           guint               button);

CLUTTER_EXPORT
const gchar *           clutter_input_device_get_device_node    (ClutterInputDevice *device);

CLUTTER_EXPORT
gboolean                  clutter_input_device_is_grouped       (ClutterInputDevice *device,
                                                                 ClutterInputDevice *other_device);
CLUTTER_EXPORT
ClutterSeat *             clutter_input_device_get_seat         (ClutterInputDevice *device);

CLUTTER_EXPORT
int clutter_input_device_get_pad_feature_group (ClutterInputDevice           *device,
                                                ClutterInputDevicePadFeature  feature,
                                                int                           n_feature);

G_END_DECLS

#endif /* __CLUTTER_INPUT_DEVICE_H__ */