Name Type Description Default Value type String Can 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" label string Text 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. "" enabled boolean Whether the item can be activated or not. true visible boolean True if the item is visible in the menu. true icon-name string Icon name of the item, following the freedesktop.org icon spec. "" icon-data binary PNG data of the icon. Empty shortcut array of arrays of strings The shortcut of the item. Each array represents the key press in the list of keypresses. Each list of strings contains a list of modifiers and then the key that is used. The modifier strings allowed are: "Control", "Alt", "Shift" and "Super". - A simple shortcut like Ctrl+S is represented as: [["Control", "S"]] - A complex shortcut like Ctrl+Q, Alt+X is represented as: [["Control", "Q"], ["Alt", "X"]] Empty toggle-type string 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-state int 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. -1 children-display string If the menu item has children this property should be set to "submenu". "" disposition string How the menuitem feels the information it's displaying to the user should be presented. - "normal" a standard menu item - "informative" providing additional information to the user - "warning" looking at potentially harmful results - "alert" something bad could potentially happen "normal" Vendor specific properties can be added by prefixing them with "x--". ]]> Provides the version of the DBusmenu API that this API is implementing. Represents the way the text direction of the application. This allows the server to handle mismatches intelligently. For left- to-right the string is "ltr" for right-to-left it is "rtl". Tells if the menus are in a normal state or they believe that they could use some attention. Cases for showing them would be if help were referring to them or they accessors were being highlighted. This property can have two values: "normal" in almost all cases and "notice" when they should have a higher priority to be shown. A list of directories that should be used for finding icons using the icon naming spec. Idealy there should only be one for the icon theme, but additional ones are often added by applications for app specific icons. 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 @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}av)'. Its content depends on the value of @a recursionDepth. The ID of the parent node for the layout. For grabbing the layout from the root node use zero. 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. The list of item properties we are interested in. If there are no entries in the list all of the properties will be sent. The revision number of the layout. For matching with layoutUpdated signals. The layout, as a recursive structure. Returns the list of items which are children of @a parentId. A list of ids that we should be finding the properties on. If the list is empty, all menu items should be sent. The list of item properties we are interested in. If there are no entries in the list all of the properties will be sent. 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 Get a signal property on a single item. This is not useful if you're going to implement this interface, it should only be used if you're debugging via a commandline tool. the id of the item which received the event the name of the property to get the value of the property -" ]]> the id of the item which received the event the type of event event-specific data The time that the event occured if available or the time the message was sent if not Used to pass a set of events as a single message for possibily several different menuitems. This is done to optimize DBus traffic. An array of all the events that should be passed. This tuple should match the parameters of the 'Event' signal. Which is roughly: id, eventID, data and timestamp. I list of menuitem IDs that couldn't be found. If none of the ones in the list can be found, a DBus error is returned. This is called by the applet to notify the application that it is about to show the menu under the specified item. Which menu item represents the parent of the item about to be shown. Whether this AboutToShow event should result in the menu being updated. A function to tell several menus being shown that they are about to be shown to the user. This is likely only useful for programitc purposes so while the return values are returned, in general, the singular function should be used in most user interacation scenarios. The IDs of the menu items who's submenus are being shown. The IDs of the menus that need updates. Note: if no update information is needed the DBus message should set the no reply flag. I list of menuitem IDs that couldn't be found. If none of the ones in the list can be found, a DBus error is returned. Triggered when there are lots of property updates across many items so they all get grouped into a single dbus message. The format is the ID of the item with a hashtable of names and values for those properties. Triggered by the application to notify display of a layout update, up to revision The revision of the layout that we're currently on 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. The server is requesting that all clients displaying this menu open it to the user. This would be for things like hotkeys that when the user presses them the menu should open and display itself to the user. ID of the menu that should be activated The time that the event occured