← Back to branch summary

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

« back to all changes in this revision

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