From b739c696ae20b0f022fd67fc3d5fd98e561c446b Mon Sep 17 00:00:00 2001 From: Ted Gould Date: Thu, 21 Jan 2010 17:13:40 -0600 Subject: Removing the idea that there should be revisions on the XML --- libdbusmenu-glib/dbus-menu.xml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'libdbusmenu-glib/dbus-menu.xml') diff --git a/libdbusmenu-glib/dbus-menu.xml b/libdbusmenu-glib/dbus-menu.xml index d2df400..a7cceaa 100644 --- a/libdbusmenu-glib/dbus-menu.xml +++ b/libdbusmenu-glib/dbus-menu.xml @@ -50,13 +50,13 @@ Provides an XML representation of the menu hierarchy XML syntax: - # Root container - # First level menu, for example "File" - ~ Second level menu, for example "Open" - + # Root container + # First level menu, for example "File" + ~ Second level menu, for example "Open" + ... - # Another first level menu, say "Edit" + # Another first level menu, say "Edit" ... ... -- cgit v1.2.3 From cc70c4613b95acd6e99bc22bf81cc0bd97bf414c Mon Sep 17 00:00:00 2001 From: Ted Gould Date: Fri, 22 Jan 2010 10:44:40 -0600 Subject: Adding timestamp to XML description. --- libdbusmenu-glib/dbus-menu.xml | 2 ++ 1 file changed, 2 insertions(+) (limited to 'libdbusmenu-glib/dbus-menu.xml') diff --git a/libdbusmenu-glib/dbus-menu.xml b/libdbusmenu-glib/dbus-menu.xml index d2df400..4ec03ef 100644 --- a/libdbusmenu-glib/dbus-menu.xml +++ b/libdbusmenu-glib/dbus-menu.xml @@ -141,6 +141,7 @@ menu item. @param id the id of the item which received the event @param type the type of event @param data event-specific data +@param timestamp The time that the event occured if available or the time the message was sent if not. @a type can be one of the following: @@ -153,6 +154,7 @@ Vendor specific events can be added by prefixing them with "x--" + -- cgit v1.2.3 From 3844bcd1fb2d8ad129a842dcee8ee1b3ec214275 Mon Sep 17 00:00:00 2001 From: Ted Gould Date: Fri, 22 Jan 2010 15:22:54 -0600 Subject: Changing all instances of 'LayoutUpdate' to 'LayoutUpdated' as discussed on the dbusmenu list. --- libdbusmenu-glib/client.c | 4 ++-- libdbusmenu-glib/dbus-menu.xml | 2 +- libdbusmenu-glib/server.c | 16 ++++++++-------- libdbusmenu-glib/server.h | 7 ++++--- 4 files changed, 15 insertions(+), 14 deletions(-) (limited to 'libdbusmenu-glib/dbus-menu.xml') diff --git a/libdbusmenu-glib/client.c b/libdbusmenu-glib/client.c index c4e9860..e0879d4 100644 --- a/libdbusmenu-glib/client.c +++ b/libdbusmenu-glib/client.c @@ -499,8 +499,8 @@ build_proxies (DbusmenuClient * client) } dbus_g_object_register_marshaller(_dbusmenu_server_marshal_VOID__INT_UINT, G_TYPE_NONE, G_TYPE_INT, G_TYPE_UINT, G_TYPE_INVALID); - dbus_g_proxy_add_signal(priv->menuproxy, "LayoutUpdate", G_TYPE_INT, G_TYPE_UINT, G_TYPE_INVALID); - dbus_g_proxy_connect_signal(priv->menuproxy, "LayoutUpdate", G_CALLBACK(layout_update), client, NULL); + dbus_g_proxy_add_signal(priv->menuproxy, "LayoutUpdated", G_TYPE_INT, G_TYPE_UINT, G_TYPE_INVALID); + dbus_g_proxy_connect_signal(priv->menuproxy, "LayoutUpdated", G_CALLBACK(layout_update), client, NULL); dbus_g_object_register_marshaller(_dbusmenu_server_marshal_VOID__UINT_STRING_POINTER, G_TYPE_NONE, G_TYPE_UINT, G_TYPE_STRING, G_TYPE_VALUE, G_TYPE_INVALID); dbus_g_proxy_add_signal(priv->menuproxy, "ItemPropertyUpdated", G_TYPE_UINT, G_TYPE_STRING, G_TYPE_VALUE, G_TYPE_INVALID); diff --git a/libdbusmenu-glib/dbus-menu.xml b/libdbusmenu-glib/dbus-menu.xml index a7cceaa..4c7446d 100644 --- a/libdbusmenu-glib/dbus-menu.xml +++ b/libdbusmenu-glib/dbus-menu.xml @@ -182,7 +182,7 @@ revision item for the entries that have changed. It is zero if the whole layout should be considered invalid. --> - + diff --git a/libdbusmenu-glib/server.c b/libdbusmenu-glib/server.c index 2c040a0..e307d95 100644 --- a/libdbusmenu-glib/server.c +++ b/libdbusmenu-glib/server.c @@ -63,7 +63,7 @@ struct _DbusmenuServerPrivate enum { ID_PROP_UPDATE, ID_UPDATE, - LAYOUT_UPDATE, + LAYOUT_UPDATED, LAST_SIGNAL }; @@ -148,7 +148,7 @@ dbusmenu_server_class_init (DbusmenuServerClass *class) g_cclosure_marshal_VOID__UINT, G_TYPE_NONE, 1, G_TYPE_UINT); /** - DbusmenuServer::layout-update: + DbusmenuServer::layout-updated: @arg0: The #DbusmenuServer emitting the signal. @arg1: A revision number representing which revision the update represents itself as. @@ -157,10 +157,10 @@ dbusmenu_server_class_init (DbusmenuServerClass *class) This signal is emitted any time the layout of the menuitems under this server is changed. */ - signals[LAYOUT_UPDATE] = g_signal_new(DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATE, + signals[LAYOUT_UPDATED] = g_signal_new(DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATED, G_TYPE_FROM_CLASS(class), G_SIGNAL_RUN_LAST, - G_STRUCT_OFFSET(DbusmenuServerClass, layout_update), + G_STRUCT_OFFSET(DbusmenuServerClass, layout_updated), NULL, NULL, _dbusmenu_server_marshal_VOID__INT_UINT, G_TYPE_NONE, 2, G_TYPE_INT, G_TYPE_UINT); @@ -248,7 +248,7 @@ set_property (GObject * obj, guint id, const GValue * value, GParamSpec * pspec) g_debug("Setting root node to NULL"); } priv->layout_revision++; - g_signal_emit(obj, signals[LAYOUT_UPDATE], 0, priv->layout_revision, 0, TRUE); + g_signal_emit(obj, signals[LAYOUT_UPDATED], 0, priv->layout_revision, 0, TRUE); break; default: g_return_if_reached(); @@ -306,7 +306,7 @@ menuitem_child_added (DbusmenuMenuitem * parent, DbusmenuMenuitem * child, guint /* TODO: We probably need to group the layout update signals to make the number more reasonble. */ DbusmenuServerPrivate * priv = DBUSMENU_SERVER_GET_PRIVATE(server); priv->layout_revision++; - g_signal_emit(G_OBJECT(server), signals[LAYOUT_UPDATE], 0, priv->layout_revision, 0, TRUE); + g_signal_emit(G_OBJECT(server), signals[LAYOUT_UPDATED], 0, priv->layout_revision, 0, TRUE); return; } @@ -317,7 +317,7 @@ menuitem_child_removed (DbusmenuMenuitem * parent, DbusmenuMenuitem * child, Dbu /* TODO: We probably need to group the layout update signals to make the number more reasonble. */ DbusmenuServerPrivate * priv = DBUSMENU_SERVER_GET_PRIVATE(server); priv->layout_revision++; - g_signal_emit(G_OBJECT(server), signals[LAYOUT_UPDATE], 0, priv->layout_revision, 0, TRUE); + g_signal_emit(G_OBJECT(server), signals[LAYOUT_UPDATED], 0, priv->layout_revision, 0, TRUE); return; } @@ -326,7 +326,7 @@ menuitem_child_moved (DbusmenuMenuitem * parent, DbusmenuMenuitem * child, guint { DbusmenuServerPrivate * priv = DBUSMENU_SERVER_GET_PRIVATE(server); priv->layout_revision++; - g_signal_emit(G_OBJECT(server), signals[LAYOUT_UPDATE], 0, priv->layout_revision, 0, TRUE); + g_signal_emit(G_OBJECT(server), signals[LAYOUT_UPDATED], 0, priv->layout_revision, 0, TRUE); return; } diff --git a/libdbusmenu-glib/server.h b/libdbusmenu-glib/server.h index 566b3cf..e4d6dc7 100644 --- a/libdbusmenu-glib/server.h +++ b/libdbusmenu-glib/server.h @@ -45,7 +45,8 @@ G_BEGIN_DECLS #define DBUSMENU_SERVER_SIGNAL_ID_PROP_UPDATE "item-property-updated" #define DBUSMENU_SERVER_SIGNAL_ID_UPDATE "item-updated" -#define DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATE "layout-update" +#define DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATED "layout-updated" +#define DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATE DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATED #define DBUSMENU_SERVER_PROP_DBUS_OBJECT "dbus-object" #define DBUSMENU_SERVER_PROP_ROOT_NODE "root-node" @@ -56,7 +57,7 @@ G_BEGIN_DECLS @parent_class: #GObjectClass @id_prop_update: Slot for #DbusmenuServer::id-prop-update. @id_update: Slot for #DbusmenuServer::id-update. - @layout_update: Slot for #DbusmenuServer::layout-update. + @layout_updated: Slot for #DbusmenuServer::layout-update. @dbusmenu_server_reserved1: Reserved for future use. @dbusmenu_server_reserved2: Reserved for future use. @dbusmenu_server_reserved3: Reserved for future use. @@ -71,7 +72,7 @@ struct _DbusmenuServerClass { /* Signals */ void (*id_prop_update)(guint id, gchar * property, gchar * value); void (*id_update)(guint id); - void (*layout_update)(gint revision); + void (*layout_updated)(gint revision); /* Reserved */ void (*dbusmenu_server_reserved1)(void); -- cgit v1.2.3 From 5f42d1712e443df0032f3313e647753d4fcddbfc Mon Sep 17 00:00:00 2001 From: Aurelien Gateau Date: Mon, 1 Feb 2010 14:51:30 -0800 Subject: Use doxymel for documentation. --- libdbusmenu-glib/Doxyfile | 257 +++++++++++++++++++++++++++++++++++++++ libdbusmenu-glib/dbus-menu.xml | 268 +++++++++++++++++++++++------------------ 2 files changed, 407 insertions(+), 118 deletions(-) create mode 100644 libdbusmenu-glib/Doxyfile (limited to 'libdbusmenu-glib/dbus-menu.xml') diff --git a/libdbusmenu-glib/Doxyfile b/libdbusmenu-glib/Doxyfile new file mode 100644 index 0000000..78e8666 --- /dev/null +++ b/libdbusmenu-glib/Doxyfile @@ -0,0 +1,257 @@ +# Doxyfile 1.6.1 + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- +DOXYFILE_ENCODING = UTF-8 +PROJECT_NAME = DBusMenu +PROJECT_NUMBER = +OUTPUT_DIRECTORY = +CREATE_SUBDIRS = NO +OUTPUT_LANGUAGE = English +BRIEF_MEMBER_DESC = YES +REPEAT_BRIEF = YES +ABBREVIATE_BRIEF = +ALWAYS_DETAILED_SEC = NO +INLINE_INHERITED_MEMB = NO +FULL_PATH_NAMES = YES +STRIP_FROM_PATH = +STRIP_FROM_INC_PATH = +SHORT_NAMES = NO +JAVADOC_AUTOBRIEF = NO +QT_AUTOBRIEF = NO +MULTILINE_CPP_IS_BRIEF = NO +INHERIT_DOCS = YES +SEPARATE_MEMBER_PAGES = NO +TAB_SIZE = 8 +ALIASES = +OPTIMIZE_OUTPUT_FOR_C = NO +OPTIMIZE_OUTPUT_JAVA = NO +OPTIMIZE_FOR_FORTRAN = NO +OPTIMIZE_OUTPUT_VHDL = NO +EXTENSION_MAPPING = +BUILTIN_STL_SUPPORT = NO +CPP_CLI_SUPPORT = NO +SIP_SUPPORT = NO +IDL_PROPERTY_SUPPORT = YES +DISTRIBUTE_GROUP_DOC = NO +SUBGROUPING = YES +TYPEDEF_HIDES_STRUCT = NO +SYMBOL_CACHE_SIZE = 0 +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- +EXTRACT_ALL = NO +EXTRACT_PRIVATE = NO +EXTRACT_STATIC = NO +EXTRACT_LOCAL_CLASSES = YES +EXTRACT_LOCAL_METHODS = NO +EXTRACT_ANON_NSPACES = NO +HIDE_UNDOC_MEMBERS = NO +HIDE_UNDOC_CLASSES = NO +HIDE_FRIEND_COMPOUNDS = NO +HIDE_IN_BODY_DOCS = NO +INTERNAL_DOCS = NO +CASE_SENSE_NAMES = YES +HIDE_SCOPE_NAMES = NO +SHOW_INCLUDE_FILES = YES +INLINE_INFO = YES +SORT_MEMBER_DOCS = YES +SORT_BRIEF_DOCS = NO +SORT_MEMBERS_CTORS_1ST = NO +SORT_GROUP_NAMES = NO +SORT_BY_SCOPE_NAME = NO +GENERATE_TODOLIST = YES +GENERATE_TESTLIST = YES +GENERATE_BUGLIST = YES +GENERATE_DEPRECATEDLIST= YES +ENABLED_SECTIONS = +MAX_INITIALIZER_LINES = 30 +SHOW_USED_FILES = YES +SHOW_DIRECTORIES = NO +SHOW_FILES = YES +SHOW_NAMESPACES = YES +FILE_VERSION_FILTER = +LAYOUT_FILE = +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- +QUIET = NO +WARNINGS = YES +WARN_IF_UNDOCUMENTED = YES +WARN_IF_DOC_ERROR = YES +WARN_NO_PARAMDOC = NO +WARN_FORMAT = "$file:$line: $text" +WARN_LOGFILE = +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- +INPUT = . +INPUT_ENCODING = UTF-8 +FILE_PATTERNS = *.xml +RECURSIVE = NO +EXCLUDE = +EXCLUDE_SYMLINKS = NO +EXCLUDE_PATTERNS = +EXCLUDE_SYMBOLS = +EXAMPLE_PATH = +EXAMPLE_PATTERNS = +EXAMPLE_RECURSIVE = NO +IMAGE_PATH = +INPUT_FILTER = doxymel +FILTER_PATTERNS = *.xml=doxymel +FILTER_SOURCE_FILES = NO +#--------------------------------------------------------------------------- +# configuration options related to source browsing +#--------------------------------------------------------------------------- +SOURCE_BROWSER = NO +INLINE_SOURCES = NO +STRIP_CODE_COMMENTS = YES +REFERENCED_BY_RELATION = NO +REFERENCES_RELATION = NO +REFERENCES_LINK_SOURCE = YES +USE_HTAGS = NO +VERBATIM_HEADERS = YES +#--------------------------------------------------------------------------- +# configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- +ALPHABETICAL_INDEX = NO +COLS_IN_ALPHA_INDEX = 5 +IGNORE_PREFIX = +#--------------------------------------------------------------------------- +# configuration options related to the HTML output +#--------------------------------------------------------------------------- +GENERATE_HTML = YES +HTML_OUTPUT = html +HTML_FILE_EXTENSION = .html +HTML_HEADER = +HTML_FOOTER = +HTML_STYLESHEET = +HTML_ALIGN_MEMBERS = YES +HTML_DYNAMIC_SECTIONS = NO +GENERATE_DOCSET = NO +DOCSET_FEEDNAME = "Doxygen generated docs" +DOCSET_BUNDLE_ID = org.doxygen.Project +GENERATE_HTMLHELP = NO +CHM_FILE = +HHC_LOCATION = +GENERATE_CHI = NO +CHM_INDEX_ENCODING = +BINARY_TOC = NO +TOC_EXPAND = NO +GENERATE_QHP = NO +QCH_FILE = +QHP_NAMESPACE = +QHP_VIRTUAL_FOLDER = doc +QHP_CUST_FILTER_NAME = +QHP_CUST_FILTER_ATTRS = +QHP_SECT_FILTER_ATTRS = +QHG_LOCATION = +DISABLE_INDEX = NO +ENUM_VALUES_PER_LINE = 4 +GENERATE_TREEVIEW = NO +USE_INLINE_TREES = NO +TREEVIEW_WIDTH = 250 +FORMULA_FONTSIZE = 10 +SEARCHENGINE = YES +#--------------------------------------------------------------------------- +# configuration options related to the LaTeX output +#--------------------------------------------------------------------------- +GENERATE_LATEX = NO +LATEX_OUTPUT = latex +LATEX_CMD_NAME = latex +MAKEINDEX_CMD_NAME = makeindex +COMPACT_LATEX = NO +PAPER_TYPE = a4wide +EXTRA_PACKAGES = +LATEX_HEADER = +PDF_HYPERLINKS = YES +USE_PDFLATEX = YES +LATEX_BATCHMODE = NO +LATEX_HIDE_INDICES = NO +LATEX_SOURCE_CODE = NO +#--------------------------------------------------------------------------- +# configuration options related to the RTF output +#--------------------------------------------------------------------------- +GENERATE_RTF = NO +RTF_OUTPUT = rtf +COMPACT_RTF = NO +RTF_HYPERLINKS = NO +RTF_STYLESHEET_FILE = +RTF_EXTENSIONS_FILE = +#--------------------------------------------------------------------------- +# configuration options related to the man page output +#--------------------------------------------------------------------------- +GENERATE_MAN = NO +MAN_OUTPUT = man +MAN_EXTENSION = .3 +MAN_LINKS = NO +#--------------------------------------------------------------------------- +# configuration options related to the XML output +#--------------------------------------------------------------------------- +GENERATE_XML = NO +XML_OUTPUT = xml +XML_SCHEMA = +XML_DTD = +XML_PROGRAMLISTING = YES +#--------------------------------------------------------------------------- +# configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- +GENERATE_AUTOGEN_DEF = NO +#--------------------------------------------------------------------------- +# configuration options related to the Perl module output +#--------------------------------------------------------------------------- +GENERATE_PERLMOD = NO +PERLMOD_LATEX = NO +PERLMOD_PRETTY = YES +PERLMOD_MAKEVAR_PREFIX = +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- +ENABLE_PREPROCESSING = YES +MACRO_EXPANSION = NO +EXPAND_ONLY_PREDEF = NO +SEARCH_INCLUDES = YES +INCLUDE_PATH = +INCLUDE_FILE_PATTERNS = +PREDEFINED = +EXPAND_AS_DEFINED = +SKIP_FUNCTION_MACROS = YES +#--------------------------------------------------------------------------- +# Configuration::additions related to external references +#--------------------------------------------------------------------------- +TAGFILES = +GENERATE_TAGFILE = +ALLEXTERNALS = NO +EXTERNAL_GROUPS = YES +PERL_PATH = /usr/bin/perl +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- +CLASS_DIAGRAMS = YES +MSCGEN_PATH = +HIDE_UNDOC_RELATIONS = YES +HAVE_DOT = NO +DOT_FONTNAME = FreeSans +DOT_FONTSIZE = 10 +DOT_FONTPATH = +CLASS_GRAPH = YES +COLLABORATION_GRAPH = YES +GROUP_GRAPHS = YES +UML_LOOK = NO +TEMPLATE_RELATIONS = NO +INCLUDE_GRAPH = YES +INCLUDED_BY_GRAPH = YES +CALL_GRAPH = NO +CALLER_GRAPH = NO +GRAPHICAL_HIERARCHY = YES +DIRECTORY_GRAPH = YES +DOT_IMAGE_FORMAT = png +DOT_PATH = +DOTFILE_DIRS = +DOT_GRAPH_MAX_NODES = 50 +MAX_DOT_GRAPH_DEPTH = 0 +DOT_TRANSPARENT = NO +DOT_MULTI_TARGETS = YES +GENERATE_LEGEND = YES +DOT_CLEANUP = YES diff --git a/libdbusmenu-glib/dbus-menu.xml b/libdbusmenu-glib/dbus-menu.xml index 866969e..692158e 100644 --- a/libdbusmenu-glib/dbus-menu.xml +++ b/libdbusmenu-glib/dbus-menu.xml @@ -27,65 +27,107 @@ 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 --> - + + -" + + @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--" + ]]> - - + + + Provides the version of the DBusmenu API that this API is + implementing. + + - - - - + # Root container + # First level menu, for example "File" + ~ Second level menu, for example "Open" + + ... + + # Another first level menu, say "Edit" + ... + + ... + + @endverbatim + ]]> + + The ID of the parent node for the layout. For + grabbing the layout from the root node use zero. + + + The revision number of the layout. For matching + with layoutUpdated signals. + + + The layout as an XML string of IDs. + - - - - + + 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. + + + + + 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. + + + + + 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 + + @@ -94,99 +136,89 @@ An item is represented as a struct following this format: - - + + Returns multiple properties in one call. This is more efficient than + GetProperty. + + - - + + The item whose properties we want to retrieve. + + + List of string name of the properties we want. If the list contains no entries, all properties are sent. + - - - - - + -" + ]]> + + 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 + - + + Triggered by the application to notify the applet that the property @a property + from item @a id has changed to @a value. + - - + + Triggered by the application to notify the applet that all properties of item + + + id which should be considered outdated + - - - - + + + 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. + + -- cgit v1.2.3 From 8ed4357299fc74f5299d6fb74d2d8439f6ac4b0a Mon Sep 17 00:00:00 2001 From: Aurelien Gateau Date: Mon, 1 Feb 2010 15:15:28 -0800 Subject: Nicer verbatim output --- libdbusmenu-glib/dbus-menu.xml | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) (limited to 'libdbusmenu-glib/dbus-menu.xml') diff --git a/libdbusmenu-glib/dbus-menu.xml b/libdbusmenu-glib/dbus-menu.xml index 692158e..07a3827 100644 --- a/libdbusmenu-glib/dbus-menu.xml +++ b/libdbusmenu-glib/dbus-menu.xml @@ -76,17 +76,17 @@ License version 3 and version 2.1 along with this program. If not, see XML syntax: @verbatim - # Root container - # First level menu, for example "File" - ~ Second level menu, for example "Open" - - ... - - # Another first level menu, say "Edit" - ... - - ... - + # Root container + # First level menu, for example "File" + ~ Second level menu, for example "Open" + + ... + + # Another first level menu, say "Edit" + ... + + ... + @endverbatim ]]> -- cgit v1.2.3 From e69b32de65e1ff5ce0ac8b43c1f22dec909ea9b7 Mon Sep 17 00:00:00 2001 From: Aurelien Gateau Date: Mon, 1 Feb 2010 16:03:31 -0800 Subject: - Make menu item id an integer (useful to indicate bad id as -1) - Merged with the other spec --- libdbusmenu-glib/dbus-menu.xml | 46 ++++++++++++++++++++++-------------------- 1 file changed, 24 insertions(+), 22 deletions(-) (limited to 'libdbusmenu-glib/dbus-menu.xml') diff --git a/libdbusmenu-glib/dbus-menu.xml b/libdbusmenu-glib/dbus-menu.xml index 07a3827..77374eb 100644 --- a/libdbusmenu-glib/dbus-menu.xml +++ b/libdbusmenu-glib/dbus-menu.xml @@ -39,22 +39,24 @@ 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 - - @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 + - @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 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 standard: An item which can be clicked to trigger an action - @c separator: A separator - - @c menu: An item which contains more items Vendor specific types can be added by prefixing them with "x--" ]]> @@ -89,7 +91,7 @@ License version 3 and version 2.1 along with this program. If not, see @endverbatim ]]> - + The ID of the parent node for the layout. For grabbing the layout from the root node use zero. @@ -106,7 +108,7 @@ License version 3 and version 2.1 along with this program. If not, see 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. @@ -119,7 +121,7 @@ License version 3 and version 2.1 along with this program. If not, see the properties will be sent. - + An array of property values. An item in this area is represented as a struct following @@ -131,13 +133,13 @@ License version 3 and version 2.1 along with this program. If not, see - + - + - + @@ -149,7 +151,7 @@ License version 3 and version 2.1 along with this program. If not, see - + The item whose properties we want to retrieve. @@ -170,7 +172,7 @@ License version 3 and version 2.1 along with this program. If not, see Vendor specific events can be added by prefixing them with "x--" ]]> - + the id of the item which received the event @@ -190,7 +192,7 @@ License version 3 and version 2.1 along with this program. If not, see Triggered by the application to notify the applet that the property @a property from item @a id has changed to @a value. - + @@ -199,7 +201,7 @@ License version 3 and version 2.1 along with this program. If not, see Triggered by the application to notify the applet that all properties of item - + id which should be considered outdated @@ -209,10 +211,10 @@ License version 3 and version 2.1 along with this program. If not, see 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 -- cgit v1.2.3 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(-) (limited to 'libdbusmenu-glib/dbus-menu.xml') 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 From 8939f05fde72c41d8f65c09a423702245c8c77a4 Mon Sep 17 00:00:00 2001 From: Aurelien Gateau Date: Mon, 1 Feb 2010 16:49:47 -0800 Subject: Misc fixes --- libdbusmenu-glib/dbus-menu.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'libdbusmenu-glib/dbus-menu.xml') diff --git a/libdbusmenu-glib/dbus-menu.xml b/libdbusmenu-glib/dbus-menu.xml index b795f9c..53b0d4c 100644 --- a/libdbusmenu-glib/dbus-menu.xml +++ b/libdbusmenu-glib/dbus-menu.xml @@ -188,7 +188,7 @@ License version 3 and version 2.1 along with this program. If not, see - list of string the list of item properties we are + The list of item properties we are interested in. If there are no entries in the list all of the properties will be sent. @@ -278,7 +278,7 @@ License version 3 and version 2.1 along with this program. If not, see - + Triggered by the application to notify display of a layout update, up to revision -- cgit v1.2.3 From 83f5fe3159641096711337b3d903e80e83b7f547 Mon Sep 17 00:00:00 2001 From: Aurelien Gateau Date: Mon, 1 Feb 2010 17:44:14 -0800 Subject: - Annotations necessary for the Qt side. - Other minor tweaks. --- libdbusmenu-glib/dbus-menu.xml | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) (limited to 'libdbusmenu-glib/dbus-menu.xml') diff --git a/libdbusmenu-glib/dbus-menu.xml b/libdbusmenu-glib/dbus-menu.xml index 53b0d4c..121725e 100644 --- a/libdbusmenu-glib/dbus-menu.xml +++ b/libdbusmenu-glib/dbus-menu.xml @@ -8,6 +8,7 @@ Copyright 2009 Canonical Ltd. Authors: Ted Gould + Aurelien Gateau This program is free software: you can redistribute it and/or modify it under the terms of either or both of the following licenses: @@ -177,10 +178,12 @@ License version 3 and version 2.1 along with this program. If not, see + + 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. @@ -205,6 +208,7 @@ License version 3 and version 2.1 along with this program. If not, see + -- cgit v1.2.3