From 3230218b3f812495f6b81d6aaa741f41aacf8c25 Mon Sep 17 00:00:00 2001 From: Aurelien Gateau Date: Mon, 1 Feb 2010 16:47:25 -0800 Subject: Turn property descriptions into a table. --- libdbusmenu-glib/dbus-menu.xml | 114 +++++++++++++++++++++++++++++++++-------- 1 file changed, 93 insertions(+), 21 deletions(-) diff --git a/libdbusmenu-glib/dbus-menu.xml b/libdbusmenu-glib/dbus-menu.xml index 77374eb..b795f9c 100644 --- a/libdbusmenu-glib/dbus-menu.xml +++ b/libdbusmenu-glib/dbus-menu.xml @@ -38,27 +38,99 @@ License version 3 and version 2.1 along with this program. If not, see Available properties are: - - @c type (string): Type of the item (see below) - - @c label (string): Text of the item, except that (a) two consecutive - underscore characters "__" are displayed as a single underscore, (b) - any remaining underscore characters are not displayed at all, and (c) - the first of those remaining underscore characters (unless it is the - last character in the string) indicates that the following character - is the access key. - - @c icon-name (string): Icon name of the item, following icon spec - - @c icon-data (binary): PNG data of the icon - - @c enabled (boolean): Whether the item can be activated or not - - @c toggle-type (string): none, checkmark, switch, radio - - @c toggle-state (int): 0 = off, 1 = on, anything else = indeterminate - - Vendor specific properties can be added by prefixing them with "x--" - - @c type property is an enum which can take the following values: - - - @c standard: An item which can be clicked to trigger an action - - @c separator: A separator - - Vendor specific types can be added by prefixing them with "x--" + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionDefault Value
typeStringCan be one of: + - "standard": an item which can be clicked to trigger an action or + show another menu + - "separator": a separator + + Vendor specific types can be added by prefixing them with + "x--". + "standard"
labelstringText of the item, except that: + -# two consecutive underscore characters "__" are displayed as a + single underscore, + -# any remaining underscore characters are not displayed at all, + -# the first of those remaining underscore characters (unless it is + the last character in the string) indicates that the following + character is the access key. + ""
enabledbooleanWhether the item can be activated or not.true
icon-namestringIcon name of the item, following the freedesktop.org icon spec.""
icon-databinaryPNG data of the icon.Empty
toggle-typestring + If the item can be toggled, this property should be set to: + - "checkmark": Item is an independent togglable item + - "radio": Item is part of a group where only one item can be + toggled at a time + - "": Item cannot be toggled + ""
toggle-stateint + Describe the current state of a "togglable" item. Can be one of: + - 0 = off + - 1 = on + - anything else = indeterminate + + Note: + The implementation does not itself handle ensuring that only one + item in a radio group is set to "on", or that a group does not have + "on" and "indeterminate" items simultaneously; maintaining this + policy is up to the toolkit wrappers. + 0
children-displaystring + If the menu item has children this property should be set to + "submenu". + ""
+ + Vendor specific properties can be added by prefixing them with + "x--". ]]> -- cgit v1.2.3