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
|
<?xml version="1.0" encoding="UTF-8"?>
<!--
A library to allow applictions to provide simple indications of
information to be displayed to users of the application through the
interface shell.
Copyright 2009 Canonical Ltd.
Authors:
Ted Gould <ted@canonical.com>
This program is free software: you can redistribute it and/or modify it
under the terms of either or both of the following licenses:
1) the GNU Lesser General Public License version 3, as published by the
Free Software Foundation; and/or
2) the GNU Lesser General Public License version 2.1, as published by
the Free Software Foundation.
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranties of
MERCHANTABILITY, SATISFACTORY QUALITY or FITNESS FOR A PARTICULAR
PURPOSE. See the applicable version of the GNU Lesser General Public
License for more details.
You should have received a copy of both the GNU Lesser General Public
License version 3 and version 2.1 along with this program. If not, see
<http://www.gnu.org/licenses/>
-->
<node name="/" xmlns:dox="http://www.ayatana.org/dbus/dox.dtd">
<interface name="org.ayatana.dbusmenu">
<dox:d><![CDATA[
The goal of this DBus interface is to be able to pass menu items
through DBus.
Items are represented with a unique numeric id and a dictionary of
properties.
Available properties are:
- @c type (string): Type of the item (see below)
- @c label (string): Text of the item
- @c icon-data (binary): Raw data of the icon (TODO: define format)
- @c icon (string): Icon name of the item, following icon spec
- @c sensitive (boolean): Whether the item can be activated or not
- @c checked (boolean): Whether a checkbox or radio item is checked
- @c shortcut (string): The keyboard shortcut
Vendor specific properties can be added by prefixing them with "x-<vendor>-"
@c type property is an enum which can take the following values:
- @c action: An item which can be clicked to trigger an action
- @c checkbox: An item which can be checked or unchecked
- @c radio: An item which can be checked or unchecked as part of a group
- @c separator: A separator
- @c menu: An item which contains more items
Vendor specific types can be added by prefixing them with "x-<vendor>-"
]]></dox:d>
<!-- Properties -->
<property name="version" type="u" access="read">
<dox:d>
Provides the version of the DBusmenu API that this API is
implementing.
</dox:d>
</property>
<!-- Functions -->
<method name="GetLayout">
<dox:d><![CDATA[
Provides an XML representation of the menu hierarchy
XML syntax:
@verbatim
<menu id="1" revision="2"> # Root container
<menu id="2" revision="2"> # First level menu, for example "File"
<menu id="3" revision="2"/> ~ Second level menu, for example "Open"
<menu id="4" revision="3"/>
...
</menu>
<menu id="5" revision="2"> # Another first level menu, say "Edit"
...
</menu>
...
</menu>
@endverbatim
]]></dox:d>
<arg type="u" name="parentId" direction="in">
<dox:d>The ID of the parent node for the layout. For
grabbing the layout from the root node use zero.</dox:d>
</arg>
<arg type="u" name="revision" direction="out">
<dox:d>The revision number of the layout. For matching
with layoutUpdated signals.</dox:d>
</arg>
<arg type="s" name="layout" direction="out">
<dox:d>The layout as an XML string of IDs.</dox:d>
</arg>
</method>
<method name="GetGroupProperties">
<dox:d>
Returns the list of items which are children of @a parentId.
</dox:d>
<arg type="au" name="Ids" direction="in" >
<dox:d>
A list of ids that we should be finding the properties
on. If the list is empty, all menu items should be sent.
</dox:d>
</arg>
<arg type="as" name="propertyNames" direction="in" >
<dox:d>
list of string the list of item properties we are
interested in. If there are no entries in the list all of
the properties will be sent.
</dox:d>
</arg>
<arg type="a(ua{sv})" name="properties" direction="out" >
<dox:d>
An array of property values.
An item in this area is represented as a struct following
this format:
@li id unsigned the item id
@li properties map(string => variant) the requested item properties
</dox:d>
</arg>
</method>
<method name="GetChildren">
<arg type="u" name="id" direction="in" />
<arg type="as" name="propertyNames" direction="in" />
<arg type="a(ua{sv})" name="properties" direction="out" />
</method>
<method name="GetProperty">
<arg type="u" name="id" direction="in" />
<arg type="s" name="name" direction="in" />
<arg type="v" name="value" direction="out" />
</method>
<method name="GetProperties">
<dox:d>
Returns multiple properties in one call. This is more efficient than
GetProperty.
</dox:d>
<annotation name="com.trolltech.QtDBus.QtTypeName.Out0" value="QVariantMap"/>
<arg type="u" name="id" direction="in" >
<dox:d>The item whose properties we want to retrieve.</dox:d>
</arg>
<arg type="as" name="propertyNames" direction="in" >
<dox:d>List of string name of the properties we want. If the list contains no entries, all properties are sent.</dox:d>
</arg>
<arg type="a{sv}" name="properties" direction="out" />
</method>
<method name="Event">
<dox:d><![CDATA[
This is called by the applet to notify the application an event happened on a
menu item.
@a type can be one of the following:
@li "clicked"
@li "hovered"
Vendor specific events can be added by prefixing them with "x-<vendor>-"
]]></dox:d>
<arg type="u" name="id" direction="in" >
<dox:d>the id of the item which received the event</dox:d>
</arg>
<arg type="s" name="eventId" direction="in" >
<dox:d>the type of event</dox:d>
</arg>
<arg type="v" name="data" direction="in" >
<dox:d>event-specific data</dox:d>
</arg>
<arg type="u" name="timestamp" direction="in" >
<dox:d>The time that the event occured if available or the time the message was sent if not</dox:d>
</arg>
</method>
<!-- Signals -->
<signal name="ItemPropertyUpdated">
<dox:d>
Triggered by the application to notify the applet that the property @a property
from item @a id has changed to @a value.
</dox:d>
<arg type="u" name="id" direction="out" />
<arg type="s" name="prop" direction="out" />
<arg type="v" name="value" direction="out" />
</signal>
<signal name="ItemUpdated">
<dox:d>
Triggered by the application to notify the applet that all properties of item
</dox:d>
<arg type="u" name="id" direction="out" >
<dox:d>id which should be considered outdated</dox:d>
</arg>
</signal>
<signal name="LayoutUpdate">
<dox:d>
Triggered by the application to notify display of a layout update, up to
revision
</dox:d>
<arg type="i" name="revision" direction="out" >
<dox:d>The revision of the layout that we're currently on</dox:d>
</arg>
<arg type="u" name="parent" direction="out" >
<dox:d>
If the layout update is only of a subtree, this is the
parent item for the entries that have changed. It is zero if
the whole layout should be considered invalid.
</dox:d>
</arg>
</signal>
<!-- End of interesting stuff -->
</interface>
</node>
|
