39
32
<h2><span class="refentrytitle"><a name="ClutterDeviceManager.top_of_page"></a>ClutterDeviceManager</span></h2>
40
33
<p>ClutterDeviceManager — Maintains the list of input devices</p>
42
<td valign="top" align="right"></td>
35
<td class="gallery_image" valign="top" align="right"></td>
43
36
</tr></table></div>
44
<div class="refsynopsisdiv">
45
<a name="ClutterDeviceManager.synopsis"></a><h2>Synopsis</h2>
46
<pre class="synopsis">struct <a class="link" href="ClutterDeviceManager.html#ClutterDeviceManager-struct" title="struct ClutterDeviceManager">ClutterDeviceManager</a>;
47
struct <a class="link" href="ClutterDeviceManager.html#ClutterDeviceManagerClass" title="struct ClutterDeviceManagerClass">ClutterDeviceManagerClass</a>;
48
<a class="link" href="ClutterDeviceManager.html" title="ClutterDeviceManager"><span class="returnvalue">ClutterDeviceManager</span></a> * <a class="link" href="ClutterDeviceManager.html#clutter-device-manager-get-default" title="clutter_device_manager_get_default ()">clutter_device_manager_get_default</a>
49
(<em class="parameter"><code><span class="type">void</span></code></em>);
50
<span class="returnvalue">GSList</span> * <a class="link" href="ClutterDeviceManager.html#clutter-device-manager-list-devices" title="clutter_device_manager_list_devices ()">clutter_device_manager_list_devices</a> (<em class="parameter"><code><a class="link" href="ClutterDeviceManager.html" title="ClutterDeviceManager"><span class="type">ClutterDeviceManager</span></a> *device_manager</code></em>);
51
const <span class="returnvalue">GSList</span> * <a class="link" href="ClutterDeviceManager.html#clutter-device-manager-peek-devices" title="clutter_device_manager_peek_devices ()">clutter_device_manager_peek_devices</a> (<em class="parameter"><code><a class="link" href="ClutterDeviceManager.html" title="ClutterDeviceManager"><span class="type">ClutterDeviceManager</span></a> *device_manager</code></em>);
52
<a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="returnvalue">ClutterInputDevice</span></a> * <a class="link" href="ClutterDeviceManager.html#clutter-device-manager-get-device" title="clutter_device_manager_get_device ()">clutter_device_manager_get_device</a> (<em class="parameter"><code><a class="link" href="ClutterDeviceManager.html" title="ClutterDeviceManager"><span class="type">ClutterDeviceManager</span></a> *device_manager</code></em>,
53
<em class="parameter"><code><span class="type">gint</span> device_id</code></em>);
54
<a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="returnvalue">ClutterInputDevice</span></a> * <a class="link" href="ClutterDeviceManager.html#clutter-device-manager-get-core-device" title="clutter_device_manager_get_core_device ()">clutter_device_manager_get_core_device</a>
55
(<em class="parameter"><code><a class="link" href="ClutterDeviceManager.html" title="ClutterDeviceManager"><span class="type">ClutterDeviceManager</span></a> *device_manager</code></em>,
56
<em class="parameter"><code><a class="link" href="ClutterInputDevice.html#ClutterInputDeviceType" title="enum ClutterInputDeviceType"><span class="type">ClutterInputDeviceType</span></a> device_type</code></em>);
58
<a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="returnvalue">ClutterInputDevice</span></a> * <a class="link" href="ClutterDeviceManager.html#clutter-get-input-device-for-id" title="clutter_get_input_device_for_id ()">clutter_get_input_device_for_id</a> (<em class="parameter"><code><span class="type">gint</span> id_</code></em>);
61
37
<div class="refsect1">
62
<a name="ClutterDeviceManager.object-hierarchy"></a><h2>Object Hierarchy</h2>
63
<pre class="synopsis">
65
+----ClutterDeviceManager
38
<a name="ClutterDeviceManager.functions"></a><h2>Functions</h2>
39
<div class="informaltable"><table width="100%" border="0">
41
<col width="150px" class="functions_return">
42
<col class="functions_name">
46
<td class="function_type">
47
<a class="link" href="ClutterDeviceManager.html" title="ClutterDeviceManager"><span class="returnvalue">ClutterDeviceManager</span></a> *
49
<td class="function_name">
50
<a class="link" href="ClutterDeviceManager.html#clutter-device-manager-get-default" title="clutter_device_manager_get_default ()">clutter_device_manager_get_default</a> <span class="c_punctuation">()</span>
54
<td class="function_type">
55
<span class="returnvalue">GSList</span> *
57
<td class="function_name">
58
<a class="link" href="ClutterDeviceManager.html#clutter-device-manager-list-devices" title="clutter_device_manager_list_devices ()">clutter_device_manager_list_devices</a> <span class="c_punctuation">()</span>
62
<td class="function_type">const <span class="returnvalue">GSList</span> *
64
<td class="function_name">
65
<a class="link" href="ClutterDeviceManager.html#clutter-device-manager-peek-devices" title="clutter_device_manager_peek_devices ()">clutter_device_manager_peek_devices</a> <span class="c_punctuation">()</span>
69
<td class="function_type">
70
<a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="returnvalue">ClutterInputDevice</span></a> *
72
<td class="function_name">
73
<a class="link" href="ClutterDeviceManager.html#clutter-device-manager-get-device" title="clutter_device_manager_get_device ()">clutter_device_manager_get_device</a> <span class="c_punctuation">()</span>
77
<td class="function_type">
78
<a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="returnvalue">ClutterInputDevice</span></a> *
80
<td class="function_name">
81
<a class="link" href="ClutterDeviceManager.html#clutter-device-manager-get-core-device" title="clutter_device_manager_get_core_device ()">clutter_device_manager_get_core_device</a> <span class="c_punctuation">()</span>
85
<td class="function_type">
86
<a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="returnvalue">ClutterInputDevice</span></a> *
88
<td class="function_name">
89
<a class="link" href="ClutterDeviceManager.html#clutter-get-input-device-for-id" title="clutter_get_input_device_for_id ()">clutter_get_input_device_for_id</a> <span class="c_punctuation">()</span>
68
95
<div class="refsect1">
69
96
<a name="ClutterDeviceManager.properties"></a><h2>Properties</h2>
70
<pre class="synopsis">
71
"<a class="link" href="ClutterDeviceManager.html#ClutterDeviceManager--backend" title='The "backend" property'>backend</a>" <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a>* : Read / Write / Construct Only
97
<div class="informaltable"><table border="0">
99
<col width="150px" class="properties_type">
100
<col width="300px" class="properties_name">
101
<col width="200px" class="properties_flags">
104
<td class="property_type">
105
<a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> *</td>
106
<td class="property_name"><a class="link" href="ClutterDeviceManager.html#ClutterDeviceManager--backend" title="The “backend” property">backend</a></td>
107
<td class="property_flags">Read / Write / Construct Only</td>
74
111
<div class="refsect1">
75
112
<a name="ClutterDeviceManager.signals"></a><h2>Signals</h2>
76
<pre class="synopsis">
77
"<a class="link" href="ClutterDeviceManager.html#ClutterDeviceManager-device-added" title='The "device-added" signal'>device-added</a>" : <code class="literal">Run Last</code>
78
"<a class="link" href="ClutterDeviceManager.html#ClutterDeviceManager-device-removed" title='The "device-removed" signal'>device-removed</a>" : <code class="literal">Run Last</code>
113
<div class="informaltable"><table border="0">
115
<col width="150px" class="signals_return">
116
<col width="300px" class="signals_name">
117
<col width="200px" class="signals_flags">
121
<td class="signal_type"><span class="returnvalue">void</span></td>
122
<td class="signal_name"><a class="link" href="ClutterDeviceManager.html#ClutterDeviceManager-device-added" title="The “device-added” signal">device-added</a></td>
123
<td class="signal_flags">Run Last</td>
126
<td class="signal_type"><span class="returnvalue">void</span></td>
127
<td class="signal_name"><a class="link" href="ClutterDeviceManager.html#ClutterDeviceManager-device-removed" title="The “device-removed” signal">device-removed</a></td>
128
<td class="signal_flags">Run Last</td>
133
<div class="refsect1">
134
<a name="ClutterDeviceManager.other"></a><h2>Types and Values</h2>
135
<div class="informaltable"><table width="100%" border="0">
137
<col width="150px" class="name">
138
<col class="description">
142
<td class="datatype_keyword">struct</td>
143
<td class="function_name"><a class="link" href="ClutterDeviceManager.html#ClutterDeviceManager-struct" title="struct ClutterDeviceManager">ClutterDeviceManager</a></td>
146
<td class="datatype_keyword">struct</td>
147
<td class="function_name"><a class="link" href="ClutterDeviceManager.html#ClutterDeviceManagerClass" title="struct ClutterDeviceManagerClass">ClutterDeviceManagerClass</a></td>
152
<div class="refsect1">
153
<a name="ClutterDeviceManager.object-hierarchy"></a><h2>Object Hierarchy</h2>
154
<pre class="screen"> GObject
155
<span class="lineart">╰──</span> ClutterDeviceManager
81
158
<div class="refsect1">
82
159
<a name="ClutterDeviceManager.description"></a><h2>Description</h2>
84
<a class="link" href="ClutterDeviceManager.html" title="ClutterDeviceManager"><span class="type">ClutterDeviceManager</span></a> is a singleton object, owned by Clutter, which
85
maintains the list of <a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="type">ClutterInputDevice</span></a>s.
88
Depending on the backend used by Clutter it is possible to use the
89
<a class="link" href="ClutterDeviceManager.html#ClutterDeviceManager-device-added" title='The "device-added" signal'><span class="type">"device-added"</span></a> and
90
<a class="link" href="ClutterDeviceManager.html#ClutterDeviceManager-device-removed" title='The "device-removed" signal'><span class="type">"device-removed"</span></a> to monitor addition and removal
94
<a class="link" href="ClutterDeviceManager.html" title="ClutterDeviceManager"><span class="type">ClutterDeviceManager</span></a> is available since Clutter 1.2
160
<p><a class="link" href="ClutterDeviceManager.html" title="ClutterDeviceManager"><span class="type">ClutterDeviceManager</span></a> is a singleton object, owned by Clutter, which
161
maintains the list of <a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="type">ClutterInputDevice</span></a><!-- -->s.</p>
162
<p>Depending on the backend used by Clutter it is possible to use the
163
<a class="link" href="ClutterDeviceManager.html#ClutterDeviceManager-device-added" title="The “device-added” signal"><span class="type">“device-added”</span></a> and
164
<a class="link" href="ClutterDeviceManager.html#ClutterDeviceManager-device-removed" title="The “device-removed” signal"><span class="type">“device-removed”</span></a> to monitor addition and removal
166
<p><a class="link" href="ClutterDeviceManager.html" title="ClutterDeviceManager"><span class="type">ClutterDeviceManager</span></a> is available since Clutter 1.2</p>
97
168
<div class="refsect1">
98
<a name="ClutterDeviceManager.details"></a><h2>Details</h2>
99
<div class="refsect2">
100
<a name="ClutterDeviceManager-struct"></a><h3>struct ClutterDeviceManager</h3>
101
<pre class="programlisting">struct ClutterDeviceManager;</pre>
103
The <a class="link" href="ClutterDeviceManager.html" title="ClutterDeviceManager"><span class="type">ClutterDeviceManager</span></a> structure contains only private data
105
<p class="since">Since 1.2</p>
108
<div class="refsect2">
109
<a name="ClutterDeviceManagerClass"></a><h3>struct ClutterDeviceManagerClass</h3>
110
<pre class="programlisting">struct ClutterDeviceManagerClass {
114
The <a class="link" href="ClutterDeviceManager.html#ClutterDeviceManagerClass" title="struct ClutterDeviceManagerClass"><span class="type">ClutterDeviceManagerClass</span></a> structure contains only private data
116
<p class="since">Since 1.2</p>
119
<div class="refsect2">
120
<a name="clutter-device-manager-get-default"></a><h3>clutter_device_manager_get_default ()</h3>
121
<pre class="programlisting"><a class="link" href="ClutterDeviceManager.html" title="ClutterDeviceManager"><span class="returnvalue">ClutterDeviceManager</span></a> * clutter_device_manager_get_default
122
(<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
124
Retrieves the device manager singleton
126
<div class="variablelist"><table border="0" class="variablelist">
128
<col align="left" valign="top">
132
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
133
<td>the <a class="link" href="ClutterDeviceManager.html" title="ClutterDeviceManager"><span class="type">ClutterDeviceManager</span></a> singleton.
169
<a name="ClutterDeviceManager.functions_details"></a><h2>Functions</h2>
170
<div class="refsect2">
171
<a name="clutter-device-manager-get-default"></a><h3>clutter_device_manager_get_default ()</h3>
172
<pre class="programlisting"><a class="link" href="ClutterDeviceManager.html" title="ClutterDeviceManager"><span class="returnvalue">ClutterDeviceManager</span></a> *
173
clutter_device_manager_get_default (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
174
<p>Retrieves the device manager singleton</p>
175
<div class="refsect3">
176
<a name="id-1.7.2.4.9.2.5"></a><h4>Returns</h4>
177
<p> the <a class="link" href="ClutterDeviceManager.html" title="ClutterDeviceManager"><span class="type">ClutterDeviceManager</span></a> singleton.
134
178
The returned instance is owned by Clutter and it should not be
135
modified or freed. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
139
<p class="since">Since 1.2</p>
142
<div class="refsect2">
143
<a name="clutter-device-manager-list-devices"></a><h3>clutter_device_manager_list_devices ()</h3>
144
<pre class="programlisting"><span class="returnvalue">GSList</span> * clutter_device_manager_list_devices (<em class="parameter"><code><a class="link" href="ClutterDeviceManager.html" title="ClutterDeviceManager"><span class="type">ClutterDeviceManager</span></a> *device_manager</code></em>);</pre>
146
Lists all currently registered input devices
148
<div class="variablelist"><table border="0" class="variablelist">
150
<col align="left" valign="top">
155
<td><p><span class="term"><em class="parameter"><code>device_manager</code></em> :</span></p></td>
156
<td>a <a class="link" href="ClutterDeviceManager.html" title="ClutterDeviceManager"><span class="type">ClutterDeviceManager</span></a>
160
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
161
<td>a newly allocated list of <a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="type">ClutterInputDevice</span></a> objects. Use
162
<code class="function">g_slist_free()</code> to deallocate it when done. <span class="annotation">[<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> Clutter.InputDevice]</span>
167
<p class="since">Since 1.2</p>
170
<div class="refsect2">
171
<a name="clutter-device-manager-peek-devices"></a><h3>clutter_device_manager_peek_devices ()</h3>
172
<pre class="programlisting">const <span class="returnvalue">GSList</span> * clutter_device_manager_peek_devices (<em class="parameter"><code><a class="link" href="ClutterDeviceManager.html" title="ClutterDeviceManager"><span class="type">ClutterDeviceManager</span></a> *device_manager</code></em>);</pre>
174
Lists all currently registered input devices
176
<div class="variablelist"><table border="0" class="variablelist">
178
<col align="left" valign="top">
183
<td><p><span class="term"><em class="parameter"><code>device_manager</code></em> :</span></p></td>
184
<td>a <a class="link" href="ClutterDeviceManager.html" title="ClutterDeviceManager"><span class="type">ClutterDeviceManager</span></a>
188
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
189
<td>a pointer to the internal list of <a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="type">ClutterInputDevice</span></a> objects. The
179
modified or freed. </p>
180
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
182
<p class="since">Since 1.2</p>
185
<div class="refsect2">
186
<a name="clutter-device-manager-list-devices"></a><h3>clutter_device_manager_list_devices ()</h3>
187
<pre class="programlisting"><span class="returnvalue">GSList</span> *
188
clutter_device_manager_list_devices (<em class="parameter"><code><a class="link" href="ClutterDeviceManager.html" title="ClutterDeviceManager"><span class="type">ClutterDeviceManager</span></a> *device_manager</code></em>);</pre>
189
<p>Lists all currently registered input devices</p>
190
<div class="refsect3">
191
<a name="id-1.7.2.4.9.3.5"></a><h4>Parameters</h4>
192
<div class="informaltable"><table width="100%" border="0">
194
<col width="150px" class="parameters_name">
195
<col class="parameters_description">
196
<col width="200px" class="parameters_annotations">
199
<td class="parameter_name"><p>device_manager</p></td>
200
<td class="parameter_description"><p>a <a class="link" href="ClutterDeviceManager.html" title="ClutterDeviceManager"><span class="type">ClutterDeviceManager</span></a></p></td>
201
<td class="parameter_annotations"> </td>
205
<div class="refsect3">
206
<a name="id-1.7.2.4.9.3.6"></a><h4>Returns</h4>
207
<p> a newly allocated list of <a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="type">ClutterInputDevice</span></a> objects. Use
208
<code class="function">g_slist_free()</code> to deallocate it when done. </p>
209
<p><span class="annotation">[<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> Clutter.InputDevice]</span></p>
211
<p class="since">Since 1.2</p>
214
<div class="refsect2">
215
<a name="clutter-device-manager-peek-devices"></a><h3>clutter_device_manager_peek_devices ()</h3>
216
<pre class="programlisting">const <span class="returnvalue">GSList</span> *
217
clutter_device_manager_peek_devices (<em class="parameter"><code><a class="link" href="ClutterDeviceManager.html" title="ClutterDeviceManager"><span class="type">ClutterDeviceManager</span></a> *device_manager</code></em>);</pre>
218
<p>Lists all currently registered input devices</p>
219
<div class="refsect3">
220
<a name="id-1.7.2.4.9.4.5"></a><h4>Parameters</h4>
221
<div class="informaltable"><table width="100%" border="0">
223
<col width="150px" class="parameters_name">
224
<col class="parameters_description">
225
<col width="200px" class="parameters_annotations">
228
<td class="parameter_name"><p>device_manager</p></td>
229
<td class="parameter_description"><p>a <a class="link" href="ClutterDeviceManager.html" title="ClutterDeviceManager"><span class="type">ClutterDeviceManager</span></a></p></td>
230
<td class="parameter_annotations"> </td>
234
<div class="refsect3">
235
<a name="id-1.7.2.4.9.4.6"></a><h4>Returns</h4>
236
<p> a pointer to the internal list of <a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="type">ClutterInputDevice</span></a> objects. The
190
237
returned list is owned by the <a class="link" href="ClutterDeviceManager.html" title="ClutterDeviceManager"><span class="type">ClutterDeviceManager</span></a> and should never
191
be modified or freed. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> Clutter.InputDevice]</span>
196
<p class="since">Since 1.2</p>
199
<div class="refsect2">
200
<a name="clutter-device-manager-get-device"></a><h3>clutter_device_manager_get_device ()</h3>
201
<pre class="programlisting"><a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="returnvalue">ClutterInputDevice</span></a> * clutter_device_manager_get_device (<em class="parameter"><code><a class="link" href="ClutterDeviceManager.html" title="ClutterDeviceManager"><span class="type">ClutterDeviceManager</span></a> *device_manager</code></em>,
202
<em class="parameter"><code><span class="type">gint</span> device_id</code></em>);</pre>
204
Retrieves the <a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="type">ClutterInputDevice</span></a> with the given <em class="parameter"><code>device_id</code></em>
206
<div class="variablelist"><table border="0" class="variablelist">
208
<col align="left" valign="top">
213
<td><p><span class="term"><em class="parameter"><code>device_manager</code></em> :</span></p></td>
214
<td>a <a class="link" href="ClutterDeviceManager.html" title="ClutterDeviceManager"><span class="type">ClutterDeviceManager</span></a>
218
<td><p><span class="term"><em class="parameter"><code>device_id</code></em> :</span></p></td>
219
<td>the integer id of a device</td>
222
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
223
<td>a <a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="type">ClutterInputDevice</span></a> or <code class="literal">NULL</code>. The
224
returned device is owned by the <a class="link" href="ClutterDeviceManager.html" title="ClutterDeviceManager"><span class="type">ClutterDeviceManager</span></a> and should
225
never be modified or freed. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
230
<p class="since">Since 1.2</p>
233
<div class="refsect2">
234
<a name="clutter-device-manager-get-core-device"></a><h3>clutter_device_manager_get_core_device ()</h3>
235
<pre class="programlisting"><a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="returnvalue">ClutterInputDevice</span></a> * clutter_device_manager_get_core_device
236
(<em class="parameter"><code><a class="link" href="ClutterDeviceManager.html" title="ClutterDeviceManager"><span class="type">ClutterDeviceManager</span></a> *device_manager</code></em>,
237
<em class="parameter"><code><a class="link" href="ClutterInputDevice.html#ClutterInputDeviceType" title="enum ClutterInputDeviceType"><span class="type">ClutterInputDeviceType</span></a> device_type</code></em>);</pre>
239
Retrieves the core <a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="type">ClutterInputDevice</span></a> of type <em class="parameter"><code>device_type</code></em>
242
Core devices are devices created automatically by the default
245
<div class="variablelist"><table border="0" class="variablelist">
247
<col align="left" valign="top">
252
<td><p><span class="term"><em class="parameter"><code>device_manager</code></em> :</span></p></td>
253
<td>a <a class="link" href="ClutterDeviceManager.html" title="ClutterDeviceManager"><span class="type">ClutterDeviceManager</span></a>
257
<td><p><span class="term"><em class="parameter"><code>device_type</code></em> :</span></p></td>
258
<td>the type of the core device</td>
261
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
262
<td>a <a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="type">ClutterInputDevice</span></a> or <code class="literal">NULL</code>. The
263
returned device is owned by the <a class="link" href="ClutterDeviceManager.html" title="ClutterDeviceManager"><span class="type">ClutterDeviceManager</span></a> and should
264
not be modified or freed. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
269
<p class="since">Since 1.2</p>
272
<div class="refsect2">
273
<a name="clutter-get-input-device-for-id"></a><h3>clutter_get_input_device_for_id ()</h3>
274
<pre class="programlisting"><a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="returnvalue">ClutterInputDevice</span></a> * clutter_get_input_device_for_id (<em class="parameter"><code><span class="type">gint</span> id_</code></em>);</pre>
275
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
276
<h3 class="title">Warning</h3>
277
<p><code class="literal">clutter_get_input_device_for_id</code> has been deprecated since version 1.10 and should not be used in newly-written code. Use <a class="link" href="ClutterDeviceManager.html#clutter-device-manager-get-device" title="clutter_device_manager_get_device ()"><code class="function">clutter_device_manager_get_device()</code></a> instead.</p>
280
Retrieves the <a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="type">ClutterInputDevice</span></a> from its <em class="parameter"><code>id_</code></em>. This is a convenience
281
wrapper for <a class="link" href="ClutterDeviceManager.html#clutter-device-manager-get-device" title="clutter_device_manager_get_device ()"><code class="function">clutter_device_manager_get_device()</code></a> and it is functionally
238
be modified or freed. </p>
239
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> Clutter.InputDevice]</span></p>
241
<p class="since">Since 1.2</p>
244
<div class="refsect2">
245
<a name="clutter-device-manager-get-device"></a><h3>clutter_device_manager_get_device ()</h3>
246
<pre class="programlisting"><a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="returnvalue">ClutterInputDevice</span></a> *
247
clutter_device_manager_get_device (<em class="parameter"><code><a class="link" href="ClutterDeviceManager.html" title="ClutterDeviceManager"><span class="type">ClutterDeviceManager</span></a> *device_manager</code></em>,
248
<em class="parameter"><code><span class="type">gint</span> device_id</code></em>);</pre>
249
<p>Retrieves the <a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="type">ClutterInputDevice</span></a> with the given <em class="parameter"><code>device_id</code></em>
251
<div class="refsect3">
252
<a name="id-1.7.2.4.9.5.5"></a><h4>Parameters</h4>
253
<div class="informaltable"><table width="100%" border="0">
255
<col width="150px" class="parameters_name">
256
<col class="parameters_description">
257
<col width="200px" class="parameters_annotations">
261
<td class="parameter_name"><p>device_manager</p></td>
262
<td class="parameter_description"><p>a <a class="link" href="ClutterDeviceManager.html" title="ClutterDeviceManager"><span class="type">ClutterDeviceManager</span></a></p></td>
263
<td class="parameter_annotations"> </td>
266
<td class="parameter_name"><p>device_id</p></td>
267
<td class="parameter_description"><p>the integer id of a device</p></td>
268
<td class="parameter_annotations"> </td>
273
<div class="refsect3">
274
<a name="id-1.7.2.4.9.5.6"></a><h4>Returns</h4>
275
<p> a <a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="type">ClutterInputDevice</span></a> or <code class="literal">NULL</code>. The
276
returned device is owned by the <a class="link" href="ClutterDeviceManager.html" title="ClutterDeviceManager"><span class="type">ClutterDeviceManager</span></a> and should
277
never be modified or freed. </p>
278
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
280
<p class="since">Since 1.2</p>
283
<div class="refsect2">
284
<a name="clutter-device-manager-get-core-device"></a><h3>clutter_device_manager_get_core_device ()</h3>
285
<pre class="programlisting"><a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="returnvalue">ClutterInputDevice</span></a> *
286
clutter_device_manager_get_core_device
287
(<em class="parameter"><code><a class="link" href="ClutterDeviceManager.html" title="ClutterDeviceManager"><span class="type">ClutterDeviceManager</span></a> *device_manager</code></em>,
288
<em class="parameter"><code><a class="link" href="ClutterInputDevice.html#ClutterInputDeviceType" title="enum ClutterInputDeviceType"><span class="type">ClutterInputDeviceType</span></a> device_type</code></em>);</pre>
289
<p>Retrieves the core <a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="type">ClutterInputDevice</span></a> of type <em class="parameter"><code>device_type</code></em>
291
<p>Core devices are devices created automatically by the default
293
<div class="refsect3">
294
<a name="id-1.7.2.4.9.6.6"></a><h4>Parameters</h4>
295
<div class="informaltable"><table width="100%" border="0">
297
<col width="150px" class="parameters_name">
298
<col class="parameters_description">
299
<col width="200px" class="parameters_annotations">
303
<td class="parameter_name"><p>device_manager</p></td>
304
<td class="parameter_description"><p>a <a class="link" href="ClutterDeviceManager.html" title="ClutterDeviceManager"><span class="type">ClutterDeviceManager</span></a></p></td>
305
<td class="parameter_annotations"> </td>
308
<td class="parameter_name"><p>device_type</p></td>
309
<td class="parameter_description"><p>the type of the core device</p></td>
310
<td class="parameter_annotations"> </td>
315
<div class="refsect3">
316
<a name="id-1.7.2.4.9.6.7"></a><h4>Returns</h4>
317
<p> a <a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="type">ClutterInputDevice</span></a> or <code class="literal">NULL</code>. The
318
returned device is owned by the <a class="link" href="ClutterDeviceManager.html" title="ClutterDeviceManager"><span class="type">ClutterDeviceManager</span></a> and should
319
not be modified or freed. </p>
320
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
322
<p class="since">Since 1.2</p>
325
<div class="refsect2">
326
<a name="clutter-get-input-device-for-id"></a><h3>clutter_get_input_device_for_id ()</h3>
327
<pre class="programlisting"><a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="returnvalue">ClutterInputDevice</span></a> *
328
clutter_get_input_device_for_id (<em class="parameter"><code><span class="type">gint</span> id_</code></em>);</pre>
329
<div class="warning">
330
<p><code class="literal">clutter_get_input_device_for_id</code> has been deprecated since version 1.10 and should not be used in newly-written code.</p>
331
<p>Use <a class="link" href="ClutterDeviceManager.html#clutter-device-manager-get-device" title="clutter_device_manager_get_device ()"><code class="function">clutter_device_manager_get_device()</code></a> instead.</p>
333
<p>Retrieves the <a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="type">ClutterInputDevice</span></a> from its <em class="parameter"><code>id_</code></em>
334
. This is a convenience
335
wrapper for <a class="link" href="ClutterDeviceManager.html#clutter-device-manager-get-device" title="clutter_device_manager_get_device ()"><code class="function">clutter_device_manager_get_device()</code></a> and it is functionally
286
337
<div class="informalexample">
287
338
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
307
<div class="variablelist"><table border="0" class="variablelist">
357
<div class="refsect3">
358
<a name="id-1.7.2.4.9.7.9"></a><h4>Parameters</h4>
359
<div class="informaltable"><table width="100%" border="0">
309
<col align="left" valign="top">
361
<col width="150px" class="parameters_name">
362
<col class="parameters_description">
363
<col width="200px" class="parameters_annotations">
314
<td><p><span class="term"><em class="parameter"><code>id_</code></em> :</span></p></td>
315
<td>the unique id for a device</td>
318
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
319
<td>a <a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="type">ClutterInputDevice</span></a>, or <code class="literal">NULL</code>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
366
<td class="parameter_name"><p>id_</p></td>
367
<td class="parameter_description"><p>the unique id for a device</p></td>
368
<td class="parameter_annotations"> </td>
372
<div class="refsect3">
373
<a name="id-1.7.2.4.9.7.10"></a><h4>Returns</h4>
374
<p> a <a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="type">ClutterInputDevice</span></a>, or <code class="literal">NULL</code>. </p>
375
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
324
377
<p class="since">Since 0.8</p>
327
380
<div class="refsect1">
381
<a name="ClutterDeviceManager.other_details"></a><h2>Types and Values</h2>
382
<div class="refsect2">
383
<a name="ClutterDeviceManager-struct"></a><h3>struct ClutterDeviceManager</h3>
384
<pre class="programlisting">struct ClutterDeviceManager;</pre>
385
<p>The <a class="link" href="ClutterDeviceManager.html" title="ClutterDeviceManager"><span class="type">ClutterDeviceManager</span></a> structure contains only private data</p>
386
<p class="since">Since 1.2</p>
389
<div class="refsect2">
390
<a name="ClutterDeviceManagerClass"></a><h3>struct ClutterDeviceManagerClass</h3>
391
<pre class="programlisting">struct ClutterDeviceManagerClass {
394
<p>The <a class="link" href="ClutterDeviceManager.html#ClutterDeviceManagerClass" title="struct ClutterDeviceManagerClass"><span class="type">ClutterDeviceManagerClass</span></a> structure contains only private data</p>
395
<p class="since">Since 1.2</p>
398
<div class="refsect1">
328
399
<a name="ClutterDeviceManager.property-details"></a><h2>Property Details</h2>
329
400
<div class="refsect2">
330
<a name="ClutterDeviceManager--backend"></a><h3>The <code class="literal">"backend"</code> property</h3>
331
<pre class="programlisting"> "backend" <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a>* : Read / Write / Construct Only</pre>
401
<a name="ClutterDeviceManager--backend"></a><h3>The <code class="literal">“backend”</code> property</h3>
402
<pre class="programlisting"> “backend” <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> *</pre>
332
403
<p>The ClutterBackend of the device manager.</p>
404
<p>Flags: Read / Write / Construct Only</p>
335
407
<div class="refsect1">
336
408
<a name="ClutterDeviceManager.signal-details"></a><h2>Signal Details</h2>
337
409
<div class="refsect2">
338
<a name="ClutterDeviceManager-device-added"></a><h3>The <code class="literal">"device-added"</code> signal</h3>
339
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="ClutterDeviceManager.html" title="ClutterDeviceManager"><span class="type">ClutterDeviceManager</span></a> *manager,
340
<a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="type">ClutterInputDevice</span></a> *device,
341
<span class="type">gpointer</span> user_data) : <code class="literal">Run Last</code></pre>
343
The ::device-added signal is emitted each time a device has been
344
added to the <a class="link" href="ClutterDeviceManager.html" title="ClutterDeviceManager"><span class="type">ClutterDeviceManager</span></a>
346
<div class="variablelist"><table border="0" class="variablelist">
410
<a name="ClutterDeviceManager-device-added"></a><h3>The <code class="literal">“device-added”</code> signal</h3>
411
<pre class="programlisting"><span class="returnvalue">void</span>
412
user_function (<a class="link" href="ClutterDeviceManager.html" title="ClutterDeviceManager"><span class="type">ClutterDeviceManager</span></a> *manager,
413
<a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="type">ClutterInputDevice</span></a> *device,
414
<span class="type">gpointer</span> user_data)</pre>
415
<p>The ::device-added signal is emitted each time a device has been
416
added to the <a class="link" href="ClutterDeviceManager.html" title="ClutterDeviceManager"><span class="type">ClutterDeviceManager</span></a></p>
417
<div class="refsect3">
418
<a name="id-1.7.2.4.12.2.5"></a><h4>Parameters</h4>
419
<div class="informaltable"><table width="100%" border="0">
348
<col align="left" valign="top">
421
<col width="150px" class="parameters_name">
422
<col class="parameters_description">
423
<col width="200px" class="parameters_annotations">
353
<td><p><span class="term"><em class="parameter"><code>manager</code></em> :</span></p></td>
354
<td>the <a class="link" href="ClutterDeviceManager.html" title="ClutterDeviceManager"><span class="type">ClutterDeviceManager</span></a> that emitted the signal</td>
357
<td><p><span class="term"><em class="parameter"><code>device</code></em> :</span></p></td>
358
<td>the newly added <a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="type">ClutterInputDevice</span></a>
362
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
363
<td>user data set when the signal handler was connected.</td>
427
<td class="parameter_name"><p>manager</p></td>
428
<td class="parameter_description"><p>the <a class="link" href="ClutterDeviceManager.html" title="ClutterDeviceManager"><span class="type">ClutterDeviceManager</span></a> that emitted the signal</p></td>
429
<td class="parameter_annotations"> </td>
432
<td class="parameter_name"><p>device</p></td>
433
<td class="parameter_description"><p>the newly added <a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="type">ClutterInputDevice</span></a></p></td>
434
<td class="parameter_annotations"> </td>
437
<td class="parameter_name"><p>user_data</p></td>
438
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
439
<td class="parameter_annotations"> </td>
444
<p>Flags: Run Last</p>
367
445
<p class="since">Since 1.2</p>
370
448
<div class="refsect2">
371
<a name="ClutterDeviceManager-device-removed"></a><h3>The <code class="literal">"device-removed"</code> signal</h3>
372
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="ClutterDeviceManager.html" title="ClutterDeviceManager"><span class="type">ClutterDeviceManager</span></a> *manager,
373
<a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="type">ClutterInputDevice</span></a> *device,
374
<span class="type">gpointer</span> user_data) : <code class="literal">Run Last</code></pre>
376
The ::device-removed signal is emitted each time a device has been
377
removed from the <a class="link" href="ClutterDeviceManager.html" title="ClutterDeviceManager"><span class="type">ClutterDeviceManager</span></a>
379
<div class="variablelist"><table border="0" class="variablelist">
449
<a name="ClutterDeviceManager-device-removed"></a><h3>The <code class="literal">“device-removed”</code> signal</h3>
450
<pre class="programlisting"><span class="returnvalue">void</span>
451
user_function (<a class="link" href="ClutterDeviceManager.html" title="ClutterDeviceManager"><span class="type">ClutterDeviceManager</span></a> *manager,
452
<a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="type">ClutterInputDevice</span></a> *device,
453
<span class="type">gpointer</span> user_data)</pre>
454
<p>The ::device-removed signal is emitted each time a device has been
455
removed from the <a class="link" href="ClutterDeviceManager.html" title="ClutterDeviceManager"><span class="type">ClutterDeviceManager</span></a></p>
456
<div class="refsect3">
457
<a name="id-1.7.2.4.12.3.5"></a><h4>Parameters</h4>
458
<div class="informaltable"><table width="100%" border="0">
381
<col align="left" valign="top">
460
<col width="150px" class="parameters_name">
461
<col class="parameters_description">
462
<col width="200px" class="parameters_annotations">
386
<td><p><span class="term"><em class="parameter"><code>manager</code></em> :</span></p></td>
387
<td>the <a class="link" href="ClutterDeviceManager.html" title="ClutterDeviceManager"><span class="type">ClutterDeviceManager</span></a> that emitted the signal</td>
390
<td><p><span class="term"><em class="parameter"><code>device</code></em> :</span></p></td>
391
<td>the removed <a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="type">ClutterInputDevice</span></a>
395
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
396
<td>user data set when the signal handler was connected.</td>
466
<td class="parameter_name"><p>manager</p></td>
467
<td class="parameter_description"><p>the <a class="link" href="ClutterDeviceManager.html" title="ClutterDeviceManager"><span class="type">ClutterDeviceManager</span></a> that emitted the signal</p></td>
468
<td class="parameter_annotations"> </td>
471
<td class="parameter_name"><p>device</p></td>
472
<td class="parameter_description"><p>the removed <a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="type">ClutterInputDevice</span></a></p></td>
473
<td class="parameter_annotations"> </td>
476
<td class="parameter_name"><p>user_data</p></td>
477
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
478
<td class="parameter_annotations"> </td>
483
<p>Flags: Run Last</p>
400
484
<p class="since">Since 1.2</p>
404
488
<div class="footer">
406
Generated by GTK-Doc V1.18.1</div>
490
Generated by GTK-Doc V1.20.1</div>
b'\\ No newline at end of file'