/usr/share/doc/ibus/html/IBusEngineSimple.html is in ibus-doc 1.5.11-1ubuntu2.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>IBusEngineSimple: IBus Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="IBus Reference Manual">
<link rel="up" href="ch03.html" title="Input method engine">
<link rel="prev" href="IBusEngineDesc.html" title="IBusEngineDesc">
<link rel="next" href="IBusFactory.html" title="IBusFactory">
<meta name="generator" content="GTK-Doc V1.24 (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="#IBusEngineSimple.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#IBusEngineSimple.object-hierarchy" class="shortcut">Object Hierarchy</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="ch03.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="IBusEngineDesc.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="IBusFactory.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="IBusEngineSimple"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="IBusEngineSimple.top_of_page"></a>IBusEngineSimple</span></h2>
<p>IBusEngineSimple — Input method engine supporting table-based input method</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="IBusEngineSimple.stability-level"></a><h2>Stability Level</h2>
<acronym title="The intention of a Stable interface is to enable arbitrary third parties to
develop applications to these interfaces, release them, and have confidence that
they will run on all minor releases of the product (after the one in which the
interface was introduced, and within the same major release). Even at a major
release, incompatible changes are expected to be rare, and to have strong
justifications.
"><span class="acronym">Stable</span></acronym>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="IBusEngineSimple.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">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="IBusEngineSimple.html#ibus-engine-simple-add-table" title="ibus_engine_simple_add_table ()">ibus_engine_simple_add_table</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="IBusEngineSimple.html#ibus-engine-simple-add-table-by-locale" title="ibus_engine_simple_add_table_by_locale ()">ibus_engine_simple_add_table_by_locale</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="IBusEngineSimple.html#ibus-engine-simple-add-compose-file" title="ibus_engine_simple_add_compose_file ()">ibus_engine_simple_add_compose_file</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="IBusEngineSimple.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="define_keyword">#define</td>
<td class="function_name"><a class="link" href="IBusEngineSimple.html#IBUS-MAX-COMPOSE-LEN:CAPS" title="IBUS_MAX_COMPOSE_LEN">IBUS_MAX_COMPOSE_LEN</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="IBusEngineSimple.html#IBusEngineSimple-struct" title="struct IBusEngineSimple">IBusEngineSimple</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="IBusEngineSimple.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> GInitiallyUnowned
<span class="lineart">╰──</span> <a class="link" href="IBusObject.html" title="IBusObject">IBusObject</a>
<span class="lineart">╰──</span> <a class="link" href="IBusService.html" title="IBusService">IBusService</a>
<span class="lineart">╰──</span> <a class="link" href="IBusEngine.html" title="IBusEngine">IBusEngine</a>
<span class="lineart">╰──</span> IBusEngineSimple
</pre>
</div>
<div class="refsect1">
<a name="IBusEngineSimple.description"></a><h2>Description</h2>
<p>An IBusEngineSimple provides table-based input method logic.</p>
<p>see_also: <a class="link" href="IBusEngine.html" title="IBusEngine"><span class="type">IBusEngine</span></a></p>
</div>
<div class="refsect1">
<a name="IBusEngineSimple.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="ibus-engine-simple-add-table"></a><h3>ibus_engine_simple_add_table ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
ibus_engine_simple_add_table (<em class="parameter"><code><a class="link" href="IBusEngineSimple.html" title="IBusEngineSimple"><span class="type">IBusEngineSimple</span></a> *simple</code></em>,
<em class="parameter"><code>const <span class="type">guint16</span> *data</code></em>,
<em class="parameter"><code><span class="type">gint</span> max_seq_len</code></em>,
<em class="parameter"><code><span class="type">gint</span> n_seqs</code></em>);</pre>
<p>Adds an additional table to search to the engine. Each row of the table
consists of max_seq_len key symbols followed by two guint16 interpreted as
the high and low words of a gunicode value. Tables are searched starting from
the last added.</p>
<p>The table must be sorted in dictionary order on the numeric value of the key
symbol fields. (Values beyond the length of the sequence should be zero.)</p>
<div class="refsect3">
<a name="id-1.4.6.8.2.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>simple</p></td>
<td class="parameter_description"><p>An IBusEngineSimple.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p> The table which must be available
during the whole life of the simple engine. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> guint16][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>max_seq_len</p></td>
<td class="parameter_description"><p>Maximum length of a swquence in the table (cannot be greater
than <a class="link" href="IBusEngineSimple.html#IBUS-MAX-COMPOSE-LEN:CAPS" title="IBUS_MAX_COMPOSE_LEN"><code class="literal">IBUS_MAX_COMPOSE_LEN</code></a>)</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>n_seqs</p></td>
<td class="parameter_description"><p>number of sequences in the table</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ibus-engine-simple-add-table-by-locale"></a><h3>ibus_engine_simple_add_table_by_locale ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
ibus_engine_simple_add_table_by_locale
(<em class="parameter"><code><a class="link" href="IBusEngineSimple.html" title="IBusEngineSimple"><span class="type">IBusEngineSimple</span></a> *simple</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *locale</code></em>);</pre>
<p>Call <a class="link" href="IBusEngineSimple.html#ibus-engine-simple-add-table" title="ibus_engine_simple_add_table ()"><code class="function">ibus_engine_simple_add_table()</code></a> internally by locale.</p>
<div class="refsect3">
<a name="id-1.4.6.8.3.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>simple</p></td>
<td class="parameter_description"><p>An IBusEngineSimple.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>locale</p></td>
<td class="parameter_description"><p> The locale name. If the locale is <code class="literal">NULL</code>,
the current locale is used. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.6.8.3.6"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the <em class="parameter"><code>locale</code></em>
is matched to the table.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ibus-engine-simple-add-compose-file"></a><h3>ibus_engine_simple_add_compose_file ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
ibus_engine_simple_add_compose_file (<em class="parameter"><code><a class="link" href="IBusEngineSimple.html" title="IBusEngineSimple"><span class="type">IBusEngineSimple</span></a> *simple</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *file</code></em>);</pre>
<p>Call <a class="link" href="IBusEngineSimple.html#ibus-engine-simple-add-table" title="ibus_engine_simple_add_table ()"><code class="function">ibus_engine_simple_add_table()</code></a> internally by locale.</p>
<div class="refsect3">
<a name="id-1.4.6.8.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>simple</p></td>
<td class="parameter_description"><p>An IBusEngineSimple.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>file</p></td>
<td class="parameter_description"><p>The compose file. If the <em class="parameter"><code>file</code></em>
is <code class="literal">NULL</code>,
the current locale is used.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.6.8.4.6"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the <em class="parameter"><code>file</code></em>
is loaded.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="IBusEngineSimple.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="IBUS-MAX-COMPOSE-LEN:CAPS"></a><h3>IBUS_MAX_COMPOSE_LEN</h3>
<pre class="programlisting">#define IBUS_MAX_COMPOSE_LEN 7
</pre>
</div>
<hr>
<div class="refsect2">
<a name="IBusEngineSimple-struct"></a><h3>struct IBusEngineSimple</h3>
<pre class="programlisting">struct IBusEngineSimple;</pre>
<p>IBusEngineSimple properties.</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>
|