/usr/share/gtk-doc/html/buzztard-ic/BtIcLearn.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 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>BtIcLearn</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="BtIcTriggerControl.html" title="BtIcTriggerControl">
<link rel="next" href="pt02.html" title="Part III. Appendix">
<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="BtIcTriggerControl.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="pt02.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#BtIcLearn.synopsis" class="shortcut">Top</a>
|
<a href="#BtIcLearn.description" class="shortcut">Description</a>
|
<a href="#BtIcLearn.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#BtIcLearn.implementations" class="shortcut">Known Implementations</a>
|
<a href="#BtIcLearn.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="BtIcLearn"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="BtIcLearn.top_of_page"></a>BtIcLearn</span></h2>
<p>BtIcLearn — interface for devices with learn function</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="BtIcLearn.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <libbtic/ic.h>
<a class="link" href="BtIcLearn.html#BtIcLearn-struct" title="BtIcLearn">BtIcLearn</a>;
<span class="returnvalue">gboolean</span> <a class="link" href="BtIcLearn.html#btic-learn-start" title="btic_learn_start ()">btic_learn_start</a> (<em class="parameter"><code>const <a class="link" href="BtIcLearn.html" title="BtIcLearn"><span class="type">BtIcLearn</span></a> *self</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="BtIcLearn.html#btic-learn-stop" title="btic_learn_stop ()">btic_learn_stop</a> (<em class="parameter"><code>const <a class="link" href="BtIcLearn.html" title="BtIcLearn"><span class="type">BtIcLearn</span></a> *self</code></em>);
<a class="link" href="BtIcControl.html" title="BtIcControl"><span class="returnvalue">BtIcControl</span></a> * <a class="link" href="BtIcLearn.html#btic-learn-register-learned-control" title="btic_learn_register_learned_control ()">btic_learn_register_learned_control</a> (<em class="parameter"><code>const <a class="link" href="BtIcLearn.html" title="BtIcLearn"><span class="type">BtIcLearn</span></a> *self</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="BtIcLearn.html#btic-learn-load-controller-map" title="btic_learn_load_controller_map ()">btic_learn_load_controller_map</a> (<em class="parameter"><code>const <a class="link" href="BtIcLearn.html" title="BtIcLearn"><span class="type">BtIcLearn</span></a> *self</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="BtIcLearn.html#btic-learn-store-controller-map" title="btic_learn_store_controller_map ()">btic_learn_store_controller_map</a> (<em class="parameter"><code>const <a class="link" href="BtIcLearn.html" title="BtIcLearn"><span class="type">BtIcLearn</span></a> *self</code></em>);
<span class="returnvalue">gboolean</span> (<a class="link" href="BtIcLearn.html#btic-learn-virtual-start" title="btic_learn_virtual_start ()">*btic_learn_virtual_start</a>) (<em class="parameter"><code><span class="type">gconstpointer</span> self</code></em>);
<span class="returnvalue">gboolean</span> (<a class="link" href="BtIcLearn.html#btic-learn-virtual-stop" title="btic_learn_virtual_stop ()">*btic_learn_virtual_stop</a>) (<em class="parameter"><code><span class="type">gconstpointer</span> self</code></em>);
<a class="link" href="BtIcControl.html" title="BtIcControl"><span class="returnvalue">BtIcControl</span></a> * (<a class="link" href="BtIcLearn.html#btic-learn-virtual-register-learned-control" title="btic_learn_virtual_register_learned_control ()">*btic_learn_virtual_register_learned_control</a>)
(<em class="parameter"><code><span class="type">gconstpointer</span> self</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="BtIcLearn.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GInterface
+----BtIcLearn
</pre>
</div>
<div class="refsect1">
<a name="BtIcLearn.implementations"></a><h2>Known Implementations</h2>
<p>
BtIcLearn is implemented by
<a class="link" href="BtIcMidiDevice.html" title="BtIcMidiDevice">BtIcMidiDevice</a>.</p>
</div>
<div class="refsect1">
<a name="BtIcLearn.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="BtIcLearn.html#BtIcLearn--device-controlchange" title='The "device-controlchange" property'>device-controlchange</a>" <span class="type">gchar</span>* : Read / Write
</pre>
</div>
<div class="refsect1">
<a name="BtIcLearn.description"></a><h2>Description</h2>
<p>
An interface which all devices which support interactive learning of
controls should implement.
</p>
<p>
The interface comes with an implementation for caching the learned controls.
The implementor needs to call <a class="link" href="BtIcLearn.html#btic-learn-load-controller-map" title="btic_learn_load_controller_map ()"><code class="function">btic_learn_load_controller_map()</code></a> after
construction and <a class="link" href="BtIcLearn.html#btic-learn-store-controller-map" title="btic_learn_store_controller_map ()"><code class="function">btic_learn_store_controller_map()</code></a> when a control got added.
</p>
</div>
<div class="refsect1">
<a name="BtIcLearn.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="BtIcLearn-struct"></a><h3>BtIcLearn</h3>
<pre class="programlisting">typedef struct _BtIcLearn BtIcLearn;</pre>
<p>
interface for devices which implement a learn-function
</p>
</div>
<hr>
<div class="refsect2">
<a name="btic-learn-start"></a><h3>btic_learn_start ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> btic_learn_start (<em class="parameter"><code>const <a class="link" href="BtIcLearn.html" title="BtIcLearn"><span class="type">BtIcLearn</span></a> *self</code></em>);</pre>
<p>
Starts the device if needed and enables the learn function.
Starts emission of notify::devide-controlchange signals.
</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 which implements the <a class="link" href="BtIcLearn.html" title="BtIcLearn"><span class="type">BtIcLearn</span></a> interface</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-learn-stop"></a><h3>btic_learn_stop ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> btic_learn_stop (<em class="parameter"><code>const <a class="link" href="BtIcLearn.html" title="BtIcLearn"><span class="type">BtIcLearn</span></a> *self</code></em>);</pre>
<p>
Eventually stops the device and disables the learn function.
Stops emission of notify::devide-controlchange signals.
</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 which implements the <a class="link" href="BtIcLearn.html" title="BtIcLearn"><span class="type">BtIcLearn</span></a> interface</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-learn-register-learned-control"></a><h3>btic_learn_register_learned_control ()</h3>
<pre class="programlisting"><a class="link" href="BtIcControl.html" title="BtIcControl"><span class="returnvalue">BtIcControl</span></a> * btic_learn_register_learned_control (<em class="parameter"><code>const <a class="link" href="BtIcLearn.html" title="BtIcLearn"><span class="type">BtIcLearn</span></a> *self</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
<p>
Registers the last detected control with name <em class="parameter"><code>name</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 which implements the <a class="link" href="BtIcLearn.html" title="BtIcLearn"><span class="type">BtIcLearn</span></a> interface</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>the name under which to register the control</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-learn-load-controller-map"></a><h3>btic_learn_load_controller_map ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> btic_learn_load_controller_map (<em class="parameter"><code>const <a class="link" href="BtIcLearn.html" title="BtIcLearn"><span class="type">BtIcLearn</span></a> *self</code></em>);</pre>
<p>
Create initial set of controls from a stored control map. Interface
implementations should call this from their <code class="function">GObjectClass.constructed()</code> function.
</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"><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-learn-store-controller-map"></a><h3>btic_learn_store_controller_map ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> btic_learn_store_controller_map (<em class="parameter"><code>const <a class="link" href="BtIcLearn.html" title="BtIcLearn"><span class="type">BtIcLearn</span></a> *self</code></em>);</pre>
<p>
Store a map of all controls to disk. Interface implementations should call
this from their <a class="link" href="BtIcLearn.html#btic-learn-register-learned-control" title="btic_learn_register_learned_control ()"><code class="function">btic_learn_register_learned_control()</code></a> function after they
registered a new 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"><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-learn-virtual-start"></a><h3>btic_learn_virtual_start ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> (*btic_learn_virtual_start) (<em class="parameter"><code><span class="type">gconstpointer</span> self</code></em>);</pre>
<p>
Subclasses will override this methods with a function which enables the
learning mode on this device.
</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-learn-virtual-stop"></a><h3>btic_learn_virtual_stop ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> (*btic_learn_virtual_stop) (<em class="parameter"><code><span class="type">gconstpointer</span> self</code></em>);</pre>
<p>
Subclasses will override this methods with a function which disables the
learning mode on this device.
</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-learn-virtual-register-learned-control"></a><h3>btic_learn_virtual_register_learned_control ()</h3>
<pre class="programlisting"><a class="link" href="BtIcControl.html" title="BtIcControl"><span class="returnvalue">BtIcControl</span></a> * (*btic_learn_virtual_register_learned_control)
(<em class="parameter"><code><span class="type">gconstpointer</span> self</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
<p>
Subclasses will override this methods with a function which registers
the last control which was detected in learn mode.
</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"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>the name under which to register the control</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="BtIcLearn.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="BtIcLearn--device-controlchange"></a><h3>The <code class="literal">"device-controlchange"</code> property</h3>
<pre class="programlisting"> "device-controlchange" <span class="type">gchar</span>* : Read / Write</pre>
<p>get the last detected control.</p>
<p>Default value: NULL</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|