← Back to branch summary

~ubuntu-branches/ubuntu/precise/libgrip/precise

« back to all changes in this revision

Viewing changes to doc/reference/html/libgrip-Input-Devices.html

  • Committer: Bazaar Package Importer
  • Author(s): Chase Douglas
  • Date: 2011-08-09 16:33:26 UTC
  • mfrom: (1.1.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20110809163326-p2ky362j7dbl0d99
Tags: 0.3.0-0ubuntu1
https://launchpad.net/bugs/744911
* New upstream release.
  - Add documentation (LP: #744911)
  - Expose device type and attributes

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/html/libgrip-Input-Devices.html
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html>
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 
5
<title>Input Devices</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
 
7
<link rel="home" href="index.html" title="libgrip Reference Manual">
 
8
<link rel="up" href="libgrip-api.html" title="Programming Interface">
 
9
<link rel="prev" href="libgrip-Gesture-Events.html" title="Gesture Events">
 
10
<link rel="next" href="object-tree.html" title="Object Hierarchy">
 
11
<meta name="generator" content="GTK-Doc V1.17 (XML mode)">
 
12
<link rel="stylesheet" href="style.css" type="text/css">
 
13
</head>
 
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
 
16
<tr valign="middle">
 
17
<td><a accesskey="p" href="libgrip-Gesture-Events.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
18
<td><a accesskey="u" href="libgrip-api.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
 
20
<th width="100%" align="center">libgrip Reference Manual</th>
 
21
<td><a accesskey="n" href="object-tree.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
22
</tr>
 
23
<tr><td colspan="5" class="shortcuts">
 
24
<a href="#libgrip-Input-Devices.synopsis" class="shortcut">Top</a>
 
25
                   | 
 
26
                  <a href="#libgrip-Input-Devices.description" class="shortcut">Description</a>
 
27
                   | 
 
28
                  <a href="#libgrip-Input-Devices.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
29
                   | 
 
30
                  <a href="#libgrip-Input-Devices.properties" class="shortcut">Properties</a>
 
31
</td></tr>
 
32
</table>
 
33
<div class="refentry">
 
34
<a name="libgrip-Input-Devices"></a><div class="titlepage"></div>
 
35
<div class="refnamediv"><table width="100%"><tr>
 
36
<td valign="top">
 
37
<h2><span class="refentrytitle"><a name="libgrip-Input-Devices.top_of_page"></a>Input Devices</span></h2>
 
38
<p>Input Devices</p>
 
39
</td>
 
40
<td valign="top" align="right"></td>
 
41
</tr></table></div>
 
42
<div class="refsynopsisdiv">
 
43
<a name="libgrip-Input-Devices.synopsis"></a><h2>Synopsis</h2>
 
44
<a name="GripInputDevice"></a><pre class="synopsis">                    <a class="link" href="libgrip-Input-Devices.html#GripInputDevice-struct" title="GripInputDevice">GripInputDevice</a>;
 
45
                    <a class="link" href="libgrip-Input-Devices.html#GripInputDeviceClass" title="GripInputDeviceClass">GripInputDeviceClass</a>;
 
46
 
 
47
 
 
48
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="libgrip-Input-Devices.html#grip-input-device-get-id" title="grip_input_device_get_id ()">grip_input_device_get_id</a>            (<em class="parameter"><code><a class="link" href="libgrip-Input-Devices.html#GripInputDevice"><span class="type">GripInputDevice</span></a> *input_device</code></em>);
 
49
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="libgrip-Input-Devices.html#grip-input-device-get-name" title="grip_input_device_get_name ()">grip_input_device_get_name</a>          (<em class="parameter"><code><a class="link" href="libgrip-Input-Devices.html#GripInputDevice"><span class="type">GripInputDevice</span></a> *input_device</code></em>);
 
50
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="libgrip-Input-Devices.html#grip-input-device-is-direct" title="grip_input_device_is_direct ()">grip_input_device_is_direct</a>         (<em class="parameter"><code><a class="link" href="libgrip-Input-Devices.html#GripInputDevice"><span class="type">GripInputDevice</span></a> *input_device</code></em>);
 
51
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="libgrip-Input-Devices.html#grip-input-device-is-independent" title="grip_input_device_is_independent ()">grip_input_device_is_independent</a>    (<em class="parameter"><code><a class="link" href="libgrip-Input-Devices.html#GripInputDevice"><span class="type">GripInputDevice</span></a> *input_device</code></em>);
 
52
<span class="returnvalue">AxisExtents</span> *       <a class="link" href="libgrip-Input-Devices.html#grip-input-device-get-x-extents" title="grip_input_device_get_x_extents ()">grip_input_device_get_x_extents</a>     (<em class="parameter"><code><a class="link" href="libgrip-Input-Devices.html#GripInputDevice"><span class="type">GripInputDevice</span></a> *input_device</code></em>);
 
53
<span class="returnvalue">AxisExtents</span> *       <a class="link" href="libgrip-Input-Devices.html#grip-input-device-get-y-extents" title="grip_input_device_get_y_extents ()">grip_input_device_get_y_extents</a>     (<em class="parameter"><code><a class="link" href="libgrip-Input-Devices.html#GripInputDevice"><span class="type">GripInputDevice</span></a> *input_device</code></em>);
 
54
</pre>
 
55
</div>
 
56
<div class="refsect1">
 
57
<a name="libgrip-Input-Devices.object-hierarchy"></a><h2>Object Hierarchy</h2>
 
58
<pre class="synopsis">
 
59
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
60
   +----GripInputDevice
 
61
</pre>
 
62
</div>
 
63
<div class="refsect1">
 
64
<a name="libgrip-Input-Devices.properties"></a><h2>Properties</h2>
 
65
<pre class="synopsis">
 
66
  "<a class="link" href="libgrip-Input-Devices.html#GripInputDevice--device-attrs" title='The "device-attrs" property'>device-attrs</a>"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>              : Write / Construct Only
 
67
  "<a class="link" href="libgrip-Input-Devices.html#GripInputDevice--geis-device" title='The "geis-device" property'>geis-device</a>"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>              : Write / Construct Only
 
68
</pre>
 
69
</div>
 
70
<div class="refsect1">
 
71
<a name="libgrip-Input-Devices.description"></a><h2>Description</h2>
 
72
<p>
 
73
The Grip input device represents input devices known to the uTouch gesture
 
74
recognition stack.
 
75
</p>
 
76
</div>
 
77
<div class="refsect1">
 
78
<a name="libgrip-Input-Devices.details"></a><h2>Details</h2>
 
79
<div class="refsect2">
 
80
<a name="GripInputDevice-struct"></a><h3>GripInputDevice</h3>
 
81
<pre class="programlisting">typedef struct _GripInputDevice GripInputDevice;</pre>
 
82
<p>
 
83
This struct contains private data only, and should be accessed using the
 
84
functions below.
 
85
</p>
 
86
</div>
 
87
<hr>
 
88
<div class="refsect2">
 
89
<a name="GripInputDeviceClass"></a><h3>GripInputDeviceClass</h3>
 
90
<pre class="programlisting">typedef struct {
 
91
        GObjectClass parent_class;
 
92
} GripInputDeviceClass;
 
93
</pre>
 
94
<p>
 
95
</p>
 
96
</div>
 
97
<hr>
 
98
<div class="refsect2">
 
99
<a name="grip-input-device-get-id"></a><h3>grip_input_device_get_id ()</h3>
 
100
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               grip_input_device_get_id            (<em class="parameter"><code><a class="link" href="libgrip-Input-Devices.html#GripInputDevice"><span class="type">GripInputDevice</span></a> *input_device</code></em>);</pre>
 
101
<p>
 
102
Gets the internal identifier of the input device.
 
103
</p>
 
104
<div class="variablelist"><table border="0">
 
105
<col align="left" valign="top">
 
106
<tbody>
 
107
<tr>
 
108
<td><p><span class="term"><em class="parameter"><code>input_device</code></em> :</span></p></td>
 
109
<td>A <a class="link" href="libgrip-Input-Devices.html#GripInputDevice"><span class="type">GripInputDevice</span></a>. <span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>]</span>
 
110
</td>
 
111
</tr>
 
112
<tr>
 
113
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
114
<td>the internal identifier of the input device</td>
 
115
</tr>
 
116
</tbody>
 
117
</table></div>
 
118
</div>
 
119
<hr>
 
120
<div class="refsect2">
 
121
<a name="grip-input-device-get-name"></a><h3>grip_input_device_get_name ()</h3>
 
122
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       grip_input_device_get_name          (<em class="parameter"><code><a class="link" href="libgrip-Input-Devices.html#GripInputDevice"><span class="type">GripInputDevice</span></a> *input_device</code></em>);</pre>
 
123
<p>
 
124
Gets the name of the input device, as retrieved from the device itself.
 
125
</p>
 
126
<div class="variablelist"><table border="0">
 
127
<col align="left" valign="top">
 
128
<tbody>
 
129
<tr>
 
130
<td><p><span class="term"><em class="parameter"><code>input_device</code></em> :</span></p></td>
 
131
<td>A <a class="link" href="libgrip-Input-Devices.html#GripInputDevice"><span class="type">GripInputDevice</span></a>. <span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>]</span>
 
132
</td>
 
133
</tr>
 
134
<tr>
 
135
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
136
<td>the seld-described name of the input device.</td>
 
137
</tr>
 
138
</tbody>
 
139
</table></div>
 
140
</div>
 
141
<hr>
 
142
<div class="refsect2">
 
143
<a name="grip-input-device-is-direct"></a><h3>grip_input_device_is_direct ()</h3>
 
144
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            grip_input_device_is_direct         (<em class="parameter"><code><a class="link" href="libgrip-Input-Devices.html#GripInputDevice"><span class="type">GripInputDevice</span></a> *input_device</code></em>);</pre>
 
145
<p>
 
146
Indicates if the input device is a direct input device (eg. touchscreen) or
 
147
not (eg. touchpad).
 
148
</p>
 
149
<div class="variablelist"><table border="0">
 
150
<col align="left" valign="top">
 
151
<tbody>
 
152
<tr>
 
153
<td><p><span class="term"><em class="parameter"><code>input_device</code></em> :</span></p></td>
 
154
<td>A <a class="link" href="libgrip-Input-Devices.html#GripInputDevice"><span class="type">GripInputDevice</span></a>. <span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>]</span>
 
155
</td>
 
156
</tr>
 
157
<tr>
 
158
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
159
<td>
 
160
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the input device is an direct device, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>
 
161
otherwsie.</td>
 
162
</tr>
 
163
</tbody>
 
164
</table></div>
 
165
</div>
 
166
<hr>
 
167
<div class="refsect2">
 
168
<a name="grip-input-device-is-independent"></a><h3>grip_input_device_is_independent ()</h3>
 
169
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            grip_input_device_is_independent    (<em class="parameter"><code><a class="link" href="libgrip-Input-Devices.html#GripInputDevice"><span class="type">GripInputDevice</span></a> *input_device</code></em>);</pre>
 
170
<p>
 
171
Indicates if the input device is an independent input device (for example, an
 
172
Apple MagicMouse).
 
173
</p>
 
174
<div class="variablelist"><table border="0">
 
175
<col align="left" valign="top">
 
176
<tbody>
 
177
<tr>
 
178
<td><p><span class="term"><em class="parameter"><code>input_device</code></em> :</span></p></td>
 
179
<td>A <a class="link" href="libgrip-Input-Devices.html#GripInputDevice"><span class="type">GripInputDevice</span></a>. <span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>]</span>
 
180
</td>
 
181
</tr>
 
182
<tr>
 
183
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
184
<td>
 
185
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the input device is an independent device, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>
 
186
otherwsie.</td>
 
187
</tr>
 
188
</tbody>
 
189
</table></div>
 
190
</div>
 
191
<hr>
 
192
<div class="refsect2">
 
193
<a name="grip-input-device-get-x-extents"></a><h3>grip_input_device_get_x_extents ()</h3>
 
194
<pre class="programlisting"><span class="returnvalue">AxisExtents</span> *       grip_input_device_get_x_extents     (<em class="parameter"><code><a class="link" href="libgrip-Input-Devices.html#GripInputDevice"><span class="type">GripInputDevice</span></a> *input_device</code></em>);</pre>
 
195
<div class="variablelist"><table border="0">
 
196
<col align="left" valign="top">
 
197
<tbody>
 
198
<tr>
 
199
<td><p><span class="term"><em class="parameter"><code>input_device</code></em> :</span></p></td>
 
200
<td>A <a class="link" href="libgrip-Input-Devices.html#GripInputDevice"><span class="type">GripInputDevice</span></a>. <span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>]</span>
 
201
</td>
 
202
</tr>
 
203
<tr>
 
204
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
205
<td>the X-axis extents of the device.</td>
 
206
</tr>
 
207
</tbody>
 
208
</table></div>
 
209
</div>
 
210
<hr>
 
211
<div class="refsect2">
 
212
<a name="grip-input-device-get-y-extents"></a><h3>grip_input_device_get_y_extents ()</h3>
 
213
<pre class="programlisting"><span class="returnvalue">AxisExtents</span> *       grip_input_device_get_y_extents     (<em class="parameter"><code><a class="link" href="libgrip-Input-Devices.html#GripInputDevice"><span class="type">GripInputDevice</span></a> *input_device</code></em>);</pre>
 
214
<div class="variablelist"><table border="0">
 
215
<col align="left" valign="top">
 
216
<tbody>
 
217
<tr>
 
218
<td><p><span class="term"><em class="parameter"><code>input_device</code></em> :</span></p></td>
 
219
<td>A <a class="link" href="libgrip-Input-Devices.html#GripInputDevice"><span class="type">GripInputDevice</span></a>. <span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>]</span>
 
220
</td>
 
221
</tr>
 
222
<tr>
 
223
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
224
<td>the Y-axis extents of the device.</td>
 
225
</tr>
 
226
</tbody>
 
227
</table></div>
 
228
</div>
 
229
</div>
 
230
<div class="refsect1">
 
231
<a name="libgrip-Input-Devices.property-details"></a><h2>Property Details</h2>
 
232
<div class="refsect2">
 
233
<a name="GripInputDevice--device-attrs"></a><h3>The <code class="literal">"device-attrs"</code> property</h3>
 
234
<pre class="programlisting">  "device-attrs"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>              : Write / Construct Only</pre>
 
235
<p>
 
236
A list of GEIS v1 device attrs (passed into the device callback) used to
 
237
construct a <a class="link" href="libgrip-Input-Devices.html#GripInputDevice"><span class="type">GripInputDevice</span></a>.
 
238
</p>
 
239
</div>
 
240
<hr>
 
241
<div class="refsect2">
 
242
<a name="GripInputDevice--geis-device"></a><h3>The <code class="literal">"geis-device"</code> property</h3>
 
243
<pre class="programlisting">  "geis-device"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>              : Write / Construct Only</pre>
 
244
<p>
 
245
A GEIS v2 device object used to construct a <a class="link" href="libgrip-Input-Devices.html#GripInputDevice"><span class="type">GripInputDevice</span></a>.
 
246
</p>
 
247
</div>
 
248
</div>
 
249
</div>
 
250
<div class="footer">
 
251
<hr>
 
252
          Generated by GTK-Doc V1.17</div>
 
253
</body>
 
254
</html>
 
 
b'\\ No newline at end of file'