/usr/share/gtk-doc/html/buzztard-ic/buzztard-ic-libbtic.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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>libbtic</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="libbtic.html" title="Interaction Controller Reference">
<link rel="next" href="BtIcRegistry.html" title="BtIcRegistry">
<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="libbtic.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="BtIcRegistry.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#buzztard-ic-libbtic.synopsis" class="shortcut">Top</a>
|
<a href="#buzztard-ic-libbtic.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="buzztard-ic-libbtic"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="buzztard-ic-libbtic.top_of_page"></a>libbtic</span></h2>
<p>libbtic — interaction controller library of the buzztard
application framework</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="buzztard-ic-libbtic.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <libbtic/ic.h>
<span class="returnvalue">GOptionGroup</span> * <a class="link" href="buzztard-ic-libbtic.html#btic-init-get-option-group" title="btic_init_get_option_group ()">btic_init_get_option_group</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="buzztard-ic-libbtic.html#btic-init-check" title="btic_init_check ()">btic_init_check</a> (<em class="parameter"><code><span class="type">int</span> *argc</code></em>,
<em class="parameter"><code><span class="type">char</span> **argv[]</code></em>,
<em class="parameter"><code><span class="type">GError</span> **err</code></em>);
<span class="returnvalue">void</span> <a class="link" href="buzztard-ic-libbtic.html#btic-init" title="btic_init ()">btic_init</a> (<em class="parameter"><code><span class="type">int</span> *argc</code></em>,
<em class="parameter"><code><span class="type">char</span> **argv[]</code></em>);
extern const unsigned int <a class="link" href="buzztard-ic-libbtic.html#btic-major-version" title="btic_major_version">btic_major_version</a>;
extern const unsigned int <a class="link" href="buzztard-ic-libbtic.html#btic-micro-version" title="btic_micro_version">btic_micro_version</a>;
extern const unsigned int <a class="link" href="buzztard-ic-libbtic.html#btic-minor-version" title="btic_minor_version">btic_minor_version</a>;
</pre>
</div>
<div class="refsect1">
<a name="buzztard-ic-libbtic.description"></a><h2>Description</h2>
<p>
The library offers an abstraction of hardware controllers that can be bound
to ui controls.
</p>
</div>
<div class="refsect1">
<a name="buzztard-ic-libbtic.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="btic-init-get-option-group"></a><h3>btic_init_get_option_group ()</h3>
<pre class="programlisting"><span class="returnvalue">GOptionGroup</span> * btic_init_get_option_group (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Returns a <span class="type">GOptionGroup</span> with libbtic's argument specifications. The group
is set up to use standard GOption callbacks, so when using this group in
combination with GOption parsing methods, all argument parsing and
initialization is automated.
</p>
<p>
This function is useful if you want to integrate libbtic with other
libraries that use GOption (see <code class="function">g_option_context_add_group()</code> ).
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a pointer to a GOption group. Should be dereferenced after use.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="btic-init-check"></a><h3>btic_init_check ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> btic_init_check (<em class="parameter"><code><span class="type">int</span> *argc</code></em>,
<em class="parameter"><code><span class="type">char</span> **argv[]</code></em>,
<em class="parameter"><code><span class="type">GError</span> **err</code></em>);</pre>
<p>
Initializes the Buzztard interaction controller library.
</p>
<p>
This function will return <code class="literal">FALSE</code> if Buzztard interaction controller could not
be initialized for some reason. If you want your program to fail fatally,
use <a class="link" href="buzztard-ic-libbtic.html#btic-init" title="btic_init ()"><code class="function">btic_init()</code></a> instead.
</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>argc</code></em> :</span></p></td>
<td>pointer to application's argc</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>argv</code></em> :</span></p></td>
<td>pointer to application's argv</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td>
<td>pointer to a <span class="type">GError</span> to which a message will be posted on error</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> if Buzztard interaction controller could be initialized.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="btic-init"></a><h3>btic_init ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> btic_init (<em class="parameter"><code><span class="type">int</span> *argc</code></em>,
<em class="parameter"><code><span class="type">char</span> **argv[]</code></em>);</pre>
<p>
Initializes the Buzztard Interaction Controller library.
</p>
<p>
</p>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<p>
This function will terminate your program if it was unable to initialize
the core for some reason. If you want your program to fall back,
use <a class="link" href="buzztard-ic-libbtic.html#btic-init-check" title="btic_init_check ()"><code class="function">btic_init_check()</code></a> instead.
</p>
</div>
<p>
</p>
<p>
WARNING: This function does not work in the same way as corresponding
functions in other glib-style libraries, such as <code class="function">gtk_init()</code>. In
particular, unknown command line options cause this function to
abort program execution.
</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>argc</code></em> :</span></p></td>
<td>pointer to application's argc</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>argv</code></em> :</span></p></td>
<td>pointer to application's argv</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="btic-major-version"></a><h3>btic_major_version</h3>
<pre class="programlisting">extern const unsigned int btic_major_version;
</pre>
<p>
buzztard version stamp, major part; determined from <span class="type">BTIC_MAJOR_VERSION</span>
</p>
</div>
<hr>
<div class="refsect2">
<a name="btic-micro-version"></a><h3>btic_micro_version</h3>
<pre class="programlisting">extern const unsigned int btic_micro_version;
</pre>
<p>
buzztard version stamp, micro part; determined from <span class="type">BTIC_MICRO_VERSION</span>
</p>
</div>
<hr>
<div class="refsect2">
<a name="btic-minor-version"></a><h3>btic_minor_version</h3>
<pre class="programlisting">extern const unsigned int btic_minor_version;
</pre>
<p>
buzztard version stamp, minor part; determined from <span class="type">BTIC_MINOR_VERSION</span>
</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|