← Back to branch summary

~ubuntu-branches/ubuntu/precise/ibus/precise

« back to all changes in this revision

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

  • Committer: Package Import Robot
  • Author(s): Martin Pitt
  • Date: 2012-03-06 09:45:51 UTC
  • mfrom: (6.2.20 sid)
  • Revision ID: package-import@ubuntu.com-20120306094551-2oj8nro3h3uesu8a
Tags: 1.4.1-1ubuntu1
* Merge from Debian unstable, remaining changes:
  - debian/control: Install im-switch instead of im-config by default.
  - debian/rules: Build with dh_translations. Add dh-translations build
    dependency.
  - Add 02_title_update.patch: Rename "IBus Preferences" to "Keyboard Input
    Methods"
  - Add 05_appindicator.patch: Use an indicator rather than a notification
    icon. Add python-appindicator recommends.
  - debian/control: Recommends on ibus-gtk, ibus-qt4, ibus-clutter need to
    be alternatives, because we want derivatives to be able to pick the ones
    they need.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/ibus/html/IBusSerializable.html
8
8
<link rel="up" href="ch05.html" title="Communication">
9
9
<link rel="prev" href="IBusProxy.html" title="IBusProxy">
10
10
<link rel="next" href="IBusService.html" title="IBusService">
11
 
<meta name="generator" content="GTK-Doc V1.17 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
43
43
</div>
44
44
<div class="refsynopsisdiv">
45
45
<a name="IBusSerializable.synopsis"></a><h2>Synopsis</h2>
46
 
<pre class="synopsis">#define             <a class="link" href="IBusSerializable.html#ibus-serializable-set-attachment" title="ibus_serializable_set_attachment()">ibus_serializable_set_attachment</a>    (o,
47
 
                                                         k,
48
 
                                                         v)
49
 
#define             <a class="link" href="IBusSerializable.html#ibus-serializable-get-attachment" title="ibus_serializable_get_attachment()">ibus_serializable_get_attachment</a>    (o,
50
 
                                                         k)
51
 
#define             <a class="link" href="IBusSerializable.html#ibus-serializable-remove-attachment" title="ibus_serializable_remove_attachment()">ibus_serializable_remove_attachment</a> (o,
52
 
                                                         k)
53
 
struct              <a class="link" href="IBusSerializable.html#IBusSerializable-struct" title="struct IBusSerializable">IBusSerializable</a>;
 
46
<pre class="synopsis">struct              <a class="link" href="IBusSerializable.html#IBusSerializable-struct" title="struct IBusSerializable">IBusSerializable</a>;
 
47
struct              <a class="link" href="IBusSerializable.html#IBusSerializableClass" title="struct IBusSerializableClass">IBusSerializableClass</a>;
 
48
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            (<a class="link" href="IBusSerializable.html#IBusSerializableCopyFunc" title="IBusSerializableCopyFunc ()">*IBusSerializableCopyFunc</a>)         (<em class="parameter"><code><a class="link" href="IBusSerializable.html" title="IBusSerializable"><span class="type">IBusSerializable</span></a> *dest</code></em>,
 
49
                                                         <em class="parameter"><code>const <a class="link" href="IBusSerializable.html" title="IBusSerializable"><span class="type">IBusSerializable</span></a> *src</code></em>);
 
50
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                (<a class="link" href="IBusSerializable.html#IBusSerializableDeserializeFunc" title="IBusSerializableDeserializeFunc ()">*IBusSerializableDeserializeFunc</a>)  (<em class="parameter"><code><a class="link" href="IBusSerializable.html" title="IBusSerializable"><span class="type">IBusSerializable</span></a> *serializable</code></em>,
 
51
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *variant</code></em>);
54
52
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            (<a class="link" href="IBusSerializable.html#IBusSerializableSerializeFunc" title="IBusSerializableSerializeFunc ()">*IBusSerializableSerializeFunc</a>)    (<em class="parameter"><code><a class="link" href="IBusSerializable.html" title="IBusSerializable"><span class="type">IBusSerializable</span></a> *serializable</code></em>,
55
53
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariantBuilder"><span class="type">GVariantBuilder</span></a> *builder</code></em>);
56
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                (<a class="link" href="IBusSerializable.html#IBusSerializableDeserializeFunc" title="IBusSerializableDeserializeFunc ()">*IBusSerializableDeserializeFunc</a>)  (<em class="parameter"><code><a class="link" href="IBusSerializable.html" title="IBusSerializable"><span class="type">IBusSerializable</span></a> *serializable</code></em>,
57
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *variant</code></em>);
58
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            (<a class="link" href="IBusSerializable.html#IBusSerializableCopyFunc" title="IBusSerializableCopyFunc ()">*IBusSerializableCopyFunc</a>)         (<em class="parameter"><code><a class="link" href="IBusSerializable.html" title="IBusSerializable"><span class="type">IBusSerializable</span></a> *dest</code></em>,
59
 
                                                         <em class="parameter"><code>const <a class="link" href="IBusSerializable.html" title="IBusSerializable"><span class="type">IBusSerializable</span></a> *src</code></em>);
60
 
struct              <a class="link" href="IBusSerializable.html#IBusSerializableClass" title="struct IBusSerializableClass">IBusSerializableClass</a>;
 
54
<a class="link" href="IBusSerializable.html" title="IBusSerializable"><span class="returnvalue">IBusSerializable</span></a> *  <a class="link" href="IBusSerializable.html#ibus-serializable-copy" title="ibus_serializable_copy ()">ibus_serializable_copy</a>              (<em class="parameter"><code><a class="link" href="IBusSerializable.html" title="IBusSerializable"><span class="type">IBusSerializable</span></a> *serializable</code></em>);
 
55
<a class="link" href="IBusSerializable.html" title="IBusSerializable"><span class="returnvalue">IBusSerializable</span></a> *  <a class="link" href="IBusSerializable.html#ibus-serializable-deserialize" title="ibus_serializable_deserialize ()">ibus_serializable_deserialize</a>       (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *variant</code></em>);
 
56
#define             <a class="link" href="IBusSerializable.html#ibus-serializable-get-attachment" title="ibus_serializable_get_attachment()">ibus_serializable_get_attachment</a>    (o,
 
57
                                                         k)
 
58
<a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="returnvalue">GVariant</span></a> *          <a class="link" href="IBusSerializable.html#ibus-serializable-get-qattachment" title="ibus_serializable_get_qattachment ()">ibus_serializable_get_qattachment</a>   (<em class="parameter"><code><a class="link" href="IBusSerializable.html" title="IBusSerializable"><span class="type">IBusSerializable</span></a> *serializable</code></em>,
 
59
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> key</code></em>);
61
60
<a class="link" href="IBusSerializable.html" title="IBusSerializable"><span class="returnvalue">IBusSerializable</span></a> *  <a class="link" href="IBusSerializable.html#ibus-serializable-new" title="ibus_serializable_new ()">ibus_serializable_new</a>               (<em class="parameter"><code><span class="type">void</span></code></em>);
 
61
#define             <a class="link" href="IBusSerializable.html#ibus-serializable-remove-attachment" title="ibus_serializable_remove_attachment()">ibus_serializable_remove_attachment</a> (o,
 
62
                                                         k)
 
63
<span class="returnvalue">void</span>                <a class="link" href="IBusSerializable.html#ibus-serializable-remove-qattachment" title="ibus_serializable_remove_qattachment ()">ibus_serializable_remove_qattachment</a>
 
64
                                                        (<em class="parameter"><code><a class="link" href="IBusSerializable.html" title="IBusSerializable"><span class="type">IBusSerializable</span></a> *serializable</code></em>,
 
65
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> key</code></em>);
 
66
<a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="returnvalue">GVariant</span></a> *          <a class="link" href="IBusSerializable.html#ibus-serializable-serialize" title="ibus_serializable_serialize ()">ibus_serializable_serialize</a>         (<em class="parameter"><code><a class="link" href="IBusSerializable.html" title="IBusSerializable"><span class="type">IBusSerializable</span></a> *serializable</code></em>);
 
67
#define             <a class="link" href="IBusSerializable.html#ibus-serializable-set-attachment" title="ibus_serializable_set_attachment()">ibus_serializable_set_attachment</a>    (o,
 
68
                                                         k,
 
69
                                                         v)
62
70
<span class="returnvalue">void</span>                <a class="link" href="IBusSerializable.html#ibus-serializable-set-qattachment" title="ibus_serializable_set_qattachment ()">ibus_serializable_set_qattachment</a>   (<em class="parameter"><code><a class="link" href="IBusSerializable.html" title="IBusSerializable"><span class="type">IBusSerializable</span></a> *serializable</code></em>,
63
71
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> key</code></em>,
64
72
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *value</code></em>);
65
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="returnvalue">GVariant</span></a> *          <a class="link" href="IBusSerializable.html#ibus-serializable-get-qattachment" title="ibus_serializable_get_qattachment ()">ibus_serializable_get_qattachment</a>   (<em class="parameter"><code><a class="link" href="IBusSerializable.html" title="IBusSerializable"><span class="type">IBusSerializable</span></a> *serializable</code></em>,
66
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> key</code></em>);
67
 
<span class="returnvalue">void</span>                <a class="link" href="IBusSerializable.html#ibus-serializable-remove-qattachment" title="ibus_serializable_remove_qattachment ()">ibus_serializable_remove_qattachment</a>
68
 
                                                        (<em class="parameter"><code><a class="link" href="IBusSerializable.html" title="IBusSerializable"><span class="type">IBusSerializable</span></a> *serializable</code></em>,
69
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> key</code></em>);
70
 
<a class="link" href="IBusSerializable.html" title="IBusSerializable"><span class="returnvalue">IBusSerializable</span></a> *  <a class="link" href="IBusSerializable.html#ibus-serializable-copy" title="ibus_serializable_copy ()">ibus_serializable_copy</a>              (<em class="parameter"><code><a class="link" href="IBusSerializable.html" title="IBusSerializable"><span class="type">IBusSerializable</span></a> *serializable</code></em>);
71
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="returnvalue">GVariant</span></a> *          <a class="link" href="IBusSerializable.html#ibus-serializable-serialize" title="ibus_serializable_serialize ()">ibus_serializable_serialize</a>         (<em class="parameter"><code><a class="link" href="IBusSerializable.html" title="IBusSerializable"><span class="type">IBusSerializable</span></a> *serializable</code></em>);
72
 
<a class="link" href="IBusSerializable.html" title="IBusSerializable"><span class="returnvalue">IBusSerializable</span></a> *  <a class="link" href="IBusSerializable.html#ibus-serializable-deserialize" title="ibus_serializable_deserialize ()">ibus_serializable_deserialize</a>       (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *variant</code></em>);
73
73
</pre>
74
74
</div>
75
75
<div class="refsect1">
114
114
<div class="refsect1">
115
115
<a name="IBusSerializable.details"></a><h2>Details</h2>
116
116
<div class="refsect2">
117
 
<a name="ibus-serializable-set-attachment"></a><h3>ibus_serializable_set_attachment()</h3>
118
 
<pre class="programlisting">#define             ibus_serializable_set_attachment(o, k, v)</pre>
119
 
<p>
120
 
Attach a value to an IBusSerializable.
121
 
This macro is an convenient wrapper of <a class="link" href="IBusSerializable.html#ibus-serializable-set-qattachment" title="ibus_serializable_set_qattachment ()"><code class="function">ibus_serializable_set_qattachment()</code></a>.
122
 
</p>
123
 
<div class="variablelist"><table border="0">
124
 
<col align="left" valign="top">
125
 
<tbody>
126
 
<tr>
127
 
<td><p><span class="term"><em class="parameter"><code>o</code></em> :</span></p></td>
128
 
<td>An IBusSerializable.</td>
129
 
</tr>
130
 
<tr>
131
 
<td><p><span class="term"><em class="parameter"><code>k</code></em> :</span></p></td>
132
 
<td>String formatted key for indexing value.</td>
133
 
</tr>
134
 
<tr>
135
 
<td><p><span class="term"><em class="parameter"><code>v</code></em> :</span></p></td>
136
 
<td>Value to be attached. Should be also serializable.</td>
137
 
</tr>
138
 
</tbody>
139
 
</table></div>
140
 
</div>
141
 
<hr>
142
 
<div class="refsect2">
143
 
<a name="ibus-serializable-get-attachment"></a><h3>ibus_serializable_get_attachment()</h3>
144
 
<pre class="programlisting">#define             ibus_serializable_get_attachment(o, k)</pre>
145
 
<p>
146
 
Get a value from attachment of an IBusSerializable.
147
 
This macro is an convenient wrapper of <a class="link" href="IBusSerializable.html#ibus-serializable-get-qattachment" title="ibus_serializable_get_qattachment ()"><code class="function">ibus_serializable_get_qattachment()</code></a>.
148
 
</p>
149
 
<div class="variablelist"><table border="0">
150
 
<col align="left" valign="top">
151
 
<tbody>
152
 
<tr>
153
 
<td><p><span class="term"><em class="parameter"><code>o</code></em> :</span></p></td>
154
 
<td>An IBusSerializable.</td>
155
 
</tr>
156
 
<tr>
157
 
<td><p><span class="term"><em class="parameter"><code>k</code></em> :</span></p></td>
158
 
<td>String formatted key for indexing value.</td>
159
 
</tr>
160
 
</tbody>
161
 
</table></div>
162
 
</div>
163
 
<hr>
164
 
<div class="refsect2">
165
 
<a name="ibus-serializable-remove-attachment"></a><h3>ibus_serializable_remove_attachment()</h3>
166
 
<pre class="programlisting">#define             ibus_serializable_remove_attachment(o, k)</pre>
167
 
<p>
168
 
Remove a value from attachment of an IBusSerializable.
169
 
This macro is an convenient wrapper of <a class="link" href="IBusSerializable.html#ibus-serializable-remove-qattachment" title="ibus_serializable_remove_qattachment ()"><code class="function">ibus_serializable_remove_qattachment()</code></a>.
170
 
</p>
171
 
<div class="variablelist"><table border="0">
172
 
<col align="left" valign="top">
173
 
<tbody>
174
 
<tr>
175
 
<td><p><span class="term"><em class="parameter"><code>o</code></em> :</span></p></td>
176
 
<td>An IBusSerializable.</td>
177
 
</tr>
178
 
<tr>
179
 
<td><p><span class="term"><em class="parameter"><code>k</code></em> :</span></p></td>
180
 
<td>String formatted key for indexing value.</td>
181
 
</tr>
182
 
</tbody>
183
 
</table></div>
184
 
</div>
185
 
<hr>
186
 
<div class="refsect2">
187
117
<a name="IBusSerializable-struct"></a><h3>struct IBusSerializable</h3>
188
118
<pre class="programlisting">struct IBusSerializable;</pre>
189
119
<p>
193
123
</div>
194
124
<hr>
195
125
<div class="refsect2">
196
 
<a name="IBusSerializableSerializeFunc"></a><h3>IBusSerializableSerializeFunc ()</h3>
197
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            (*IBusSerializableSerializeFunc)    (<em class="parameter"><code><a class="link" href="IBusSerializable.html" title="IBusSerializable"><span class="type">IBusSerializable</span></a> *serializable</code></em>,
198
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariantBuilder"><span class="type">GVariantBuilder</span></a> *builder</code></em>);</pre>
199
 
<p>
200
 
Prototype of serialize function.
201
 
Serialize function convert an IBusSerializable to IBusMessageIter.
202
 
Returns a gboolean value which indicates whether the conversion is success.
203
 
Return <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if succeed.
204
 
</p>
205
 
<div class="variablelist"><table border="0">
206
 
<col align="left" valign="top">
207
 
<tbody>
208
 
<tr>
209
 
<td><p><span class="term"><em class="parameter"><code>serializable</code></em> :</span></p></td>
210
 
<td>An <a class="link" href="IBusSerializable.html" title="IBusSerializable"><span class="type">IBusSerializable</span></a>.</td>
211
 
</tr>
212
 
<tr>
213
 
<td><p><span class="term"><em class="parameter"><code>builder</code></em> :</span></p></td>
214
 
<td>A <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariantBuilder"><span class="type">GVariantBuilder</span></a>.</td>
215
 
</tr>
216
 
<tr>
217
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
218
 
<td>
219
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if succeed; <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</td>
220
 
</tr>
221
 
</tbody>
222
 
</table></div>
223
 
</div>
224
 
<hr>
225
 
<div class="refsect2">
226
 
<a name="IBusSerializableDeserializeFunc"></a><h3>IBusSerializableDeserializeFunc ()</h3>
227
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                (*IBusSerializableDeserializeFunc)  (<em class="parameter"><code><a class="link" href="IBusSerializable.html" title="IBusSerializable"><span class="type">IBusSerializable</span></a> *serializable</code></em>,
228
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *variant</code></em>);</pre>
229
 
<p>
230
 
Prototype of deserialize function.
231
 
Deserialize function convert an IBusMessageIter to IBusSerializable.
232
 
Returns an integer value which indicates how many values in
233
 
the variant(tuple) are consumed.
234
 
</p>
235
 
<div class="variablelist"><table border="0">
236
 
<col align="left" valign="top">
237
 
<tbody>
238
 
<tr>
239
 
<td><p><span class="term"><em class="parameter"><code>serializable</code></em> :</span></p></td>
240
 
<td>An <a class="link" href="IBusSerializable.html" title="IBusSerializable"><span class="type">IBusSerializable</span></a>.</td>
241
 
</tr>
242
 
<tr>
243
 
<td><p><span class="term"><em class="parameter"><code>variant</code></em> :</span></p></td>
244
 
<td>A <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> contains a tuple.</td>
245
 
</tr>
246
 
<tr>
247
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
248
 
<td>The number of values in the variant(tuple) are consumed.</td>
249
 
</tr>
250
 
</tbody>
251
 
</table></div>
 
126
<a name="IBusSerializableClass"></a><h3>struct IBusSerializableClass</h3>
 
127
<pre class="programlisting">struct IBusSerializableClass {
 
128
};
 
129
</pre>
 
130
<p>
 
131
</p>
252
132
</div>
253
133
<hr>
254
134
<div class="refsect2">
281
161
</div>
282
162
<hr>
283
163
<div class="refsect2">
284
 
<a name="IBusSerializableClass"></a><h3>struct IBusSerializableClass</h3>
285
 
<pre class="programlisting">struct IBusSerializableClass {
286
 
};
287
 
</pre>
288
 
<p>
289
 
</p>
 
164
<a name="IBusSerializableDeserializeFunc"></a><h3>IBusSerializableDeserializeFunc ()</h3>
 
165
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                (*IBusSerializableDeserializeFunc)  (<em class="parameter"><code><a class="link" href="IBusSerializable.html" title="IBusSerializable"><span class="type">IBusSerializable</span></a> *serializable</code></em>,
 
166
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *variant</code></em>);</pre>
 
167
<p>
 
168
Prototype of deserialize function.
 
169
Deserialize function convert an IBusMessageIter to IBusSerializable.
 
170
Returns an integer value which indicates how many values in
 
171
the variant(tuple) are consumed.
 
172
</p>
 
173
<div class="variablelist"><table border="0">
 
174
<col align="left" valign="top">
 
175
<tbody>
 
176
<tr>
 
177
<td><p><span class="term"><em class="parameter"><code>serializable</code></em> :</span></p></td>
 
178
<td>An <a class="link" href="IBusSerializable.html" title="IBusSerializable"><span class="type">IBusSerializable</span></a>.</td>
 
179
</tr>
 
180
<tr>
 
181
<td><p><span class="term"><em class="parameter"><code>variant</code></em> :</span></p></td>
 
182
<td>A <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> contains a tuple.</td>
 
183
</tr>
 
184
<tr>
 
185
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
186
<td>The number of values in the variant(tuple) are consumed.</td>
 
187
</tr>
 
188
</tbody>
 
189
</table></div>
 
190
</div>
 
191
<hr>
 
192
<div class="refsect2">
 
193
<a name="IBusSerializableSerializeFunc"></a><h3>IBusSerializableSerializeFunc ()</h3>
 
194
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            (*IBusSerializableSerializeFunc)    (<em class="parameter"><code><a class="link" href="IBusSerializable.html" title="IBusSerializable"><span class="type">IBusSerializable</span></a> *serializable</code></em>,
 
195
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariantBuilder"><span class="type">GVariantBuilder</span></a> *builder</code></em>);</pre>
 
196
<p>
 
197
Prototype of serialize function.
 
198
Serialize function convert an IBusSerializable to IBusMessageIter.
 
199
Returns a gboolean value which indicates whether the conversion is success.
 
200
Return <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if succeed.
 
201
</p>
 
202
<div class="variablelist"><table border="0">
 
203
<col align="left" valign="top">
 
204
<tbody>
 
205
<tr>
 
206
<td><p><span class="term"><em class="parameter"><code>serializable</code></em> :</span></p></td>
 
207
<td>An <a class="link" href="IBusSerializable.html" title="IBusSerializable"><span class="type">IBusSerializable</span></a>.</td>
 
208
</tr>
 
209
<tr>
 
210
<td><p><span class="term"><em class="parameter"><code>builder</code></em> :</span></p></td>
 
211
<td>A <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariantBuilder"><span class="type">GVariantBuilder</span></a>.</td>
 
212
</tr>
 
213
<tr>
 
214
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
215
<td>
 
216
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if succeed; <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</td>
 
217
</tr>
 
218
</tbody>
 
219
</table></div>
 
220
</div>
 
221
<hr>
 
222
<div class="refsect2">
 
223
<a name="ibus-serializable-copy"></a><h3>ibus_serializable_copy ()</h3>
 
224
<pre class="programlisting"><a class="link" href="IBusSerializable.html" title="IBusSerializable"><span class="returnvalue">IBusSerializable</span></a> *  ibus_serializable_copy              (<em class="parameter"><code><a class="link" href="IBusSerializable.html" title="IBusSerializable"><span class="type">IBusSerializable</span></a> *serializable</code></em>);</pre>
 
225
<p>
 
226
Clone an <a class="link" href="IBusSerializable.html" title="IBusSerializable"><span class="type">IBusSerializable</span></a>.
 
227
The copy method should be implemented in extended class.
 
228
</p>
 
229
<p>
 
230
<em class="parameter"><code>see_also</code></em>: <a class="link" href="IBusSerializable.html#IBusSerializableCopyFunc" title="IBusSerializableCopyFunc ()"><code class="function">IBusSerializableCopyFunc()</code></a>.
 
231
</p>
 
232
<div class="variablelist"><table border="0">
 
233
<col align="left" valign="top">
 
234
<tbody>
 
235
<tr>
 
236
<td><p><span class="term"><em class="parameter"><code>serializable</code></em> :</span></p></td>
 
237
<td>An <a class="link" href="IBusSerializable.html" title="IBusSerializable"><span class="type">IBusSerializable</span></a>.</td>
 
238
</tr>
 
239
<tr>
 
240
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
241
<td>A newly allocated clone object; or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if <em class="parameter"><code>object</code></em> is not serializable.</td>
 
242
</tr>
 
243
</tbody>
 
244
</table></div>
 
245
</div>
 
246
<hr>
 
247
<div class="refsect2">
 
248
<a name="ibus-serializable-deserialize"></a><h3>ibus_serializable_deserialize ()</h3>
 
249
<pre class="programlisting"><a class="link" href="IBusSerializable.html" title="IBusSerializable"><span class="returnvalue">IBusSerializable</span></a> *  ibus_serializable_deserialize       (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *variant</code></em>);</pre>
 
250
<p>
 
251
Deserialize a <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> to an <a class="link" href="IBusSerializable.html" title="IBusSerializable"><span class="type">IBusSerializable</span></a>/
 
252
The deserialize method should be implemented in extended class.
 
253
</p>
 
254
<p>
 
255
<em class="parameter"><code>see_also</code></em>: <a class="link" href="IBusSerializable.html#IBusSerializableCopyFunc" title="IBusSerializableCopyFunc ()"><code class="function">IBusSerializableCopyFunc()</code></a>.
 
256
</p>
 
257
<div class="variablelist"><table border="0">
 
258
<col align="left" valign="top">
 
259
<tbody>
 
260
<tr>
 
261
<td><p><span class="term"><em class="parameter"><code>variant</code></em> :</span></p></td>
 
262
<td>A <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a>.</td>
 
263
</tr>
 
264
<tr>
 
265
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
266
<td>The deserialized <a class="link" href="IBusSerializable.html" title="IBusSerializable"><span class="type">IBusSerializable</span></a>.</td>
 
267
</tr>
 
268
</tbody>
 
269
</table></div>
 
270
</div>
 
271
<hr>
 
272
<div class="refsect2">
 
273
<a name="ibus-serializable-get-attachment"></a><h3>ibus_serializable_get_attachment()</h3>
 
274
<pre class="programlisting">#define             ibus_serializable_get_attachment(o, k)</pre>
 
275
<p>
 
276
Get a value from attachment of an IBusSerializable.
 
277
This macro is an convenient wrapper of <a class="link" href="IBusSerializable.html#ibus-serializable-get-qattachment" title="ibus_serializable_get_qattachment ()"><code class="function">ibus_serializable_get_qattachment()</code></a>.
 
278
</p>
 
279
<div class="variablelist"><table border="0">
 
280
<col align="left" valign="top">
 
281
<tbody>
 
282
<tr>
 
283
<td><p><span class="term"><em class="parameter"><code>o</code></em> :</span></p></td>
 
284
<td>An IBusSerializable.</td>
 
285
</tr>
 
286
<tr>
 
287
<td><p><span class="term"><em class="parameter"><code>k</code></em> :</span></p></td>
 
288
<td>String formatted key for indexing value.</td>
 
289
</tr>
 
290
</tbody>
 
291
</table></div>
 
292
</div>
 
293
<hr>
 
294
<div class="refsect2">
 
295
<a name="ibus-serializable-get-qattachment"></a><h3>ibus_serializable_get_qattachment ()</h3>
 
296
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="returnvalue">GVariant</span></a> *          ibus_serializable_get_qattachment   (<em class="parameter"><code><a class="link" href="IBusSerializable.html" title="IBusSerializable"><span class="type">IBusSerializable</span></a> *serializable</code></em>,
 
297
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> key</code></em>);</pre>
 
298
<p>
 
299
Get a value from attachment of an <a class="link" href="IBusSerializable.html" title="IBusSerializable"><span class="type">IBusSerializable</span></a>.
 
300
<em class="parameter"><code>see_also</code></em>: <a class="link" href="IBusSerializable.html#ibus-serializable-set-attachment" title="ibus_serializable_set_attachment()"><code class="function">ibus_serializable_set_attachment()</code></a>.
 
301
</p>
 
302
<div class="variablelist"><table border="0">
 
303
<col align="left" valign="top">
 
304
<tbody>
 
305
<tr>
 
306
<td><p><span class="term"><em class="parameter"><code>serializable</code></em> :</span></p></td>
 
307
<td>An <a class="link" href="IBusSerializable.html" title="IBusSerializable"><span class="type">IBusSerializable</span></a>.</td>
 
308
</tr>
 
309
<tr>
 
310
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
 
311
<td>String formatted key for indexing value.</td>
 
312
</tr>
 
313
<tr>
 
314
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
315
<td>The attached value; or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if fail to retrieve the value.</td>
 
316
</tr>
 
317
</tbody>
 
318
</table></div>
290
319
</div>
291
320
<hr>
292
321
<div class="refsect2">
305
334
</div>
306
335
<hr>
307
336
<div class="refsect2">
308
 
<a name="ibus-serializable-set-qattachment"></a><h3>ibus_serializable_set_qattachment ()</h3>
309
 
<pre class="programlisting"><span class="returnvalue">void</span>                ibus_serializable_set_qattachment   (<em class="parameter"><code><a class="link" href="IBusSerializable.html" title="IBusSerializable"><span class="type">IBusSerializable</span></a> *serializable</code></em>,
310
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> key</code></em>,
311
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *value</code></em>);</pre>
312
 
<p>
313
 
Attach a value to an IBusSerializable. If the value is floating,
314
 
the serializable will take the ownership.
315
 
</p>
316
 
<p>
317
 
<em class="parameter"><code>see_also</code></em>: <a class="link" href="IBusSerializable.html#ibus-serializable-set-attachment" title="ibus_serializable_set_attachment()"><code class="function">ibus_serializable_set_attachment()</code></a>.
318
 
</p>
319
 
<div class="variablelist"><table border="0">
320
 
<col align="left" valign="top">
321
 
<tbody>
322
 
<tr>
323
 
<td><p><span class="term"><em class="parameter"><code>serializable</code></em> :</span></p></td>
324
 
<td>An <a class="link" href="IBusSerializable.html" title="IBusSerializable"><span class="type">IBusSerializable</span></a>.</td>
325
 
</tr>
326
 
<tr>
327
 
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
328
 
<td>String formatted key for indexing value.</td>
329
 
</tr>
330
 
<tr>
331
 
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
332
 
<td>Value to be attached or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to remove any prevoius value.</td>
333
 
</tr>
334
 
</tbody>
335
 
</table></div>
336
 
</div>
337
 
<hr>
338
 
<div class="refsect2">
339
 
<a name="ibus-serializable-get-qattachment"></a><h3>ibus_serializable_get_qattachment ()</h3>
340
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="returnvalue">GVariant</span></a> *          ibus_serializable_get_qattachment   (<em class="parameter"><code><a class="link" href="IBusSerializable.html" title="IBusSerializable"><span class="type">IBusSerializable</span></a> *serializable</code></em>,
341
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> key</code></em>);</pre>
342
 
<p>
343
 
Get a value from attachment of an <a class="link" href="IBusSerializable.html" title="IBusSerializable"><span class="type">IBusSerializable</span></a>.
344
 
<em class="parameter"><code>see_also</code></em>: <a class="link" href="IBusSerializable.html#ibus-serializable-set-attachment" title="ibus_serializable_set_attachment()"><code class="function">ibus_serializable_set_attachment()</code></a>.
345
 
</p>
346
 
<div class="variablelist"><table border="0">
347
 
<col align="left" valign="top">
348
 
<tbody>
349
 
<tr>
350
 
<td><p><span class="term"><em class="parameter"><code>serializable</code></em> :</span></p></td>
351
 
<td>An <a class="link" href="IBusSerializable.html" title="IBusSerializable"><span class="type">IBusSerializable</span></a>.</td>
352
 
</tr>
353
 
<tr>
354
 
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
355
 
<td>String formatted key for indexing value.</td>
356
 
</tr>
357
 
<tr>
358
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
359
 
<td>The attached value; or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if fail to retrieve the value.</td>
 
337
<a name="ibus-serializable-remove-attachment"></a><h3>ibus_serializable_remove_attachment()</h3>
 
338
<pre class="programlisting">#define             ibus_serializable_remove_attachment(o, k)</pre>
 
339
<p>
 
340
Remove a value from attachment of an IBusSerializable.
 
341
This macro is an convenient wrapper of <a class="link" href="IBusSerializable.html#ibus-serializable-remove-qattachment" title="ibus_serializable_remove_qattachment ()"><code class="function">ibus_serializable_remove_qattachment()</code></a>.
 
342
</p>
 
343
<div class="variablelist"><table border="0">
 
344
<col align="left" valign="top">
 
345
<tbody>
 
346
<tr>
 
347
<td><p><span class="term"><em class="parameter"><code>o</code></em> :</span></p></td>
 
348
<td>An IBusSerializable.</td>
 
349
</tr>
 
350
<tr>
 
351
<td><p><span class="term"><em class="parameter"><code>k</code></em> :</span></p></td>
 
352
<td>String formatted key for indexing value.</td>
360
353
</tr>
361
354
</tbody>
362
355
</table></div>
387
380
</div>
388
381
<hr>
389
382
<div class="refsect2">
390
 
<a name="ibus-serializable-copy"></a><h3>ibus_serializable_copy ()</h3>
391
 
<pre class="programlisting"><a class="link" href="IBusSerializable.html" title="IBusSerializable"><span class="returnvalue">IBusSerializable</span></a> *  ibus_serializable_copy              (<em class="parameter"><code><a class="link" href="IBusSerializable.html" title="IBusSerializable"><span class="type">IBusSerializable</span></a> *serializable</code></em>);</pre>
392
 
<p>
393
 
Clone an <a class="link" href="IBusSerializable.html" title="IBusSerializable"><span class="type">IBusSerializable</span></a>.
394
 
The copy method should be implemented in extended class.
395
 
</p>
396
 
<p>
397
 
<em class="parameter"><code>see_also</code></em>: <a class="link" href="IBusSerializable.html#IBusSerializableCopyFunc" title="IBusSerializableCopyFunc ()"><code class="function">IBusSerializableCopyFunc()</code></a>.
398
 
</p>
399
 
<div class="variablelist"><table border="0">
400
 
<col align="left" valign="top">
401
 
<tbody>
402
 
<tr>
403
 
<td><p><span class="term"><em class="parameter"><code>serializable</code></em> :</span></p></td>
404
 
<td>An <a class="link" href="IBusSerializable.html" title="IBusSerializable"><span class="type">IBusSerializable</span></a>.</td>
405
 
</tr>
406
 
<tr>
407
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
408
 
<td>A newly allocated clone object; or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if <em class="parameter"><code>object</code></em> is not serializable.</td>
409
 
</tr>
410
 
</tbody>
411
 
</table></div>
412
 
</div>
413
 
<hr>
414
 
<div class="refsect2">
415
383
<a name="ibus-serializable-serialize"></a><h3>ibus_serializable_serialize ()</h3>
416
384
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="returnvalue">GVariant</span></a> *          ibus_serializable_serialize         (<em class="parameter"><code><a class="link" href="IBusSerializable.html" title="IBusSerializable"><span class="type">IBusSerializable</span></a> *serializable</code></em>);</pre>
417
385
<p>
437
405
</div>
438
406
<hr>
439
407
<div class="refsect2">
440
 
<a name="ibus-serializable-deserialize"></a><h3>ibus_serializable_deserialize ()</h3>
441
 
<pre class="programlisting"><a class="link" href="IBusSerializable.html" title="IBusSerializable"><span class="returnvalue">IBusSerializable</span></a> *  ibus_serializable_deserialize       (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *variant</code></em>);</pre>
442
 
<p>
443
 
Deserialize a <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> to an <a class="link" href="IBusSerializable.html" title="IBusSerializable"><span class="type">IBusSerializable</span></a>/
444
 
The deserialize method should be implemented in extended class.
445
 
</p>
446
 
<p>
447
 
<em class="parameter"><code>see_also</code></em>: <a class="link" href="IBusSerializable.html#IBusSerializableCopyFunc" title="IBusSerializableCopyFunc ()"><code class="function">IBusSerializableCopyFunc()</code></a>.
448
 
</p>
449
 
<div class="variablelist"><table border="0">
450
 
<col align="left" valign="top">
451
 
<tbody>
452
 
<tr>
453
 
<td><p><span class="term"><em class="parameter"><code>variant</code></em> :</span></p></td>
454
 
<td>A <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a>.</td>
455
 
</tr>
456
 
<tr>
457
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
458
 
<td>The deserialized <a class="link" href="IBusSerializable.html" title="IBusSerializable"><span class="type">IBusSerializable</span></a>.</td>
 
408
<a name="ibus-serializable-set-attachment"></a><h3>ibus_serializable_set_attachment()</h3>
 
409
<pre class="programlisting">#define             ibus_serializable_set_attachment(o, k, v)</pre>
 
410
<p>
 
411
Attach a value to an IBusSerializable.
 
412
This macro is an convenient wrapper of <a class="link" href="IBusSerializable.html#ibus-serializable-set-qattachment" title="ibus_serializable_set_qattachment ()"><code class="function">ibus_serializable_set_qattachment()</code></a>.
 
413
</p>
 
414
<div class="variablelist"><table border="0">
 
415
<col align="left" valign="top">
 
416
<tbody>
 
417
<tr>
 
418
<td><p><span class="term"><em class="parameter"><code>o</code></em> :</span></p></td>
 
419
<td>An IBusSerializable.</td>
 
420
</tr>
 
421
<tr>
 
422
<td><p><span class="term"><em class="parameter"><code>k</code></em> :</span></p></td>
 
423
<td>String formatted key for indexing value.</td>
 
424
</tr>
 
425
<tr>
 
426
<td><p><span class="term"><em class="parameter"><code>v</code></em> :</span></p></td>
 
427
<td>Value to be attached. Should be also serializable.</td>
 
428
</tr>
 
429
</tbody>
 
430
</table></div>
 
431
</div>
 
432
<hr>
 
433
<div class="refsect2">
 
434
<a name="ibus-serializable-set-qattachment"></a><h3>ibus_serializable_set_qattachment ()</h3>
 
435
<pre class="programlisting"><span class="returnvalue">void</span>                ibus_serializable_set_qattachment   (<em class="parameter"><code><a class="link" href="IBusSerializable.html" title="IBusSerializable"><span class="type">IBusSerializable</span></a> *serializable</code></em>,
 
436
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> key</code></em>,
 
437
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *value</code></em>);</pre>
 
438
<p>
 
439
Attach a value to an IBusSerializable. If the value is floating,
 
440
the serializable will take the ownership.
 
441
</p>
 
442
<p>
 
443
<em class="parameter"><code>see_also</code></em>: <a class="link" href="IBusSerializable.html#ibus-serializable-set-attachment" title="ibus_serializable_set_attachment()"><code class="function">ibus_serializable_set_attachment()</code></a>.
 
444
</p>
 
445
<div class="variablelist"><table border="0">
 
446
<col align="left" valign="top">
 
447
<tbody>
 
448
<tr>
 
449
<td><p><span class="term"><em class="parameter"><code>serializable</code></em> :</span></p></td>
 
450
<td>An <a class="link" href="IBusSerializable.html" title="IBusSerializable"><span class="type">IBusSerializable</span></a>.</td>
 
451
</tr>
 
452
<tr>
 
453
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
 
454
<td>String formatted key for indexing value.</td>
 
455
</tr>
 
456
<tr>
 
457
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
 
458
<td>Value to be attached or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to remove any prevoius value.</td>
459
459
</tr>
460
460
</tbody>
461
461
</table></div>
464
464
</div>
465
465
<div class="footer">
466
466
<hr>
467
 
          Generated by GTK-Doc V1.17</div>
 
467
          Generated by GTK-Doc V1.18</div>
468
468
</body>
469
469
</html>
 
 
b'\\ No newline at end of file'