libxklavier-dev 5.2.1-1 / usr / share / gtk-doc / html / libxklavier / libxklavier-xkl-engine.html

This file is indexed.

/usr/share/gtk-doc/html/libxklavier/libxklavier-xkl-engine.html is in libxklavier-dev 5.2.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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>XklEngine</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Libxklavier Reference Manual">
<link rel="up" href="ch01.html" title="Libxklavier Objects">
<link rel="prev" href="ch01.html" title="Libxklavier Objects">
<link rel="next" href="XklConfigItem.html" title="XklConfigItem">
<meta name="generator" content="GTK-Doc V1.18 (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="ch01.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.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">Libxklavier Reference Manual</th>
<td><a accesskey="n" href="XklConfigItem.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libxklavier-xkl-engine.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#libxklavier-xkl-engine.description" class="shortcut">Description</a>
                   | 
                  <a href="#libxklavier-xkl-engine.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#libxklavier-xkl-engine.properties" class="shortcut">Properties</a>
                   | 
                  <a href="#libxklavier-xkl-engine.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry">
<a name="libxklavier-xkl-engine"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libxklavier-xkl-engine.top_of_page"></a>XklEngine</span></h2>
<p>XklEngine</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libxklavier-xkl-engine.synopsis"></a><h2>Synopsis</h2>
<a name="XklEngine"></a><pre class="synopsis">                    <a class="link" href="libxklavier-xkl-engine.html#XklEnginePrivate" title="XklEnginePrivate">XklEnginePrivate</a>;
enum                <a class="link" href="libxklavier-xkl-engine.html#XklEngineStateChange" title="enum XklEngineStateChange">XklEngineStateChange</a>;
enum                <a class="link" href="libxklavier-xkl-engine.html#XklEngineFeatures" title="enum XklEngineFeatures">XklEngineFeatures</a>;
                    <a class="link" href="libxklavier-xkl-engine.html#XklEngine-struct" title="XklEngine">XklEngine</a>;
<a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a>               <a class="link" href="libxklavier-xkl-engine.html#xkl-engine-features-get-type" title="xkl_engine_features_get_type ()">xkl_engine_features_get_type</a>        (<em class="parameter"><code><span class="type">void</span></code></em>);
<a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a>               <a class="link" href="libxklavier-xkl-engine.html#xkl-engine-listen-modes-get-type" title="xkl_engine_listen_modes_get_type ()">xkl_engine_listen_modes_get_type</a>    (<em class="parameter"><code><span class="type">void</span></code></em>);
<a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a>               <a class="link" href="libxklavier-xkl-engine.html#xkl-engine-state-change-get-type" title="xkl_engine_state_change_get_type ()">xkl_engine_state_change_get_type</a>    (<em class="parameter"><code><span class="type">void</span></code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libxklavier-xkl-engine.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
   +----XklEngine
</pre>
</div>
<div class="refsect1">
<a name="libxklavier-xkl-engine.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<a class="link" href="libxklavier-xkl-engine.html#XklEngine--backendName" title='The "backendName" property'>backendName</a>"              <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read
  "<a class="link" href="libxklavier-xkl-engine.html#XklEngine--default-group" title='The "default-group" property'>default-group</a>"            <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read
  "<a class="link" href="libxklavier-xkl-engine.html#XklEngine--display" title='The "display" property'>display</a>"                  <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>              : Read / Write / Construct Only
  "<a class="link" href="libxklavier-xkl-engine.html#XklEngine--features" title='The "features" property'>features</a>"                 <a class="link" href="libxklavier-xkl-engine.html#XklEngineFeatures" title="enum XklEngineFeatures"><span class="type">XklEngineFeatures</span></a>     : Read
  "<a class="link" href="libxklavier-xkl-engine.html#XklEngine--indicators-handling" title='The "indicators-handling" property'>indicators-handling</a>"      <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read
  "<a class="link" href="libxklavier-xkl-engine.html#XklEngine--max-num-groups" title='The "max-num-groups" property'>max-num-groups</a>"           <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read
  "<a class="link" href="libxklavier-xkl-engine.html#XklEngine--num-groups" title='The "num-groups" property'>num-groups</a>"               <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read
  "<a class="link" href="libxklavier-xkl-engine.html#XklEngine--secondary-groups-mask" title='The "secondary-groups-mask" property'>secondary-groups-mask</a>"    <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read
</pre>
</div>
<div class="refsect1">
<a name="libxklavier-xkl-engine.signals"></a><h2>Signals</h2>
<pre class="synopsis">
  "<a class="link" href="libxklavier-xkl-engine.html#XklEngine-X-config-changed" title='The "X-config-changed" signal'>X-config-changed</a>"                               : <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
  "<a class="link" href="libxklavier-xkl-engine.html#XklEngine-X-new-device" title='The "X-new-device" signal'>X-new-device</a>"                                   : <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
  "<a class="link" href="libxklavier-xkl-engine.html#XklEngine-X-state-changed" title='The "X-state-changed" signal'>X-state-changed</a>"                                : <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
  "<a class="link" href="libxklavier-xkl-engine.html#XklEngine-new-toplevel-window" title='The "new-toplevel-window" signal'>new-toplevel-window</a>"                            : <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
</pre>
</div>
<div class="refsect1">
<a name="libxklavier-xkl-engine.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="libxklavier-xkl-engine.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="XklEnginePrivate"></a><h3>XklEnginePrivate</h3>
<pre class="programlisting">typedef struct _XklEnginePrivate XklEnginePrivate;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="XklEngineStateChange"></a><h3>enum XklEngineStateChange</h3>
<pre class="programlisting">typedef enum {
		GROUP_CHANGED,
		INDICATORS_CHANGED
} XklEngineStateChange;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="XklEngineFeatures"></a><h3>enum XklEngineFeatures</h3>
<pre class="programlisting">typedef enum {
		XKLF_CAN_TOGGLE_INDICATORS = 1 &lt;&lt; 0,
		XKLF_CAN_OUTPUT_CONFIG_AS_ASCII = 1 &lt;&lt; 1,
		XKLF_CAN_OUTPUT_CONFIG_AS_BINARY = 1 &lt;&lt; 2,
		XKLF_MULTIPLE_LAYOUTS_SUPPORTED = 1 &lt;&lt; 3,
		XKLF_REQUIRES_MANUAL_LAYOUT_MANAGEMENT = 1 &lt;&lt; 4,
		XKLF_DEVICE_DISCOVERY = 1 &lt;&lt; 5
} XklEngineFeatures;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="XklEngine-struct"></a><h3>XklEngine</h3>
<pre class="programlisting">typedef struct _XklEngine XklEngine;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="xkl-engine-features-get-type"></a><h3>xkl_engine_features_get_type ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a>               xkl_engine_features_get_type        (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="xkl-engine-listen-modes-get-type"></a><h3>xkl_engine_listen_modes_get_type ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a>               xkl_engine_listen_modes_get_type    (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="xkl-engine-state-change-get-type"></a><h3>xkl_engine_state_change_get_type ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a>               xkl_engine_state_change_get_type    (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
</p>
</div>
</div>
<div class="refsect1">
<a name="libxklavier-xkl-engine.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="XklEngine--backendName"></a><h3>The <code class="literal">"backendName"</code> property</h3>
<pre class="programlisting">  "backendName"              <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read</pre>
<p>Backend name.</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="XklEngine--default-group"></a><h3>The <code class="literal">"default-group"</code> property</h3>
<pre class="programlisting">  "default-group"            <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read</pre>
<p>Default group.</p>
<p>Allowed values: &lt;= 256</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="XklEngine--display"></a><h3>The <code class="literal">"display"</code> property</h3>
<pre class="programlisting">  "display"                  <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>              : Read / Write / Construct Only</pre>
<p>X Display pointer.</p>
</div>
<hr>
<div class="refsect2">
<a name="XklEngine--features"></a><h3>The <code class="literal">"features"</code> property</h3>
<pre class="programlisting">  "features"                 <a class="link" href="libxklavier-xkl-engine.html#XklEngineFeatures" title="enum XklEngineFeatures"><span class="type">XklEngineFeatures</span></a>     : Read</pre>
<p>Backend features.</p>
</div>
<hr>
<div class="refsect2">
<a name="XklEngine--indicators-handling"></a><h3>The <code class="literal">"indicators-handling"</code> property</h3>
<pre class="programlisting">  "indicators-handling"      <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read</pre>
<p>Whether engine should handle indicators.</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="XklEngine--max-num-groups"></a><h3>The <code class="literal">"max-num-groups"</code> property</h3>
<pre class="programlisting">  "max-num-groups"           <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read</pre>
<p>Max number of groups.</p>
<p>Allowed values: &lt;= 256</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="XklEngine--num-groups"></a><h3>The <code class="literal">"num-groups"</code> property</h3>
<pre class="programlisting">  "num-groups"               <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read</pre>
<p>Current number of groups.</p>
<p>Allowed values: &lt;= 256</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="XklEngine--secondary-groups-mask"></a><h3>The <code class="literal">"secondary-groups-mask"</code> property</h3>
<pre class="programlisting">  "secondary-groups-mask"    <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read</pre>
<p>Secondary groups mask.</p>
<p>Allowed values: &lt;= 256</p>
<p>Default value: 0</p>
</div>
</div>
<div class="refsect1">
<a name="libxklavier-xkl-engine.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="XklEngine-X-config-changed"></a><h3>The <code class="literal">"X-config-changed"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="libxklavier-xkl-engine.html#XklEngine"><span class="type">XklEngine</span></a> *xklengine,
                                                        <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>   user_data)      : <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>xklengine</code></em> :</span></p></td>
<td>the object which received the signal.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="XklEngine-X-new-device"></a><h3>The <code class="literal">"X-new-device"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="libxklavier-xkl-engine.html#XklEngine"><span class="type">XklEngine</span></a> *xklengine,
                                                        <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>   user_data)      : <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>xklengine</code></em> :</span></p></td>
<td>the object which received the signal.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="XklEngine-X-state-changed"></a><h3>The <code class="literal">"X-state-changed"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="libxklavier-xkl-engine.html#XklEngine"><span class="type">XklEngine</span></a>               *xklengine,
                                                        <span class="type">XklEngineStateChangeType</span> arg1,
                                                        <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                     arg2,
                                                        <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>                 arg3,
                                                        <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>                 user_data)      : <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>xklengine</code></em> :</span></p></td>
<td>the object which received the signal.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="XklEngine-new-toplevel-window"></a><h3>The <code class="literal">"new-toplevel-window"</code> signal</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                user_function                      (<a class="link" href="libxklavier-xkl-engine.html#XklEngine"><span class="type">XklEngine</span></a> *xklengine,
                                                        <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#glong"><span class="type">glong</span></a>      arg1,
                                                        <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#glong"><span class="type">glong</span></a>      arg2,
                                                        <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>   user_data)      : <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>xklengine</code></em> :</span></p></td>
<td>the object which received the signal.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.