131
132
<title>IBusService</title>
132
133
<indexterm zone="IBusService-struct"><primary sortas="IBusService">IBusService</primary></indexterm><programlisting>typedef struct _IBusService IBusService;</programlisting>
135
An opaque data type representing an IBusService.</para>
134
137
</para></refsect2>
135
138
<refsect2 id="ibus-service-new" role="function">
136
139
<title>ibus_service_new ()</title>
137
140
<indexterm zone="ibus-service-new"><primary sortas="ibus_service_new">ibus_service_new</primary></indexterm><programlisting><link linkend="IBusService">IBusService</link> * ibus_service_new (const <link linkend="gchar">gchar</link> *path);</programlisting>
142
New an IBusService.</para>
139
144
</para><variablelist role="params">
140
145
<varlistentry><term><parameter>path</parameter> :</term>
146
<listitem><simpara> Object path.
142
147
</simpara></listitem></varlistentry>
143
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
148
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A newly allocated IBusService
144
149
</simpara></listitem></varlistentry>
145
150
</variablelist></refsect2>
146
151
<refsect2 id="ibus-service-get-path" role="function">
147
152
<title>ibus_service_get_path ()</title>
148
153
<indexterm zone="ibus-service-get-path"><primary sortas="ibus_service_get_path">ibus_service_get_path</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link> * ibus_service_get_path (<link linkend="IBusService">IBusService</link> *service);</programlisting>
155
Returns the object path of an IBusService.</para>
150
157
</para><variablelist role="params">
151
158
<varlistentry><term><parameter>service</parameter> :</term>
159
<listitem><simpara> An IBusService.
153
160
</simpara></listitem></varlistentry>
154
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
161
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The object path of <parameter>service</parameter>
155
162
</simpara></listitem></varlistentry>
156
163
</variablelist></refsect2>
157
164
<refsect2 id="ibus-service-handle-message" role="function">
160
167
<link linkend="IBusConnection">IBusConnection</link> *connection,
161
168
<link linkend="IBusMessage">IBusMessage</link> *message);</programlisting>
170
Emit an IBusMessage on an IBusConnection.</para>
163
172
</para><variablelist role="params">
164
173
<varlistentry><term><parameter>service</parameter> :</term>
174
<listitem><simpara> An IBusService.
166
175
</simpara></listitem></varlistentry>
167
176
<varlistentry><term><parameter>connection</parameter> :</term>
177
<listitem><simpara> Corresponding IBusCOnnection
169
178
</simpara></listitem></varlistentry>
170
179
<varlistentry><term><parameter>message</parameter> :</term>
180
<listitem><simpara> IBusMessage to be handled.
172
181
</simpara></listitem></varlistentry>
173
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
182
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if succeed; FALSE otherwise.
174
183
</simpara></listitem></varlistentry>
175
184
</variablelist></refsect2>
176
185
<refsect2 id="ibus-service-add-to-connection" role="function">
178
187
<indexterm zone="ibus-service-add-to-connection"><primary sortas="ibus_service_add_to_connection">ibus_service_add_to_connection</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> ibus_service_add_to_connection (<link linkend="IBusService">IBusService</link> *service,
179
188
<link linkend="IBusConnection">IBusConnection</link> *connection);</programlisting>
190
Add an IBusService to an IBusConnection.
191
This function also connects the service to the signal IBusConnection::destroy of the connection.</para>
181
193
</para><variablelist role="params">
182
194
<varlistentry><term><parameter>service</parameter> :</term>
195
<listitem><simpara> An IBusService.
184
196
</simpara></listitem></varlistentry>
185
197
<varlistentry><term><parameter>connection</parameter> :</term>
198
<listitem><simpara> Corresponding IBusCOnnection
187
199
</simpara></listitem></varlistentry>
188
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
200
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if succeed; FALSE otherwise.
189
201
</simpara></listitem></varlistentry>
190
202
</variablelist></refsect2>
191
203
<refsect2 id="ibus-service-get-connections" role="function">
204
216
<indexterm zone="ibus-service-remove-from-connection"><primary sortas="ibus_service_remove_from_connection">ibus_service_remove_from_connection</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> ibus_service_remove_from_connection (<link linkend="IBusService">IBusService</link> *service,
205
217
<link linkend="IBusConnection">IBusConnection</link> *connection);</programlisting>
219
Remove an IBusService from an IBusConnection.
220
This function also disconnects the signal IBusConnection::destroy.</para>
207
222
</para><variablelist role="params">
208
223
<varlistentry><term><parameter>service</parameter> :</term>
224
<listitem><simpara> An IBusService.
210
225
</simpara></listitem></varlistentry>
211
226
<varlistentry><term><parameter>connection</parameter> :</term>
227
<listitem><simpara> Corresponding IBusCOnnection
213
228
</simpara></listitem></varlistentry>
214
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
229
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if succeed; FALSE otherwise.
215
230
</simpara></listitem></varlistentry>
216
231
</variablelist></refsect2>
217
232
<refsect2 id="ibus-service-remove-from-all-connections" role="function">
219
234
<indexterm zone="ibus-service-remove-from-all-connections"><primary sortas="ibus_service_remove_from_all_connections">ibus_service_remove_from_all_connections</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> ibus_service_remove_from_all_connections
220
235
(<link linkend="IBusService">IBusService</link> *service);</programlisting>
237
Remove an IBusService from all connections.
238
This function also disconnects the signal IBusConnection::destroy.</para>
222
240
</para><variablelist role="params">
223
241
<varlistentry><term><parameter>service</parameter> :</term>
242
<listitem><simpara> An IBusService.
225
243
</simpara></listitem></varlistentry>
226
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
244
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if succeed; FALSE otherwise.
227
245
</simpara></listitem></varlistentry>
228
246
</variablelist></refsect2>
229
247
<refsect2 id="ibus-service-send-signal" role="function">
234
252
<link linkend="GType">GType</link> first_arg_type,
235
253
...);</programlisting>
255
Send signal to all the IBusConnections of an IBusService.
258
<parameter>see_also</parameter>: <link linkend="ibus-connection-send-signal"><function>ibus_connection_send_signal()</function></link></para>
237
260
</para><variablelist role="params">
238
261
<varlistentry><term><parameter>service</parameter> :</term>
262
<listitem><simpara> An IBusService.
240
263
</simpara></listitem></varlistentry>
241
264
<varlistentry><term><parameter>interface</parameter> :</term>
265
<listitem><simpara> The interface the signal is emitted from.
243
266
</simpara></listitem></varlistentry>
244
267
<varlistentry><term><parameter>name</parameter> :</term>
268
<listitem><simpara> Name of the signal.
246
269
</simpara></listitem></varlistentry>
247
270
<varlistentry><term><parameter>first_arg_type</parameter> :</term>
271
<listitem><simpara> Type of first argument.
249
272
</simpara></listitem></varlistentry>
250
273
<varlistentry><term><parameter>...</parameter> :</term>
274
<listitem><simpara> Rest of arguments, NULL to mark the end.
252
275
</simpara></listitem></varlistentry>
253
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
276
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if succeed; FALSE otherwise.
254
277
</simpara></listitem></varlistentry>
255
278
</variablelist></refsect2>
259
282
<title role="property_details.title">Property Details</title>
260
283
<refsect2 id="IBusService--path" role="property"><title>The <literal>"path"</literal> property</title>
261
284
<indexterm zone="IBusService--path"><primary sortas="IBusService:path">IBusService:path</primary></indexterm><programlisting> "path" <link linkend="gchar">gchar</link>* : Read / Write / Construct Only</programlisting>
262
<para>The path of service object.</para><para>Default value: NULL</para>
286
The path of service object.</para>
288
</para><para>Default value: NULL</para>
266
292
<refsect1 id="IBusService.signal-details" role="signals">
267
293
<title role="signals.title">Signal Details</title>
268
294
<refsect2 id="IBusService-ibus-message" role="signal"><title>The <literal>"ibus-message"</literal> signal</title>
269
<indexterm zone="IBusService-ibus-message"><primary sortas="IBusService::ibus-message">IBusService::ibus-message</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> user_function (<link linkend="IBusService">IBusService</link> *ibusservice,
270
<link linkend="gpointer">gpointer</link> arg1,
271
<link linkend="gpointer">gpointer</link> arg2,
272
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
295
<indexterm zone="IBusService-ibus-message"><primary sortas="IBusService::ibus-message">IBusService::ibus-message</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> user_function (<link linkend="IBusService">IBusService</link> *service,
296
<link linkend="gpointer">gpointer</link> connection,
297
<link linkend="gpointer">gpointer</link> message,
298
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
300
Send an IBusMessage though the <parameter>connection</parameter>.</para>
274
302
</para><variablelist role="params">
275
<varlistentry><term><parameter>ibusservice</parameter> :</term>
276
<listitem><simpara>the object which received the signal.
277
</simpara></listitem></varlistentry>
278
<varlistentry><term><parameter>arg1</parameter> :</term>
280
</simpara></listitem></varlistentry>
281
<varlistentry><term><parameter>arg2</parameter> :</term>
303
<varlistentry><term><parameter>service</parameter> :</term>
304
<listitem><simpara> An IBusService.
305
</simpara></listitem></varlistentry>
306
<varlistentry><term><parameter>connection</parameter> :</term>
307
<listitem><simpara> Corresponding IBusConnection.
308
</simpara></listitem></varlistentry>
309
<varlistentry><term><parameter>message</parameter> :</term>
310
<listitem><simpara> An IBusMessage to be sent.
283
311
</simpara></listitem></varlistentry>
284
312
<varlistentry><term><parameter>user_data</parameter> :</term>
285
313
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
286
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
314
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if succeed; FALSE otherwise.
315
<note><para><parameter>user_data</parameter> is not actually a valid parameter. It is displayed because of GtkDoc bug.</para></note>
287
316
</simpara></listitem></varlistentry>
288
317
</variablelist></refsect2><refsect2 id="IBusService-ibus-signal" role="signal"><title>The <literal>"ibus-signal"</literal> signal</title>
289
318
<indexterm zone="IBusService-ibus-signal"><primary sortas="IBusService::ibus-signal">IBusService::ibus-signal</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> user_function (<link linkend="IBusService">IBusService</link> *ibusservice,
added
removed
docs/reference/ibus/xml/ibusservice.xml
