aboutsummaryrefslogtreecommitdiff
path: root/libdbusmenu-glib/dbus-menu.xml
diff options
context:
space:
mode:
Diffstat (limited to 'libdbusmenu-glib/dbus-menu.xml')
-rw-r--r--libdbusmenu-glib/dbus-menu.xml26
1 files changed, 23 insertions, 3 deletions
diff --git a/libdbusmenu-glib/dbus-menu.xml b/libdbusmenu-glib/dbus-menu.xml
index 7937049..53b67de 100644
--- a/libdbusmenu-glib/dbus-menu.xml
+++ b/libdbusmenu-glib/dbus-menu.xml
@@ -29,12 +29,18 @@ 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">
+ <dox:d><![CDATA[
+ @mainpage
+
+ The goal of DBusMenu is to expose menus on DBus.
+
+ Main interface is documented here: @ref org::ayatana::dbusmenu
+ ]]></dox:d>
<interface name="org.ayatana.dbusmenu">
<dox:d><![CDATA[
- The goal of this DBus interface is to be able to pass menu items
- through DBus.
+ A DBus interface to expose menus on DBus.
- Items are represented with a unique numeric id and a dictionary of
+ Menu items are represented with a unique numeric id and a dictionary of
properties.
To reduce the amount of DBus traffic, a property should only be returned
@@ -100,6 +106,20 @@ License version 3 and version 2.1 along with this program. If not, see
<td>Empty</td>
</tr>
<tr>
+ <td>shortcut</td>
+ <td>array of arrays of strings</td>
+ <td>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"]]</td>
+ <td>Empty</td>
+ </tr>
+ <tr>
<td>toggle-type</td>
<td>string</td>
<td>