aboutsummaryrefslogtreecommitdiff
path: root/docs/libdbusmenu-glib/reference/html/libdbusmenu-glib-DbusmenuServer.html
blob: df0ca9760a1f11eace5a05711b08a8c6e4ab3ca3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>DbusmenuServer</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="libdbusmenu-glib Reference Manual">
<link rel="up" href="ch01.html" title="API">
<link rel="prev" href="ch01.html" title="API">
<link rel="next" href="libdbusmenu-glib-DbusmenuMenuitemProxy.html" title="DbusmenuMenuitemProxy">
<meta name="generator" content="GTK-Doc V1.14 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="ch01.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">libdbusmenu-glib Reference Manual</th>
<td><a accesskey="n" href="libdbusmenu-glib-DbusmenuMenuitemProxy.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libdbusmenu-glib-DbusmenuServer.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#libdbusmenu-glib-DbusmenuServer.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="DbusmenuServer">
<a name="libdbusmenu-glib-DbusmenuServer"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libdbusmenu-glib-DbusmenuServer.top_of_page"></a>DbusmenuServer</span></h2>
<p>DbusmenuServer</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="libdbusmenu-glib-DbusmenuServer.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">#define             <a class="link" href="libdbusmenu-glib-DbusmenuServer.html#DBUSMENU-SERVER-SIGNAL-ID-PROP-UPDATE:CAPS" title="DBUSMENU_SERVER_SIGNAL_ID_PROP_UPDATE">DBUSMENU_SERVER_SIGNAL_ID_PROP_UPDATE</a>
#define             <a class="link" href="libdbusmenu-glib-DbusmenuServer.html#DBUSMENU-SERVER-SIGNAL-ID-UPDATE:CAPS" title="DBUSMENU_SERVER_SIGNAL_ID_UPDATE">DBUSMENU_SERVER_SIGNAL_ID_UPDATE</a>
#define             <a class="link" href="libdbusmenu-glib-DbusmenuServer.html#DBUSMENU-SERVER-SIGNAL-LAYOUT-UPDATED:CAPS" title="DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATED">DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATED</a>
#define             <a class="link" href="libdbusmenu-glib-DbusmenuServer.html#DBUSMENU-SERVER-SIGNAL-LAYOUT-UPDATE:CAPS" title="DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATE">DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATE</a>
#define             <a class="link" href="libdbusmenu-glib-DbusmenuServer.html#DBUSMENU-SERVER-PROP-DBUS-OBJECT:CAPS" title="DBUSMENU_SERVER_PROP_DBUS_OBJECT">DBUSMENU_SERVER_PROP_DBUS_OBJECT</a>
#define             <a class="link" href="libdbusmenu-glib-DbusmenuServer.html#DBUSMENU-SERVER-PROP-ROOT-NODE:CAPS" title="DBUSMENU_SERVER_PROP_ROOT_NODE">DBUSMENU_SERVER_PROP_ROOT_NODE</a>
#define             <a class="link" href="libdbusmenu-glib-DbusmenuServer.html#DBUSMENU-SERVER-PROP-VERSION:CAPS" title="DBUSMENU_SERVER_PROP_VERSION">DBUSMENU_SERVER_PROP_VERSION</a>
                    <a class="link" href="libdbusmenu-glib-DbusmenuServer.html#DbusmenuServer" title="DbusmenuServer">DbusmenuServer</a>;
                    <a class="link" href="libdbusmenu-glib-DbusmenuServer.html#DbusmenuServerClass" title="DbusmenuServerClass">DbusmenuServerClass</a>;
<a class="link" href="libdbusmenu-glib-DbusmenuServer.html#DbusmenuServer" title="DbusmenuServer"><span class="returnvalue">DbusmenuServer</span></a> *    <a class="link" href="libdbusmenu-glib-DbusmenuServer.html#dbusmenu-server-new" title="dbusmenu_server_new ()">dbusmenu_server_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> *object</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="libdbusmenu-glib-DbusmenuServer.html#dbusmenu-server-set-root" title="dbusmenu_server_set_root ()">dbusmenu_server_set_root</a>            (<em class="parameter"><code><a class="link" href="libdbusmenu-glib-DbusmenuServer.html#DbusmenuServer" title="DbusmenuServer"><span class="type">DbusmenuServer</span></a> *server</code></em>,
                                                         <em class="parameter"><code><a class="link" href="libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem" title="DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> *root</code></em>);
</pre>
</div>
<div class="refsect1" title="Description">
<a name="libdbusmenu-glib-DbusmenuServer.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" title="Details">
<a name="libdbusmenu-glib-DbusmenuServer.details"></a><h2>Details</h2>
<div class="refsect2" title="DBUSMENU_SERVER_SIGNAL_ID_PROP_UPDATE">
<a name="DBUSMENU-SERVER-SIGNAL-ID-PROP-UPDATE:CAPS"></a><h3>DBUSMENU_SERVER_SIGNAL_ID_PROP_UPDATE</h3>
<pre class="programlisting">#define DBUSMENU_SERVER_SIGNAL_ID_PROP_UPDATE  "item-property-updated"
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="DBUSMENU_SERVER_SIGNAL_ID_UPDATE">
<a name="DBUSMENU-SERVER-SIGNAL-ID-UPDATE:CAPS"></a><h3>DBUSMENU_SERVER_SIGNAL_ID_UPDATE</h3>
<pre class="programlisting">#define DBUSMENU_SERVER_SIGNAL_ID_UPDATE       "item-updated"
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATED">
<a name="DBUSMENU-SERVER-SIGNAL-LAYOUT-UPDATED:CAPS"></a><h3>DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATED</h3>
<pre class="programlisting">#define DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATED  "layout-updated"
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATE">
<a name="DBUSMENU-SERVER-SIGNAL-LAYOUT-UPDATE:CAPS"></a><h3>DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATE</h3>
<pre class="programlisting">#define DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATE   DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATED
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="DBUSMENU_SERVER_PROP_DBUS_OBJECT">
<a name="DBUSMENU-SERVER-PROP-DBUS-OBJECT:CAPS"></a><h3>DBUSMENU_SERVER_PROP_DBUS_OBJECT</h3>
<pre class="programlisting">#define DBUSMENU_SERVER_PROP_DBUS_OBJECT       "dbus-object"
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="DBUSMENU_SERVER_PROP_ROOT_NODE">
<a name="DBUSMENU-SERVER-PROP-ROOT-NODE:CAPS"></a><h3>DBUSMENU_SERVER_PROP_ROOT_NODE</h3>
<pre class="programlisting">#define DBUSMENU_SERVER_PROP_ROOT_NODE         "root-node"
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="DBUSMENU_SERVER_PROP_VERSION">
<a name="DBUSMENU-SERVER-PROP-VERSION:CAPS"></a><h3>DBUSMENU_SERVER_PROP_VERSION</h3>
<pre class="programlisting">#define DBUSMENU_SERVER_PROP_VERSION           "version"
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="DbusmenuServer">
<a name="DbusmenuServer"></a><h3>DbusmenuServer</h3>
<pre class="programlisting">typedef struct {
	GObject parent;
} DbusmenuServer;
</pre>
<p>
A server which represents a sharing of a set of
	<a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem"><span class="type">DbusmenuMenuitems</span></a> across DBus to a <a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DbusmenuClient" title="DbusmenuClient"><span class="type">DbusmenuClient</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> <em class="structfield"><code><a name="DbusmenuServer.parent"></a>parent</code></em>;</span></p></td>
<td>
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="DbusmenuServerClass">
<a name="DbusmenuServerClass"></a><h3>DbusmenuServerClass</h3>
<pre class="programlisting">typedef struct {
	GObjectClass parent_class;

	/* Signals */
	void (*id_prop_update)(gint id, gchar * property, gchar * value);
	void (*id_update)(gint id);
	void (*layout_updated)(gint revision);

	/* Reserved */
	void (*dbusmenu_server_reserved1)(void);
	void (*dbusmenu_server_reserved2)(void);
	void (*dbusmenu_server_reserved3)(void);
	void (*dbusmenu_server_reserved4)(void);
} DbusmenuServerClass;
</pre>
<p>
The class implementing the virtual functions for <a class="link" href="libdbusmenu-glib-DbusmenuServer.html#DbusmenuServer" title="DbusmenuServer"><span class="type">DbusmenuServer</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<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="DbusmenuServerClass.parent-class"></a>parent_class</code></em>;</span></p></td>
<td>
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObjectClass"><span class="type">GObjectClass</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="DbusmenuServerClass.id-prop-update"></a>id_prop_update</code></em> ()</span></p></td>
<td>Slot for <span class="type">"id-prop-update"</span>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="DbusmenuServerClass.id-update"></a>id_update</code></em> ()</span></p></td>
<td>Slot for <span class="type">"id-update"</span>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="DbusmenuServerClass.layout-updated"></a>layout_updated</code></em> ()</span></p></td>
<td>Slot for <span class="type">"layout-update"</span>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="DbusmenuServerClass.dbusmenu-server-reserved1"></a>dbusmenu_server_reserved1</code></em> ()</span></p></td>
<td>Reserved for future use.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="DbusmenuServerClass.dbusmenu-server-reserved2"></a>dbusmenu_server_reserved2</code></em> ()</span></p></td>
<td>Reserved for future use.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="DbusmenuServerClass.dbusmenu-server-reserved3"></a>dbusmenu_server_reserved3</code></em> ()</span></p></td>
<td>Reserved for future use.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="DbusmenuServerClass.dbusmenu-server-reserved4"></a>dbusmenu_server_reserved4</code></em> ()</span></p></td>
<td>Reserved for future use.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="dbusmenu_server_new ()">
<a name="dbusmenu-server-new"></a><h3>dbusmenu_server_new ()</h3>
<pre class="programlisting"><a class="link" href="libdbusmenu-glib-DbusmenuServer.html#DbusmenuServer" title="DbusmenuServer"><span class="returnvalue">DbusmenuServer</span></a> *    dbusmenu_server_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> *object</code></em>);</pre>
<p>
Creates a new <a class="link" href="libdbusmenu-glib-DbusmenuServer.html#DbusmenuServer" title="DbusmenuServer"><span class="type">DbusmenuServer</span></a> object with a specific object
	path on DBus.  If <em class="parameter"><code>object</code></em> is set to NULL the default object
	name of "/org/ayatana/dbusmenu" will be used.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
<td>The object name to show for this menu structure
		on DBus.  May be NULL.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A brand new <a class="link" href="libdbusmenu-glib-DbusmenuServer.html#DbusmenuServer" title="DbusmenuServer"><span class="type">DbusmenuServer</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="dbusmenu_server_set_root ()">
<a name="dbusmenu-server-set-root"></a><h3>dbusmenu_server_set_root ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                dbusmenu_server_set_root            (<em class="parameter"><code><a class="link" href="libdbusmenu-glib-DbusmenuServer.html#DbusmenuServer" title="DbusmenuServer"><span class="type">DbusmenuServer</span></a> *server</code></em>,
                                                         <em class="parameter"><code><a class="link" href="libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem" title="DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> *root</code></em>);</pre>
<p>
This function contains all of the <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> wrapping
	required to set the property <span class="type">"root-node"</span>
	on the server <em class="parameter"><code>self</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>server</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>root</code></em> :</span></p></td>
<td>The new root <a class="link" href="libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem" title="DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> tree
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.14</div>
</body>
</html>