<!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.77.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#XklState" title="XklState">XklState</a>;
<a class="link" href="libxklavier-xkl-engine.html#XklEngine-struct" title="XklEngine">XklEngine</a>;
<span class="returnvalue">GType</span> <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>);
<span class="returnvalue">GType</span> <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>);
<span class="returnvalue">GType</span> <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">
GObject
+----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>" <span class="type">gchar</span>* : Read
"<a class="link" href="libxklavier-xkl-engine.html#XklEngine--default-group" title='The "default-group" property'>default-group</a>" <span class="type">guint</span> : Read
"<a class="link" href="libxklavier-xkl-engine.html#XklEngine--display" title='The "display" property'>display</a>" <span class="type">gpointer</span> : 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>" <span class="type">gboolean</span> : Read
"<a class="link" href="libxklavier-xkl-engine.html#XklEngine--max-num-groups" title='The "max-num-groups" property'>max-num-groups</a>" <span class="type">guint</span> : Read
"<a class="link" href="libxklavier-xkl-engine.html#XklEngine--num-groups" title='The "num-groups" property'>num-groups</a>" <span class="type">guint</span> : Read
"<a class="link" href="libxklavier-xkl-engine.html#XklEngine--secondary-groups-mask" title='The "secondary-groups-mask" property'>secondary-groups-mask</a>" <span class="type">guint</span> : 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>" : <code class="literal">Run Last</code>
"<a class="link" href="libxklavier-xkl-engine.html#XklEngine-X-new-device" title='The "X-new-device" signal'>X-new-device</a>" : <code class="literal">Run Last</code>
"<a class="link" href="libxklavier-xkl-engine.html#XklEngine-X-state-changed" title='The "X-state-changed" signal'>X-state-changed</a>" : <code class="literal">Run Last</code>
"<a class="link" href="libxklavier-xkl-engine.html#XklEngine-new-toplevel-window" title='The "new-toplevel-window" signal'>new-toplevel-window</a>" : <code class="literal">Run Last</code>
</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>
The type of the keyboard state change
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="GROUP-CHANGED:CAPS"></a><span class="term"><code class="literal">GROUP_CHANGED</code></span></p></td>
<td>Group was changed
</td>
</tr>
<tr>
<td><p><a name="INDICATORS-CHANGED:CAPS"></a><span class="term"><code class="literal">INDICATORS_CHANGED</code></span></p></td>
<td>Indicators were changed
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="XklEngineFeatures"></a><h3>enum XklEngineFeatures</h3>
<pre class="programlisting">typedef enum {
/*< flags >*/
XKLF_CAN_TOGGLE_INDICATORS = 1 << 0,
XKLF_CAN_OUTPUT_CONFIG_AS_ASCII = 1 << 1,
XKLF_CAN_OUTPUT_CONFIG_AS_BINARY = 1 << 2,
XKLF_MULTIPLE_LAYOUTS_SUPPORTED = 1 << 3,
XKLF_REQUIRES_MANUAL_LAYOUT_MANAGEMENT = 1 << 4,
XKLF_DEVICE_DISCOVERY = 1 << 5
} XklEngineFeatures;
</pre>
<p>
A set of flags used to indicate the capabilities of the active backend
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="XKLF-CAN-TOGGLE-INDICATORS:CAPS"></a><span class="term"><code class="literal">XKLF_CAN_TOGGLE_INDICATORS</code></span></p></td>
<td>Backend allows to toggls indicators on/off
</td>
</tr>
<tr>
<td><p><a name="XKLF-CAN-OUTPUT-CONFIG-AS-ASCII:CAPS"></a><span class="term"><code class="literal">XKLF_CAN_OUTPUT_CONFIG_AS_ASCII</code></span></p></td>
<td>Backend allows writing ASCII representation of the configuration
</td>
</tr>
<tr>
<td><p><a name="XKLF-CAN-OUTPUT-CONFIG-AS-BINARY:CAPS"></a><span class="term"><code class="literal">XKLF_CAN_OUTPUT_CONFIG_AS_BINARY</code></span></p></td>
<td>Backend allows writing binary representation of the configuration
</td>
</tr>
<tr>
<td><p><a name="XKLF-MULTIPLE-LAYOUTS-SUPPORTED:CAPS"></a><span class="term"><code class="literal">XKLF_MULTIPLE_LAYOUTS_SUPPORTED</code></span></p></td>
<td>Backend supports multiple layouts
</td>
</tr>
<tr>
<td><p><a name="XKLF-REQUIRES-MANUAL-LAYOUT-MANAGEMENT:CAPS"></a><span class="term"><code class="literal">XKLF_REQUIRES_MANUAL_LAYOUT_MANAGEMENT</code></span></p></td>
<td>Backend requires manual configuration, some daemon should do
xkl_start_listen(engine,XKLL_MANAGE_LAYOUTS);
</td>
</tr>
<tr>
<td><p><a name="XKLF-DEVICE-DISCOVERY:CAPS"></a><span class="term"><code class="literal">XKLF_DEVICE_DISCOVERY</code></span></p></td>
<td>Backend supports device discovery, can notify
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="XklState"></a><h3>XklState</h3>
<pre class="programlisting">typedef struct _XklState XklState;</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"><span class="returnvalue">GType</span> 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"><span class="returnvalue">GType</span> 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"><span class="returnvalue">GType</span> 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" <span class="type">gchar</span>* : 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" <span class="type">guint</span> : Read</pre>
<p>Default group.</p>
<p>Allowed values: <= 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" <span class="type">gpointer</span> : 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" <span class="type">gboolean</span> : 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" <span class="type">guint</span> : Read</pre>
<p>Max number of groups.</p>
<p>Allowed values: <= 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" <span class="type">guint</span> : Read</pre>
<p>Current number of groups.</p>
<p>Allowed values: <= 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" <span class="type">guint</span> : Read</pre>
<p>Secondary groups mask.</p>
<p>Allowed values: <= 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,
<span class="type">gpointer</span> user_data) : <code class="literal">Run Last</code></pre>
<p>
</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>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,
<span class="type">gpointer</span> user_data) : <code class="literal">Run Last</code></pre>
<p>
</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>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,
<a class="link" href="libxklavier-xkl-engine.html#XklEngineStateChange" title="enum XklEngineStateChange"><span class="type">XklEngineStateChange</span></a> arg1,
<span class="type">gint</span> arg2,
<span class="type">gboolean</span> arg3,
<span class="type">gpointer</span> user_data) : <code class="literal">Run Last</code></pre>
<p>
</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>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"><span class="returnvalue">gint</span> user_function (<a class="link" href="libxklavier-xkl-engine.html#XklEngine"><span class="type">XklEngine</span></a> *xklengine,
<span class="type">glong</span> arg1,
<span class="type">glong</span> arg2,
<span class="type">gpointer</span> user_data) : <code class="literal">Run Last</code></pre>
<p>
</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>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>