diff options
| -rw-r--r-- | libdbusmenu-glib/Doxyfile | 257 | ||||
| -rw-r--r-- | libdbusmenu-glib/dbus-menu.xml | 268 |
2 files changed, 407 insertions, 118 deletions
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 <http://www.gnu.org/licenses/> --> -<node name="/"> +<node name="/" xmlns:dox="http://www.ayatana.org/dbus/dox.dtd"> <interface name="org.ayatana.dbusmenu"> + <dox:d><![CDATA[ + The goal of this DBus interface is to be able to pass menu items + through DBus. + + Items are represented with a unique numeric id and a dictionary of + properties. + + 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 + + Vendor specific properties can be added by prefixing them with "x-<vendor>-" + + @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-<vendor>-" + ]]></dox:d> <!-- Properties --> -<!-- -Provides the version of the DBusmenu API that this API is -implementing. ---> - <property name="version" type="u" access="read"/> + <property name="version" type="u" access="read"> + <dox:d> + Provides the version of the DBusmenu API that this API is + implementing. + </dox:d> + </property> <!-- Functions --> -<!-- -Provides an XML representation of the menu hierarchy - -@param parentId The ID of the parent node for the layout. For - grabbing the layout from the root node use zero. -@param revision The revision number of the layout. For matching - with layoutUpdated signals. -@param layout The layout as an XML string of IDs. - -XML syntax: - -<menu id="1"> # Root container - <menu id="2"> # First level menu, for example "File" - <menu id="3"/> ~ Second level menu, for example "Open" - <menu id="4"/> - ... - </menu> - <menu id="5"> # Another first level menu, say "Edit" - ... - </menu> - ... -</menu> ---> <method name="GetLayout"> - <arg type="u" name="parentId" direction="in" /> - <arg type="u" name="revision" direction="out" /> - <arg type="s" name="layout" direction="out" /> + <dox:d><![CDATA[ + Provides an XML representation of the menu hierarchy + + XML syntax: + + @verbatim + <menu id="1" revision="2"> # Root container + <menu id="2" revision="2"> # First level menu, for example "File" + <menu id="3" revision="2"/> ~ Second level menu, for example "Open" + <menu id="4" revision="3"/> + ... + </menu> + <menu id="5" revision="2"> # Another first level menu, say "Edit" + ... + </menu> + ... + </menu> + @endverbatim + ]]></dox:d> + <arg type="u" 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="u" name="revision" direction="out"> + <dox:d>The revision number of the layout. For matching + with layoutUpdated signals.</dox:d> + </arg> + <arg type="s" name="layout" direction="out"> + <dox:d>The layout as an XML string of IDs.</dox:d> + </arg> </method> -<!-- -Returns the list of items which are children of @a parentId. - -@param Ids A list of ids that we should be finding the properties - on. If the list is empty, all menu items should be sent. -@param propertyNames 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 item is represented as a struct following this format: -@li id unsigned the item id -@li properties map(string => variant) the requested item properties - ---> <method name="GetGroupProperties"> - <arg type="au" name="Ids" direction="in" /> - <arg type="as" name="propertyNames" direction="in" /> - <arg type="a(ua{sv})" name="properties" direction="out" /> + <dox:d> + Returns the list of items which are children of @a parentId. + </dox:d> + <arg type="au" name="Ids" direction="in" > + <dox:d> + A list of ids that we should be finding the properties + on. If the list is empty, all menu items should be sent. + </dox:d> + </arg> + <arg type="as" name="propertyNames" direction="in" > + <dox:d> + 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. + </dox:d> + </arg> + <arg type="a(ua{sv})" name="properties" direction="out" > + <dox:d> + 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 + </dox:d> + </arg> </method> <method name="GetChildren"> @@ -94,99 +136,89 @@ An item is represented as a struct following this format: <arg type="a(ua{sv})" name="properties" direction="out" /> </method> -<!-- -Each menu item has a set of properties. Property keys are in menuitem.h: - -@li type string Type of the item (see below) -@li label string Text of the item -@li icon-data binary Raw data of the icon (TODO: define format) -@li icon string Icon name of the item, following icon spec -@li sensitive boolean Whether the item can be activated or not -@li visible boolean Whether the item is visible or not (XXX: Is this necessary?) -@li checked boolean Whether a checkbox or radio item is checked -@li shortcut string The keyboard shortcut - -@c type property is an enum which can take the following values (client.h): - -@li action An item which can be clicked to trigger an action -@li checkbox An item which can be checked or unchecked -@li radio An item which can be checked or unchecked as part of a group -@li separator A separator -@li menu An item which contains more items ---> <method name="GetProperty"> <arg type="u" name="id" direction="in" /> <arg type="s" name="name" direction="in" /> <arg type="v" name="value" direction="out" /> </method> -<!-- -Returns multiple properties in one call. This is more efficient than -GetProperty. - -@param id unsigned the item whose properties we want to retrieve. -@param propertyNames list of string name of the properties we want. If the list contains no entries, all properties are sent. ---> <method name="GetProperties"> + <dox:d> + Returns multiple properties in one call. This is more efficient than + GetProperty. + + </dox:d> <annotation name="com.trolltech.QtDBus.QtTypeName.Out0" value="QVariantMap"/> - <arg type="u" name="id" direction="in" /> - <arg type="as" name="propertyNames" direction="in" /> + <arg type="u" name="id" direction="in" > + <dox:d>The item whose properties we want to retrieve.</dox:d> + </arg> + <arg type="as" name="propertyNames" direction="in" > + <dox:d>List of string name of the properties we want. If the list contains no entries, all properties are sent.</dox:d> + </arg> <arg type="a{sv}" name="properties" direction="out" /> </method> -<!-- -This is called by the applet to notify the application an event happened on a -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: - -@li "clicked" -@li "hovered" - -Vendor specific events can be added by prefixing them with "x-<vendor>-" ---> <method name="Event"> - <arg type="u" name="id" direction="in" /> - <arg type="s" name="eventId" direction="in" /> - <arg type="v" name="data" direction="in" /> - <arg type="u" name="timestamp" direction="in" /> + <dox:d><![CDATA[ + This is called by the applet to notify the application an event happened on a + menu item. + + @a type can be one of the following: + + @li "clicked" + @li "hovered" + + Vendor specific events can be added by prefixing them with "x-<vendor>-" + ]]></dox:d> + <arg type="u" name="id" direction="in" > + <dox:d>the id of the item which received the event</dox:d> + </arg> + <arg type="s" name="eventId" direction="in" > + <dox:d>the type of event</dox:d> + </arg> + <arg type="v" name="data" direction="in" > + <dox:d>event-specific data</dox:d> + </arg> + <arg type="u" name="timestamp" direction="in" > + <dox:d>The time that the event occured if available or the time the message was sent if not</dox:d> + </arg> </method> <!-- Signals --> -<!-- -Triggered by the application to notify the applet that the property @a property -from item @a id has changed to @a value. ---> <signal name="ItemPropertyUpdated"> + <dox:d> + Triggered by the application to notify the applet that the property @a property + from item @a id has changed to @a value. + </dox:d> <arg type="u" name="id" direction="out" /> <arg type="s" name="prop" direction="out" /> <arg type="v" name="value" direction="out" /> </signal> -<!-- -Triggered by the application to notify the applet that all properties of item -@a id should be considered outdated ---> <signal name="ItemUpdated"> - <arg type="u" name="id" direction="out" /> + <dox:d> + Triggered by the application to notify the applet that all properties of item + </dox:d> + <arg type="u" name="id" direction="out" > + <dox:d>id which should be considered outdated</dox:d> + </arg> </signal> -<!-- -Triggered by the application to notify display of a layout update, up to -revision -@param revsion The revision of the layout that we're currently on -@param parent 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. ---> - <signal name="LayoutUpdated"> - <arg type="i" name="revision" direction="out" /> - <arg type="u" name="parent" direction="out" /> + <signal name="LayoutUpdate"> + <dox:d> + Triggered by the application to notify display of a layout update, up to + revision + </dox:d> + <arg type="i" name="revision" direction="out" > + <dox:d>The revision of the layout that we're currently on</dox:d> + </arg> + <arg type="u" name="parent" direction="out" > + <dox:d> + 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. + </dox:d> + </arg> </signal> <!-- End of interesting stuff --> |