~ubuntu-branches/ubuntu/quantal/ibus/quantal

« back to all changes in this revision

Viewing changes to docs/reference/ibus/html/IBusEngineDesc.html

  • Committer: Bazaar Package Importer
  • Author(s): Barry Warsaw
  • Date: 2011-08-11 17:00:57 UTC
  • mfrom: (6.2.14 sid)
  • Revision ID: james.westby@ubuntu.com-20110811170057-6dmbfs4s3cchzl7x
Tags: 1.3.99.20110419-1ubuntu1
* Merge with Debian unstable.  Remaining Ubuntu changes:
  - Indicator support:
    + Add 05_appindicator.patch: Use an indicator rather than a notification
      icon.
    + debian/control: Recommend python-appindicator.
  - debian/control: Install im-switch instead of im-config by default.
  - debian/README.source: Removed, it was outdated and no longer correct
  - debian/patches/01_ubuntu_desktop: Fix "Desktop entry needs the
    X-Ubuntu-Gettext-Domain key"  (LP: #457632)
  - debian/patches/02_title_update.patch: Rename "IBus Preferences" to
    "Keyboard Input Methods"
  - debian/patches/06_locale_parser.patch: Cherry-picked from upstream.

Show diffs side-by-side

added added

removed removed

Lines of Context:
26
26
                  <a href="#IBusEngineDesc.description" class="shortcut">Description</a>
27
27
                   | 
28
28
                  <a href="#IBusEngineDesc.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
29
                   | 
 
30
                  <a href="#IBusEngineDesc.properties" class="shortcut">Properties</a>
29
31
</td></tr>
30
32
</table>
31
33
<div class="refentry" title="IBusEngineDesc">
45
47
<a name="IBusEngineDesc.synopsis"></a><h2>Synopsis</h2>
46
48
<pre class="synopsis">                    <a class="link" href="IBusEngineDesc.html#IBusEngineDesc-struct" title="IBusEngineDesc">IBusEngineDesc</a>;
47
49
                    <a class="link" href="IBusEngineDesc.html#IBusEngineDescClass" title="IBusEngineDescClass">IBusEngineDescClass</a>;
48
 
                    <a class="link" href="IBusEngineDesc.html#BusComponent" title="BusComponent">BusComponent</a>;
49
50
<a class="link" href="IBusEngineDesc.html" title="IBusEngineDesc"><span class="returnvalue">IBusEngineDesc</span></a> *    <a class="link" href="IBusEngineDesc.html#ibus-engine-desc-new" title="ibus_engine_desc_new ()">ibus_engine_desc_new</a>                (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>,
50
51
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *longname</code></em>,
51
52
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *description</code></em>,
54
55
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *author</code></em>,
55
56
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *icon</code></em>,
56
57
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *layout</code></em>);
 
58
<a class="link" href="IBusEngineDesc.html" title="IBusEngineDesc"><span class="returnvalue">IBusEngineDesc</span></a> *    <a class="link" href="IBusEngineDesc.html#ibus-engine-desc-new-varargs" title="ibus_engine_desc_new_varargs ()">ibus_engine_desc_new_varargs</a>        (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *first_property_name</code></em>,
 
59
                                                         <em class="parameter"><code>...</code></em>);
57
60
<a class="link" href="IBusEngineDesc.html" title="IBusEngineDesc"><span class="returnvalue">IBusEngineDesc</span></a> *    <a class="link" href="IBusEngineDesc.html#ibus-engine-desc-new-from-xml-node" title="ibus_engine_desc_new_from_xml_node ()">ibus_engine_desc_new_from_xml_node</a>  (<em class="parameter"><code><a class="link" href="ibus-ibusxml.html#XMLNode" title="XMLNode"><span class="type">XMLNode</span></a> *node</code></em>);
 
61
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="IBusEngineDesc.html#ibus-engine-desc-get-name" title="ibus_engine_desc_get_name ()">ibus_engine_desc_get_name</a>           (<em class="parameter"><code><a class="link" href="IBusEngineDesc.html" title="IBusEngineDesc"><span class="type">IBusEngineDesc</span></a> *info</code></em>);
 
62
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="IBusEngineDesc.html#ibus-engine-desc-get-longname" title="ibus_engine_desc_get_longname ()">ibus_engine_desc_get_longname</a>       (<em class="parameter"><code><a class="link" href="IBusEngineDesc.html" title="IBusEngineDesc"><span class="type">IBusEngineDesc</span></a> *info</code></em>);
 
63
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="IBusEngineDesc.html#ibus-engine-desc-get-description" title="ibus_engine_desc_get_description ()">ibus_engine_desc_get_description</a>    (<em class="parameter"><code><a class="link" href="IBusEngineDesc.html" title="IBusEngineDesc"><span class="type">IBusEngineDesc</span></a> *info</code></em>);
 
64
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="IBusEngineDesc.html#ibus-engine-desc-get-language" title="ibus_engine_desc_get_language ()">ibus_engine_desc_get_language</a>       (<em class="parameter"><code><a class="link" href="IBusEngineDesc.html" title="IBusEngineDesc"><span class="type">IBusEngineDesc</span></a> *info</code></em>);
 
65
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="IBusEngineDesc.html#ibus-engine-desc-get-license" title="ibus_engine_desc_get_license ()">ibus_engine_desc_get_license</a>        (<em class="parameter"><code><a class="link" href="IBusEngineDesc.html" title="IBusEngineDesc"><span class="type">IBusEngineDesc</span></a> *info</code></em>);
 
66
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="IBusEngineDesc.html#ibus-engine-desc-get-author" title="ibus_engine_desc_get_author ()">ibus_engine_desc_get_author</a>         (<em class="parameter"><code><a class="link" href="IBusEngineDesc.html" title="IBusEngineDesc"><span class="type">IBusEngineDesc</span></a> *info</code></em>);
 
67
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="IBusEngineDesc.html#ibus-engine-desc-get-icon" title="ibus_engine_desc_get_icon ()">ibus_engine_desc_get_icon</a>           (<em class="parameter"><code><a class="link" href="IBusEngineDesc.html" title="IBusEngineDesc"><span class="type">IBusEngineDesc</span></a> *info</code></em>);
 
68
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="IBusEngineDesc.html#ibus-engine-desc-get-layout" title="ibus_engine_desc_get_layout ()">ibus_engine_desc_get_layout</a>         (<em class="parameter"><code><a class="link" href="IBusEngineDesc.html" title="IBusEngineDesc"><span class="type">IBusEngineDesc</span></a> *info</code></em>);
 
69
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="IBusEngineDesc.html#ibus-engine-desc-get-rank" title="ibus_engine_desc_get_rank ()">ibus_engine_desc_get_rank</a>           (<em class="parameter"><code><a class="link" href="IBusEngineDesc.html" title="IBusEngineDesc"><span class="type">IBusEngineDesc</span></a> *info</code></em>);
 
70
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="IBusEngineDesc.html#ibus-engine-desc-get-hotkeys" title="ibus_engine_desc_get_hotkeys ()">ibus_engine_desc_get_hotkeys</a>        (<em class="parameter"><code><a class="link" href="IBusEngineDesc.html" title="IBusEngineDesc"><span class="type">IBusEngineDesc</span></a> *info</code></em>);
58
71
<span class="returnvalue">void</span>                <a class="link" href="IBusEngineDesc.html#ibus-engine-desc-output" title="ibus_engine_desc_output ()">ibus_engine_desc_output</a>             (<em class="parameter"><code><a class="link" href="IBusEngineDesc.html" title="IBusEngineDesc"><span class="type">IBusEngineDesc</span></a> *info</code></em>,
59
72
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Strings.html#GString"><span class="type">GString</span></a> *output</code></em>,
60
73
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> indent</code></em>);
70
83
                     +----IBusEngineDesc
71
84
</pre>
72
85
</div>
 
86
<div class="refsect1" title="Properties">
 
87
<a name="IBusEngineDesc.properties"></a><h2>Properties</h2>
 
88
<pre class="synopsis">
 
89
  "<a class="link" href="IBusEngineDesc.html#IBusEngineDesc--author" title='The "author" property'>author</a>"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only
 
90
  "<a class="link" href="IBusEngineDesc.html#IBusEngineDesc--description" title='The "description" property'>description</a>"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only
 
91
  "<a class="link" href="IBusEngineDesc.html#IBusEngineDesc--hotkeys" title='The "hotkeys" property'>hotkeys</a>"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only
 
92
  "<a class="link" href="IBusEngineDesc.html#IBusEngineDesc--icon" title='The "icon" property'>icon</a>"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only
 
93
  "<a class="link" href="IBusEngineDesc.html#IBusEngineDesc--language" title='The "language" property'>language</a>"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only
 
94
  "<a class="link" href="IBusEngineDesc.html#IBusEngineDesc--layout" title='The "layout" property'>layout</a>"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only
 
95
  "<a class="link" href="IBusEngineDesc.html#IBusEngineDesc--license" title='The "license" property'>license</a>"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only
 
96
  "<a class="link" href="IBusEngineDesc.html#IBusEngineDesc--longname" title='The "longname" property'>longname</a>"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only
 
97
  "<a class="link" href="IBusEngineDesc.html#IBusEngineDesc--name" title='The "name" property'>name</a>"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only
 
98
  "<a class="link" href="IBusEngineDesc.html#IBusEngineDesc--rank" title='The "rank" property'>rank</a>"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write / Construct Only
 
99
</pre>
 
100
</div>
73
101
<div class="refsect1" title="Description">
74
102
<a name="IBusEngineDesc.description"></a><h2>Description</h2>
75
103
<p>
91
119
<a name="IBusEngineDesc.details"></a><h2>Details</h2>
92
120
<div class="refsect2" title="IBusEngineDesc">
93
121
<a name="IBusEngineDesc-struct"></a><h3>IBusEngineDesc</h3>
94
 
<pre class="programlisting">typedef struct {
95
 
    gchar *name;
96
 
    gchar *longname;
97
 
    gchar *description;
98
 
    gchar *language;
99
 
    gchar *license;
100
 
    gchar *author;
101
 
    gchar *icon;
102
 
    gchar *layout;
103
 
    gchar *hotkeys;
104
 
    guint  rank;
105
 
} IBusEngineDesc;
106
 
</pre>
 
122
<pre class="programlisting">typedef struct _IBusEngineDesc IBusEngineDesc;</pre>
107
123
<p>
108
124
Input method engine description data.
109
 
</p>
110
 
<div class="variablelist"><table border="0">
111
 
<col align="left" valign="top">
112
 
<tbody>
113
 
<tr>
114
 
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="IBusEngineDesc-struct.name"></a>name</code></em>;</span></p></td>
115
 
<td>Name of the engine.
116
 
</td>
117
 
</tr>
118
 
<tr>
119
 
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="IBusEngineDesc-struct.longname"></a>longname</code></em>;</span></p></td>
120
 
<td>Long name of the input method engine.
121
 
</td>
122
 
</tr>
123
 
<tr>
124
 
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="IBusEngineDesc-struct.description"></a>description</code></em>;</span></p></td>
125
 
<td>Input method engine description.
126
 
</td>
127
 
</tr>
128
 
<tr>
129
 
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="IBusEngineDesc-struct.language"></a>language</code></em>;</span></p></td>
130
 
<td>Language (e.g. zh, jp) supported by this input method engine.
131
 
</td>
132
 
</tr>
133
 
<tr>
134
 
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="IBusEngineDesc-struct.license"></a>license</code></em>;</span></p></td>
135
 
<td>License of the input method engine.
136
 
</td>
137
 
</tr>
138
 
<tr>
139
 
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="IBusEngineDesc-struct.author"></a>author</code></em>;</span></p></td>
140
 
<td>Author of the input method engine.
141
 
</td>
142
 
</tr>
143
 
<tr>
144
 
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="IBusEngineDesc-struct.icon"></a>icon</code></em>;</span></p></td>
145
 
<td>Icon file of this engine.
146
 
</td>
147
 
</tr>
148
 
<tr>
149
 
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="IBusEngineDesc-struct.layout"></a>layout</code></em>;</span></p></td>
150
 
<td>Keyboard layout
151
 
</td>
152
 
</tr>
153
 
<tr>
154
 
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="IBusEngineDesc-struct.hotkeys"></a>hotkeys</code></em>;</span></p></td>
155
 
<td>One or more hotkeys for switching to this engine, separated by
 
125
You can get extended values with g_object_get_properties.
 
126
name: Name of the engine.
 
127
longname: Long name of the input method engine.
 
128
description: Input method engine description.
 
129
language: Language (e.g. zh, jp) supported by this input method engine.
 
130
license: License of the input method engine.
 
131
author: Author of the input method engine.
 
132
icon: Icon file of this engine.
 
133
layout: Keyboard layout
 
134
rank: Preference rank among engines, the highest ranked IME will put in
 
135
the front.
 
136
hotkeys: One or more hotkeys for switching to this engine, separated by
156
137
 semi-colon.
157
 
</td>
158
 
</tr>
159
 
<tr>
160
 
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> <em class="structfield"><code><a name="IBusEngineDesc-struct.rank"></a>rank</code></em>;</span></p></td>
161
 
<td>Preference rank among engines, the highest ranked IME will put in
162
 
the front.
163
 
</td>
164
 
</tr>
165
 
</tbody>
166
 
</table></div>
 
138
</p>
167
139
</div>
168
140
<hr>
169
141
<div class="refsect2" title="IBusEngineDescClass">
177
149
</p>
178
150
</div>
179
151
<hr>
180
 
<div class="refsect2" title="BusComponent">
181
 
<a name="BusComponent"></a><h3>BusComponent</h3>
182
 
<pre class="programlisting">typedef struct _BusComponent BusComponent;</pre>
183
 
<p>
184
 
</p>
185
 
</div>
186
 
<hr>
187
152
<div class="refsect2" title="ibus_engine_desc_new ()">
188
153
<a name="ibus-engine-desc-new"></a><h3>ibus_engine_desc_new ()</h3>
189
154
<pre class="programlisting"><a class="link" href="IBusEngineDesc.html" title="IBusEngineDesc"><span class="returnvalue">IBusEngineDesc</span></a> *    ibus_engine_desc_new                (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>,
249
214
</table></div>
250
215
</div>
251
216
<hr>
 
217
<div class="refsect2" title="ibus_engine_desc_new_varargs ()">
 
218
<a name="ibus-engine-desc-new-varargs"></a><h3>ibus_engine_desc_new_varargs ()</h3>
 
219
<pre class="programlisting"><a class="link" href="IBusEngineDesc.html" title="IBusEngineDesc"><span class="returnvalue">IBusEngineDesc</span></a> *    ibus_engine_desc_new_varargs        (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *first_property_name</code></em>,
 
220
                                                         <em class="parameter"><code>...</code></em>);</pre>
 
221
<p>
 
222
New a IBusEngineDesc.
 
223
<a class="link" href="IBusEngineDesc.html#ibus-engine-desc-new-varargs" title="ibus_engine_desc_new_varargs ()"><code class="function">ibus_engine_desc_new_varargs()</code></a> supports the va_list format.
 
224
name property is required. e.g.
 
225
ibus_engine_desc_new_varargs("name", "ibus-foo", "language", "us", NULL)
 
226
</p>
 
227
<div class="variablelist"><table border="0">
 
228
<col align="left" valign="top">
 
229
<tbody>
 
230
<tr>
 
231
<td><p><span class="term"><em class="parameter"><code>first_property_name</code></em> :</span></p></td>
 
232
<td>Name of the first property.
 
233
</td>
 
234
</tr>
 
235
<tr>
 
236
<td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
 
237
<td>the NULL-terminated arguments of the properties and values.
 
238
</td>
 
239
</tr>
 
240
<tr>
 
241
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
242
<td>
 
243
</td>
 
244
</tr>
 
245
</tbody>
 
246
</table></div>
 
247
</div>
 
248
<hr>
252
249
<div class="refsect2" title="ibus_engine_desc_new_from_xml_node ()">
253
250
<a name="ibus-engine-desc-new-from-xml-node"></a><h3>ibus_engine_desc_new_from_xml_node ()</h3>
254
251
<pre class="programlisting"><a class="link" href="IBusEngineDesc.html" title="IBusEngineDesc"><span class="returnvalue">IBusEngineDesc</span></a> *    ibus_engine_desc_new_from_xml_node  (<em class="parameter"><code><a class="link" href="ibus-ibusxml.html#XMLNode" title="XMLNode"><span class="type">XMLNode</span></a> *node</code></em>);</pre>
255
252
<p>
256
253
New a IBusEngineDesc from an XML node.
257
 
</p>
258
 
<div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
259
 
<h3 class="title">Note</h3>
260
 
<p>This function is called by <a class="link" href="IBusComponent.html#ibus-component-new-from-file" title="ibus_component_new_from_file ()"><code class="function">ibus_component_new_from_file()</code></a>,
 
254
&lt;note&gt;&lt;para&gt;This function is called by <a class="link" href="IBusComponent.html#ibus-component-new-from-file" title="ibus_component_new_from_file ()"><code class="function">ibus_component_new_from_file()</code></a>,
261
255
 so developers normally do not need to call it directly.
262
 
</p>
263
 
</div>
264
 
<p>
 
256
&lt;/para&gt;&lt;/note&gt;
265
257
</p>
266
258
<div class="variablelist"><table border="0">
267
259
<col align="left" valign="top">
281
273
</table></div>
282
274
</div>
283
275
<hr>
 
276
<div class="refsect2" title="ibus_engine_desc_get_name ()">
 
277
<a name="ibus-engine-desc-get-name"></a><h3>ibus_engine_desc_get_name ()</h3>
 
278
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       ibus_engine_desc_get_name           (<em class="parameter"><code><a class="link" href="IBusEngineDesc.html" title="IBusEngineDesc"><span class="type">IBusEngineDesc</span></a> *info</code></em>);</pre>
 
279
<p>
 
280
Return the name property in IBusEngineDesc. It should not be freed.
 
281
</p>
 
282
<div class="variablelist"><table border="0">
 
283
<col align="left" valign="top">
 
284
<tbody>
 
285
<tr>
 
286
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
 
287
<td>An IBusEngineDesc
 
288
</td>
 
289
</tr>
 
290
<tr>
 
291
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
292
<td>name property in IBusEngineDesc
 
293
</td>
 
294
</tr>
 
295
</tbody>
 
296
</table></div>
 
297
</div>
 
298
<hr>
 
299
<div class="refsect2" title="ibus_engine_desc_get_longname ()">
 
300
<a name="ibus-engine-desc-get-longname"></a><h3>ibus_engine_desc_get_longname ()</h3>
 
301
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       ibus_engine_desc_get_longname       (<em class="parameter"><code><a class="link" href="IBusEngineDesc.html" title="IBusEngineDesc"><span class="type">IBusEngineDesc</span></a> *info</code></em>);</pre>
 
302
<p>
 
303
Return the longname property in IBusEngineDesc. It should not be freed.
 
304
</p>
 
305
<div class="variablelist"><table border="0">
 
306
<col align="left" valign="top">
 
307
<tbody>
 
308
<tr>
 
309
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
 
310
<td>An IBusEngineDesc
 
311
</td>
 
312
</tr>
 
313
<tr>
 
314
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
315
<td>longname property in IBusEngineDesc
 
316
</td>
 
317
</tr>
 
318
</tbody>
 
319
</table></div>
 
320
</div>
 
321
<hr>
 
322
<div class="refsect2" title="ibus_engine_desc_get_description ()">
 
323
<a name="ibus-engine-desc-get-description"></a><h3>ibus_engine_desc_get_description ()</h3>
 
324
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       ibus_engine_desc_get_description    (<em class="parameter"><code><a class="link" href="IBusEngineDesc.html" title="IBusEngineDesc"><span class="type">IBusEngineDesc</span></a> *info</code></em>);</pre>
 
325
<p>
 
326
Return the description property in IBusEngineDesc. It should not be freed.
 
327
</p>
 
328
<div class="variablelist"><table border="0">
 
329
<col align="left" valign="top">
 
330
<tbody>
 
331
<tr>
 
332
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
 
333
<td>An IBusEngineDesc
 
334
</td>
 
335
</tr>
 
336
<tr>
 
337
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
338
<td>description property in IBusEngineDesc
 
339
</td>
 
340
</tr>
 
341
</tbody>
 
342
</table></div>
 
343
</div>
 
344
<hr>
 
345
<div class="refsect2" title="ibus_engine_desc_get_language ()">
 
346
<a name="ibus-engine-desc-get-language"></a><h3>ibus_engine_desc_get_language ()</h3>
 
347
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       ibus_engine_desc_get_language       (<em class="parameter"><code><a class="link" href="IBusEngineDesc.html" title="IBusEngineDesc"><span class="type">IBusEngineDesc</span></a> *info</code></em>);</pre>
 
348
<p>
 
349
Return the language property in IBusEngineDesc. It should not be freed.
 
350
</p>
 
351
<div class="variablelist"><table border="0">
 
352
<col align="left" valign="top">
 
353
<tbody>
 
354
<tr>
 
355
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
 
356
<td>An IBusEngineDesc
 
357
</td>
 
358
</tr>
 
359
<tr>
 
360
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
361
<td>language property in IBusEngineDesc
 
362
</td>
 
363
</tr>
 
364
</tbody>
 
365
</table></div>
 
366
</div>
 
367
<hr>
 
368
<div class="refsect2" title="ibus_engine_desc_get_license ()">
 
369
<a name="ibus-engine-desc-get-license"></a><h3>ibus_engine_desc_get_license ()</h3>
 
370
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       ibus_engine_desc_get_license        (<em class="parameter"><code><a class="link" href="IBusEngineDesc.html" title="IBusEngineDesc"><span class="type">IBusEngineDesc</span></a> *info</code></em>);</pre>
 
371
<p>
 
372
Return the license property in IBusEngineDesc. It should not be freed.
 
373
</p>
 
374
<div class="variablelist"><table border="0">
 
375
<col align="left" valign="top">
 
376
<tbody>
 
377
<tr>
 
378
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
 
379
<td>An IBusEngineDesc
 
380
</td>
 
381
</tr>
 
382
<tr>
 
383
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
384
<td>license property in IBusEngineDesc
 
385
</td>
 
386
</tr>
 
387
</tbody>
 
388
</table></div>
 
389
</div>
 
390
<hr>
 
391
<div class="refsect2" title="ibus_engine_desc_get_author ()">
 
392
<a name="ibus-engine-desc-get-author"></a><h3>ibus_engine_desc_get_author ()</h3>
 
393
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       ibus_engine_desc_get_author         (<em class="parameter"><code><a class="link" href="IBusEngineDesc.html" title="IBusEngineDesc"><span class="type">IBusEngineDesc</span></a> *info</code></em>);</pre>
 
394
<p>
 
395
Return the author property in IBusEngineDesc. It should not be freed.
 
396
</p>
 
397
<div class="variablelist"><table border="0">
 
398
<col align="left" valign="top">
 
399
<tbody>
 
400
<tr>
 
401
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
 
402
<td>An IBusEngineDesc
 
403
</td>
 
404
</tr>
 
405
<tr>
 
406
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
407
<td>author property in IBusEngineDesc
 
408
</td>
 
409
</tr>
 
410
</tbody>
 
411
</table></div>
 
412
</div>
 
413
<hr>
 
414
<div class="refsect2" title="ibus_engine_desc_get_icon ()">
 
415
<a name="ibus-engine-desc-get-icon"></a><h3>ibus_engine_desc_get_icon ()</h3>
 
416
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       ibus_engine_desc_get_icon           (<em class="parameter"><code><a class="link" href="IBusEngineDesc.html" title="IBusEngineDesc"><span class="type">IBusEngineDesc</span></a> *info</code></em>);</pre>
 
417
<p>
 
418
Return the icon property in IBusEngineDesc. It should not be freed.
 
419
</p>
 
420
<div class="variablelist"><table border="0">
 
421
<col align="left" valign="top">
 
422
<tbody>
 
423
<tr>
 
424
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
 
425
<td>An IBusEngineDesc
 
426
</td>
 
427
</tr>
 
428
<tr>
 
429
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
430
<td>icon property in IBusEngineDesc
 
431
</td>
 
432
</tr>
 
433
</tbody>
 
434
</table></div>
 
435
</div>
 
436
<hr>
 
437
<div class="refsect2" title="ibus_engine_desc_get_layout ()">
 
438
<a name="ibus-engine-desc-get-layout"></a><h3>ibus_engine_desc_get_layout ()</h3>
 
439
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       ibus_engine_desc_get_layout         (<em class="parameter"><code><a class="link" href="IBusEngineDesc.html" title="IBusEngineDesc"><span class="type">IBusEngineDesc</span></a> *info</code></em>);</pre>
 
440
<p>
 
441
Return the layout property in IBusEngineDesc. It should not be freed.
 
442
</p>
 
443
<div class="variablelist"><table border="0">
 
444
<col align="left" valign="top">
 
445
<tbody>
 
446
<tr>
 
447
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
 
448
<td>An IBusEngineDesc
 
449
</td>
 
450
</tr>
 
451
<tr>
 
452
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
453
<td>layout property in IBusEngineDesc
 
454
</td>
 
455
</tr>
 
456
</tbody>
 
457
</table></div>
 
458
</div>
 
459
<hr>
 
460
<div class="refsect2" title="ibus_engine_desc_get_rank ()">
 
461
<a name="ibus-engine-desc-get-rank"></a><h3>ibus_engine_desc_get_rank ()</h3>
 
462
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               ibus_engine_desc_get_rank           (<em class="parameter"><code><a class="link" href="IBusEngineDesc.html" title="IBusEngineDesc"><span class="type">IBusEngineDesc</span></a> *info</code></em>);</pre>
 
463
<p>
 
464
Return the rank property in IBusEngineDesc.
 
465
</p>
 
466
<div class="variablelist"><table border="0">
 
467
<col align="left" valign="top">
 
468
<tbody>
 
469
<tr>
 
470
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
 
471
<td>An IBusEngineDesc
 
472
</td>
 
473
</tr>
 
474
<tr>
 
475
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
476
<td>rank property in IBusEngineDesc
 
477
</td>
 
478
</tr>
 
479
</tbody>
 
480
</table></div>
 
481
</div>
 
482
<hr>
 
483
<div class="refsect2" title="ibus_engine_desc_get_hotkeys ()">
 
484
<a name="ibus-engine-desc-get-hotkeys"></a><h3>ibus_engine_desc_get_hotkeys ()</h3>
 
485
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       ibus_engine_desc_get_hotkeys        (<em class="parameter"><code><a class="link" href="IBusEngineDesc.html" title="IBusEngineDesc"><span class="type">IBusEngineDesc</span></a> *info</code></em>);</pre>
 
486
<p>
 
487
Return the hotkeys property in IBusEngineDesc. It should not be freed.
 
488
</p>
 
489
<div class="variablelist"><table border="0">
 
490
<col align="left" valign="top">
 
491
<tbody>
 
492
<tr>
 
493
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
 
494
<td>An IBusEngineDesc
 
495
</td>
 
496
</tr>
 
497
<tr>
 
498
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
499
<td>hotkeys property in IBusEngineDesc
 
500
</td>
 
501
</tr>
 
502
</tbody>
 
503
</table></div>
 
504
</div>
 
505
<hr>
284
506
<div class="refsect2" title="ibus_engine_desc_output ()">
285
507
<a name="ibus-engine-desc-output"></a><h3>ibus_engine_desc_output ()</h3>
286
508
<pre class="programlisting"><span class="returnvalue">void</span>                ibus_engine_desc_output             (<em class="parameter"><code><a class="link" href="IBusEngineDesc.html" title="IBusEngineDesc"><span class="type">IBusEngineDesc</span></a> *info</code></em>,
312
534
</table></div>
313
535
</div>
314
536
</div>
 
537
<div class="refsect1" title="Property Details">
 
538
<a name="IBusEngineDesc.property-details"></a><h2>Property Details</h2>
 
539
<div class="refsect2" title='The "author" property'>
 
540
<a name="IBusEngineDesc--author"></a><h3>The <code class="literal">"author"</code> property</h3>
 
541
<pre class="programlisting">  "author"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only</pre>
 
542
<p>
 
543
The author of engine description
 
544
</p>
 
545
<p>Default value: ""</p>
 
546
</div>
 
547
<hr>
 
548
<div class="refsect2" title='The "description" property'>
 
549
<a name="IBusEngineDesc--description"></a><h3>The <code class="literal">"description"</code> property</h3>
 
550
<pre class="programlisting">  "description"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only</pre>
 
551
<p>
 
552
The description of engine description
 
553
</p>
 
554
<p>Default value: ""</p>
 
555
</div>
 
556
<hr>
 
557
<div class="refsect2" title='The "hotkeys" property'>
 
558
<a name="IBusEngineDesc--hotkeys"></a><h3>The <code class="literal">"hotkeys"</code> property</h3>
 
559
<pre class="programlisting">  "hotkeys"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only</pre>
 
560
<p>
 
561
The hotkeys of engine description
 
562
</p>
 
563
<p>Default value: ""</p>
 
564
</div>
 
565
<hr>
 
566
<div class="refsect2" title='The "icon" property'>
 
567
<a name="IBusEngineDesc--icon"></a><h3>The <code class="literal">"icon"</code> property</h3>
 
568
<pre class="programlisting">  "icon"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only</pre>
 
569
<p>
 
570
The icon of engine description
 
571
</p>
 
572
<p>Default value: "ibus-engine"</p>
 
573
</div>
 
574
<hr>
 
575
<div class="refsect2" title='The "language" property'>
 
576
<a name="IBusEngineDesc--language"></a><h3>The <code class="literal">"language"</code> property</h3>
 
577
<pre class="programlisting">  "language"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only</pre>
 
578
<p>
 
579
The language of engine description
 
580
</p>
 
581
<p>Default value: ""</p>
 
582
</div>
 
583
<hr>
 
584
<div class="refsect2" title='The "layout" property'>
 
585
<a name="IBusEngineDesc--layout"></a><h3>The <code class="literal">"layout"</code> property</h3>
 
586
<pre class="programlisting">  "layout"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only</pre>
 
587
<p>
 
588
The layout of engine description
 
589
</p>
 
590
<p>Default value: "us"</p>
 
591
</div>
 
592
<hr>
 
593
<div class="refsect2" title='The "license" property'>
 
594
<a name="IBusEngineDesc--license"></a><h3>The <code class="literal">"license"</code> property</h3>
 
595
<pre class="programlisting">  "license"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only</pre>
 
596
<p>
 
597
The license of engine description
 
598
</p>
 
599
<p>Default value: ""</p>
 
600
</div>
 
601
<hr>
 
602
<div class="refsect2" title='The "longname" property'>
 
603
<a name="IBusEngineDesc--longname"></a><h3>The <code class="literal">"longname"</code> property</h3>
 
604
<pre class="programlisting">  "longname"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only</pre>
 
605
<p>
 
606
The longname of engine description
 
607
</p>
 
608
<p>Default value: ""</p>
 
609
</div>
 
610
<hr>
 
611
<div class="refsect2" title='The "name" property'>
 
612
<a name="IBusEngineDesc--name"></a><h3>The <code class="literal">"name"</code> property</h3>
 
613
<pre class="programlisting">  "name"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only</pre>
 
614
<p>
 
615
The name of engine description
 
616
</p>
 
617
<p>Default value: NULL</p>
 
618
</div>
 
619
<hr>
 
620
<div class="refsect2" title='The "rank" property'>
 
621
<a name="IBusEngineDesc--rank"></a><h3>The <code class="literal">"rank"</code> property</h3>
 
622
<pre class="programlisting">  "rank"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write / Construct Only</pre>
 
623
<p>
 
624
The rank of engine description
 
625
</p>
 
626
<p>Default value: 0</p>
 
627
</div>
 
628
</div>
315
629
</div>
316
630
<div class="footer">
317
631
<hr>