ibus-doc 1.5.17-3ubuntu4 / usr / share / doc / ibus / html / ibus-ibuskeys.html

This file is indexed.

/usr/share/doc/ibus/html/ibus-ibuskeys.html is in ibus-doc 1.5.17-3ubuntu4.

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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ibuskeys: IBus Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.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="IBusInputContext.html" title="IBusInputContext">
<link rel="next" href="IBusKeymap.html" title="IBusKeymap">
<meta name="generator" content="GTK-Doc V1.27 (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="#ibus-ibuskeys.description" class="shortcut">Description</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="IBusInputContext.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="IBusKeymap.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="ibus-ibuskeys"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="ibus-ibuskeys.top_of_page"></a>ibuskeys</span></h2>
<p>ibuskeys</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="ibus-ibuskeys.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="ibus-ibuskeys.html#ibus-keyval-name" title="ibus_keyval_name ()">ibus_keyval_name</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">guint</span>
</td>
<td class="function_name">
<a class="link" href="ibus-ibuskeys.html#ibus-keyval-from-name" title="ibus_keyval_from_name ()">ibus_keyval_from_name</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">guint</span>
</td>
<td class="function_name">
<a class="link" href="ibus-ibuskeys.html#ibus-unicode-to-keyval" title="ibus_unicode_to_keyval ()">ibus_unicode_to_keyval</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gunichar</span>
</td>
<td class="function_name">
<a class="link" href="ibus-ibuskeys.html#ibus-keyval-to-unicode" title="ibus_keyval_to_unicode ()">ibus_keyval_to_unicode</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">guint</span>
</td>
<td class="function_name">
<a class="link" href="ibus-ibuskeys.html#ibus-keyval-to-upper" title="ibus_keyval_to_upper ()">ibus_keyval_to_upper</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">guint</span>
</td>
<td class="function_name">
<a class="link" href="ibus-ibuskeys.html#ibus-keyval-to-lower" title="ibus_keyval_to_lower ()">ibus_keyval_to_lower</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="ibus-ibuskeys.html#ibus-keyval-convert-case" title="ibus_keyval_convert_case ()">ibus_keyval_convert_case</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ibus-ibuskeys.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="ibus-ibuskeys.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="ibus-keyval-name"></a><h3>ibus_keyval_name ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
ibus_keyval_name (<em class="parameter"><code><span class="type">guint</span> keyval</code></em>);</pre>
<p>Return the name of a key symbol.</p>
<p>Note that the returned string is used internally, so don't free it.</p>
<div class="refsect3">
<a name="ibus-keyval-name.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>keyval</p></td>
<td class="parameter_description"><p>Key symbol.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="ibus-keyval-name.returns"></a><h4>Returns</h4>
<p> Corresponding key name. <code class="literal">NULL</code> if no such key symbol.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ibus-keyval-from-name"></a><h3>ibus_keyval_from_name ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>
ibus_keyval_from_name (<em class="parameter"><code>const <span class="type">gchar</span> *keyval_name</code></em>);</pre>
<p>Return the key symbol that associate with the key name.</p>
<div class="refsect3">
<a name="ibus-keyval-from-name.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>keyval_name</p></td>
<td class="parameter_description"><p>Key name in <span class="type">gdk_keys_by_name</span>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="ibus-keyval-from-name.returns"></a><h4>Returns</h4>
<p> Corresponding key symbol.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ibus-unicode-to-keyval"></a><h3>ibus_unicode_to_keyval ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>
ibus_unicode_to_keyval (<em class="parameter"><code><span class="type">gunichar</span> wc</code></em>);</pre>
<p>Convert from a ISO10646 character to a key symbol.</p>
<div class="refsect3">
<a name="ibus-unicode-to-keyval.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>wc</p></td>
<td class="parameter_description"><p>a ISO10646 encoded character</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="ibus-unicode-to-keyval.returns"></a><h4>Returns</h4>
<p> the corresponding IBus key symbol, if one exists.
or, if there is no corresponding symbol,
wc | 0x01000000</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ibus-keyval-to-unicode"></a><h3>ibus_keyval_to_unicode ()</h3>
<pre class="programlisting"><span class="returnvalue">gunichar</span>
ibus_keyval_to_unicode (<em class="parameter"><code><span class="type">guint</span> keyval</code></em>);</pre>
<p>Convert from an IBus key symbol to the corresponding ISO10646 (Unicode)
character.</p>
<div class="refsect3">
<a name="ibus-keyval-to-unicode.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>keyval</p></td>
<td class="parameter_description"><p>an IBus key symbol</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="ibus-keyval-to-unicode.returns"></a><h4>Returns</h4>
<p> the corresponding unicode character, or 0 if there
is no corresponding character.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ibus-keyval-to-upper"></a><h3>ibus_keyval_to_upper ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>
ibus_keyval_to_upper (<em class="parameter"><code><span class="type">guint</span> keyval</code></em>);</pre>
<p>Converts a key value to upper case, if applicable.</p>
<div class="refsect3">
<a name="ibus-keyval-to-upper.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>keyval</p></td>
<td class="parameter_description"><p>a key value.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="ibus-keyval-to-upper.returns"></a><h4>Returns</h4>
<p> the upper case form of <em class="parameter"><code>keyval</code></em>
, or <em class="parameter"><code>keyval</code></em>
itself if it is already
in upper case or it is not subject to case conversion.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ibus-keyval-to-lower"></a><h3>ibus_keyval_to_lower ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>
ibus_keyval_to_lower (<em class="parameter"><code><span class="type">guint</span> keyval</code></em>);</pre>
<p>Converts a key value to lower case, if applicable.</p>
<div class="refsect3">
<a name="ibus-keyval-to-lower.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>keyval</p></td>
<td class="parameter_description"><p>a key value.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="ibus-keyval-to-lower.returns"></a><h4>Returns</h4>
<p> the lower case form of <em class="parameter"><code>keyval</code></em>
, or <em class="parameter"><code>keyval</code></em>
itself if it is already
in lower case or it is not subject to case conversion.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ibus-keyval-convert-case"></a><h3>ibus_keyval_convert_case ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
ibus_keyval_convert_case (<em class="parameter"><code><span class="type">guint</span> symbol</code></em>,
                          <em class="parameter"><code><span class="type">guint</span> *lower</code></em>,
                          <em class="parameter"><code><span class="type">guint</span> *upper</code></em>);</pre>
<p>Obtains the upper- and lower-case versions of the keyval <em class="parameter"><code>symbol</code></em>
.
Examples of keyvals are <a class="link" href="ibus-IBusKeysyms.html#IBUS-KEY-a" title="IBUS_KEY_a"><span class="type">IBUS_KEY_a</span></a>, <a class="link" href="ibus-IBusKeysyms.html#IBUS-KEY-Return" title="IBUS_KEY_Return"><span class="type">IBUS_KEY_Return</span></a>, <a class="link" href="ibus-IBusKeysyms.html#IBUS-KEY-F1:CAPS" title="IBUS_KEY_F1"><span class="type">IBUS_KEY_F1</span></a>, etc.</p>
<div class="refsect3">
<a name="ibus-keyval-convert-case.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>symbol</p></td>
<td class="parameter_description"><p>a keyval</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>lower</p></td>
<td class="parameter_description"><p>return location for lowercase version of <em class="parameter"><code>symbol</code></em>
. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>upper</p></td>
<td class="parameter_description"><p>return location for uppercase version of <em class="parameter"><code>symbol</code></em>
. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="ibus-ibuskeys.other_details"></a><h2>Types and Values</h2>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.