blob: 712840a1886c7b7acbb70300eeff66a997bc3718 (
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
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
[
<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
]>
<refentry id="libdbusmenu-glib-DbusmenuServer">
<refmeta>
<refentrytitle role="top_of_page" id="libdbusmenu-glib-DbusmenuServer.top_of_page">DbusmenuServer</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>
LIBDBUSMENU-GLIB Library
</refmiscinfo>
</refmeta>
<refnamediv>
<refname>DbusmenuServer</refname>
<refpurpose></refpurpose>
</refnamediv>
<refsynopsisdiv id="libdbusmenu-glib-DbusmenuServer.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>#define <link linkend="DBUSMENU-SERVER-SIGNAL-ID-PROP-UPDATE:CAPS">DBUSMENU_SERVER_SIGNAL_ID_PROP_UPDATE</link>
#define <link linkend="DBUSMENU-SERVER-SIGNAL-ID-UPDATE:CAPS">DBUSMENU_SERVER_SIGNAL_ID_UPDATE</link>
#define <link linkend="DBUSMENU-SERVER-SIGNAL-LAYOUT-UPDATED:CAPS">DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATED</link>
#define <link linkend="DBUSMENU-SERVER-SIGNAL-LAYOUT-UPDATE:CAPS">DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATE</link>
#define <link linkend="DBUSMENU-SERVER-PROP-DBUS-OBJECT:CAPS">DBUSMENU_SERVER_PROP_DBUS_OBJECT</link>
#define <link linkend="DBUSMENU-SERVER-PROP-ROOT-NODE:CAPS">DBUSMENU_SERVER_PROP_ROOT_NODE</link>
#define <link linkend="DBUSMENU-SERVER-PROP-VERSION:CAPS">DBUSMENU_SERVER_PROP_VERSION</link>
<link linkend="DbusmenuServer">DbusmenuServer</link>;
<link linkend="DbusmenuServerClass">DbusmenuServerClass</link>;
<link linkend="DbusmenuServer"><returnvalue>DbusmenuServer</returnvalue></link> * <link linkend="dbusmenu-server-new">dbusmenu_server_new</link> (<parameter>const <link linkend="gchar"><type>gchar</type></link> *object</parameter>);
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="dbusmenu-server-set-root">dbusmenu_server_set_root</link> (<parameter><link linkend="DbusmenuServer"><type>DbusmenuServer</type></link> *server</parameter>,
<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *root</parameter>);
</synopsis>
</refsynopsisdiv>
<refsect1 id="libdbusmenu-glib-DbusmenuServer.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="libdbusmenu-glib-DbusmenuServer.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="DBUSMENU-SERVER-SIGNAL-ID-PROP-UPDATE:CAPS" role="macro">
<title>DBUSMENU_SERVER_SIGNAL_ID_PROP_UPDATE</title>
<indexterm zone="DBUSMENU-SERVER-SIGNAL-ID-PROP-UPDATE:CAPS"><primary>DBUSMENU_SERVER_SIGNAL_ID_PROP_UPDATE</primary></indexterm>
<programlisting>#define DBUSMENU_SERVER_SIGNAL_ID_PROP_UPDATE "item-property-updated"
</programlisting>
<para>
</para></refsect2>
<refsect2 id="DBUSMENU-SERVER-SIGNAL-ID-UPDATE:CAPS" role="macro">
<title>DBUSMENU_SERVER_SIGNAL_ID_UPDATE</title>
<indexterm zone="DBUSMENU-SERVER-SIGNAL-ID-UPDATE:CAPS"><primary>DBUSMENU_SERVER_SIGNAL_ID_UPDATE</primary></indexterm>
<programlisting>#define DBUSMENU_SERVER_SIGNAL_ID_UPDATE "item-updated"
</programlisting>
<para>
</para></refsect2>
<refsect2 id="DBUSMENU-SERVER-SIGNAL-LAYOUT-UPDATED:CAPS" role="macro">
<title>DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATED</title>
<indexterm zone="DBUSMENU-SERVER-SIGNAL-LAYOUT-UPDATED:CAPS"><primary>DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATED</primary></indexterm>
<programlisting>#define DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATED "layout-updated"
</programlisting>
<para>
</para></refsect2>
<refsect2 id="DBUSMENU-SERVER-SIGNAL-LAYOUT-UPDATE:CAPS" role="macro">
<title>DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATE</title>
<indexterm zone="DBUSMENU-SERVER-SIGNAL-LAYOUT-UPDATE:CAPS"><primary>DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATE</primary></indexterm>
<programlisting>#define DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATE DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATED
</programlisting>
<para>
</para></refsect2>
<refsect2 id="DBUSMENU-SERVER-PROP-DBUS-OBJECT:CAPS" role="macro">
<title>DBUSMENU_SERVER_PROP_DBUS_OBJECT</title>
<indexterm zone="DBUSMENU-SERVER-PROP-DBUS-OBJECT:CAPS"><primary>DBUSMENU_SERVER_PROP_DBUS_OBJECT</primary></indexterm>
<programlisting>#define DBUSMENU_SERVER_PROP_DBUS_OBJECT "dbus-object"
</programlisting>
<para>
</para></refsect2>
<refsect2 id="DBUSMENU-SERVER-PROP-ROOT-NODE:CAPS" role="macro">
<title>DBUSMENU_SERVER_PROP_ROOT_NODE</title>
<indexterm zone="DBUSMENU-SERVER-PROP-ROOT-NODE:CAPS"><primary>DBUSMENU_SERVER_PROP_ROOT_NODE</primary></indexterm>
<programlisting>#define DBUSMENU_SERVER_PROP_ROOT_NODE "root-node"
</programlisting>
<para>
</para></refsect2>
<refsect2 id="DBUSMENU-SERVER-PROP-VERSION:CAPS" role="macro">
<title>DBUSMENU_SERVER_PROP_VERSION</title>
<indexterm zone="DBUSMENU-SERVER-PROP-VERSION:CAPS"><primary>DBUSMENU_SERVER_PROP_VERSION</primary></indexterm>
<programlisting>#define DBUSMENU_SERVER_PROP_VERSION "version"
</programlisting>
<para>
</para></refsect2>
<refsect2 id="DbusmenuServer" role="struct">
<title>DbusmenuServer</title>
<indexterm zone="DbusmenuServer"><primary>DbusmenuServer</primary></indexterm>
<programlisting>typedef struct {
GObject parent;
} DbusmenuServer;
</programlisting>
<para>
A server which represents a sharing of a set of
<link linkend="DbusmenuMenuitems"><type>DbusmenuMenuitems</type></link> across DBus to a <link linkend="DbusmenuClient"><type>DbusmenuClient</type></link>.
</para><variablelist role="struct">
<varlistentry><term><link linkend="GObject"><type>GObject</type></link> <structfield id="DbusmenuServer.parent">parent</structfield>;</term>
<listitem><simpara><link linkend="GObject"><type>GObject</type></link>
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2 id="DbusmenuServerClass" role="struct">
<title>DbusmenuServerClass</title>
<indexterm zone="DbusmenuServerClass"><primary>DbusmenuServerClass</primary></indexterm>
<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);
void (*item_activation)(gint id, guint timestamp);
/* Reserved */
void (*dbusmenu_server_reserved1)(void);
void (*dbusmenu_server_reserved2)(void);
void (*dbusmenu_server_reserved3)(void);
} DbusmenuServerClass;
</programlisting>
<para>
The class implementing the virtual functions for <link linkend="DbusmenuServer"><type>DbusmenuServer</type></link>.
</para><variablelist role="struct">
<varlistentry><term><link linkend="GObjectClass"><type>GObjectClass</type></link> <structfield id="DbusmenuServerClass.parent-class">parent_class</structfield>;</term>
<listitem><simpara><link linkend="GObjectClass"><type>GObjectClass</type></link>
</simpara></listitem>
</varlistentry>
<varlistentry><term><structfield id="DbusmenuServerClass.id-prop-update">id_prop_update</structfield> ()</term>
<listitem><simpara>Slot for <link linkend="DbusmenuServer-id-prop-update"><type>"id-prop-update"</type></link>.
</simpara></listitem>
</varlistentry>
<varlistentry><term><structfield id="DbusmenuServerClass.id-update">id_update</structfield> ()</term>
<listitem><simpara>Slot for <link linkend="DbusmenuServer-id-update"><type>"id-update"</type></link>.
</simpara></listitem>
</varlistentry>
<varlistentry><term><structfield id="DbusmenuServerClass.layout-updated">layout_updated</structfield> ()</term>
<listitem><simpara>Slot for <link linkend="DbusmenuServer-layout-update"><type>"layout-update"</type></link>.
</simpara></listitem>
</varlistentry>
<varlistentry><term><structfield id="DbusmenuServerClass.item-activation">item_activation</structfield> ()</term>
<listitem><simpara>
</simpara></listitem>
</varlistentry>
<varlistentry><term><structfield id="DbusmenuServerClass.dbusmenu-server-reserved1">dbusmenu_server_reserved1</structfield> ()</term>
<listitem><simpara>Reserved for future use.
</simpara></listitem>
</varlistentry>
<varlistentry><term><structfield id="DbusmenuServerClass.dbusmenu-server-reserved2">dbusmenu_server_reserved2</structfield> ()</term>
<listitem><simpara>Reserved for future use.
</simpara></listitem>
</varlistentry>
<varlistentry><term><structfield id="DbusmenuServerClass.dbusmenu-server-reserved3">dbusmenu_server_reserved3</structfield> ()</term>
<listitem><simpara>Reserved for future use.
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2 id="dbusmenu-server-new" role="function">
<title>dbusmenu_server_new ()</title>
<indexterm zone="dbusmenu-server-new"><primary>dbusmenu_server_new</primary></indexterm>
<programlisting><link linkend="DbusmenuServer"><returnvalue>DbusmenuServer</returnvalue></link> * dbusmenu_server_new (<parameter>const <link linkend="gchar"><type>gchar</type></link> *object</parameter>);</programlisting>
<para>
Creates a new <link linkend="DbusmenuServer"><type>DbusmenuServer</type></link> object with a specific object
path on DBus. If <parameter>object</parameter> is set to NULL the default object
name of "/org/ayatana/dbusmenu" will be used.
</para><variablelist role="params">
<varlistentry><term><parameter>object</parameter> :</term>
<listitem><simpara>The object name to show for this menu structure
on DBus. May be NULL.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A brand new <link linkend="DbusmenuServer"><type>DbusmenuServer</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="dbusmenu-server-set-root" role="function">
<title>dbusmenu_server_set_root ()</title>
<indexterm zone="dbusmenu-server-set-root"><primary>dbusmenu_server_set_root</primary></indexterm>
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> dbusmenu_server_set_root (<parameter><link linkend="DbusmenuServer"><type>DbusmenuServer</type></link> *server</parameter>,
<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *root</parameter>);</programlisting>
<para>
This function contains all of the <link linkend="GValue"><type>GValue</type></link> wrapping
required to set the property <link linkend="DbusmenuServer--root-node"><type>"root-node"</type></link>
on the server <parameter>self</parameter>.
</para><variablelist role="params">
<varlistentry><term><parameter>server</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>root</parameter> :</term>
<listitem><simpara>The new root <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> tree
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
