← Back to branch summary

~ubuntu-branches/ubuntu/karmic/ibus/karmic-updates

« back to all changes in this revision

Viewing changes to docs/reference/ibus/xml/ibusinternal.xml

  • Committer: Bazaar Package Importer
  • Author(s): LI Daobing
  • Date: 2009-07-23 20:22:09 UTC
  • mfrom: (1.1.4 upstream) (6.1.7 sid)
  • Revision ID: james.westby@ubuntu.com-20090723202209-bmgqa80g1umg8l2p
Tags: 1.2.0.20090723-1
new upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/ibus/xml/ibusinternal.xml
10
10
 
11
11
<refnamediv>
12
12
<refname>ibusinternal</refname>
13
 
<refpurpose></refpurpose>
 
13
<refpurpose>IBus DBus setting functions for internal use.</refpurpose>
14
14
</refnamediv>
 
15
<refsect1 id="ibus-ibusinternal.stability-level">
 
16
<title>Stability Level</title>
 
17
Stable, unless otherwise indicated
 
18
</refsect1>
15
19
 
16
20
<refsynopsisdiv id="ibus-ibusinternal.synopsis" role="synopsis">
17
21
<title role="synopsis.title">Synopsis</title>
36
40
<refsect1 id="ibus-ibusinternal.description" role="desc">
37
41
<title role="desc.title">Description</title>
38
42
<para>
 
43
This section contain several IBus house keeping functions.</para>
 
44
<para>
39
45
</para>
40
46
</refsect1>
41
47
 
56
62
<indexterm zone="dbus-server-setup"><primary sortas="dbus_server_setup">dbus_server_setup</primary></indexterm><programlisting><link linkend="void">void</link>                dbus_server_setup                   (<link linkend="DBusServer">DBusServer</link> *server,
57
63
                                                         <link linkend="GMainContext">GMainContext</link> *context);</programlisting>
58
64
<para>
 
65
Sets the watch and timeout functions of a <link linkend="DBusServer"><type>DBusServer</type></link>
 
66
to integrate the server with the GLib main loop.
 
67
In most cases the context argument should be <link linkend="NULL--CAPS"><type>NULL</type></link>.
 
68
</para>
 
69
<para>
 
70
If called twice for the same context, does nothing the second
 
71
time. If called once with context A and once with context B,
 
72
context B replaces context A as the context monitoring the
 
73
connection.</para>
 
74
<para>
59
75
</para><variablelist role="params">
60
76
<varlistentry><term><parameter>server</parameter>&#160;:</term>
61
 
<listitem><simpara>
 
77
<listitem><simpara> the server
62
78
</simpara></listitem></varlistentry>
63
79
<varlistentry><term><parameter>context</parameter>&#160;:</term>
64
 
<listitem><simpara>
 
80
<listitem><simpara> the <link linkend="GMainContext"><type>GMainContext</type></link> or <link linkend="NULL--CAPS"><type>NULL</type></link> for default
65
81
</simpara></listitem></varlistentry>
66
82
</variablelist></refsect2>
67
83
<refsect2 id="dbus-connection-setup" role="function">
69
85
<indexterm zone="dbus-connection-setup"><primary sortas="dbus_connection_setup">dbus_connection_setup</primary></indexterm><programlisting><link linkend="void">void</link>                dbus_connection_setup               (<link linkend="DBusConnection">DBusConnection</link> *connection,
70
86
                                                         <link linkend="GMainContext">GMainContext</link> *context);</programlisting>
71
87
<para>
 
88
Sets the watch and timeout functions of a <link linkend="DBusConnection"><type>DBusConnection</type></link>
 
89
to integrate the connection with the GLib main loop.
 
90
</para>
 
91
<para>
 
92
This function uses the parameter <parameter>user_data</parameter> and
 
93
connection_func set with <link linkend="ibus-mainloop-setup"><function>ibus_mainloop_setup()</function></link>,
 
94
or fall back to NULL and <link linkend="dbus-connection-setup"><function>dbus_connection_setup()</function></link> if those are not defined.
 
95
</para>
 
96
<para>
 
97
<parameter>see_also</parameter>: <link linkend="ibus-mainloop-setup"><function>ibus_mainloop_setup()</function></link>, <link linkend="dbus-connection-setup"><function>dbus_connection_setup()</function></link>.</para>
 
98
<para>
72
99
</para><variablelist role="params">
73
100
<varlistentry><term><parameter>connection</parameter>&#160;:</term>
74
 
<listitem><simpara>
 
101
<listitem><simpara> A DBusConnection.
75
102
</simpara></listitem></varlistentry>
76
103
<varlistentry><term><parameter>context</parameter>&#160;:</term>
77
104
<listitem><simpara>
82
109
 
83
110
 
84
111
 
 
112
<refsect1 id="ibus-ibusinternal.see-also">
 
113
<title>See Also</title>
 
114
#IBusMainLoop
 
115
</refsect1>
85
116
 
86
117
</refentry>