aboutsummaryrefslogtreecommitdiff
path: root/libdbusmenu-glib
diff options
context:
space:
mode:
authorTed Gould <ted@gould.cx>2011-03-01 11:49:47 -0600
committerTed Gould <ted@gould.cx>2011-03-01 11:49:47 -0600
commit462b9940b0384c913570d6c54c6e464e38bd573a (patch)
tree3d7843b785b846b95eb5cca2b3aba8c26124f49b /libdbusmenu-glib
parentb2f6b6137f9a0bfe587d91b1437a6b3894ea1509 (diff)
parent356ee2d0385f8fd22ec60d84620c0eb2df018384 (diff)
downloadlibdbusmenu-462b9940b0384c913570d6c54c6e464e38bd573a.tar.gz
libdbusmenu-462b9940b0384c913570d6c54c6e464e38bd573a.tar.bz2
libdbusmenu-462b9940b0384c913570d6c54c6e464e38bd573a.zip
Specification cleanups
Diffstat (limited to 'libdbusmenu-glib')
-rw-r--r--libdbusmenu-glib/dbus-menu.xml23
1 files changed, 12 insertions, 11 deletions
diff --git a/libdbusmenu-glib/dbus-menu.xml b/libdbusmenu-glib/dbus-menu.xml
index 0d2a2d6..2352712 100644
--- a/libdbusmenu-glib/dbus-menu.xml
+++ b/libdbusmenu-glib/dbus-menu.xml
@@ -195,21 +195,24 @@ License version 3 and version 2.1 along with this program. If not, see
<dox:d>
Provides the layout and propertiers that are attached to the entries
that are in the layout. It only gives the items that are children
- of the item that is specified in @parentId. It will return all of the
- properties or specific ones depending of the value in @propertyNames.
+ of the item that is specified in @a parentId. It will return all of the
+ properties or specific ones depending of the value in @a propertyNames.
The format is recursive, where the second 'v' is in the same format
- as the original 'a(ia(sv)a(v))'. If the @recursive flag is set to
- less than one then the second array will have zero entries.
+ as the original 'a(ia{sv}av)'. Its content depends on the value
+ of @a recursionDepth.
</dox:d>
<arg type="i" 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="i" name="recurse" direction="in">
+ <arg type="i" name="recursionDepth" direction="in">
<dox:d>
- The amount of levels of recursion to use. -1, as value would
- deliver all the items under the @parentId.
+ The amount of levels of recursion to use. This affects the
+ content of the second variant array.
+ - -1: deliver all the items under the @a parentId.
+ - 0: no recursion, the array will be empty.
+ - n: array will contains items up to 'n' level depth.
</dox:d>
</arg>
<arg type="as" name="propertyNames" direction="in" >
@@ -224,13 +227,11 @@ License version 3 and version 2.1 along with this program. If not, see
with layoutUpdated signals.</dox:d>
</arg>
<arg type="(ia{sv}av)" name="layout" direction="out">
- <dox:d>The layout as an XML string of IDs.</dox:d>
+ <dox:d>The layout, as a recursive structure.</dox:d>
</arg>
</method>
<method name="GetGroupProperties">
- <annotation name="com.trolltech.QtDBus.QtTypeName.In0" value="QVariantList"/>
- <annotation name="com.trolltech.QtDBus.QtTypeName.Out0" value="DBusMenuItemList"/>
<dox:d>
Returns the list of items which are children of @a parentId.
</dox:d>
@@ -327,7 +328,7 @@ License version 3 and version 2.1 along with this program. If not, see
properties.
</dox:d>
<arg type="a(ia{sv})" name="updatedProps" direction="out" />
- <arg type="a(ias)" name="removedProps" direction="out" />
+ <arg type="a(ias)" name="removedProps" direction="out" />
</signal>
<signal name="LayoutUpdated">
<dox:d>