~ubuntu-branches/ubuntu/quantal/libdbusmenu/quantal-proposed
» Revision
32
: docs/libdbusmenu-glib/reference/html/libdbusmenu-glib-DbusmenuClient.html
« back to all changes in this revision
Viewing changes to docs/libdbusmenu-glib/reference/html/libdbusmenu-glib-DbusmenuClient.html
- browse files at revision 32
- compare with another revision
- download diff
- download tarball
- view history from revision 32
- Committer: Package Import Robot
- Author(s): Charles Kerr
- Date: 2012-04-05 14:22:33 UTC
- mfrom: (1.1.63)
- Revision ID: package-import@ubuntu.com-20120405142233-qdmmtpxaevpgb9ea
Tags: 0.5.99-0ubuntu1
* New upstream release.
* Reduce the number of messages hud-service sends. (LP: #957022)
* Fix valgrind tests thanks to a little help from sewardj.
* Add gcov targets to autotools build for code-coverage reporting.
* Make private two impl functions that were accidentally public
* Reduce the number of messages hud-service sends. (LP: #957022)
* Fix valgrind tests thanks to a little help from sewardj.
* Add gcov targets to autotools build for code-coverage reporting.
* Make private two impl functions that were accidentally public
- files added:
- Makefile.am.coverage
- files modified:
- AUTHORS
added
removed
docs/libdbusmenu-glib/reference/html/libdbusmenu-glib-DbusmenuClient.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>DbusmenuClient</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7
<link rel="home" href="index.html" title="libdbusmenu-glib Reference Manual">
8
<link rel="up" href="ch01.html" title="API">
9
<link rel="prev" href="libdbusmenu-glib-DbusmenuMenuitem.html" title="DbusmenuMenuitem">
10
<link rel="next" href="libdbusmenu-glib-Types.html" title="Types">
11
<meta name="generator" content="GTK-Doc V1.18 (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="libdbusmenu-glib-DbusmenuMenuitem.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18
<td><a accesskey="u" href="ch01.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">libdbusmenu-glib Reference Manual</th>
21
<td><a accesskey="n" href="libdbusmenu-glib-Types.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="#libdbusmenu-glib-DbusmenuClient.synopsis" class="shortcut">Top</a>
25
|
26
<a href="#libdbusmenu-glib-DbusmenuClient.description" class="shortcut">Description</a>
27
</td></tr>
28
</table>
29
<div class="refentry">
30
<a name="libdbusmenu-glib-DbusmenuClient"></a><div class="titlepage"></div>
31
<div class="refnamediv"><table width="100%"><tr>
32
<td valign="top">
33
<h2><span class="refentrytitle"><a name="libdbusmenu-glib-DbusmenuClient.top_of_page"></a>DbusmenuClient</span></h2>
34
<p>DbusmenuClient — The catcher of all the server traffic</p>
35
</td>
36
<td valign="top" align="right"></td>
37
</tr></table></div>
38
<div class="refsect1">
39
<a name="libdbusmenu-glib-DbusmenuClient.stability-level"></a><h2>Stability Level</h2>
40
Unstable, unless otherwise indicated
41
</div>
42
<div class="refsynopsisdiv">
43
<a name="libdbusmenu-glib-DbusmenuClient.synopsis"></a><h2>Synopsis</h2>
44
<pre class="synopsis">
45
#include <libdbusmenu-glib/client.h>
46
47
#define <a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DBUSMENU-CLIENT-SIGNAL-LAYOUT-UPDATED:CAPS" title="DBUSMENU_CLIENT_SIGNAL_LAYOUT_UPDATED">DBUSMENU_CLIENT_SIGNAL_LAYOUT_UPDATED</a>
48
#define <a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DBUSMENU-CLIENT-SIGNAL-ROOT-CHANGED:CAPS" title="DBUSMENU_CLIENT_SIGNAL_ROOT_CHANGED">DBUSMENU_CLIENT_SIGNAL_ROOT_CHANGED</a>
49
#define <a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DBUSMENU-CLIENT-SIGNAL-NEW-MENUITEM:CAPS" title="DBUSMENU_CLIENT_SIGNAL_NEW_MENUITEM">DBUSMENU_CLIENT_SIGNAL_NEW_MENUITEM</a>
50
#define <a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DBUSMENU-CLIENT-SIGNAL-EVENT-RESULT:CAPS" title="DBUSMENU_CLIENT_SIGNAL_EVENT_RESULT">DBUSMENU_CLIENT_SIGNAL_EVENT_RESULT</a>
51
#define <a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DBUSMENU-CLIENT-SIGNAL-ITEM-ACTIVATE:CAPS" title="DBUSMENU_CLIENT_SIGNAL_ITEM_ACTIVATE">DBUSMENU_CLIENT_SIGNAL_ITEM_ACTIVATE</a>
52
#define <a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DBUSMENU-CLIENT-SIGNAL-ICON-THEME-DIRS-CHANGED:CAPS" title="DBUSMENU_CLIENT_SIGNAL_ICON_THEME_DIRS_CHANGED">DBUSMENU_CLIENT_SIGNAL_ICON_THEME_DIRS_CHANGED</a>
53
#define <a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DBUSMENU-CLIENT-PROP-DBUS-NAME:CAPS" title="DBUSMENU_CLIENT_PROP_DBUS_NAME">DBUSMENU_CLIENT_PROP_DBUS_NAME</a>
54
#define <a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DBUSMENU-CLIENT-PROP-DBUS-OBJECT:CAPS" title="DBUSMENU_CLIENT_PROP_DBUS_OBJECT">DBUSMENU_CLIENT_PROP_DBUS_OBJECT</a>
55
#define <a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DBUSMENU-CLIENT-PROP-GROUP-EVENTS:CAPS" title="DBUSMENU_CLIENT_PROP_GROUP_EVENTS">DBUSMENU_CLIENT_PROP_GROUP_EVENTS</a>
56
#define <a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DBUSMENU-CLIENT-PROP-STATUS:CAPS" title="DBUSMENU_CLIENT_PROP_STATUS">DBUSMENU_CLIENT_PROP_STATUS</a>
57
#define <a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DBUSMENU-CLIENT-PROP-TEXT-DIRECTION:CAPS" title="DBUSMENU_CLIENT_PROP_TEXT_DIRECTION">DBUSMENU_CLIENT_PROP_TEXT_DIRECTION</a>
58
#define <a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DBUSMENU-CLIENT-TYPES-DEFAULT:CAPS" title="DBUSMENU_CLIENT_TYPES_DEFAULT">DBUSMENU_CLIENT_TYPES_DEFAULT</a>
59
#define <a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DBUSMENU-CLIENT-TYPES-SEPARATOR:CAPS" title="DBUSMENU_CLIENT_TYPES_SEPARATOR">DBUSMENU_CLIENT_TYPES_SEPARATOR</a>
60
#define <a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DBUSMENU-CLIENT-TYPES-IMAGE:CAPS" title="DBUSMENU_CLIENT_TYPES_IMAGE">DBUSMENU_CLIENT_TYPES_IMAGE</a>
61
<a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DbusmenuClient" title="DbusmenuClient">DbusmenuClient</a>;
62
struct <a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DbusmenuClientClass" title="struct DbusmenuClientClass">DbusmenuClientClass</a>;
63
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> (<a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DbusmenuClientTypeHandler" title="DbusmenuClientTypeHandler ()">*DbusmenuClientTypeHandler</a>) (<em class="parameter"><code><a class="link" href="libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem" title="struct DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> *newitem</code></em>,
64
<em class="parameter"><code><a class="link" href="libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem" title="struct DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> *parent</code></em>,
65
<em class="parameter"><code><a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DbusmenuClient" title="DbusmenuClient"><span class="type">DbusmenuClient</span></a> *client</code></em>,
66
<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>);
67
<a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DbusmenuClient" title="DbusmenuClient"><span class="returnvalue">DbusmenuClient</span></a> * <a class="link" href="libdbusmenu-glib-DbusmenuClient.html#dbusmenu-client-new" title="dbusmenu_client_new ()">dbusmenu_client_new</a> (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>,
68
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *object</code></em>);
69
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-Boxed-Types.html#GStrv"><span class="returnvalue">GStrv</span></a> <a class="link" href="libdbusmenu-glib-DbusmenuClient.html#dbusmenu-client-get-icon-paths" title="dbusmenu_client_get_icon_paths ()">dbusmenu_client_get_icon_paths</a> (<em class="parameter"><code><a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DbusmenuClient" title="DbusmenuClient"><span class="type">DbusmenuClient</span></a> *client</code></em>);
70
<a class="link" href="libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem" title="struct DbusmenuMenuitem"><span class="returnvalue">DbusmenuMenuitem</span></a> * <a class="link" href="libdbusmenu-glib-DbusmenuClient.html#dbusmenu-client-get-root" title="dbusmenu_client_get_root ()">dbusmenu_client_get_root</a> (<em class="parameter"><code><a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DbusmenuClient" title="DbusmenuClient"><span class="type">DbusmenuClient</span></a> *client</code></em>);
71
<a class="link" href="libdbusmenu-glib-Types.html#DbusmenuStatus" title="enum DbusmenuStatus"><span class="returnvalue">DbusmenuStatus</span></a> <a class="link" href="libdbusmenu-glib-DbusmenuClient.html#dbusmenu-client-get-status" title="dbusmenu_client_get_status ()">dbusmenu_client_get_status</a> (<em class="parameter"><code><a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DbusmenuClient" title="DbusmenuClient"><span class="type">DbusmenuClient</span></a> *client</code></em>);
72
<a class="link" href="libdbusmenu-glib-Types.html#DbusmenuTextDirection" title="enum DbusmenuTextDirection"><span class="returnvalue">DbusmenuTextDirection</span></a> <a class="link" href="libdbusmenu-glib-DbusmenuClient.html#dbusmenu-client-get-text-direction" title="dbusmenu_client_get_text_direction ()">dbusmenu_client_get_text_direction</a>
73
(<em class="parameter"><code><a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DbusmenuClient" title="DbusmenuClient"><span class="type">DbusmenuClient</span></a> *client</code></em>);
74
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="libdbusmenu-glib-DbusmenuClient.html#dbusmenu-client-add-type-handler" title="dbusmenu_client_add_type_handler ()">dbusmenu_client_add_type_handler</a> (<em class="parameter"><code><a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DbusmenuClient" title="DbusmenuClient"><span class="type">DbusmenuClient</span></a> *client</code></em>,
75
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *type</code></em>,
76
<em class="parameter"><code><a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DbusmenuClientTypeHandler" title="DbusmenuClientTypeHandler ()"><span class="type">DbusmenuClientTypeHandler</span></a> newfunc</code></em>);
77
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="libdbusmenu-glib-DbusmenuClient.html#dbusmenu-client-add-type-handler-full" title="dbusmenu_client_add_type_handler_full ()">dbusmenu_client_add_type_handler_full</a>
78
(<em class="parameter"><code><a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DbusmenuClient" title="DbusmenuClient"><span class="type">DbusmenuClient</span></a> *client</code></em>,
79
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *type</code></em>,
80
<em class="parameter"><code><a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DbusmenuClientTypeHandler" title="DbusmenuClientTypeHandler ()"><span class="type">DbusmenuClientTypeHandler</span></a> newfunc</code></em>,
81
<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>,
82
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> destroy_func</code></em>);
83
</pre>
84
</div>
85
<div class="refsect1">
86
<a name="libdbusmenu-glib-DbusmenuClient.description"></a><h2>Description</h2>
87
<p>
88
The client exists as a mirror to the server. For most folks
89
all they will do with a client is set it up to connect to
90
a server and then watch as the menu items on their side
91
of the bus change. This is all they should need to know about
92
the client, that it magically makes their menuitems dance.
93
</p>
94
<p>
95
It does this by setting up signal watchers and adjusting
96
the menuitems appropriately. Most users should watch the
97
menu items and the signal <span class="type">"layout-changed"</span> for
98
larger events so that they can be optimized. It is possible
99
with that signal that even the root node would change. If
100
that doesn't happen the normal signals on the individual
101
nodes should be enough for most users.
102
</p>
103
</div>
104
<div class="refsect1">
105
<a name="libdbusmenu-glib-DbusmenuClient.details"></a><h2>Details</h2>
106
<div class="refsect2">
107
<a name="DBUSMENU-CLIENT-SIGNAL-LAYOUT-UPDATED:CAPS"></a><h3>DBUSMENU_CLIENT_SIGNAL_LAYOUT_UPDATED</h3>
108
<pre class="programlisting">#define DBUSMENU_CLIENT_SIGNAL_LAYOUT_UPDATED "layout-updated"
109
</pre>
110
<p>
111
String to attach to signal <span class="type">"layout-updated"</span>
112
</p>
113
</div>
114
<hr>
115
<div class="refsect2">
116
<a name="DBUSMENU-CLIENT-SIGNAL-ROOT-CHANGED:CAPS"></a><h3>DBUSMENU_CLIENT_SIGNAL_ROOT_CHANGED</h3>
117
<pre class="programlisting">#define DBUSMENU_CLIENT_SIGNAL_ROOT_CHANGED "root-changed"
118
</pre>
119
<p>
120
String to attach to signal <span class="type">"root-changed"</span>
121
</p>
122
</div>
123
<hr>
124
<div class="refsect2">
125
<a name="DBUSMENU-CLIENT-SIGNAL-NEW-MENUITEM:CAPS"></a><h3>DBUSMENU_CLIENT_SIGNAL_NEW_MENUITEM</h3>
126
<pre class="programlisting">#define DBUSMENU_CLIENT_SIGNAL_NEW_MENUITEM "new-menuitem"
127
</pre>
128
<p>
129
String to attach to signal <span class="type">"new-menuitem"</span>
130
</p>
131
</div>
132
<hr>
133
<div class="refsect2">
134
<a name="DBUSMENU-CLIENT-SIGNAL-EVENT-RESULT:CAPS"></a><h3>DBUSMENU_CLIENT_SIGNAL_EVENT_RESULT</h3>
135
<pre class="programlisting">#define DBUSMENU_CLIENT_SIGNAL_EVENT_RESULT "event-result"
136
</pre>
137
<p>
138
String to attach to signal <span class="type">"event-result"</span>
139
</p>
140
</div>
141
<hr>
142
<div class="refsect2">
143
<a name="DBUSMENU-CLIENT-SIGNAL-ITEM-ACTIVATE:CAPS"></a><h3>DBUSMENU_CLIENT_SIGNAL_ITEM_ACTIVATE</h3>
144
<pre class="programlisting">#define DBUSMENU_CLIENT_SIGNAL_ITEM_ACTIVATE "item-activate"
145
</pre>
146
<p>
147
String to attach to signal <span class="type">"item-activate"</span>
148
</p>
149
</div>
150
<hr>
151
<div class="refsect2">
152
<a name="DBUSMENU-CLIENT-SIGNAL-ICON-THEME-DIRS-CHANGED:CAPS"></a><h3>DBUSMENU_CLIENT_SIGNAL_ICON_THEME_DIRS_CHANGED</h3>
153
<pre class="programlisting">#define DBUSMENU_CLIENT_SIGNAL_ICON_THEME_DIRS_CHANGED "icon-theme-dirs-changed"
154
</pre>
155
<p>
156
String to attach to signal <span class="type">"icon-theme-dirs-changed"</span>
157
</p>
158
</div>
159
<hr>
160
<div class="refsect2">
161
<a name="DBUSMENU-CLIENT-PROP-DBUS-NAME:CAPS"></a><h3>DBUSMENU_CLIENT_PROP_DBUS_NAME</h3>
162
<pre class="programlisting">#define DBUSMENU_CLIENT_PROP_DBUS_NAME "dbus-name"
163
</pre>
164
<p>
165
String to access property <span class="type">"dbus-name"</span>
166
</p>
167
</div>
168
<hr>
169
<div class="refsect2">
170
<a name="DBUSMENU-CLIENT-PROP-DBUS-OBJECT:CAPS"></a><h3>DBUSMENU_CLIENT_PROP_DBUS_OBJECT</h3>
171
<pre class="programlisting">#define DBUSMENU_CLIENT_PROP_DBUS_OBJECT "dbus-object"
172
</pre>
173
<p>
174
String to access property <span class="type">"dbus-object"</span>
175
</p>
176
</div>
177
<hr>
178
<div class="refsect2">
179
<a name="DBUSMENU-CLIENT-PROP-GROUP-EVENTS:CAPS"></a><h3>DBUSMENU_CLIENT_PROP_GROUP_EVENTS</h3>
180
<pre class="programlisting">#define DBUSMENU_CLIENT_PROP_GROUP_EVENTS "group-events"
181
</pre>
182
<p>
183
String to access property <span class="type">"group-events"</span>
184
</p>
185
</div>
186
<hr>
187
<div class="refsect2">
188
<a name="DBUSMENU-CLIENT-PROP-STATUS:CAPS"></a><h3>DBUSMENU_CLIENT_PROP_STATUS</h3>
189
<pre class="programlisting">#define DBUSMENU_CLIENT_PROP_STATUS "status"
190
</pre>
191
<p>
192
String to access property <span class="type">"status"</span>
193
</p>
194
</div>
195
<hr>
196
<div class="refsect2">
197
<a name="DBUSMENU-CLIENT-PROP-TEXT-DIRECTION:CAPS"></a><h3>DBUSMENU_CLIENT_PROP_TEXT_DIRECTION</h3>
198
<pre class="programlisting">#define DBUSMENU_CLIENT_PROP_TEXT_DIRECTION "text-direction"
199
</pre>
200
<p>
201
String to access property <span class="type">"text-direction"</span>
202
</p>
203
</div>
204
<hr>
205
<div class="refsect2">
206
<a name="DBUSMENU-CLIENT-TYPES-DEFAULT:CAPS"></a><h3>DBUSMENU_CLIENT_TYPES_DEFAULT</h3>
207
<pre class="programlisting">#define DBUSMENU_CLIENT_TYPES_DEFAULT "standard"
208
</pre>
209
<p>
210
Used to set the 'type' property on a menu item to create
211
a standard menu item.
212
</p>
213
</div>
214
<hr>
215
<div class="refsect2">
216
<a name="DBUSMENU-CLIENT-TYPES-SEPARATOR:CAPS"></a><h3>DBUSMENU_CLIENT_TYPES_SEPARATOR</h3>
217
<pre class="programlisting">#define DBUSMENU_CLIENT_TYPES_SEPARATOR "separator"
218
</pre>
219
<p>
220
Used to set the 'type' property on a menu item to create
221
a separator menu item.
222
</p>
223
</div>
224
<hr>
225
<div class="refsect2">
226
<a name="DBUSMENU-CLIENT-TYPES-IMAGE:CAPS"></a><h3>DBUSMENU_CLIENT_TYPES_IMAGE</h3>
227
<pre class="programlisting">#define DBUSMENU_CLIENT_TYPES_IMAGE "standard"
228
</pre>
229
<p>
230
Used to set the 'type' property on a menu item to create
231
an image menu item. Deprecated as standard menu items now
232
support images as well.
233
</p>
234
</div>
235
<hr>
236
<div class="refsect2">
237
<a name="DbusmenuClient"></a><h3>DbusmenuClient</h3>
238
<pre class="programlisting">typedef struct _DbusmenuClient DbusmenuClient;</pre>
239
<p>
240
The client for a <a class="link" href="libdbusmenu-glib-DbusmenuServer.html#DbusmenuServer" title="DbusmenuServer"><span class="type">DbusmenuServer</span></a> creating a shared
241
object set of <a class="link" href="libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem" title="struct DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> objects.
242
</p>
243
</div>
244
<hr>
245
<div class="refsect2">
246
<a name="DbusmenuClientClass"></a><h3>struct DbusmenuClientClass</h3>
247
<pre class="programlisting">struct DbusmenuClientClass {
248
GObjectClass parent_class;
249
250
void (*layout_updated)(void);
251
void (*root_changed) (DbusmenuMenuitem * newroot);
252
void (*new_menuitem) (DbusmenuMenuitem * newitem);
253
void (*item_activate) (DbusmenuMenuitem * item, guint timestamp);
254
void (*event_result) (DbusmenuMenuitem * item, gchar * event, GVariant * data, guint timestamp, GError * error);
255
void (*icon_theme_dirs) (DbusmenuMenuitem * item, gpointer theme_dirs, GError * error);
256
257
/*< Private >*/
258
void (*reserved1) (void);
259
void (*reserved2) (void);
260
void (*reserved3) (void);
261
void (*reserved4) (void);
262
void (*reserved5) (void);
263
};
264
</pre>
265
<p>
266
A simple class that takes all of the information from a
267
<a class="link" href="libdbusmenu-glib-DbusmenuServer.html#DbusmenuServer" title="DbusmenuServer"><span class="type">DbusmenuServer</span></a> over DBus and makes the same set of
268
<a class="link" href="libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem" title="struct DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> objects appear on the other side.
269
</p>
270
<div class="variablelist"><table border="0">
271
<col align="left" valign="top">
272
<tbody>
273
<tr>
274
<td><p><span class="term"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObjectClass"><span class="type">GObjectClass</span></a> <em class="structfield"><code><a name="DbusmenuClientClass.parent-class"></a>parent_class</code></em>;</span></p></td>
275
<td><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObjectClass"><span class="type">GObjectClass</span></a></td>
276
</tr>
277
<tr>
278
<td><p><span class="term"><em class="structfield"><code><a name="DbusmenuClientClass.layout-updated"></a>layout_updated</code></em> ()</span></p></td>
279
<td>Slot for <span class="type">"layout-updated"</span>.</td>
280
</tr>
281
<tr>
282
<td><p><span class="term"><em class="structfield"><code><a name="DbusmenuClientClass.root-changed"></a>root_changed</code></em> ()</span></p></td>
283
<td>Slot for <span class="type">"root-changed"</span>.</td>
284
</tr>
285
<tr>
286
<td><p><span class="term"><em class="structfield"><code><a name="DbusmenuClientClass.new-menuitem"></a>new_menuitem</code></em> ()</span></p></td>
287
<td>Slot for <span class="type">"new-menuitem"</span>.</td>
288
</tr>
289
<tr>
290
<td><p><span class="term"><em class="structfield"><code><a name="DbusmenuClientClass.item-activate"></a>item_activate</code></em> ()</span></p></td>
291
<td>Slot for <span class="type">"item-activate"</span>.</td>
292
</tr>
293
<tr>
294
<td><p><span class="term"><em class="structfield"><code><a name="DbusmenuClientClass.event-result"></a>event_result</code></em> ()</span></p></td>
295
<td>Slot for <span class="type">"event-error"</span>.</td>
296
</tr>
297
<tr>
298
<td><p><span class="term"><em class="structfield"><code><a name="DbusmenuClientClass.icon-theme-dirs"></a>icon_theme_dirs</code></em> ()</span></p></td>
299
<td>Slot for <span class="type">"icon-theme-dirs-changed"</span>.</td>
300
</tr>
301
<tr>
302
<td><p><span class="term"><em class="structfield"><code><a name="DbusmenuClientClass.reserved1"></a>reserved1</code></em> ()</span></p></td>
303
<td>Reserved for future use.</td>
304
</tr>
305
<tr>
306
<td><p><span class="term"><em class="structfield"><code><a name="DbusmenuClientClass.reserved2"></a>reserved2</code></em> ()</span></p></td>
307
<td>Reserved for future use.</td>
308
</tr>
309
<tr>
310
<td><p><span class="term"><em class="structfield"><code><a name="DbusmenuClientClass.reserved3"></a>reserved3</code></em> ()</span></p></td>
311
<td>Reserved for future use.</td>
312
</tr>
313
<tr>
314
<td><p><span class="term"><em class="structfield"><code><a name="DbusmenuClientClass.reserved4"></a>reserved4</code></em> ()</span></p></td>
315
<td>Reserved for future use.</td>
316
</tr>
317
<tr>
318
<td><p><span class="term"><em class="structfield"><code><a name="DbusmenuClientClass.reserved5"></a>reserved5</code></em> ()</span></p></td>
319
<td>Reserved for future use.</td>
320
</tr>
321
</tbody>
322
</table></div>
323
</div>
324
<hr>
325
<div class="refsect2">
326
<a name="DbusmenuClientTypeHandler"></a><h3>DbusmenuClientTypeHandler ()</h3>
327
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> (*DbusmenuClientTypeHandler) (<em class="parameter"><code><a class="link" href="libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem" title="struct DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> *newitem</code></em>,
328
<em class="parameter"><code><a class="link" href="libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem" title="struct DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> *parent</code></em>,
329
<em class="parameter"><code><a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DbusmenuClient" title="DbusmenuClient"><span class="type">DbusmenuClient</span></a> *client</code></em>,
330
<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>
331
<p>
332
The type handler is called when a dbusmenu item is created
333
with a matching type as setup in <a class="link" href="libdbusmenu-glib-DbusmenuClient.html#dbusmenu-client-add-type-handler" title="dbusmenu_client_add_type_handler ()"><span class="type">dbusmenu_client_add_type_handler</span></a>
334
</p>
335
<div class="variablelist"><table border="0">
336
<col align="left" valign="top">
337
<tbody>
338
<tr>
339
<td><p><span class="term"><em class="parameter"><code>newitem</code></em> :</span></p></td>
340
<td>The <a class="link" href="libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem" title="struct DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> that was created</td>
341
</tr>
342
<tr>
343
<td><p><span class="term"><em class="parameter"><code>parent</code></em> :</span></p></td>
344
<td>The parent of <em class="parameter"><code>newitem</code></em> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><span class="type">NULL</span></a> if none</td>
345
</tr>
346
<tr>
347
<td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
348
<td>A pointer to the <a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DbusmenuClient" title="DbusmenuClient"><span class="type">DbusmenuClient</span></a>
349
</td>
350
</tr>
351
<tr>
352
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
353
<td>The data you gave us</td>
354
</tr>
355
<tr>
356
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
357
<td>
358
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a> if the type has been handled. <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><span class="type">FALSE</span></a> if this
359
function was somehow unable to handle it.</td>
360
</tr>
361
</tbody>
362
</table></div>
363
</div>
364
<hr>
365
<div class="refsect2">
366
<a name="dbusmenu-client-new"></a><h3>dbusmenu_client_new ()</h3>
367
<pre class="programlisting"><a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DbusmenuClient" title="DbusmenuClient"><span class="returnvalue">DbusmenuClient</span></a> * dbusmenu_client_new (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>,
368
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *object</code></em>);</pre>
369
<p>
370
This function creates a new client that connects to a specific
371
server on DBus. That server is at a specific location sharing
372
a known object. The interface is assumed by the code to be
373
the DBus menu interface. The newly created client will start
374
sending out events as it syncs up with the server.
375
</p>
376
<div class="variablelist"><table border="0">
377
<col align="left" valign="top">
378
<tbody>
379
<tr>
380
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
381
<td>The DBus name for the server to connect to</td>
382
</tr>
383
<tr>
384
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
385
<td>The object on the server to monitor</td>
386
</tr>
387
<tr>
388
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
389
<td>A brand new <a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DbusmenuClient" title="DbusmenuClient"><span class="type">DbusmenuClient</span></a>
390
</td>
391
</tr>
392
</tbody>
393
</table></div>
394
</div>
395
<hr>
396
<div class="refsect2">
397
<a name="dbusmenu-client-get-icon-paths"></a><h3>dbusmenu_client_get_icon_paths ()</h3>
398
<pre class="programlisting"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Boxed-Types.html#GStrv"><span class="returnvalue">GStrv</span></a> dbusmenu_client_get_icon_paths (<em class="parameter"><code><a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DbusmenuClient" title="DbusmenuClient"><span class="type">DbusmenuClient</span></a> *client</code></em>);</pre>
399
<p>
400
Gets the stored and exported icon paths from the client.
401
</p>
402
<div class="variablelist"><table border="0">
403
<col align="left" valign="top">
404
<tbody>
405
<tr>
406
<td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
407
<td>The <a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DbusmenuClient" title="DbusmenuClient"><span class="type">DbusmenuClient</span></a> to get the icon paths from</td>
408
</tr>
409
<tr>
410
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
411
<td>A NULL-terminated list of icon paths with
412
memory managed by the client. Duplicate if you want
413
to keep them. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
414
</td>
415
</tr>
416
</tbody>
417
</table></div>
418
</div>
419
<hr>
420
<div class="refsect2">
421
<a name="dbusmenu-client-get-root"></a><h3>dbusmenu_client_get_root ()</h3>
422
<pre class="programlisting"><a class="link" href="libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem" title="struct DbusmenuMenuitem"><span class="returnvalue">DbusmenuMenuitem</span></a> * dbusmenu_client_get_root (<em class="parameter"><code><a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DbusmenuClient" title="DbusmenuClient"><span class="type">DbusmenuClient</span></a> *client</code></em>);</pre>
423
<p>
424
Grabs the root node for the specified client <em class="parameter"><code>client</code></em>. This
425
function may block. It will block if there is currently a
426
call to update the layout, it will block on that layout
427
updated and then return the newly updated layout. Chances
428
are that this update is in the queue for the mainloop as
429
it would have been requested some time ago, but in theory
430
it could block longer.
431
</p>
432
<div class="variablelist"><table border="0">
433
<col align="left" valign="top">
434
<tbody>
435
<tr>
436
<td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
437
<td>The <a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DbusmenuClient" title="DbusmenuClient"><span class="type">DbusmenuClient</span></a> to get the root node from</td>
438
</tr>
439
<tr>
440
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
441
<td>A <a class="link" href="libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem" title="struct DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> representing the root of
442
menu on the server. If there is no server or there is
443
an error receiving its layout it'll return <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><span class="type">NULL</span></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
444
</td>
445
</tr>
446
</tbody>
447
</table></div>
448
</div>
449
<hr>
450
<div class="refsect2">
451
<a name="dbusmenu-client-get-status"></a><h3>dbusmenu_client_get_status ()</h3>
452
<pre class="programlisting"><a class="link" href="libdbusmenu-glib-Types.html#DbusmenuStatus" title="enum DbusmenuStatus"><span class="returnvalue">DbusmenuStatus</span></a> dbusmenu_client_get_status (<em class="parameter"><code><a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DbusmenuClient" title="DbusmenuClient"><span class="type">DbusmenuClient</span></a> *client</code></em>);</pre>
453
<p>
454
Gets the recommended current status that the server
455
is exporting for the menus. In situtations where the
456
value is <a class="link" href="libdbusmenu-glib-Types.html#DBUSMENU-STATUS-NOTICE:CAPS"><span class="type">DBUSMENU_STATUS_NOTICE</span></a> it is recommended that
457
the client show the menus to the user an a more noticible
458
way.
459
</p>
460
<div class="variablelist"><table border="0">
461
<col align="left" valign="top">
462
<tbody>
463
<tr>
464
<td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
465
<td>
466
<a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DbusmenuClient" title="DbusmenuClient"><span class="type">DbusmenuClient</span></a> to check the status on</td>
467
</tr>
468
<tr>
469
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
470
<td>Status being exported.</td>
471
</tr>
472
</tbody>
473
</table></div>
474
</div>
475
<hr>
476
<div class="refsect2">
477
<a name="dbusmenu-client-get-text-direction"></a><h3>dbusmenu_client_get_text_direction ()</h3>
478
<pre class="programlisting"><a class="link" href="libdbusmenu-glib-Types.html#DbusmenuTextDirection" title="enum DbusmenuTextDirection"><span class="returnvalue">DbusmenuTextDirection</span></a> dbusmenu_client_get_text_direction
479
(<em class="parameter"><code><a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DbusmenuClient" title="DbusmenuClient"><span class="type">DbusmenuClient</span></a> *client</code></em>);</pre>
480
<p>
481
Gets the text direction that the server is exporting. If
482
the server is not exporting a direction then the value
483
<a class="link" href="libdbusmenu-glib-Types.html#DBUSMENU-TEXT-DIRECTION-NONE:CAPS"><span class="type">DBUSMENU_TEXT_DIRECTION_NONE</span></a> will be returned.
484
</p>
485
<div class="variablelist"><table border="0">
486
<col align="left" valign="top">
487
<tbody>
488
<tr>
489
<td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
490
<td>
491
<a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DbusmenuClient" title="DbusmenuClient"><span class="type">DbusmenuClient</span></a> to check the text direction on</td>
492
</tr>
493
<tr>
494
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
495
<td>Text direction being exported.</td>
496
</tr>
497
</tbody>
498
</table></div>
499
</div>
500
<hr>
501
<div class="refsect2">
502
<a name="dbusmenu-client-add-type-handler"></a><h3>dbusmenu_client_add_type_handler ()</h3>
503
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> dbusmenu_client_add_type_handler (<em class="parameter"><code><a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DbusmenuClient" title="DbusmenuClient"><span class="type">DbusmenuClient</span></a> *client</code></em>,
504
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *type</code></em>,
505
<em class="parameter"><code><a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DbusmenuClientTypeHandler" title="DbusmenuClientTypeHandler ()"><span class="type">DbusmenuClientTypeHandler</span></a> newfunc</code></em>);</pre>
506
<p>
507
This function connects into the type handling of the <a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DbusmenuClient" title="DbusmenuClient"><span class="type">DbusmenuClient</span></a>.
508
Every new menuitem that comes in immediately gets asked for it's
509
properties. When we get those properties we check the 'type'
510
property and look to see if it matches a handler that is known
511
by the client. If so, the <em class="parameter"><code>newfunc</code></em> function is executed on that
512
<a class="link" href="libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem" title="struct DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a>. If not, then the DbusmenuClient::new-menuitem
513
signal is sent.
514
</p>
515
<p>
516
In the future the known types will be sent to the server so that it
517
can make choices about the menu item types availble.
518
</p>
519
<div class="variablelist"><table border="0">
520
<col align="left" valign="top">
521
<tbody>
522
<tr>
523
<td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
524
<td>Client where we're getting types coming in</td>
525
</tr>
526
<tr>
527
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
528
<td>A text string that will be matched with the 'type'
529
property on incoming menu items</td>
530
</tr>
531
<tr>
532
<td><p><span class="term"><em class="parameter"><code>newfunc</code></em> :</span></p></td>
533
<td>The function that will be executed with those new
534
items when they come in. <span class="annotation">[<acronym title="The callback is valid until the GDestroyNotify argument is called."><span class="acronym">scope notified</span></acronym>]</span>
535
</td>
536
</tr>
537
<tr>
538
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
539
<td>If registering the new type was successful.</td>
540
</tr>
541
</tbody>
542
</table></div>
543
</div>
544
<hr>
545
<div class="refsect2">
546
<a name="dbusmenu-client-add-type-handler-full"></a><h3>dbusmenu_client_add_type_handler_full ()</h3>
547
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> dbusmenu_client_add_type_handler_full
548
(<em class="parameter"><code><a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DbusmenuClient" title="DbusmenuClient"><span class="type">DbusmenuClient</span></a> *client</code></em>,
549
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *type</code></em>,
550
<em class="parameter"><code><a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DbusmenuClientTypeHandler" title="DbusmenuClientTypeHandler ()"><span class="type">DbusmenuClientTypeHandler</span></a> newfunc</code></em>,
551
<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>,
552
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> destroy_func</code></em>);</pre>
553
<p>
554
This function connects into the type handling of the <a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DbusmenuClient" title="DbusmenuClient"><span class="type">DbusmenuClient</span></a>.
555
Every new menuitem that comes in immediately gets asked for it's
556
properties. When we get those properties we check the 'type'
557
property and look to see if it matches a handler that is known
558
by the client. If so, the <em class="parameter"><code>newfunc</code></em> function is executed on that
559
<a class="link" href="libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem" title="struct DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a>. If not, then the DbusmenuClient::new-menuitem
560
signal is sent.
561
</p>
562
<p>
563
In the future the known types will be sent to the server so that it
564
can make choices about the menu item types availble.
565
</p>
566
<div class="variablelist"><table border="0">
567
<col align="left" valign="top">
568
<tbody>
569
<tr>
570
<td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
571
<td>Client where we're getting types coming in</td>
572
</tr>
573
<tr>
574
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
575
<td>A text string that will be matched with the 'type'
576
property on incoming menu items</td>
577
</tr>
578
<tr>
579
<td><p><span class="term"><em class="parameter"><code>newfunc</code></em> :</span></p></td>
580
<td>The function that will be executed with those new
581
items when they come in. <span class="annotation">[<acronym title="The callback is valid until the GDestroyNotify argument is called."><span class="acronym">scope notified</span></acronym>]</span>
582
</td>
583
</tr>
584
<tr>
585
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
586
<td>Data passed to <em class="parameter"><code>newfunc</code></em> when it is called</td>
587
</tr>
588
<tr>
589
<td><p><span class="term"><em class="parameter"><code>destroy_func</code></em> :</span></p></td>
590
<td>A function that is called when the type handler is
591
removed (usually on client destruction) which will free
592
the resources in <em class="parameter"><code>user_data</code></em>.</td>
593
</tr>
594
<tr>
595
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
596
<td>If registering the new type was successful.</td>
597
</tr>
598
</tbody>
599
</table></div>
600
</div>
601
</div>
602
</div>
603
<div class="footer">
604
<hr>
605
Generated by GTK-Doc V1.18</div>
606
</body>
607
</html>
b'\\ No newline at end of file'
Loggerhead is a web-based interface for Breezy
Version: 2.0.1