/usr/share/gtk-doc/html/buzztard-ic/BtIcDevice.html is in libbuzztard-dev 0.6.0-1.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>BtIcDevice</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Buzztard Bt-Ic Reference Manual">
<link rel="up" href="libbtic.html" title="Interaction Controller Reference">
<link rel="prev" href="BtIcGudevDiscoverer.html" title="BtIcGudevDiscoverer">
<link rel="next" href="BtIcInputDevice.html" title="BtIcInputDevice">
<meta name="generator" content="GTK-Doc V1.19 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="BtIcGudevDiscoverer.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libbtic.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Buzztard Bt-Ic Reference Manual</th>
<td><a accesskey="n" href="BtIcInputDevice.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#BtIcDevice.synopsis" class="shortcut">Top</a>
|
<a href="#BtIcDevice.description" class="shortcut">Description</a>
|
<a href="#BtIcDevice.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#BtIcDevice.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="BtIcDevice"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="BtIcDevice.top_of_page"></a>BtIcDevice</span></h2>
<p>BtIcDevice — buzztards interaction controller device</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="BtIcDevice.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <libbtic/ic.h>
struct <a class="link" href="BtIcDevice.html#BtIcDevice-struct" title="struct BtIcDevice">BtIcDevice</a>;
<span class="returnvalue">void</span> <a class="link" href="BtIcDevice.html#btic-device-add-control" title="btic_device_add_control ()">btic_device_add_control</a> (<em class="parameter"><code>const <a class="link" href="BtIcDevice.html" title="BtIcDevice"><span class="type">BtIcDevice</span></a> *self</code></em>,
<em class="parameter"><code>const <a class="link" href="BtIcControl.html" title="BtIcControl"><span class="type">BtIcControl</span></a> *control</code></em>);
<a class="link" href="BtIcControl.html" title="BtIcControl"><span class="returnvalue">BtIcControl</span></a> * <a class="link" href="BtIcDevice.html#btic-device-get-control-by-id" title="btic_device_get_control_by_id ()">btic_device_get_control_by_id</a> (<em class="parameter"><code>const <a class="link" href="BtIcDevice.html" title="BtIcDevice"><span class="type">BtIcDevice</span></a> *self</code></em>,
<em class="parameter"><code><span class="type">guint</span> id</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="BtIcDevice.html#btic-device-has-controls" title="btic_device_has_controls ()">btic_device_has_controls</a> (<em class="parameter"><code>const <a class="link" href="BtIcDevice.html" title="BtIcDevice"><span class="type">BtIcDevice</span></a> *self</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="BtIcDevice.html#btic-device-start" title="btic_device_start ()">btic_device_start</a> (<em class="parameter"><code>const <a class="link" href="BtIcDevice.html" title="BtIcDevice"><span class="type">BtIcDevice</span></a> *self</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="BtIcDevice.html#btic-device-stop" title="btic_device_stop ()">btic_device_stop</a> (<em class="parameter"><code>const <a class="link" href="BtIcDevice.html" title="BtIcDevice"><span class="type">BtIcDevice</span></a> *self</code></em>);
<span class="returnvalue">gboolean</span> (<a class="link" href="BtIcDevice.html#btic-device-virtual-start" title="btic_device_virtual_start ()">*btic_device_virtual_start</a>) (<em class="parameter"><code><span class="type">gconstpointer</span> self</code></em>);
<span class="returnvalue">gboolean</span> (<a class="link" href="BtIcDevice.html#btic-device-virtual-stop" title="btic_device_virtual_stop ()">*btic_device_virtual_stop</a>) (<em class="parameter"><code><span class="type">gconstpointer</span> self</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="BtIcDevice.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----BtIcDevice
+----<a class="link" href="BtIcInputDevice.html" title="BtIcInputDevice">BtIcInputDevice</a>
+----<a class="link" href="BtIcMidiDevice.html" title="BtIcMidiDevice">BtIcMidiDevice</a>
</pre>
</div>
<div class="refsect1">
<a name="BtIcDevice.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="BtIcDevice.html#BtIcDevice--controls" title='The "controls" property'>controls</a>" <span class="type">gpointer</span> : Read
"<a class="link" href="BtIcDevice.html#BtIcDevice--name" title='The "name" property'>name</a>" <span class="type">gchar</span>* : Read / Write / Construct Only
"<a class="link" href="BtIcDevice.html#BtIcDevice--udi" title='The "udi" property'>udi</a>" <span class="type">gchar</span>* : Read / Write / Construct Only
</pre>
</div>
<div class="refsect1">
<a name="BtIcDevice.description"></a><h2>Description</h2>
<p>
Abstract base class for control devices. Subclasses will provide
functionality to query capabilities and register <a class="link" href="BtIcControl.html" title="BtIcControl"><span class="type">BtIcControl</span></a> instances.
They will also read from the device and trigger the change events on their
controls (via value property).
</p>
<p>
This baseclass manages the added controls. The can be queries by calling
<a class="link" href="BtIcDevice.html#btic-device-get-control-by-id" title="btic_device_get_control_by_id ()"><code class="function">btic_device_get_control_by_id()</code></a> or iterating the list in
BtIcDevice::controls.
</p>
</div>
<div class="refsect1">
<a name="BtIcDevice.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="BtIcDevice-struct"></a><h3>struct BtIcDevice</h3>
<pre class="programlisting">struct BtIcDevice;</pre>
<p>
buzztards interaction controller device
</p>
</div>
<hr>
<div class="refsect2">
<a name="btic-device-add-control"></a><h3>btic_device_add_control ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> btic_device_add_control (<em class="parameter"><code>const <a class="link" href="BtIcDevice.html" title="BtIcDevice"><span class="type">BtIcDevice</span></a> *self</code></em>,
<em class="parameter"><code>const <a class="link" href="BtIcControl.html" title="BtIcControl"><span class="type">BtIcControl</span></a> *control</code></em>);</pre>
<p>
Add the given <em class="parameter"><code>control</code></em> to the list that the device manages. Takes ownership
of the control.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>the device</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>control</code></em> :</span></p></td>
<td>new control</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="btic-device-get-control-by-id"></a><h3>btic_device_get_control_by_id ()</h3>
<pre class="programlisting"><a class="link" href="BtIcControl.html" title="BtIcControl"><span class="returnvalue">BtIcControl</span></a> * btic_device_get_control_by_id (<em class="parameter"><code>const <a class="link" href="BtIcDevice.html" title="BtIcDevice"><span class="type">BtIcDevice</span></a> *self</code></em>,
<em class="parameter"><code><span class="type">guint</span> id</code></em>);</pre>
<p>
Look up a control by <em class="parameter"><code>id</code></em>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>the device</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
<td>he control id</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the found instance or <code class="literal">NULL</code>. This does not increase the ref-count!</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.6</p>
</div>
<hr>
<div class="refsect2">
<a name="btic-device-has-controls"></a><h3>btic_device_has_controls ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> btic_device_has_controls (<em class="parameter"><code>const <a class="link" href="BtIcDevice.html" title="BtIcDevice"><span class="type">BtIcDevice</span></a> *self</code></em>);</pre>
<p>
Check if the device has controls. This is useful to check after device
creation. One reason for not having any controls could also be missing
read-permissions on the device node.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>the device</td>
</tr></tbody>
</table></div>
<p class="since">Since 0.6</p>
</div>
<hr>
<div class="refsect2">
<a name="btic-device-start"></a><h3>btic_device_start ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> btic_device_start (<em class="parameter"><code>const <a class="link" href="BtIcDevice.html" title="BtIcDevice"><span class="type">BtIcDevice</span></a> *self</code></em>);</pre>
<p>
Starts the io-loop for the device. This can be called multiple times and must
be paired by an equal amount of <a class="link" href="BtIcDevice.html#btic-device-stop" title="btic_device_stop ()"><code class="function">btic_device_stop()</code></a> calls.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>the <a class="link" href="BtIcDevice.html" title="BtIcDevice"><span class="type">BtIcDevice</span></a> instance to use</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> for success</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="btic-device-stop"></a><h3>btic_device_stop ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> btic_device_stop (<em class="parameter"><code>const <a class="link" href="BtIcDevice.html" title="BtIcDevice"><span class="type">BtIcDevice</span></a> *self</code></em>);</pre>
<p>
Stops the io-loop for the device. This must be called as often as the device
has been started using <a class="link" href="BtIcDevice.html#btic-device-start" title="btic_device_start ()"><code class="function">btic_device_start()</code></a>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>the <a class="link" href="BtIcDevice.html" title="BtIcDevice"><span class="type">BtIcDevice</span></a> instance to use</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> for success</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="btic-device-virtual-start"></a><h3>btic_device_virtual_start ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> (*btic_device_virtual_start) (<em class="parameter"><code><span class="type">gconstpointer</span> self</code></em>);</pre>
<p>
Subclasses will override this methods with a function that counts start calls
and runs the device-io for starts>0.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>device instance</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> for success</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="btic-device-virtual-stop"></a><h3>btic_device_virtual_stop ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> (*btic_device_virtual_stop) (<em class="parameter"><code><span class="type">gconstpointer</span> self</code></em>);</pre>
<p>
Subclasses will override this methods with a function that counts stop calls
and stops the device-io for starts==0.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>device instance</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> for success</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="BtIcDevice.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="BtIcDevice--controls"></a><h3>The <code class="literal">"controls"</code> property</h3>
<pre class="programlisting"> "controls" <span class="type">gpointer</span> : Read</pre>
<p>A copy of the list of device controls.</p>
</div>
<hr>
<div class="refsect2">
<a name="BtIcDevice--name"></a><h3>The <code class="literal">"name"</code> property</h3>
<pre class="programlisting"> "name" <span class="type">gchar</span>* : Read / Write / Construct Only</pre>
<p>device name.</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="BtIcDevice--udi"></a><h3>The <code class="literal">"udi"</code> property</h3>
<pre class="programlisting"> "udi" <span class="type">gchar</span>* : Read / Write / Construct Only</pre>
<p>device udi.</p>
<p>Default value: NULL</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|