← Back to branch summary

~joel-auterson/ubuntu/maverick/ibus/newmenuname

« back to all changes in this revision

Viewing changes to docs/reference/ibus/html/ibus-ibusmainloop.html

  • Committer: Bazaar Package Importer
  • Author(s): LI Daobing
  • Date: 2009-10-05 20:45:18 UTC
  • mfrom: (1.1.5 upstream) (6.1.15 sid)
  • Revision ID: james.westby@ubuntu.com-20091005204518-069vlwrl3r8v7bbr
Tags: 1.2.0.20090927-2
https://launchpad.net/bugs/188690
https://launchpad.net/bugs/432375
* create po template when build (LP: #188690)
  - debian/rules: updated.
  - debian/clean: remove pot file when clean.
* debian/control: build depends on python-rsvg (LP: #432375)

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/ibus/html/ibus-ibusmainloop.html
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html>
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 
5
<title>ibusmainloop</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.74.3">
 
7
<link rel="home" href="index.html" title="IBus Reference Manual">
 
8
<link rel="up" href="ch04.html" title="Communication and Configuration">
 
9
<link rel="prev" href="IBusConnection.html" title="IBusConnection">
 
10
<link rel="next" href="ibus-ibusmessage.html" title="ibusmessage">
 
11
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
 
12
<link rel="stylesheet" href="style.css" type="text/css">
 
13
<link rel="chapter" href="ch01.html" title="Overview">
 
14
<link rel="chapter" href="ch02.html" title="Panel (User Interfaces)">
 
15
<link rel="chapter" href="ch03.html" title="Input method engine">
 
16
<link rel="chapter" href="ch04.html" title="Communication and Configuration">
 
17
<link rel="chapter" href="ch05.html" title="Internal">
 
18
</head>
 
19
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 
20
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
 
21
<tr valign="middle">
 
22
<td><a accesskey="p" href="IBusConnection.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
23
<td><a accesskey="u" href="ch04.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
24
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
 
25
<th width="100%" align="center">IBus Reference Manual</th>
 
26
<td><a accesskey="n" href="ibus-ibusmessage.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
27
</tr>
 
28
<tr><td colspan="5" class="shortcuts">
 
29
<a href="#ibus-ibusmainloop.synopsis" class="shortcut">Top</a>
 
30
                 | 
 
31
                <a href="#ibus-ibusmainloop.description" class="shortcut">Description</a>
 
32
</td></tr>
 
33
</table>
 
34
<div class="refentry" lang="en">
 
35
<a name="ibus-ibusmainloop"></a><div class="titlepage"></div>
 
36
<div class="refnamediv"><table width="100%"><tr>
 
37
<td valign="top">
 
38
<h2><span class="refentrytitle"><a name="ibus-ibusmainloop.top_of_page"></a>ibusmainloop</span></h2>
 
39
<p>ibusmainloop — DBus server and connection setup functions.</p>
 
40
</td>
 
41
<td valign="top" align="right"></td>
 
42
</tr></table></div>
 
43
<div class="refsect1" lang="en">
 
44
<a name="ibus-ibusmainloop.stability-level"></a><h2>Stability Level</h2>
 
45
Stable, unless otherwise indicated
 
46
</div>
 
47
<div class="refsynopsisdiv">
 
48
<a name="ibus-ibusmainloop.synopsis"></a><h2>Synopsis</h2>
 
49
<pre class="synopsis">
 
50
void                (<a class="link" href="ibus-ibusmainloop.html#DBusConnectionSetupFunc" title="DBusConnectionSetupFunc ()">*DBusConnectionSetupFunc</a>)          (DBusConnection *connection,
 
51
                                                         <a
 
52
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
 
53
>gpointer</a> user_data);
 
54
void                (<a class="link" href="ibus-ibusmainloop.html#DBusServerSetupFunc" title="DBusServerSetupFunc ()">*DBusServerSetupFunc</a>)              (DBusServer *server,
 
55
                                                         <a
 
56
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
 
57
>gpointer</a> user_data);
 
58
void                <a class="link" href="ibus-ibusmainloop.html#ibus-mainloop-setup" title="ibus_mainloop_setup ()">ibus_mainloop_setup</a>                 (<a class="link" href="ibus-ibusmainloop.html#DBusConnectionSetupFunc" title="DBusConnectionSetupFunc ()">DBusConnectionSetupFunc</a> connection_func,
 
59
                                                         <a class="link" href="ibus-ibusmainloop.html#DBusServerSetupFunc" title="DBusServerSetupFunc ()">DBusServerSetupFunc</a> server_func,
 
60
                                                         <a
 
61
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
 
62
>gpointer</a> user_data);
 
63
void                <a class="link" href="ibus-ibusmainloop.html#ibus-dbus-server-setup" title="ibus_dbus_server_setup ()">ibus_dbus_server_setup</a>              (DBusServer *server);
 
64
void                <a class="link" href="ibus-ibusmainloop.html#ibus-dbus-connection-setup" title="ibus_dbus_connection_setup ()">ibus_dbus_connection_setup</a>          (DBusConnection *connection);
 
65
</pre>
 
66
</div>
 
67
<div class="refsect1" lang="en">
 
68
<a name="ibus-ibusmainloop.description"></a><h2>Description</h2>
 
69
<p>
 
70
This section defines the DBus server and connection setup functions,
 
71
and prototypes of their callback functions.</p>
 
72
<p>
 
73
</p>
 
74
</div>
 
75
<div class="refsect1" lang="en">
 
76
<a name="ibus-ibusmainloop.details"></a><h2>Details</h2>
 
77
<div class="refsect2" lang="en">
 
78
<a name="DBusConnectionSetupFunc"></a><h3>DBusConnectionSetupFunc ()</h3>
 
79
<pre class="programlisting">void                (*DBusConnectionSetupFunc)          (DBusConnection *connection,
 
80
                                                         <a
 
81
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
 
82
>gpointer</a> user_data);</pre>
 
83
<p>
 
84
A prototype of callback to DBus connection setup function.</p>
 
85
<p>
 
86
</p>
 
87
<div class="variablelist"><table border="0">
 
88
<col align="left" valign="top">
 
89
<tbody>
 
90
<tr>
 
91
<td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td>
 
92
<td> A DBusConnection
 
93
</td>
 
94
</tr>
 
95
<tr>
 
96
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 
97
<td> User data to be passed to callback function.
 
98
</td>
 
99
</tr>
 
100
</tbody>
 
101
</table></div>
 
102
</div>
 
103
<hr>
 
104
<div class="refsect2" lang="en">
 
105
<a name="DBusServerSetupFunc"></a><h3>DBusServerSetupFunc ()</h3>
 
106
<pre class="programlisting">void                (*DBusServerSetupFunc)              (DBusServer *server,
 
107
                                                         <a
 
108
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
 
109
>gpointer</a> user_data);</pre>
 
110
<p>
 
111
A prototype of DBus server setup function.</p>
 
112
<p>
 
113
</p>
 
114
<div class="variablelist"><table border="0">
 
115
<col align="left" valign="top">
 
116
<tbody>
 
117
<tr>
 
118
<td><p><span class="term"><em class="parameter"><code>server</code></em> :</span></p></td>
 
119
<td> A DBusConnection
 
120
</td>
 
121
</tr>
 
122
<tr>
 
123
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 
124
<td> User data to be passed to callback function.
 
125
</td>
 
126
</tr>
 
127
</tbody>
 
128
</table></div>
 
129
</div>
 
130
<hr>
 
131
<div class="refsect2" lang="en">
 
132
<a name="ibus-mainloop-setup"></a><h3>ibus_mainloop_setup ()</h3>
 
133
<pre class="programlisting">void                ibus_mainloop_setup                 (<a class="link" href="ibus-ibusmainloop.html#DBusConnectionSetupFunc" title="DBusConnectionSetupFunc ()">DBusConnectionSetupFunc</a> connection_func,
 
134
                                                         <a class="link" href="ibus-ibusmainloop.html#DBusServerSetupFunc" title="DBusServerSetupFunc ()">DBusServerSetupFunc</a> server_func,
 
135
                                                         <a
 
136
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
 
137
>gpointer</a> user_data);</pre>
 
138
<p>
 
139
Sets the watch and timeout functions of a <span class="type">DBusConnection</span>
 
140
and <span class="type">DBusServer</span> to integrate the connection with the GLib main loop.
 
141
</p>
 
142
<p>
 
143
Parameter <em class="parameter"><code>user_data</code></em> should be in type <a
 
144
href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GMainContext"
 
145
><span class="type">GMainContext</span></a>.
 
146
It will be passed to both callback functions,
 
147
however, normally <a
 
148
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
 
149
><code class="literal">NULL</code></a> is sufficient.
 
150
</p>
 
151
<p>
 
152
If called twice for the same user_data, does nothing the second
 
153
time. If called once with user_data A and once with user_data B,
 
154
user_data B replaces user_data A as the context monitoring the
 
155
connection.
 
156
</p>
 
157
<p>
 
158
<em class="parameter"><code>see_also</code></em>: <a class="link" href="ibus-ibusmainloop.html#ibus-dbus-connection-setup" title="ibus_dbus_connection_setup ()"><code class="function">ibus_dbus_connection_setup()</code></a>, <a class="link" href="ibus-ibusmainloop.html#ibus-dbus-server-setup" title="ibus_dbus_server_setup ()"><code class="function">ibus_dbus_server_setup()</code></a>.</p>
 
159
<p>
 
160
</p>
 
161
<div class="variablelist"><table border="0">
 
162
<col align="left" valign="top">
 
163
<tbody>
 
164
<tr>
 
165
<td><p><span class="term"><em class="parameter"><code>connection_func</code></em> :</span></p></td>
 
166
<td> A DBus connection setup function.
 
167
</td>
 
168
</tr>
 
169
<tr>
 
170
<td><p><span class="term"><em class="parameter"><code>server_func</code></em> :</span></p></td>
 
171
<td> A prototype of DBus server setup function.
 
172
</td>
 
173
</tr>
 
174
<tr>
 
175
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 
176
<td> User data to be passed to callback function.
 
177
</td>
 
178
</tr>
 
179
</tbody>
 
180
</table></div>
 
181
</div>
 
182
<hr>
 
183
<div class="refsect2" lang="en">
 
184
<a name="ibus-dbus-server-setup"></a><h3>ibus_dbus_server_setup ()</h3>
 
185
<pre class="programlisting">void                ibus_dbus_server_setup              (DBusServer *server);</pre>
 
186
<p>
 
187
Sets the watch and timeout functions of a <span class="type">DBusServer</span>
 
188
to integrate the server with the GLib main loop.
 
189
</p>
 
190
<p>
 
191
This function uses the parameter <em class="parameter"><code>user_data</code></em> and
 
192
server_func set with <a class="link" href="ibus-ibusmainloop.html#ibus-mainloop-setup" title="ibus_mainloop_setup ()"><code class="function">ibus_mainloop_setup()</code></a>,
 
193
or fall back to NULL and <a class="link" href="ibus-ibusinternal.html#dbus-server-setup" title="dbus_server_setup ()"><code class="function">dbus_server_setup()</code></a> if those are not defined.
 
194
</p>
 
195
<p>
 
196
<em class="parameter"><code>see_also</code></em>: <a class="link" href="ibus-ibusmainloop.html#ibus-mainloop-setup" title="ibus_mainloop_setup ()"><code class="function">ibus_mainloop_setup()</code></a>, <a class="link" href="ibus-ibusinternal.html#dbus-server-setup" title="dbus_server_setup ()"><code class="function">dbus_server_setup()</code></a>.</p>
 
197
<p>
 
198
</p>
 
199
<div class="variablelist"><table border="0">
 
200
<col align="left" valign="top">
 
201
<tbody><tr>
 
202
<td><p><span class="term"><em class="parameter"><code>server</code></em> :</span></p></td>
 
203
<td> A DBusServer.
 
204
</td>
 
205
</tr></tbody>
 
206
</table></div>
 
207
</div>
 
208
<hr>
 
209
<div class="refsect2" lang="en">
 
210
<a name="ibus-dbus-connection-setup"></a><h3>ibus_dbus_connection_setup ()</h3>
 
211
<pre class="programlisting">void                ibus_dbus_connection_setup          (DBusConnection *connection);</pre>
 
212
<p>
 
213
Sets the watch and timeout functions of a <span class="type">DBusConnection</span>
 
214
to integrate the connection with the GLib main loop.
 
215
</p>
 
216
<p>
 
217
This function uses the parameter <em class="parameter"><code>user_data</code></em> and
 
218
connection_func set with <a class="link" href="ibus-ibusmainloop.html#ibus-mainloop-setup" title="ibus_mainloop_setup ()"><code class="function">ibus_mainloop_setup()</code></a>,
 
219
or fall back to NULL and <a class="link" href="ibus-ibusinternal.html#dbus-connection-setup" title="dbus_connection_setup ()"><code class="function">dbus_connection_setup()</code></a> if those are not defined.
 
220
</p>
 
221
<p>
 
222
<em class="parameter"><code>see_also</code></em>: <a class="link" href="ibus-ibusmainloop.html#ibus-mainloop-setup" title="ibus_mainloop_setup ()"><code class="function">ibus_mainloop_setup()</code></a>, <a class="link" href="ibus-ibusinternal.html#dbus-connection-setup" title="dbus_connection_setup ()"><code class="function">dbus_connection_setup()</code></a>.</p>
 
223
<p>
 
224
</p>
 
225
<div class="variablelist"><table border="0">
 
226
<col align="left" valign="top">
 
227
<tbody><tr>
 
228
<td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td>
 
229
<td> A DBusConnection.
 
230
</td>
 
231
</tr></tbody>
 
232
</table></div>
 
233
</div>
 
234
</div>
 
235
</div>
 
236
<div class="footer">
 
237
<hr>
 
238
          Generated by GTK-Doc V1.11</div>
 
239
</body>
 
240
</html>