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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>BtIcRegistry: Buzztrax Bt-Ic Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Buzztrax Bt-Ic Reference Manual">
<link rel="up" href="libbtic.html" title="Interaction Controller Reference">
<link rel="prev" href="buzztrax-ic-libbtic.html" title="libbtic">
<link rel="next" href="BtIcASeqDiscoverer.html" title="BtIcASeqDiscoverer">
<meta name="generator" content="GTK-Doc V1.24.1 (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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#BtIcRegistry.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#BtIcRegistry.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#BtIcRegistry.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="libbtic.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="buzztrax-ic-libbtic.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="BtIcASeqDiscoverer.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="BtIcRegistry"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="BtIcRegistry.top_of_page"></a>BtIcRegistry</span></h2>
<p>BtIcRegistry — buzztraxs interaction controller registry</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="BtIcRegistry.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="BtIcRegistry.html" title="BtIcRegistry"><span class="returnvalue">BtIcRegistry</span></a> *
</td>
<td class="function_name">
<a class="link" href="BtIcRegistry.html#btic-registry-new" title="btic_registry_new ()">btic_registry_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="BtIcRegistry.html#btic-registry-add-device" title="btic_registry_add_device ()">btic_registry_add_device</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="BtIcDevice.html" title="BtIcDevice"><span class="returnvalue">BtIcDevice</span></a> *
</td>
<td class="function_name">
<a class="link" href="BtIcRegistry.html#btic-registry-get-device-by-name" title="btic_registry_get_device_by_name ()">btic_registry_get_device_by_name</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="BtIcRegistry.html#btic-registry-remove-device-by-udi" title="btic_registry_remove_device_by_udi ()">btic_registry_remove_device_by_udi</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="BtIcRegistry.properties"></a><h2>Properties</h2>
<div class="informaltable"><table border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody><tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a></td>
<td class="property_name"><a class="link" href="BtIcRegistry.html#BtIcRegistry--devices" title="The “devices” property">devices</a></td>
<td class="property_flags">Read</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="BtIcRegistry.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="BtIcRegistry.html#BtIcRegistry-struct" title="struct BtIcRegistry">BtIcRegistry</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="BtIcRegistry.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobjectgobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
<span class="lineart">╰──</span> BtIcRegistry
</pre>
</div>
<div class="refsect1">
<a name="BtIcRegistry.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libbtic/ic.h>
</pre>
</div>
<div class="refsect1">
<a name="BtIcRegistry.description"></a><h2>Description</h2>
<p>Manages a dynamic list of controller devices. It uses a discoverer helper to
scan devices. Right now GUdev is supported.</p>
</div>
<div class="refsect1">
<a name="BtIcRegistry.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="btic-registry-new"></a><h3>btic_registry_new ()</h3>
<pre class="programlisting"><a class="link" href="BtIcRegistry.html" title="BtIcRegistry"><span class="returnvalue">BtIcRegistry</span></a> *
btic_registry_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Create a new instance</p>
<div class="refsect3">
<a name="id-1.4.4.9.2.5"></a><h4>Returns</h4>
<p> the new instance</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="btic-registry-add-device"></a><h3>btic_registry_add_device ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
btic_registry_add_device (<em class="parameter"><code><a class="link" href="BtIcDevice.html" title="BtIcDevice"><span class="type">BtIcDevice</span></a> *device</code></em>);</pre>
<p>Add the given device to the registry.</p>
<p>Only to be used by discoverers.</p>
<div class="refsect3">
<a name="id-1.4.4.9.3.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>device</p></td>
<td class="parameter_description"><p>new device</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="btic-registry-get-device-by-name"></a><h3>btic_registry_get_device_by_name ()</h3>
<pre class="programlisting"><a class="link" href="BtIcDevice.html" title="BtIcDevice"><span class="returnvalue">BtIcDevice</span></a> *
btic_registry_get_device_by_name (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
<p>Find the device identified by the given <em class="parameter"><code>name</code></em>
in the registry.</p>
<div class="refsect3">
<a name="id-1.4.4.9.4.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>device name</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.4.9.4.6"></a><h4>Returns</h4>
<p> a ref to the device or <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="api-index-0-9.html#api-index-0.9">0.9</a></p>
</div>
<hr>
<div class="refsect2">
<a name="btic-registry-remove-device-by-udi"></a><h3>btic_registry_remove_device_by_udi ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
btic_registry_remove_device_by_udi (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *udi</code></em>);</pre>
<p>Remove device identified by the given <em class="parameter"><code>udi</code></em>
from the registry.</p>
<p>Only to be used by discoverers.</p>
<div class="refsect3">
<a name="id-1.4.4.9.5.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>udi</p></td>
<td class="parameter_description"><p>device id</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="BtIcRegistry.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="BtIcRegistry-struct"></a><h3>struct BtIcRegistry</h3>
<pre class="programlisting">struct BtIcRegistry;</pre>
<p>buzztraxs interaction controller registry</p>
</div>
</div>
<div class="refsect1">
<a name="BtIcRegistry.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="BtIcRegistry--devices"></a><h3>The <code class="literal">“devices”</code> property</h3>
<pre class="programlisting"> “devices” <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a></pre>
<p>A copy of the list of control devices.</p>
<p>Flags: Read</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24.1</div>
</body>
</html>
|