<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>XAppKbdLayoutController: XApp Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="XApp Reference Manual">
<link rel="up" href="ch01.html" title="API reference">
<link rel="prev" href="XAppIconChooserDialog.html" title="XAppIconChooserDialog">
<link rel="next" href="XAppMonitorBlanker.html" title="XAppMonitorBlanker">
<meta name="generator" content="GTK-Doc V1.32 (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="#XAppKbdLayoutController.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#XAppKbdLayoutController.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#XAppKbdLayoutController.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span>
<a href="#XAppKbdLayoutController.signals" class="shortcut">Signals</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="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="XAppIconChooserDialog.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="XAppMonitorBlanker.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="XAppKbdLayoutController"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="XAppKbdLayoutController.top_of_page"></a>XAppKbdLayoutController</span></h2>
<p>XAppKbdLayoutController — Keyboard layout selection UI element provider.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="XAppKbdLayoutController.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="returnvalue">XAppKbdLayoutController</span></a> *
</td>
<td class="function_name">
<a class="link" href="XAppKbdLayoutController.html#xapp-kbd-layout-controller-new" title="xapp_kbd_layout_controller_new ()">xapp_kbd_layout_controller_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="XAppKbdLayoutController.html#xapp-kbd-layout-controller-get-enabled" title="xapp_kbd_layout_controller_get_enabled ()">xapp_kbd_layout_controller_get_enabled</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
</td>
<td class="function_name">
<a class="link" href="XAppKbdLayoutController.html#xapp-kbd-layout-controller-get-current-group" title="xapp_kbd_layout_controller_get_current_group ()">xapp_kbd_layout_controller_get_current_group</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="XAppKbdLayoutController.html#xapp-kbd-layout-controller-set-current-group" title="xapp_kbd_layout_controller_set_current_group ()">xapp_kbd_layout_controller_set_current_group</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="XAppKbdLayoutController.html#xapp-kbd-layout-controller-next-group" title="xapp_kbd_layout_controller_next_group ()">xapp_kbd_layout_controller_next_group</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="XAppKbdLayoutController.html#xapp-kbd-layout-controller-previous-group" title="xapp_kbd_layout_controller_previous_group ()">xapp_kbd_layout_controller_previous_group</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="XAppKbdLayoutController.html#xapp-kbd-layout-controller-get-current-name" title="xapp_kbd_layout_controller_get_current_name ()">xapp_kbd_layout_controller_get_current_name</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> **
</td>
<td class="function_name">
<a class="link" href="XAppKbdLayoutController.html#xapp-kbd-layout-controller-get-all-names" title="xapp_kbd_layout_controller_get_all_names ()">xapp_kbd_layout_controller_get_all_names</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="XAppKbdLayoutController.html#xapp-kbd-layout-controller-get-current-icon-name" title="xapp_kbd_layout_controller_get_current_icon_name ()">xapp_kbd_layout_controller_get_current_icon_name</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="XAppKbdLayoutController.html#xapp-kbd-layout-controller-get-icon-name-for-group" title="xapp_kbd_layout_controller_get_icon_name_for_group ()">xapp_kbd_layout_controller_get_icon_name_for_group</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
</td>
<td class="function_name">
<a class="link" href="XAppKbdLayoutController.html#xapp-kbd-layout-controller-get-current-flag-id" title="xapp_kbd_layout_controller_get_current_flag_id ()">xapp_kbd_layout_controller_get_current_flag_id</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
</td>
<td class="function_name">
<a class="link" href="XAppKbdLayoutController.html#xapp-kbd-layout-controller-get-flag-id-for-group" title="xapp_kbd_layout_controller_get_flag_id_for_group ()">xapp_kbd_layout_controller_get_flag_id_for_group</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="XAppKbdLayoutController.html#xapp-kbd-layout-controller-get-current-short-group-label" title="xapp_kbd_layout_controller_get_current_short_group_label ()">xapp_kbd_layout_controller_get_current_short_group_label</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="XAppKbdLayoutController.html#xapp-kbd-layout-controller-get-short-group-label-for-group" title="xapp_kbd_layout_controller_get_short_group_label_for_group ()">xapp_kbd_layout_controller_get_short_group_label_for_group</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="XAppKbdLayoutController.html#xapp-kbd-layout-controller-get-current-variant-label" title="xapp_kbd_layout_controller_get_current_variant_label ()">xapp_kbd_layout_controller_get_current_variant_label</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="XAppKbdLayoutController.html#xapp-kbd-layout-controller-get-variant-label-for-group" title="xapp_kbd_layout_controller_get_variant_label_for_group ()">xapp_kbd_layout_controller_get_variant_label_for_group</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="XAppKbdLayoutController.html#xapp-kbd-layout-controller-render-cairo-subscript" title="xapp_kbd_layout_controller_render_cairo_subscript ()">xapp_kbd_layout_controller_render_cairo_subscript</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="XAppKbdLayoutController.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody><tr>
<td class="property_type"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
<td class="property_name"><a class="link" href="XAppKbdLayoutController.html#XAppKbdLayoutController--enabled" title="The “enabled” property">enabled</a></td>
<td class="property_flags">Read</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="XAppKbdLayoutController.signals"></a><h2>Signals</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="signal_proto_type">
<col width="300px" class="signal_proto_name">
<col width="200px" class="signal_proto_flags">
</colgroup>
<tbody>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="XAppKbdLayoutController.html#XAppKbdLayoutController-config-changed" title="The “config-changed” signal">config-changed</a></td>
<td class="signal_flags"><a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="XAppKbdLayoutController.html#XAppKbdLayoutController-layout-changed" title="The “layout-changed” signal">layout-changed</a></td>
<td class="signal_flags"><a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="XAppKbdLayoutController.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
<span class="lineart">╰──</span> XAppKbdLayoutController
</pre>
</div>
<div class="refsect1">
<a name="XAppKbdLayoutController.description"></a><h2>Description</h2>
<p>A GObject wrapper for Gkbd that provides additional UI element
support for keyboard layout flags and abbreviations, as well as
Wfacilities to distinguish regional and hardware-based variants
which might otherwise appear identical in a layout list.</p>
</div>
<div class="refsect1">
<a name="XAppKbdLayoutController.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="xapp-kbd-layout-controller-new"></a><h3>xapp_kbd_layout_controller_new ()</h3>
<pre class="programlisting"><a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="returnvalue">XAppKbdLayoutController</span></a> *
xapp_kbd_layout_controller_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates a new XAppKbdLayoutController instance.</p>
<div class="refsect3">
<a name="xapp-kbd-layout-controller-new.returns"></a><h4>Returns</h4>
<p>a new <a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a> instance. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="xapp-kbd-layout-controller-get-enabled"></a><h3>xapp_kbd_layout_controller_get_enabled ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
xapp_kbd_layout_controller_get_enabled
(<em class="parameter"><code><a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a> *controller</code></em>);</pre>
<p>Returns whether or not the layout controller is enabled</p>
<div class="refsect3">
<a name="xapp-kbd-layout-controller-get-enabled.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>controller</p></td>
<td class="parameter_description"><p>the <a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="xapp-kbd-layout-controller-get-current-group"></a><h3>xapp_kbd_layout_controller_get_current_group ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
xapp_kbd_layout_controller_get_current_group
(<em class="parameter"><code><a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a> *controller</code></em>);</pre>
<p>Selects the previous group in the group list.</p>
<div class="refsect3">
<a name="xapp-kbd-layout-controller-get-current-group.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>controller</p></td>
<td class="parameter_description"><p>the <a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="xapp-kbd-layout-controller-set-current-group"></a><h3>xapp_kbd_layout_controller_set_current_group ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
xapp_kbd_layout_controller_set_current_group
(<em class="parameter"><code><a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a> *controller</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> group</code></em>);</pre>
<p>Selects the given group number as active.</p>
<div class="refsect3">
<a name="xapp-kbd-layout-controller-set-current-group.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>controller</p></td>
<td class="parameter_description"><p>the <a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>group</p></td>
<td class="parameter_description"><p>the group number to make active</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="xapp-kbd-layout-controller-next-group"></a><h3>xapp_kbd_layout_controller_next_group ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
xapp_kbd_layout_controller_next_group (<em class="parameter"><code><a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a> *controller</code></em>);</pre>
<p>Selects the next group in the group list.</p>
<div class="refsect3">
<a name="xapp-kbd-layout-controller-next-group.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>controller</p></td>
<td class="parameter_description"><p>the <a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="xapp-kbd-layout-controller-previous-group"></a><h3>xapp_kbd_layout_controller_previous_group ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
xapp_kbd_layout_controller_previous_group
(<em class="parameter"><code><a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a> *controller</code></em>);</pre>
<p>Selects the previous group in the group list.</p>
<div class="refsect3">
<a name="xapp-kbd-layout-controller-previous-group.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>controller</p></td>
<td class="parameter_description"><p>the <a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="xapp-kbd-layout-controller-get-current-name"></a><h3>xapp_kbd_layout_controller_get_current_name ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
xapp_kbd_layout_controller_get_current_name
(<em class="parameter"><code><a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a> *controller</code></em>);</pre>
<p>Returns the full name of the current keyboard layout.</p>
<div class="refsect3">
<a name="xapp-kbd-layout-controller-get-current-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>controller</p></td>
<td class="parameter_description"><p>the <a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="xapp-kbd-layout-controller-get-current-name.returns"></a><h4>Returns</h4>
<p>the newly created string or NULL
if something went wrong. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="xapp-kbd-layout-controller-get-all-names"></a><h3>xapp_kbd_layout_controller_get_all_names ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> **
xapp_kbd_layout_controller_get_all_names
(<em class="parameter"><code><a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a> *controller</code></em>);</pre>
<p>Returns an array of all full layout names</p>
<div class="refsect3">
<a name="xapp-kbd-layout-controller-get-all-names.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>controller</p></td>
<td class="parameter_description"><p>the <a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="xapp-kbd-layout-controller-get-all-names.returns"></a><h4>Returns</h4>
<p>array of names. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> zero-terminated=1]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="xapp-kbd-layout-controller-get-current-icon-name"></a><h3>xapp_kbd_layout_controller_get_current_icon_name ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
xapp_kbd_layout_controller_get_current_icon_name
(<em class="parameter"><code><a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a> *controller</code></em>);</pre>
<p>Returns the icon file name (no path or extension) to use for the current layout</p>
<div class="refsect3">
<a name="xapp-kbd-layout-controller-get-current-icon-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>controller</p></td>
<td class="parameter_description"><p>the <a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="xapp-kbd-layout-controller-get-current-icon-name.returns"></a><h4>Returns</h4>
<p>a new string with the icon name. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="xapp-kbd-layout-controller-get-icon-name-for-group"></a><h3>xapp_kbd_layout_controller_get_icon_name_for_group ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
xapp_kbd_layout_controller_get_icon_name_for_group
(<em class="parameter"><code><a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a> *controller</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> group</code></em>);</pre>
<p>Returns the icon file name (no path or extension) to use for the specified layout.</p>
<div class="refsect3">
<a name="xapp-kbd-layout-controller-get-icon-name-for-group.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>controller</p></td>
<td class="parameter_description"><p>the <a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>group</p></td>
<td class="parameter_description"><p>a group number</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="xapp-kbd-layout-controller-get-icon-name-for-group.returns"></a><h4>Returns</h4>
<p>a new string with the icon name. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="xapp-kbd-layout-controller-get-current-flag-id"></a><h3>xapp_kbd_layout_controller_get_current_flag_id ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
xapp_kbd_layout_controller_get_current_flag_id
(<em class="parameter"><code><a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a> *controller</code></em>);</pre>
<p>Returns the duplicate id for the current layout</p>
<div class="refsect3">
<a name="xapp-kbd-layout-controller-get-current-flag-id.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>controller</p></td>
<td class="parameter_description"><p>the <a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="xapp-kbd-layout-controller-get-current-flag-id.returns"></a><h4>Returns</h4>
<p> the id</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="xapp-kbd-layout-controller-get-flag-id-for-group"></a><h3>xapp_kbd_layout_controller_get_flag_id_for_group ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
xapp_kbd_layout_controller_get_flag_id_for_group
(<em class="parameter"><code><a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a> *controller</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> group</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="xapp-kbd-layout-controller-get-current-short-group-label"></a><h3>xapp_kbd_layout_controller_get_current_short_group_label ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
xapp_kbd_layout_controller_get_current_short_group_label
(<em class="parameter"><code><a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a> *controller</code></em>);</pre>
<p>Returns the short group label (and subscript, if any) of the current layout</p>
<div class="refsect3">
<a name="xapp-kbd-layout-controller-get-current-short-group-label.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>controller</p></td>
<td class="parameter_description"><p>the <a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="xapp-kbd-layout-controller-get-current-short-group-label.returns"></a><h4>Returns</h4>
<p>a new string or NULL. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="xapp-kbd-layout-controller-get-short-group-label-for-group"></a><h3>xapp_kbd_layout_controller_get_short_group_label_for_group ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
xapp_kbd_layout_controller_get_short_group_label_for_group
(<em class="parameter"><code><a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a> *controller</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> group</code></em>);</pre>
<p>Returns the short group label and subscript of the specified layout.</p>
<div class="refsect3">
<a name="xapp-kbd-layout-controller-get-short-group-label-for-group.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>controller</p></td>
<td class="parameter_description"><p>the <a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>group</p></td>
<td class="parameter_description"><p>a group number</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="xapp-kbd-layout-controller-get-short-group-label-for-group.returns"></a><h4>Returns</h4>
<p>a new string or NULL. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="xapp-kbd-layout-controller-get-current-variant-label"></a><h3>xapp_kbd_layout_controller_get_current_variant_label ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
xapp_kbd_layout_controller_get_current_variant_label
(<em class="parameter"><code><a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a> *controller</code></em>);</pre>
<p>Returns the variant label (and subscript, if any) of the current layout</p>
<div class="refsect3">
<a name="xapp-kbd-layout-controller-get-current-variant-label.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>controller</p></td>
<td class="parameter_description"><p>the <a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="xapp-kbd-layout-controller-get-current-variant-label.returns"></a><h4>Returns</h4>
<p>a new string or NULL. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="xapp-kbd-layout-controller-get-variant-label-for-group"></a><h3>xapp_kbd_layout_controller_get_variant_label_for_group ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
xapp_kbd_layout_controller_get_variant_label_for_group
(<em class="parameter"><code><a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a> *controller</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> group</code></em>);</pre>
<p>Returns the variant label and subscript of the specified layout.</p>
<div class="refsect3">
<a name="xapp-kbd-layout-controller-get-variant-label-for-group.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>controller</p></td>
<td class="parameter_description"><p>the <a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>group</p></td>
<td class="parameter_description"><p>a group number</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="xapp-kbd-layout-controller-get-variant-label-for-group.returns"></a><h4>Returns</h4>
<p>a new string or NULL. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="xapp-kbd-layout-controller-render-cairo-subscript"></a><h3>xapp_kbd_layout_controller_render_cairo_subscript ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
xapp_kbd_layout_controller_render_cairo_subscript
(<em class="parameter"><code><span class="type">cairo_t</span> *cr</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> x</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> y</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> width</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> height</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> subscript</code></em>);</pre>
<p>Renders a subscript number in the given work area. This should
be called from within a "draw" or "paint" widget/actor function,
where a valid cairo_t is provided to draw with.</p>
<div class="refsect3">
<a name="xapp-kbd-layout-controller-render-cairo-subscript.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>cr</p></td>
<td class="parameter_description"><p>a <span class="type">cairo_t</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>x</p></td>
<td class="parameter_description"><p>the x position of the drawing area</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>y</p></td>
<td class="parameter_description"><p>the y position of the drawing area</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>width</p></td>
<td class="parameter_description"><p>the width of the drawing area</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>height</p></td>
<td class="parameter_description"><p>the height of the drawing area</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>subscript</p></td>
<td class="parameter_description"><p>the number to render</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="XAppKbdLayoutController.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="XAppKbdLayoutController--enabled"></a><h3>The <code class="literal">“enabled”</code> property</h3>
<pre class="programlisting"> “enabled” <a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
<p>Whether we're enabled (more than one keyboard layout is installed).</p>
<p>Owner: XAppKbdLayoutController</p>
<p>Flags: Read</p>
<p>Default value: FALSE</p>
</div>
</div>
<div class="refsect1">
<a name="XAppKbdLayoutController.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="XAppKbdLayoutController-config-changed"></a><h3>The <code class="literal">“config-changed”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a> *xappkbdlayoutcontroller,
<a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>Flags: <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
</div>
<hr>
<div class="refsect2">
<a name="XAppKbdLayoutController-layout-changed"></a><h3>The <code class="literal">“layout-changed”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="XAppKbdLayoutController.html" title="XAppKbdLayoutController"><span class="type">XAppKbdLayoutController</span></a> *xappkbdlayoutcontroller,
<a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> arg1,
<a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>Flags: <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.32</div>
</body>
</html>
