=== modified file 'ChangeLog' --- ChangeLog 2012-04-11 16:52:59 +0000 +++ ChangeLog 2012-06-13 19:49:21 +0000 @@ -1,5 +1,37 @@ # Generated by Makefile. Do not edit. +2012-06-13 Ted Gould + + 0.6.2 + +2012-06-07 Ted Gould + + Escape the text we are using for markup + +2012-06-07 Ted Gould + + Making the headers match independent of build directory + +2012-04-11 Charles Kerr + + merge lp:~ted/dbusmenu/double-underscore to fix the double underscore regression introduced earlier. + +2012-04-11 Ted Gould + + No reason to bother with that in the global namespace + +2012-04-11 Ted Gould + + Provide a function to sanitize the label and use that as Pango isn't doing it for us now + +2012-04-11 Ted Gould + + Oops, get the real trunk + +2012-04-11 Ted Gould + + Attaching bug + 2012-04-11 Charles Kerr 0.6.1 === modified file 'configure' --- configure 2012-04-11 16:54:01 +0000 +++ configure 2012-06-13 19:49:21 +0000 @@ -1,6 +1,6 @@ #! /bin/sh # Guess values for system-dependent variables and create Makefiles. -# Generated by GNU Autoconf 2.68 for libdbusmenu 0.6.1. +# Generated by GNU Autoconf 2.68 for libdbusmenu 0.6.2. # # Report bugs to . # @@ -572,8 +572,8 @@ # Identity of this package. PACKAGE_NAME='libdbusmenu' PACKAGE_TARNAME='libdbusmenu' -PACKAGE_VERSION='0.6.1' -PACKAGE_STRING='libdbusmenu 0.6.1' +PACKAGE_VERSION='0.6.2' +PACKAGE_STRING='libdbusmenu 0.6.2' PACKAGE_BUGREPORT='ted@canonical.com' PACKAGE_URL='' @@ -1454,7 +1454,7 @@ # Omit some internal or obsolete options to make the list less imposing. # This message is too long to be a string in the A/UX 3.1 sh. cat <<_ACEOF -\`configure' configures libdbusmenu 0.6.1 to adapt to many kinds of systems. +\`configure' configures libdbusmenu 0.6.2 to adapt to many kinds of systems. Usage: $0 [OPTION]... [VAR=VALUE]... @@ -1524,7 +1524,7 @@ if test -n "$ac_init_help"; then case $ac_init_help in - short | recursive ) echo "Configuration of libdbusmenu 0.6.1:";; + short | recursive ) echo "Configuration of libdbusmenu 0.6.2:";; esac cat <<\_ACEOF @@ -1679,7 +1679,7 @@ test -n "$ac_init_help" && exit $ac_status if $ac_init_version; then cat <<\_ACEOF -libdbusmenu configure 0.6.1 +libdbusmenu configure 0.6.2 generated by GNU Autoconf 2.68 Copyright (C) 2010 Free Software Foundation, Inc. @@ -2050,7 +2050,7 @@ This file contains any messages produced by compilers while running configure, to aid debugging if configure makes a mistake. -It was created by libdbusmenu $as_me 0.6.1, which was +It was created by libdbusmenu $as_me 0.6.2, which was generated by GNU Autoconf 2.68. Invocation command line was $ $0 $@ @@ -2871,7 +2871,7 @@ # Define the identity of the package. PACKAGE=libdbusmenu - VERSION=0.6.1 + VERSION=0.6.2 # Some tools Automake needs. @@ -14544,7 +14544,7 @@ ########################### LIBDBUSMENU_CURRENT=4 -LIBDBUSMENU_REVISION=12 +LIBDBUSMENU_REVISION=13 LIBDBUSMENU_AGE=0 @@ -16183,7 +16183,7 @@ # report actual input values of CONFIG_FILES etc. instead of their # values after options handling. ac_log=" -This file was extended by libdbusmenu $as_me 0.6.1, which was +This file was extended by libdbusmenu $as_me 0.6.2, which was generated by GNU Autoconf 2.68. Invocation command line was CONFIG_FILES = $CONFIG_FILES @@ -16249,7 +16249,7 @@ cat >>$CONFIG_STATUS <<_ACEOF || ac_write_fail=1 ac_cs_config="`$as_echo "$ac_configure_args" | sed 's/^ //; s/[\\""\`\$]/\\\\&/g'`" ac_cs_version="\\ -libdbusmenu config.status 0.6.1 +libdbusmenu config.status 0.6.2 configured by $0, generated by GNU Autoconf 2.68, with options \\"\$ac_cs_config\\" === modified file 'configure.ac' --- configure.ac 2012-04-11 16:54:01 +0000 +++ configure.ac 2012-06-13 19:49:21 +0000 @@ -1,11 +1,11 @@ -AC_INIT(libdbusmenu, 0.6.1, ted@canonical.com) +AC_INIT(libdbusmenu, 0.6.2, ted@canonical.com) AC_COPYRIGHT([Copyright 2009,2010 Canonical]) AC_PREREQ(2.62) AM_CONFIG_HEADER(config.h) -AM_INIT_AUTOMAKE(libdbusmenu, 0.6.1, [-Wno-portability]) +AM_INIT_AUTOMAKE(libdbusmenu, 0.6.2, [-Wno-portability]) AM_MAINTAINER_MODE @@ -166,7 +166,7 @@ ########################### LIBDBUSMENU_CURRENT=4 -LIBDBUSMENU_REVISION=12 +LIBDBUSMENU_REVISION=13 LIBDBUSMENU_AGE=0 AC_SUBST(LIBDBUSMENU_CURRENT) === modified file 'debian/changelog' --- debian/changelog 2012-04-16 19:38:16 +0000 +++ debian/changelog 2012-06-13 19:49:21 +0000 @@ -1,3 +1,13 @@ +libdbusmenu (0.6.2-0ubuntu1~ppa1) precise; urgency=low + + * New upstream release. + * Fixed duplicated underscores in menus (LP: #979301) + * Fix for keybindings not showing in menus bug (LP: #982656) + * DbusmenuServer leaks private string (LP: #981766) + * Ensure menuitems with '&' show them properly (LP: #994564) + + -- Ted Gould Wed, 13 Jun 2012 14:44:52 -0500 + libdbusmenu (0.6.1-0ubuntu3) precise-proposed; urgency=low * Backport fix for keybindings not showing in menus bug (lp: #982656) === added file 'docs/libdbusmenu-glib/reference/html/annotation-glossary.html' --- docs/libdbusmenu-glib/reference/html/annotation-glossary.html 1970-01-01 00:00:00 +0000 +++ docs/libdbusmenu-glib/reference/html/annotation-glossary.html 2012-06-13 19:49:21 +0000 @@ -0,0 +1,83 @@ + + + + +Annotation Glossary + + + + + + + + + + + + + + + + + + +
+

+Annotation Glossary

+

A

+
+allow-none
+

NULL is ok, both for passing and for returning.

+

C

+
+closure
+

This parameter is a 'user_data', for callbacks; many bindings can pass NULL here.

+

T

+
+transfer none
+

Don't free data after the code is done.

+

A

+
+array
+

Parameter points to an array of items.

+

E

+
+element-type
+

Generics and defining elements of containers and arrays.

+

I

+
+in
+

Parameter for input. Default is transfer none.

+

T

+
+transfer container
+

Free data container after the code is done.

+
+transfer full
+

Free data after the code is done.

+

S

+
+scope notified
+

The callback is valid until the GDestroyNotify argument is called.

+
+ + + \ No newline at end of file === added file 'docs/libdbusmenu-glib/reference/html/api-index-deprecated.html' --- docs/libdbusmenu-glib/reference/html/api-index-deprecated.html 1970-01-01 00:00:00 +0000 +++ docs/libdbusmenu-glib/reference/html/api-index-deprecated.html 2012-06-13 19:49:21 +0000 @@ -0,0 +1,31 @@ + + + + +Deprecated API Index + + + + + + + + + + + + + + + + +
+

+Deprecated API Index

+ +
+ + + \ No newline at end of file === added file 'docs/libdbusmenu-glib/reference/html/api-index-full.html' --- docs/libdbusmenu-glib/reference/html/api-index-full.html 1970-01-01 00:00:00 +0000 +++ docs/libdbusmenu-glib/reference/html/api-index-full.html 2012-06-13 19:49:21 +0000 @@ -0,0 +1,593 @@ + + + + +API Index + + + + + + + + + + + + + + + + + + + +
+

+API Index

+

C

+
+DbusmenuClient, struct in DbusmenuClient +
+
+
+DbusmenuClientClass, struct in DbusmenuClient +
+
+
+DbusmenuClientTypeHandler, user_function in DbusmenuClient +
+
+
+dbusmenu_client_add_type_handler, function in DbusmenuClient +
+
+
+dbusmenu_client_add_type_handler_full, function in DbusmenuClient +
+
+
+dbusmenu_client_get_icon_paths, function in DbusmenuClient +
+
+
+dbusmenu_client_get_root, function in DbusmenuClient +
+
+
+dbusmenu_client_get_status, function in DbusmenuClient +
+
+
+dbusmenu_client_get_text_direction, function in DbusmenuClient +
+
+
+dbusmenu_client_new, function in DbusmenuClient +
+
+
+DBUSMENU_CLIENT_PROP_DBUS_NAME, macro in DbusmenuClient +
+
+
+DBUSMENU_CLIENT_PROP_DBUS_OBJECT, macro in DbusmenuClient +
+
+
+DBUSMENU_CLIENT_PROP_GROUP_EVENTS, macro in DbusmenuClient +
+
+
+DBUSMENU_CLIENT_PROP_STATUS, macro in DbusmenuClient +
+
+
+DBUSMENU_CLIENT_PROP_TEXT_DIRECTION, macro in DbusmenuClient +
+
+
+DBUSMENU_CLIENT_SIGNAL_EVENT_RESULT, macro in DbusmenuClient +
+
+
+DBUSMENU_CLIENT_SIGNAL_ICON_THEME_DIRS_CHANGED, macro in DbusmenuClient +
+
+
+DBUSMENU_CLIENT_SIGNAL_ITEM_ACTIVATE, macro in DbusmenuClient +
+
+
+DBUSMENU_CLIENT_SIGNAL_LAYOUT_UPDATED, macro in DbusmenuClient +
+
+
+DBUSMENU_CLIENT_SIGNAL_NEW_MENUITEM, macro in DbusmenuClient +
+
+
+DBUSMENU_CLIENT_SIGNAL_ROOT_CHANGED, macro in DbusmenuClient +
+
+
+DBUSMENU_CLIENT_TYPES_DEFAULT, macro in DbusmenuClient +
+
+
+DBUSMENU_CLIENT_TYPES_IMAGE, macro in DbusmenuClient +
+
+
+DBUSMENU_CLIENT_TYPES_SEPARATOR, macro in DbusmenuClient +
+
+

M

+
+DbusmenuMenuitem, struct in DbusmenuMenuitem +
+
+
+DbusmenuMenuitemClass, struct in DbusmenuMenuitem +
+
+
+DbusmenuMenuitemProxy, struct in DbusmenuMenuitemProxy +
+
+
+DbusmenuMenuitemProxyClass, struct in DbusmenuMenuitemProxy +
+
+
+dbusmenu_menuitem_about_to_show_cb, user_function in DbusmenuMenuitem +
+
+
+dbusmenu_menuitem_buildvariant_slot_t, user_function in DbusmenuMenuitem +
+
+
+dbusmenu_menuitem_child_add_position, function in DbusmenuMenuitem +
+
+
+dbusmenu_menuitem_child_append, function in DbusmenuMenuitem +
+
+
+dbusmenu_menuitem_child_delete, function in DbusmenuMenuitem +
+
+
+DBUSMENU_MENUITEM_CHILD_DISPLAY_SUBMENU, macro in DbusmenuMenuitem +
+
+
+dbusmenu_menuitem_child_find, function in DbusmenuMenuitem +
+
+
+dbusmenu_menuitem_child_prepend, function in DbusmenuMenuitem +
+
+
+dbusmenu_menuitem_child_reorder, function in DbusmenuMenuitem +
+
+
+DBUSMENU_MENUITEM_DISPOSITION_ALERT, macro in DbusmenuMenuitem +
+
+
+DBUSMENU_MENUITEM_DISPOSITION_INFORMATIVE, macro in DbusmenuMenuitem +
+
+
+DBUSMENU_MENUITEM_DISPOSITION_NORMAL, macro in DbusmenuMenuitem +
+
+
+DBUSMENU_MENUITEM_DISPOSITION_WARNING, macro in DbusmenuMenuitem +
+
+
+DBUSMENU_MENUITEM_EVENT_ACTIVATED, macro in DbusmenuMenuitem +
+
+
+DBUSMENU_MENUITEM_EVENT_CLOSED, macro in DbusmenuMenuitem +
+
+
+DBUSMENU_MENUITEM_EVENT_OPENED, macro in DbusmenuMenuitem +
+
+
+dbusmenu_menuitem_find_id, function in DbusmenuMenuitem +
+
+
+dbusmenu_menuitem_foreach, function in DbusmenuMenuitem +
+
+
+dbusmenu_menuitem_get_children, function in DbusmenuMenuitem +
+
+
+dbusmenu_menuitem_get_id, function in DbusmenuMenuitem +
+
+
+dbusmenu_menuitem_get_parent, function in DbusmenuMenuitem +
+
+
+dbusmenu_menuitem_get_position, function in DbusmenuMenuitem +
+
+
+dbusmenu_menuitem_get_position_realized, function in DbusmenuMenuitem +
+
+
+dbusmenu_menuitem_get_root, function in DbusmenuMenuitem +
+
+
+dbusmenu_menuitem_handle_event, function in DbusmenuMenuitem +
+
+
+DBUSMENU_MENUITEM_ICON_NAME_BLANK, macro in DbusmenuMenuitem +
+
+
+dbusmenu_menuitem_new, function in DbusmenuMenuitem +
+
+
+dbusmenu_menuitem_new_with_id, function in DbusmenuMenuitem +
+
+
+dbusmenu_menuitem_properties_copy, function in DbusmenuMenuitem +
+
+
+dbusmenu_menuitem_properties_list, function in DbusmenuMenuitem +
+
+
+dbusmenu_menuitem_property_exist, function in DbusmenuMenuitem +
+
+
+dbusmenu_menuitem_property_get, function in DbusmenuMenuitem +
+
+
+dbusmenu_menuitem_property_get_bool, function in DbusmenuMenuitem +
+
+
+dbusmenu_menuitem_property_get_byte_array, function in DbusmenuMenuitem +
+
+
+dbusmenu_menuitem_property_get_int, function in DbusmenuMenuitem +
+
+
+dbusmenu_menuitem_property_get_variant, function in DbusmenuMenuitem +
+
+
+dbusmenu_menuitem_property_remove, function in DbusmenuMenuitem +
+
+
+dbusmenu_menuitem_property_set, function in DbusmenuMenuitem +
+
+
+dbusmenu_menuitem_property_set_bool, function in DbusmenuMenuitem +
+
+
+dbusmenu_menuitem_property_set_byte_array, function in DbusmenuMenuitem +
+
+
+dbusmenu_menuitem_property_set_int, function in DbusmenuMenuitem +
+
+
+dbusmenu_menuitem_property_set_variant, function in DbusmenuMenuitem +
+
+
+DBUSMENU_MENUITEM_PROP_ACCESSIBLE_DESC, macro in DbusmenuMenuitem +
+
+
+DBUSMENU_MENUITEM_PROP_CHILD_DISPLAY, macro in DbusmenuMenuitem +
+
+
+DBUSMENU_MENUITEM_PROP_DISPOSITION, macro in DbusmenuMenuitem +
+
+
+DBUSMENU_MENUITEM_PROP_ENABLED, macro in DbusmenuMenuitem +
+
+
+DBUSMENU_MENUITEM_PROP_ICON_DATA, macro in DbusmenuMenuitem +
+
+
+DBUSMENU_MENUITEM_PROP_ICON_NAME, macro in DbusmenuMenuitem +
+
+
+DBUSMENU_MENUITEM_PROP_LABEL, macro in DbusmenuMenuitem +
+
+
+DBUSMENU_MENUITEM_PROP_SHORTCUT, macro in DbusmenuMenuitem +
+
+
+DBUSMENU_MENUITEM_PROP_TOGGLE_STATE, macro in DbusmenuMenuitem +
+
+
+DBUSMENU_MENUITEM_PROP_TOGGLE_TYPE, macro in DbusmenuMenuitem +
+
+
+DBUSMENU_MENUITEM_PROP_TYPE, macro in DbusmenuMenuitem +
+
+
+DBUSMENU_MENUITEM_PROP_VISIBLE, macro in DbusmenuMenuitem +
+
+
+dbusmenu_menuitem_proxy_get_wrapped, function in DbusmenuMenuitemProxy +
+
+
+dbusmenu_menuitem_proxy_new, function in DbusmenuMenuitemProxy +
+
+
+dbusmenu_menuitem_send_about_to_show, function in DbusmenuMenuitem +
+
+
+dbusmenu_menuitem_set_parent, function in DbusmenuMenuitem +
+
+
+dbusmenu_menuitem_set_root, function in DbusmenuMenuitem +
+
+
+DBUSMENU_MENUITEM_SHORTCUT_ALT, macro in DbusmenuMenuitem +
+
+
+DBUSMENU_MENUITEM_SHORTCUT_CONTROL, macro in DbusmenuMenuitem +
+
+
+DBUSMENU_MENUITEM_SHORTCUT_SHIFT, macro in DbusmenuMenuitem +
+
+
+DBUSMENU_MENUITEM_SHORTCUT_SUPER, macro in DbusmenuMenuitem +
+
+
+dbusmenu_menuitem_show_to_user, function in DbusmenuMenuitem +
+
+
+DBUSMENU_MENUITEM_SIGNAL_ABOUT_TO_SHOW, macro in DbusmenuMenuitem +
+
+
+DBUSMENU_MENUITEM_SIGNAL_CHILD_ADDED, macro in DbusmenuMenuitem +
+
+
+DBUSMENU_MENUITEM_SIGNAL_CHILD_MOVED, macro in DbusmenuMenuitem +
+
+
+DBUSMENU_MENUITEM_SIGNAL_CHILD_REMOVED, macro in DbusmenuMenuitem +
+
+
+DBUSMENU_MENUITEM_SIGNAL_EVENT, macro in DbusmenuMenuitem +
+
+
+DBUSMENU_MENUITEM_SIGNAL_ITEM_ACTIVATED, macro in DbusmenuMenuitem +
+
+
+DBUSMENU_MENUITEM_SIGNAL_PROPERTY_CHANGED, macro in DbusmenuMenuitem +
+
+
+DBUSMENU_MENUITEM_SIGNAL_REALIZED, macro in DbusmenuMenuitem +
+
+
+DBUSMENU_MENUITEM_SIGNAL_REALIZED_ID, macro in DbusmenuMenuitem +
+
+
+DBUSMENU_MENUITEM_SIGNAL_SHOW_TO_USER, macro in DbusmenuMenuitem +
+
+
+dbusmenu_menuitem_take_children, function in DbusmenuMenuitem +
+
+
+DBUSMENU_MENUITEM_TOGGLE_CHECK, macro in DbusmenuMenuitem +
+
+
+DBUSMENU_MENUITEM_TOGGLE_RADIO, macro in DbusmenuMenuitem +
+
+
+DBUSMENU_MENUITEM_TOGGLE_STATE_CHECKED, macro in DbusmenuMenuitem +
+
+
+DBUSMENU_MENUITEM_TOGGLE_STATE_UNCHECKED, macro in DbusmenuMenuitem +
+
+
+DBUSMENU_MENUITEM_TOGGLE_STATE_UNKNOWN, macro in DbusmenuMenuitem +
+
+
+dbusmenu_menuitem_unparent, function in DbusmenuMenuitem +
+
+

S

+
+DbusmenuServer, struct in DbusmenuServer +
+
+
+DbusmenuServerClass, struct in DbusmenuServer +
+
+
+dbusmenu_server_get_status, function in DbusmenuServer +
+
+
+dbusmenu_server_get_text_direction, function in DbusmenuServer +
+
+
+dbusmenu_server_new, function in DbusmenuServer +
+
+
+DBUSMENU_SERVER_PROP_DBUS_OBJECT, macro in DbusmenuServer +
+
+
+DBUSMENU_SERVER_PROP_ROOT_NODE, macro in DbusmenuServer +
+
+
+DBUSMENU_SERVER_PROP_STATUS, macro in DbusmenuServer +
+
+
+DBUSMENU_SERVER_PROP_TEXT_DIRECTION, macro in DbusmenuServer +
+
+
+DBUSMENU_SERVER_PROP_VERSION, macro in DbusmenuServer +
+
+
+dbusmenu_server_set_root, function in DbusmenuServer +
+
+
+dbusmenu_server_set_status, function in DbusmenuServer +
+
+
+dbusmenu_server_set_text_direction, function in DbusmenuServer +
+
+
+DBUSMENU_SERVER_SIGNAL_ID_PROP_UPDATE, macro in DbusmenuServer +
+
+
+DBUSMENU_SERVER_SIGNAL_ID_UPDATE, macro in DbusmenuServer +
+
+
+DBUSMENU_SERVER_SIGNAL_ITEM_ACTIVATION, macro in DbusmenuServer +
+
+
+DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATE, macro in DbusmenuServer +
+
+
+DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATED, macro in DbusmenuServer +
+
+
+DbusmenuStatus, enum in Types +
+
+
+dbusmenu_status_get_nick, function in Types +
+
+
+dbusmenu_status_get_type, function in Types +
+
+
+dbusmenu_status_get_value_from_nick, function in Types +
+
+

T

+
+DbusmenuTextDirection, enum in Types +
+
+
+dbusmenu_text_direction_get_nick, function in Types +
+
+
+dbusmenu_text_direction_get_type, function in Types +
+
+
+dbusmenu_text_direction_get_value_from_nick, function in Types +
+
+
+DBUSMENU_TYPE_STATUS, macro in Types +
+
+
+DBUSMENU_TYPE_TEXT_DIRECTION, macro in Types +
+
+
+ + + \ No newline at end of file === added file 'docs/libdbusmenu-glib/reference/html/ch01.html' --- docs/libdbusmenu-glib/reference/html/ch01.html 1970-01-01 00:00:00 +0000 +++ docs/libdbusmenu-glib/reference/html/ch01.html 2012-06-13 19:49:21 +0000 @@ -0,0 +1,50 @@ + + + + +API + + + + + + + + + + + + + + + + +
+

+API

+
+
+DbusmenuServer — The server signals changed and + updates on a tree of DbusmenuMenuitem objecs. +
+
+DbusmenuMenuitemProxy — A menuitem that proxies from another menuitem +
+
+DbusmenuMenuitem — A lowlevel represenation of a menuitem +
+
+DbusmenuClient — The catcher of all the server traffic +
+
+Types — Types that are used by both client and + server. +
+
+<xi:include></xi:include><xi:include></xi:include><xi:include></xi:include> +
+ + + \ No newline at end of file === added file 'docs/libdbusmenu-glib/reference/html/home.png' Binary files docs/libdbusmenu-glib/reference/html/home.png 1970-01-01 00:00:00 +0000 and docs/libdbusmenu-glib/reference/html/home.png 2012-06-13 19:49:21 +0000 differ === added file 'docs/libdbusmenu-glib/reference/html/index.html' --- docs/libdbusmenu-glib/reference/html/index.html 1970-01-01 00:00:00 +0000 +++ docs/libdbusmenu-glib/reference/html/index.html 2012-06-13 19:49:21 +0000 @@ -0,0 +1,49 @@ + + + + +libdbusmenu-glib Reference Manual + + + + + + + +
+
+
+
+
+
+
API
+
+
+DbusmenuServer — The server signals changed and + updates on a tree of DbusmenuMenuitem objecs. +
+
+DbusmenuMenuitemProxy — A menuitem that proxies from another menuitem +
+
+DbusmenuMenuitem — A lowlevel represenation of a menuitem +
+
+DbusmenuClient — The catcher of all the server traffic +
+
+Types — Types that are used by both client and + server. +
+
+
Object Hierarchy
+
API Index
+
Deprecated API Index
+
Annotation Glossary
+
+
+ + + \ No newline at end of file === added file 'docs/libdbusmenu-glib/reference/html/index.sgml' --- docs/libdbusmenu-glib/reference/html/index.sgml 1970-01-01 00:00:00 +0000 +++ docs/libdbusmenu-glib/reference/html/index.sgml 2012-06-13 19:49:21 +0000 @@ -0,0 +1,176 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + === added file 'docs/libdbusmenu-glib/reference/html/left.png' Binary files docs/libdbusmenu-glib/reference/html/left.png 1970-01-01 00:00:00 +0000 and docs/libdbusmenu-glib/reference/html/left.png 2012-06-13 19:49:21 +0000 differ === added file 'docs/libdbusmenu-glib/reference/html/libdbusmenu-glib-DbusmenuClient.html' --- docs/libdbusmenu-glib/reference/html/libdbusmenu-glib-DbusmenuClient.html 1970-01-01 00:00:00 +0000 +++ docs/libdbusmenu-glib/reference/html/libdbusmenu-glib-DbusmenuClient.html 2012-06-13 19:49:21 +0000 @@ -0,0 +1,607 @@ + + + + +DbusmenuClient + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

DbusmenuClient

+

DbusmenuClient — The catcher of all the server traffic

+
+
+

Stability Level

+Unstable, unless otherwise indicated +
+
+

Synopsis

+
+#include <libdbusmenu-glib/client.h>
+
+#define             DBUSMENU_CLIENT_SIGNAL_LAYOUT_UPDATED
+#define             DBUSMENU_CLIENT_SIGNAL_ROOT_CHANGED
+#define             DBUSMENU_CLIENT_SIGNAL_NEW_MENUITEM
+#define             DBUSMENU_CLIENT_SIGNAL_EVENT_RESULT
+#define             DBUSMENU_CLIENT_SIGNAL_ITEM_ACTIVATE
+#define             DBUSMENU_CLIENT_SIGNAL_ICON_THEME_DIRS_CHANGED
+#define             DBUSMENU_CLIENT_PROP_DBUS_NAME
+#define             DBUSMENU_CLIENT_PROP_DBUS_OBJECT
+#define             DBUSMENU_CLIENT_PROP_GROUP_EVENTS
+#define             DBUSMENU_CLIENT_PROP_STATUS
+#define             DBUSMENU_CLIENT_PROP_TEXT_DIRECTION
+#define             DBUSMENU_CLIENT_TYPES_DEFAULT
+#define             DBUSMENU_CLIENT_TYPES_SEPARATOR
+#define             DBUSMENU_CLIENT_TYPES_IMAGE
+                    DbusmenuClient;
+struct              DbusmenuClientClass;
+gboolean            (*DbusmenuClientTypeHandler)        (DbusmenuMenuitem *newitem,
+                                                         DbusmenuMenuitem *parent,
+                                                         DbusmenuClient *client,
+                                                         gpointer user_data);
+DbusmenuClient *    dbusmenu_client_new                 (const gchar *name,
+                                                         const gchar *object);
+GStrv               dbusmenu_client_get_icon_paths      (DbusmenuClient *client);
+DbusmenuMenuitem *  dbusmenu_client_get_root            (DbusmenuClient *client);
+DbusmenuStatus      dbusmenu_client_get_status          (DbusmenuClient *client);
+DbusmenuTextDirection dbusmenu_client_get_text_direction
+                                                        (DbusmenuClient *client);
+gboolean            dbusmenu_client_add_type_handler    (DbusmenuClient *client,
+                                                         const gchar *type,
+                                                         DbusmenuClientTypeHandler newfunc);
+gboolean            dbusmenu_client_add_type_handler_full
+                                                        (DbusmenuClient *client,
+                                                         const gchar *type,
+                                                         DbusmenuClientTypeHandler newfunc,
+                                                         gpointer user_data,
+                                                         GDestroyNotify destroy_func);
+
+
+
+

Description

+

+The client exists as a mirror to the server. For most folks + all they will do with a client is set it up to connect to + a server and then watch as the menu items on their side + of the bus change. This is all they should need to know about + the client, that it magically makes their menuitems dance. +

+

+ It does this by setting up signal watchers and adjusting + the menuitems appropriately. Most users should watch the + menu items and the signal "layout-changed" for + larger events so that they can be optimized. It is possible + with that signal that even the root node would change. If + that doesn't happen the normal signals on the individual + nodes should be enough for most users. +

+
+
+

Details

+
+

DBUSMENU_CLIENT_SIGNAL_LAYOUT_UPDATED

+
#define DBUSMENU_CLIENT_SIGNAL_LAYOUT_UPDATED  "layout-updated"
+
+

+String to attach to signal "layout-updated" +

+
+
+
+

DBUSMENU_CLIENT_SIGNAL_ROOT_CHANGED

+
#define DBUSMENU_CLIENT_SIGNAL_ROOT_CHANGED    "root-changed"
+
+

+String to attach to signal "root-changed" +

+
+
+
+

DBUSMENU_CLIENT_SIGNAL_NEW_MENUITEM

+
#define DBUSMENU_CLIENT_SIGNAL_NEW_MENUITEM    "new-menuitem"
+
+

+String to attach to signal "new-menuitem" +

+
+
+
+

DBUSMENU_CLIENT_SIGNAL_EVENT_RESULT

+
#define DBUSMENU_CLIENT_SIGNAL_EVENT_RESULT    "event-result"
+
+

+String to attach to signal "event-result" +

+
+
+
+

DBUSMENU_CLIENT_SIGNAL_ITEM_ACTIVATE

+
#define DBUSMENU_CLIENT_SIGNAL_ITEM_ACTIVATE   "item-activate"
+
+

+String to attach to signal "item-activate" +

+
+
+
+

DBUSMENU_CLIENT_SIGNAL_ICON_THEME_DIRS_CHANGED

+
#define DBUSMENU_CLIENT_SIGNAL_ICON_THEME_DIRS_CHANGED    "icon-theme-dirs-changed"
+
+

+String to attach to signal "icon-theme-dirs-changed" +

+
+
+
+

DBUSMENU_CLIENT_PROP_DBUS_NAME

+
#define DBUSMENU_CLIENT_PROP_DBUS_NAME     "dbus-name"
+
+

+String to access property "dbus-name" +

+
+
+
+

DBUSMENU_CLIENT_PROP_DBUS_OBJECT

+
#define DBUSMENU_CLIENT_PROP_DBUS_OBJECT   "dbus-object"
+
+

+String to access property "dbus-object" +

+
+
+
+

DBUSMENU_CLIENT_PROP_GROUP_EVENTS

+
#define DBUSMENU_CLIENT_PROP_GROUP_EVENTS "group-events"
+
+

+String to access property "group-events" +

+
+
+
+

DBUSMENU_CLIENT_PROP_STATUS

+
#define DBUSMENU_CLIENT_PROP_STATUS        "status"
+
+

+String to access property "status" +

+
+
+
+

DBUSMENU_CLIENT_PROP_TEXT_DIRECTION

+
#define DBUSMENU_CLIENT_PROP_TEXT_DIRECTION "text-direction"
+
+

+String to access property "text-direction" +

+
+
+
+

DBUSMENU_CLIENT_TYPES_DEFAULT

+
#define DBUSMENU_CLIENT_TYPES_DEFAULT      "standard"
+
+

+Used to set the 'type' property on a menu item to create +a standard menu item. +

+
+
+
+

DBUSMENU_CLIENT_TYPES_SEPARATOR

+
#define DBUSMENU_CLIENT_TYPES_SEPARATOR    "separator"
+
+

+Used to set the 'type' property on a menu item to create +a separator menu item. +

+
+
+
+

DBUSMENU_CLIENT_TYPES_IMAGE

+
#define DBUSMENU_CLIENT_TYPES_IMAGE        "standard"
+
+

+Used to set the 'type' property on a menu item to create +an image menu item. Deprecated as standard menu items now +support images as well. +

+
+
+
+

DbusmenuClient

+
typedef struct _DbusmenuClient DbusmenuClient;
+

+The client for a DbusmenuServer creating a shared + object set of DbusmenuMenuitem objects. +

+
+
+
+

struct DbusmenuClientClass

+
struct DbusmenuClientClass {
+	GObjectClass parent_class;
+
+	void (*layout_updated)(void);
+	void (*root_changed) (DbusmenuMenuitem * newroot);
+	void (*new_menuitem) (DbusmenuMenuitem * newitem);
+	void (*item_activate) (DbusmenuMenuitem * item, guint timestamp);
+	void (*event_result) (DbusmenuMenuitem * item, gchar * event, GVariant * data, guint timestamp, GError * error);
+	void (*icon_theme_dirs) (DbusmenuMenuitem * item, gpointer theme_dirs, GError * error);
+
+	/*< Private >*/
+	void (*reserved1) (void);
+	void (*reserved2) (void);
+	void (*reserved3) (void);
+	void (*reserved4) (void);
+	void (*reserved5) (void);
+};
+
+

+A simple class that takes all of the information from a + DbusmenuServer over DBus and makes the same set of + DbusmenuMenuitem objects appear on the other side. +

+
++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

GObjectClass parent_class;

GObjectClass

layout_updated ()

Slot for "layout-updated".

root_changed ()

Slot for "root-changed".

new_menuitem ()

Slot for "new-menuitem".

item_activate ()

Slot for "item-activate".

event_result ()

Slot for "event-error".

icon_theme_dirs ()

Slot for "icon-theme-dirs-changed".

reserved1 ()

Reserved for future use.

reserved2 ()

Reserved for future use.

reserved3 ()

Reserved for future use.

reserved4 ()

Reserved for future use.

reserved5 ()

Reserved for future use.
+
+
+
+

DbusmenuClientTypeHandler ()

+
gboolean            (*DbusmenuClientTypeHandler)        (DbusmenuMenuitem *newitem,
+                                                         DbusmenuMenuitem *parent,
+                                                         DbusmenuClient *client,
+                                                         gpointer user_data);
+

+The type handler is called when a dbusmenu item is created + with a matching type as setup in dbusmenu_client_add_type_handler +

+
++ + + + + + + + + + + + + + + + + + + + + + +

newitem :

The DbusmenuMenuitem that was created

parent :

The parent of newitem or NULL if none

client :

A pointer to the DbusmenuClient +

user_data :

The data you gave us

Returns :

+TRUE if the type has been handled. FALSE if this +function was somehow unable to handle it.
+
+
+
+

dbusmenu_client_new ()

+
DbusmenuClient *    dbusmenu_client_new                 (const gchar *name,
+                                                         const gchar *object);
+

+This function creates a new client that connects to a specific +server on DBus. That server is at a specific location sharing +a known object. The interface is assumed by the code to be +the DBus menu interface. The newly created client will start +sending out events as it syncs up with the server. +

+
++ + + + + + + + + + + + + + +

name :

The DBus name for the server to connect to

object :

The object on the server to monitor

Returns :

A brand new DbusmenuClient +
+
+
+
+

dbusmenu_client_get_icon_paths ()

+
GStrv               dbusmenu_client_get_icon_paths      (DbusmenuClient *client);
+

+Gets the stored and exported icon paths from the client. +

+
++ + + + + + + + + + +

client :

The DbusmenuClient to get the icon paths from

Returns :

A NULL-terminated list of icon paths with +memory managed by the client. Duplicate if you want +to keep them. [transfer none] +
+
+
+
+

dbusmenu_client_get_root ()

+
DbusmenuMenuitem *  dbusmenu_client_get_root            (DbusmenuClient *client);
+

+Grabs the root node for the specified client client. This +function may block. It will block if there is currently a +call to update the layout, it will block on that layout +updated and then return the newly updated layout. Chances +are that this update is in the queue for the mainloop as +it would have been requested some time ago, but in theory +it could block longer. +

+
++ + + + + + + + + + +

client :

The DbusmenuClient to get the root node from

Returns :

A DbusmenuMenuitem representing the root of +menu on the server. If there is no server or there is +an error receiving its layout it'll return NULL. [transfer none] +
+
+
+
+

dbusmenu_client_get_status ()

+
DbusmenuStatus      dbusmenu_client_get_status          (DbusmenuClient *client);
+

+Gets the recommended current status that the server + is exporting for the menus. In situtations where the + value is DBUSMENU_STATUS_NOTICE it is recommended that + the client show the menus to the user an a more noticible + way. +

+
++ + + + + + + + + + +

client :

+DbusmenuClient to check the status on

Returns :

Status being exported.
+
+
+
+

dbusmenu_client_get_text_direction ()

+
DbusmenuTextDirection dbusmenu_client_get_text_direction
+                                                        (DbusmenuClient *client);
+

+Gets the text direction that the server is exporting. If + the server is not exporting a direction then the value + DBUSMENU_TEXT_DIRECTION_NONE will be returned. +

+
++ + + + + + + + + + +

client :

+DbusmenuClient to check the text direction on

Returns :

Text direction being exported.
+
+
+
+

dbusmenu_client_add_type_handler ()

+
gboolean            dbusmenu_client_add_type_handler    (DbusmenuClient *client,
+                                                         const gchar *type,
+                                                         DbusmenuClientTypeHandler newfunc);
+

+This function connects into the type handling of the DbusmenuClient. +Every new menuitem that comes in immediately gets asked for it's +properties. When we get those properties we check the 'type' +property and look to see if it matches a handler that is known +by the client. If so, the newfunc function is executed on that +DbusmenuMenuitem. If not, then the DbusmenuClient::new-menuitem +signal is sent. +

+

+In the future the known types will be sent to the server so that it +can make choices about the menu item types availble. +

+
++ + + + + + + + + + + + + + + + + + +

client :

Client where we're getting types coming in

type :

A text string that will be matched with the 'type' +property on incoming menu items

newfunc :

The function that will be executed with those new +items when they come in. [scope notified] +

Returns :

If registering the new type was successful.
+
+
+
+

dbusmenu_client_add_type_handler_full ()

+
gboolean            dbusmenu_client_add_type_handler_full
+                                                        (DbusmenuClient *client,
+                                                         const gchar *type,
+                                                         DbusmenuClientTypeHandler newfunc,
+                                                         gpointer user_data,
+                                                         GDestroyNotify destroy_func);
+

+This function connects into the type handling of the DbusmenuClient. +Every new menuitem that comes in immediately gets asked for it's +properties. When we get those properties we check the 'type' +property and look to see if it matches a handler that is known +by the client. If so, the newfunc function is executed on that +DbusmenuMenuitem. If not, then the DbusmenuClient::new-menuitem +signal is sent. +

+

+In the future the known types will be sent to the server so that it +can make choices about the menu item types availble. +

+
++ + + + + + + + + + + + + + + + + + + + + + + + + + +

client :

Client where we're getting types coming in

type :

A text string that will be matched with the 'type' +property on incoming menu items

newfunc :

The function that will be executed with those new +items when they come in. [scope notified] +

user_data :

Data passed to newfunc when it is called

destroy_func :

A function that is called when the type handler is +removed (usually on client destruction) which will free +the resources in user_data.

Returns :

If registering the new type was successful.
+
+
+
+ + + \ No newline at end of file === added file 'docs/libdbusmenu-glib/reference/html/libdbusmenu-glib-DbusmenuMenuitem.html' --- docs/libdbusmenu-glib/reference/html/libdbusmenu-glib-DbusmenuMenuitem.html 1970-01-01 00:00:00 +0000 +++ docs/libdbusmenu-glib/reference/html/libdbusmenu-glib-DbusmenuMenuitem.html 2012-06-13 19:49:21 +0000 @@ -0,0 +1,1893 @@ + + + + +DbusmenuMenuitem + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

DbusmenuMenuitem

+

DbusmenuMenuitem — A lowlevel represenation of a menuitem

+
+
+

Stability Level

+Unstable, unless otherwise indicated +
+
+

Synopsis

+
+#include <libdbusmenu-glib/menuitem.h>
+
+#define             DBUSMENU_MENUITEM_SIGNAL_PROPERTY_CHANGED
+#define             DBUSMENU_MENUITEM_SIGNAL_ITEM_ACTIVATED
+#define             DBUSMENU_MENUITEM_SIGNAL_CHILD_ADDED
+#define             DBUSMENU_MENUITEM_SIGNAL_CHILD_REMOVED
+#define             DBUSMENU_MENUITEM_SIGNAL_CHILD_MOVED
+#define             DBUSMENU_MENUITEM_SIGNAL_EVENT
+#define             DBUSMENU_MENUITEM_SIGNAL_REALIZED
+#define             DBUSMENU_MENUITEM_SIGNAL_REALIZED_ID
+#define             DBUSMENU_MENUITEM_SIGNAL_ABOUT_TO_SHOW
+#define             DBUSMENU_MENUITEM_SIGNAL_SHOW_TO_USER
+#define             DBUSMENU_MENUITEM_PROP_TYPE
+#define             DBUSMENU_MENUITEM_PROP_VISIBLE
+#define             DBUSMENU_MENUITEM_PROP_ENABLED
+#define             DBUSMENU_MENUITEM_PROP_LABEL
+#define             DBUSMENU_MENUITEM_PROP_ICON_NAME
+#define             DBUSMENU_MENUITEM_PROP_ICON_DATA
+#define             DBUSMENU_MENUITEM_PROP_TOGGLE_TYPE
+#define             DBUSMENU_MENUITEM_PROP_TOGGLE_STATE
+#define             DBUSMENU_MENUITEM_PROP_CHILD_DISPLAY
+#define             DBUSMENU_MENUITEM_PROP_SHORTCUT
+#define             DBUSMENU_MENUITEM_PROP_DISPOSITION
+#define             DBUSMENU_MENUITEM_PROP_ACCESSIBLE_DESC
+#define             DBUSMENU_MENUITEM_TOGGLE_CHECK
+#define             DBUSMENU_MENUITEM_TOGGLE_RADIO
+#define             DBUSMENU_MENUITEM_TOGGLE_STATE_UNCHECKED
+#define             DBUSMENU_MENUITEM_TOGGLE_STATE_CHECKED
+#define             DBUSMENU_MENUITEM_TOGGLE_STATE_UNKNOWN
+#define             DBUSMENU_MENUITEM_ICON_NAME_BLANK
+#define             DBUSMENU_MENUITEM_CHILD_DISPLAY_SUBMENU
+#define             DBUSMENU_MENUITEM_SHORTCUT_ALT
+#define             DBUSMENU_MENUITEM_SHORTCUT_CONTROL
+#define             DBUSMENU_MENUITEM_SHORTCUT_SHIFT
+#define             DBUSMENU_MENUITEM_SHORTCUT_SUPER
+#define             DBUSMENU_MENUITEM_DISPOSITION_NORMAL
+#define             DBUSMENU_MENUITEM_DISPOSITION_INFORMATIVE
+#define             DBUSMENU_MENUITEM_DISPOSITION_WARNING
+#define             DBUSMENU_MENUITEM_DISPOSITION_ALERT
+#define             DBUSMENU_MENUITEM_EVENT_ACTIVATED
+#define             DBUSMENU_MENUITEM_EVENT_CLOSED
+#define             DBUSMENU_MENUITEM_EVENT_OPENED
+struct              DbusmenuMenuitem;
+void                (*dbusmenu_menuitem_about_to_show_cb)
+                                                        (DbusmenuMenuitem *mi,
+                                                         gpointer user_data);
+GVariant *          (*dbusmenu_menuitem_buildvariant_slot_t)
+                                                        (DbusmenuMenuitem *mi,
+                                                         gchar **properties);
+struct              DbusmenuMenuitemClass;
+DbusmenuMenuitem *  dbusmenu_menuitem_new               (void);
+DbusmenuMenuitem *  dbusmenu_menuitem_new_with_id       (gint id);
+gint                dbusmenu_menuitem_get_id            (DbusmenuMenuitem *mi);
+GList *             dbusmenu_menuitem_get_children      (DbusmenuMenuitem *mi);
+GList *             dbusmenu_menuitem_take_children     (DbusmenuMenuitem *mi);
+guint               dbusmenu_menuitem_get_position      (DbusmenuMenuitem *mi,
+                                                         DbusmenuMenuitem *parent);
+guint               dbusmenu_menuitem_get_position_realized
+                                                        (DbusmenuMenuitem *mi,
+                                                         DbusmenuMenuitem *parent);
+gboolean            dbusmenu_menuitem_child_append      (DbusmenuMenuitem *mi,
+                                                         DbusmenuMenuitem *child);
+gboolean            dbusmenu_menuitem_child_prepend     (DbusmenuMenuitem *mi,
+                                                         DbusmenuMenuitem *child);
+gboolean            dbusmenu_menuitem_child_delete      (DbusmenuMenuitem *mi,
+                                                         DbusmenuMenuitem *child);
+gboolean            dbusmenu_menuitem_child_add_position
+                                                        (DbusmenuMenuitem *mi,
+                                                         DbusmenuMenuitem *child,
+                                                         guint position);
+gboolean            dbusmenu_menuitem_child_reorder     (DbusmenuMenuitem *mi,
+                                                         DbusmenuMenuitem *child,
+                                                         guint position);
+DbusmenuMenuitem *  dbusmenu_menuitem_child_find        (DbusmenuMenuitem *mi,
+                                                         gint id);
+DbusmenuMenuitem *  dbusmenu_menuitem_find_id           (DbusmenuMenuitem *mi,
+                                                         gint id);
+gboolean            dbusmenu_menuitem_property_set      (DbusmenuMenuitem *mi,
+                                                         const gchar *property,
+                                                         const gchar *value);
+gboolean            dbusmenu_menuitem_property_set_bool (DbusmenuMenuitem *mi,
+                                                         const gchar *property,
+                                                         const gboolean value);
+gboolean            dbusmenu_menuitem_property_set_byte_array
+                                                        (DbusmenuMenuitem *mi,
+                                                         const gchar *property,
+                                                         const guchar *value,
+                                                         gsize nelements);
+gboolean            dbusmenu_menuitem_property_set_int  (DbusmenuMenuitem *mi,
+                                                         const gchar *property,
+                                                         const gint value);
+gboolean            dbusmenu_menuitem_property_set_variant
+                                                        (DbusmenuMenuitem *mi,
+                                                         const gchar *property,
+                                                         GVariant *value);
+const gchar *       dbusmenu_menuitem_property_get      (DbusmenuMenuitem *mi,
+                                                         const gchar *property);
+gboolean            dbusmenu_menuitem_property_get_bool (DbusmenuMenuitem *mi,
+                                                         const gchar *property);
+const guchar *      dbusmenu_menuitem_property_get_byte_array
+                                                        (DbusmenuMenuitem *mi,
+                                                         const gchar *property,
+                                                         gsize *nelements);
+gint                dbusmenu_menuitem_property_get_int  (DbusmenuMenuitem *mi,
+                                                         const gchar *property);
+GVariant *          dbusmenu_menuitem_property_get_variant
+                                                        (DbusmenuMenuitem *mi,
+                                                         const gchar *property);
+gboolean            dbusmenu_menuitem_property_exist    (DbusmenuMenuitem *mi,
+                                                         const gchar *property);
+GList *             dbusmenu_menuitem_properties_list   (DbusmenuMenuitem *mi);
+GHashTable *        dbusmenu_menuitem_properties_copy   (DbusmenuMenuitem *mi);
+void                dbusmenu_menuitem_property_remove   (DbusmenuMenuitem *mi,
+                                                         const gchar *property);
+void                dbusmenu_menuitem_set_root          (DbusmenuMenuitem *mi,
+                                                         gboolean root);
+gboolean            dbusmenu_menuitem_get_root          (DbusmenuMenuitem *mi);
+void                dbusmenu_menuitem_foreach           (DbusmenuMenuitem *mi,
+                                                         void (*func) (DbusmenuMenuitem * mi, gpointer data),
+                                                         gpointer data);
+void                dbusmenu_menuitem_handle_event      (DbusmenuMenuitem *mi,
+                                                         const gchar *name,
+                                                         GVariant *variant,
+                                                         guint timestamp);
+void                dbusmenu_menuitem_send_about_to_show
+                                                        (DbusmenuMenuitem *mi,
+                                                         void (*cb) (DbusmenuMenuitem * mi, gpointer user_data),
+                                                         gpointer cb_data);
+void                dbusmenu_menuitem_show_to_user      (DbusmenuMenuitem *mi,
+                                                         guint timestamp);
+DbusmenuMenuitem *  dbusmenu_menuitem_get_parent        (DbusmenuMenuitem *mi);
+gboolean            dbusmenu_menuitem_set_parent        (DbusmenuMenuitem *mi,
+                                                         DbusmenuMenuitem *parent);
+gboolean            dbusmenu_menuitem_unparent          (DbusmenuMenuitem *mi);
+
+
+
+

Description

+

+A DbusmenuMenuitem is the lowest level of represenation of a +single item in a menu. It gets created on the server side +and copied over to the client side where it gets rendered. As +the server starts to change it, and grow it, and do all kinds +of fun stuff that information is transfered over DBus and the +client updates it's understanding of the object model. +

+

+Most people using either the client or the server should be +able to deal mostly with DbusmenuMenuitem objects. These +are simple, but then they can be attached to more complex +objects and handled appropriately. +

+
+
+

Details

+
+

DBUSMENU_MENUITEM_SIGNAL_PROPERTY_CHANGED

+
#define DBUSMENU_MENUITEM_SIGNAL_PROPERTY_CHANGED    "property-changed"
+
+

+String to attach to signal "property-changed" +

+
+
+
+

DBUSMENU_MENUITEM_SIGNAL_ITEM_ACTIVATED

+
#define DBUSMENU_MENUITEM_SIGNAL_ITEM_ACTIVATED      "item-activated"
+
+

+String to attach to signal "item-activated" +

+
+
+
+

DBUSMENU_MENUITEM_SIGNAL_CHILD_ADDED

+
#define DBUSMENU_MENUITEM_SIGNAL_CHILD_ADDED         "child-added"
+
+

+String to attach to signal "child-added" +

+
+
+
+

DBUSMENU_MENUITEM_SIGNAL_CHILD_REMOVED

+
#define DBUSMENU_MENUITEM_SIGNAL_CHILD_REMOVED       "child-removed"
+
+

+String to attach to signal "child-removed" +

+
+
+
+

DBUSMENU_MENUITEM_SIGNAL_CHILD_MOVED

+
#define DBUSMENU_MENUITEM_SIGNAL_CHILD_MOVED         "child-moved"
+
+

+String to attach to signal "child-moved" +

+
+
+
+

DBUSMENU_MENUITEM_SIGNAL_EVENT

+
#define DBUSMENU_MENUITEM_SIGNAL_EVENT               "event"
+
+

+String to attach to signal "event" +

+
+
+
+

DBUSMENU_MENUITEM_SIGNAL_REALIZED

+
#define DBUSMENU_MENUITEM_SIGNAL_REALIZED            "realized"
+
+

+String to attach to signal "realized" +

+
+
+
+

DBUSMENU_MENUITEM_SIGNAL_REALIZED_ID

+
#define DBUSMENU_MENUITEM_SIGNAL_REALIZED_ID         (g_signal_lookup(DBUSMENU_MENUITEM_SIGNAL_REALIZED, DBUSMENU_TYPE_MENUITEM))
+
+

+ID to attach to signal "realized" +

+
+
+
+

DBUSMENU_MENUITEM_SIGNAL_ABOUT_TO_SHOW

+
#define DBUSMENU_MENUITEM_SIGNAL_ABOUT_TO_SHOW       "about-to-show"
+
+

+String to attach to signal "about-to-show" +

+
+
+
+

DBUSMENU_MENUITEM_SIGNAL_SHOW_TO_USER

+
#define DBUSMENU_MENUITEM_SIGNAL_SHOW_TO_USER        "show-to-user"
+
+

+String to attach to signal "show-to-user" +

+
+
+
+

DBUSMENU_MENUITEM_PROP_TYPE

+
#define DBUSMENU_MENUITEM_PROP_TYPE                  "type"
+
+

+DbusmenuMenuitem property used to represent what type of menuitem +this object represents. Type: G_VARIANT_TYPE_STRING. +

+
+
+
+

DBUSMENU_MENUITEM_PROP_VISIBLE

+
#define DBUSMENU_MENUITEM_PROP_VISIBLE               "visible"
+
+

+DbusmenuMenuitem property used to represent whether the menuitem +should be shown or not. Type: G_VARIANT_TYPE_BOOLEAN. +

+
+
+
+

DBUSMENU_MENUITEM_PROP_ENABLED

+
#define DBUSMENU_MENUITEM_PROP_ENABLED               "enabled"
+
+

+DbusmenuMenuitem property used to represent whether the menuitem +is clickable or not. Type: G_VARIANT_TYPE_BOOLEAN. +

+
+
+
+

DBUSMENU_MENUITEM_PROP_LABEL

+
#define DBUSMENU_MENUITEM_PROP_LABEL                 "label"
+
+

+DbusmenuMenuitem property used for the text on the menu item. +Type: G_VARIANT_TYPE_STRING +

+
+
+
+

DBUSMENU_MENUITEM_PROP_ICON_NAME

+
#define DBUSMENU_MENUITEM_PROP_ICON_NAME             "icon-name"
+
+

+DbusmenuMenuitem property that is the name of the icon under the +Freedesktop.org icon naming spec. Type: G_VARIANT_TYPE_STRING +

+
+
+
+

DBUSMENU_MENUITEM_PROP_ICON_DATA

+
#define DBUSMENU_MENUITEM_PROP_ICON_DATA             "icon-data"
+
+

+DbusmenuMenuitem property that is the raw data of a custom icon +used in the application. Type: G_VARIANT_TYPE_VARIANT +

+

+It is recommended that this is not set directly but instead the +libdbusmenu-gtk library is used with the function dbusmenu_menuitem_property_set_image() +

+
+
+
+

DBUSMENU_MENUITEM_PROP_TOGGLE_TYPE

+
#define DBUSMENU_MENUITEM_PROP_TOGGLE_TYPE           "toggle-type"
+
+

+DbusmenuMenuitem property that says what type of toggle entry should +be shown in the menu. Should be either DBUSMENU_MENUITEM_TOGGLE_CHECK +or DBUSMENU_MENUITEM_TOGGLE_RADIO. Type: G_VARIANT_TYPE_STRING +

+
+
+
+

DBUSMENU_MENUITEM_PROP_TOGGLE_STATE

+
#define DBUSMENU_MENUITEM_PROP_TOGGLE_STATE          "toggle-state"
+
+

+DbusmenuMenuitem property that says what state a toggle entry should +be shown as the menu. Should be either DBUSMENU_MENUITEM_TOGGLE_STATE_UNCHECKED +DBUSMENU_MENUITEM_TOGGLE_STATE_CHECKED or DBUSMENU_MENUITEM_TOGGLE_STATUE_UNKNOWN. +Type: G_VARIANT_TYPE_INT32 +

+
+
+
+

DBUSMENU_MENUITEM_PROP_CHILD_DISPLAY

+
#define DBUSMENU_MENUITEM_PROP_CHILD_DISPLAY         "children-display"
+
+

+DbusmenuMenuitem property that tells how the children of this menuitem +should be displayed. Most likely this will be unset or of the value +DBUSMENU_MENUITEM_CHILD_DISPLAY_SUBMENU. Type: G_VARIANT_TYPE_STRING +

+
+
+
+

DBUSMENU_MENUITEM_PROP_SHORTCUT

+
#define DBUSMENU_MENUITEM_PROP_SHORTCUT              "shortcut"
+
+

+DbusmenuMenuitem property that is the entries that represent a shortcut +to activate the menuitem. It is an array of arrays of strings. +Type: G_VARIANT_TYPE_ARRAY +

+

+It is recommended that this is not set directly but instead the +libdbusmenu-gtk library is used with the function dbusmenu_menuitem_property_set_shortcut() +

+
+
+
+

DBUSMENU_MENUITEM_PROP_DISPOSITION

+
#define DBUSMENU_MENUITEM_PROP_DISPOSITION           "disposition"
+
+

+DbusmenuMenuitem property to tell what type of information that the +menu item is displaying to the user. Type: G_VARIANT_TYPE_STRING +

+
+
+
+

DBUSMENU_MENUITEM_PROP_ACCESSIBLE_DESC

+
#define DBUSMENU_MENUITEM_PROP_ACCESSIBLE_DESC       "accessible-desc"
+
+

+DbusmenuMenuitem property used to provide a textual description of any +information that the icon may convey. The contents of this property are +passed through to assistive technologies such as the Orca screen reader. +The contents of this property will not be visible in the menu item. If +this property is set, Orca will use this property instead of the label +property. +Type: G_VARIANT_TYPE_STRING +

+
+
+
+

DBUSMENU_MENUITEM_TOGGLE_CHECK

+
#define DBUSMENU_MENUITEM_TOGGLE_CHECK               "checkmark"
+
+

+Used to set DBUSMENU_MENUITEM_PROP_TOGGLE_TYPE to be a standard +check mark item. +

+
+
+
+

DBUSMENU_MENUITEM_TOGGLE_RADIO

+
#define DBUSMENU_MENUITEM_TOGGLE_RADIO               "radio"
+
+

+Used to set DBUSMENU_MENUITEM_PROP_TOGGLE_TYPE to be a standard +radio item. +

+
+
+
+

DBUSMENU_MENUITEM_TOGGLE_STATE_UNCHECKED

+
#define DBUSMENU_MENUITEM_TOGGLE_STATE_UNCHECKED     0
+
+

+Used to set DBUSMENU_MENUITEM_PROP_TOGGLE_STATE so that the menu's +toggle item is empty. +

+
+
+
+

DBUSMENU_MENUITEM_TOGGLE_STATE_CHECKED

+
#define DBUSMENU_MENUITEM_TOGGLE_STATE_CHECKED       1
+
+

+Used to set DBUSMENU_MENUITEM_PROP_TOGGLE_STATE so that the menu's +toggle item is filled. +

+
+
+
+

DBUSMENU_MENUITEM_TOGGLE_STATE_UNKNOWN

+
#define DBUSMENU_MENUITEM_TOGGLE_STATE_UNKNOWN       -1
+
+

+Used to set DBUSMENU_MENUITEM_PROP_TOGGLE_STATE so that the menu's +toggle item is undecided. +

+
+
+
+

DBUSMENU_MENUITEM_ICON_NAME_BLANK

+
#define DBUSMENU_MENUITEM_ICON_NAME_BLANK            "blank-icon"
+
+

+Used to set DBUSMENU_MENUITEM_PROP_TOGGLE_STATE so that the menu's +toggle item is undecided. +

+
+
+
+

DBUSMENU_MENUITEM_CHILD_DISPLAY_SUBMENU

+
#define DBUSMENU_MENUITEM_CHILD_DISPLAY_SUBMENU      "submenu"
+
+

+Used in DBUSMENU_MENUITEM_PROP_CHILD_DISPLAY to have the +subitems displayed as a submenu. +

+
+
+
+

DBUSMENU_MENUITEM_SHORTCUT_ALT

+
#define DBUSMENU_MENUITEM_SHORTCUT_ALT               "Alt"
+
+

+Used in DBUSMENU_MENUITEM_PROP_SHORTCUT to represent the +alternate key. +

+
+
+
+

DBUSMENU_MENUITEM_SHORTCUT_CONTROL

+
#define DBUSMENU_MENUITEM_SHORTCUT_CONTROL           "Control"
+
+

+Used in DBUSMENU_MENUITEM_PROP_SHORTCUT to represent the +control key. +

+
+
+
+

DBUSMENU_MENUITEM_SHORTCUT_SHIFT

+
#define DBUSMENU_MENUITEM_SHORTCUT_SHIFT             "Shift"
+
+

+Used in DBUSMENU_MENUITEM_PROP_SHORTCUT to represent the +shift key. +

+
+
+
+

DBUSMENU_MENUITEM_SHORTCUT_SUPER

+
#define DBUSMENU_MENUITEM_SHORTCUT_SUPER             "Super"
+
+

+Used in DBUSMENU_MENUITEM_PROP_SHORTCUT to represent the +super key. +

+
+
+
+

DBUSMENU_MENUITEM_DISPOSITION_NORMAL

+
#define DBUSMENU_MENUITEM_DISPOSITION_NORMAL         "normal"
+
+

+Used in DBUSMENU_MENUITEM_PROP_DISPOSITION to have a menu +item displayed in the normal manner. Default value. +

+
+
+
+

DBUSMENU_MENUITEM_DISPOSITION_INFORMATIVE

+
#define DBUSMENU_MENUITEM_DISPOSITION_INFORMATIVE    "informative"
+
+

+Used in DBUSMENU_MENUITEM_PROP_DISPOSITION to have a menu +item displayed in a way that conveys it's giving additional +information to the user. +

+
+
+
+

DBUSMENU_MENUITEM_DISPOSITION_WARNING

+
#define DBUSMENU_MENUITEM_DISPOSITION_WARNING        "warning"
+
+

+Used in DBUSMENU_MENUITEM_PROP_DISPOSITION to have a menu +item displayed in a way that conveys it's giving a warning +to the user. +

+
+
+
+

DBUSMENU_MENUITEM_DISPOSITION_ALERT

+
#define DBUSMENU_MENUITEM_DISPOSITION_ALERT          "alert"
+
+

+Used in DBUSMENU_MENUITEM_PROP_DISPOSITION to have a menu +item displayed in a way that conveys it's giving an alert +to the user. +

+
+
+
+

DBUSMENU_MENUITEM_EVENT_ACTIVATED

+
#define DBUSMENU_MENUITEM_EVENT_ACTIVATED            "clicked"
+
+

+String for the event identifier when a menu item is clicked +on by the user. +

+
+
+
+

DBUSMENU_MENUITEM_EVENT_CLOSED

+
#define DBUSMENU_MENUITEM_EVENT_CLOSED               "closed"
+
+

+String for the event identifier when a menu is closed and +displayed to the user. Only valid for items that contain +submenus. +

+
+
+
+

DBUSMENU_MENUITEM_EVENT_OPENED

+
#define DBUSMENU_MENUITEM_EVENT_OPENED               "opened"
+
+

+String for the event identifier when a menu is opened and +displayed to the user. Only valid for items that contain +submenus. +

+
+
+
+

struct DbusmenuMenuitem

+
struct DbusmenuMenuitem {
+	GObject parent;
+
+	/*< Private >*/
+	DbusmenuMenuitemPrivate * priv;
+};
+
+

+This is the GObject based object that represents a menu +item. It gets created the same on both the client and +the server side and libdbusmenu-glib does the work of making +this object model appear on both sides of DBus. Simple +really, though through updates and people coming on and off +the bus it can lead to lots of fun complex scenarios. +

+
++ + + + + + + + + + +

GObject parent;

Parent object

DbusmenuMenuitemPrivate *priv;

Private data
+
+
+
+

dbusmenu_menuitem_about_to_show_cb ()

+
void                (*dbusmenu_menuitem_about_to_show_cb)
+                                                        (DbusmenuMenuitem *mi,
+                                                         gpointer user_data);
+

+Callback prototype for a callback that is called when the +menu should be shown. +

+
++ + + + + + + + + + +

mi :

Menu item that should be shown

user_data :

Extra user data sent with the function. [closure] +
+
+
+
+

dbusmenu_menuitem_buildvariant_slot_t ()

+
GVariant *          (*dbusmenu_menuitem_buildvariant_slot_t)
+                                                        (DbusmenuMenuitem *mi,
+                                                         gchar **properties);
+

+This is the function that is called to represent this menu item +as a variant. Should call it's own children. +

+
++ + + + + + + + + + + + + + +

mi :

Menu item that should be built from. [in] +

properties :

A list of properties that should be the only ones in the resulting variant structure. [allow-none] +

Returns :

A variant representing this item and it's children. [transfer full] +
+
+
+
+

struct DbusmenuMenuitemClass

+
struct DbusmenuMenuitemClass {
+	GObjectClass parent_class;
+
+	/* Signals */
+	void (*property_changed) (gchar * property, GVariant * value);
+	void (*item_activated) (guint timestamp);
+	void (*child_added) (DbusmenuMenuitem * child, guint position);
+	void (*child_removed) (DbusmenuMenuitem * child);
+	void (*child_moved) (DbusmenuMenuitem * child, guint newpos, guint oldpos);
+	void (*realized) (void);
+
+	/* Virtual functions */
+	dbusmenu_menuitem_buildvariant_slot_t buildvariant;
+	void (*handle_event) (DbusmenuMenuitem * mi, const gchar * name, GVariant * variant, guint timestamp);
+	void (*send_about_to_show) (DbusmenuMenuitem * mi, void (*cb) (DbusmenuMenuitem * mi, gpointer user_data), gpointer cb_data);
+
+	void (*show_to_user) (DbusmenuMenuitem * mi, guint timestamp, gpointer cb_data);
+	gboolean (*about_to_show) (void);
+
+	void (*event) (const gchar * name, GVariant * value, guint timestamp);
+
+	/*< Private >*/
+	void (*reserved1) (void);
+	void (*reserved2) (void);
+	void (*reserved3) (void);
+	void (*reserved4) (void);
+	void (*reserved5) (void);
+};
+
+

+Functions and signals that every menuitem should know something +about. +

+
++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

GObjectClass parent_class;

Functions and signals from our parent

property_changed ()

Slot for "property-changed".

item_activated ()

Slot for "item-activated".

child_added ()

Slot for "child-added".

child_removed ()

Slot for "child-removed".

child_moved ()

Slot for "child-moved".

realized ()

Slot for "realized".

dbusmenu_menuitem_buildvariant_slot_t buildvariant;

Virtual function that appends the strings required to represent this menu item in the menu variant.

handle_event ()

This function is to override how events are handled by subclasses. Look at dbusmenu_menuitem_handle_event for lots of good information.

show_to_user ()

Slot for "show-to-user".

about_to_show ()

Slot for "about-to-show".

event ()

Slot for "event".

reserved1 ()

Reserved for future use.

reserved2 ()

Reserved for future use.

reserved3 ()

Reserved for future use.

reserved4 ()

Reserved for future use.

reserved5 ()

Reserved for future use.
+
+
+
+

dbusmenu_menuitem_new ()

+
DbusmenuMenuitem *  dbusmenu_menuitem_new               (void);
+

+Create a new DbusmenuMenuitem with all default values. +

+
++ + + + +

Returns :

A newly allocated DbusmenuMenuitem.
+
+
+
+

dbusmenu_menuitem_new_with_id ()

+
DbusmenuMenuitem *  dbusmenu_menuitem_new_with_id       (gint id);
+

+This creates a blank DbusmenuMenuitem with a specific ID. +

+
++ + + + + + + + + + +

id :

ID to use for this menuitem

Returns :

A newly allocated DbusmenuMenuitem.
+
+
+
+

dbusmenu_menuitem_get_id ()

+
gint                dbusmenu_menuitem_get_id            (DbusmenuMenuitem *mi);
+

+Gets the unique ID for mi. +

+
++ + + + + + + + + + +

mi :

The DbusmenuMenuitem to query.

Returns :

The ID of the mi.
+
+
+
+

dbusmenu_menuitem_get_children ()

+
GList *             dbusmenu_menuitem_get_children      (DbusmenuMenuitem *mi);
+

+Returns simply the list of children that this menu item +has. The list is valid until another child related function +is called, where it might be changed. +

+
++ + + + + + + + + + +

mi :

The DbusmenuMenuitem to query.

Returns :

A GList of pointers to DbusmenuMenuitem objects. [transfer none][element-type Dbusmenu.Menuitem] +
+
+
+
+

dbusmenu_menuitem_take_children ()

+
GList *             dbusmenu_menuitem_take_children     (DbusmenuMenuitem *mi);
+

+While the name sounds devious that's exactly what this function +does. It takes the list of children from the mi and clears the +internal list. The calling function is now in charge of the ref's +on the children it has taken. A lot of responsibility involved +in taking children. +

+
++ + + + + + + + + + +

mi :

The DbusmenMenuitem to take the children from.

Returns :

A GList of pointers to DbusmenuMenuitem objects. [transfer full][element-type Dbusmenu.Menuitem] +
+
+
+
+

dbusmenu_menuitem_get_position ()

+
guint               dbusmenu_menuitem_get_position      (DbusmenuMenuitem *mi,
+                                                         DbusmenuMenuitem *parent);
+

+This function returns the position of the menu item mi +in the children of parent. It will return zero if the +menu item can't be found. +

+
++ + + + + + + + + + + + + + +

mi :

The DbusmenuMenuitem to find the position of

parent :

The DbusmenuMenuitem who's children contain mi +

Returns :

The position of mi in the children of parent.
+
+
+
+

dbusmenu_menuitem_get_position_realized ()

+
guint               dbusmenu_menuitem_get_position_realized
+                                                        (DbusmenuMenuitem *mi,
+                                                         DbusmenuMenuitem *parent);
+

+This function is very similar to dbusmenu_menuitem_get_position +except that it only counts in the children that have been realized. +

+
++ + + + + + + + + + + + + + +

mi :

The DbusmenuMenuitem to find the position of

parent :

The DbusmenuMenuitem who's children contain mi +

Returns :

The position of mi in the realized children of parent.
+
+
+
+

dbusmenu_menuitem_child_append ()

+
gboolean            dbusmenu_menuitem_child_append      (DbusmenuMenuitem *mi,
+                                                         DbusmenuMenuitem *child);
+

+This function adds child to the list of children on mi at +the end of that list. +

+
++ + + + + + + + + + + + + + +

mi :

The DbusmenuMenuitem which will become a new parent

child :

The DbusmenMenuitem that will be a child

Returns :

Whether the child has been added successfully.
+
+
+
+

dbusmenu_menuitem_child_prepend ()

+
gboolean            dbusmenu_menuitem_child_prepend     (DbusmenuMenuitem *mi,
+                                                         DbusmenuMenuitem *child);
+

+This function adds child to the list of children on mi at +the beginning of that list. +

+
++ + + + + + + + + + + + + + +

mi :

The DbusmenuMenuitem which will become a new parent

child :

The DbusmenMenuitem that will be a child

Returns :

Whether the child has been added successfully.
+
+
+
+

dbusmenu_menuitem_child_delete ()

+
gboolean            dbusmenu_menuitem_child_delete      (DbusmenuMenuitem *mi,
+                                                         DbusmenuMenuitem *child);
+

+This function removes child from the children list of mi. It does +not call g_object_unref on child. +

+
++ + + + + + + + + + + + + + +

mi :

The DbusmenuMenuitem which has child as a child

child :

The child DbusmenuMenuitem that you want to no longer +be a child of mi.

Returns :

If we were able to delete child.
+
+
+
+

dbusmenu_menuitem_child_add_position ()

+
gboolean            dbusmenu_menuitem_child_add_position
+                                                        (DbusmenuMenuitem *mi,
+                                                         DbusmenuMenuitem *child,
+                                                         guint position);
+

+Puts child in the list of children for mi at the location +specified in position. If there is not enough entires available +then child will be placed at the end of the list. +

+
++ + + + + + + + + + + + + + + + + + +

mi :

The DbusmenuMenuitem that we're adding the child child to.

child :

The DbusmenuMenuitem to make a child of mi.

position :

Where in mi object's list of chidren child should be placed.

Returns :

Whether child was added successfully.
+
+
+
+

dbusmenu_menuitem_child_reorder ()

+
gboolean            dbusmenu_menuitem_child_reorder     (DbusmenuMenuitem *mi,
+                                                         DbusmenuMenuitem *child,
+                                                         guint position);
+

+This function moves a child on the list of children. It is +for a child that is already in the list, but simply needs a +new location. +

+
++ + + + + + + + + + + + + + + + + + +

mi :

The DbusmenuMenuitem that has children needing realignment

child :

The DbusmenuMenuitem that is a child needing to be moved

position :

The position in the list to place it in

Returns :

Whether the move was successful.
+
+
+
+

dbusmenu_menuitem_child_find ()

+
DbusmenuMenuitem *  dbusmenu_menuitem_child_find        (DbusmenuMenuitem *mi,
+                                                         gint id);
+

+Search the children of mi to find one with the ID of id. +If it doesn't exist then we return NULL. +

+
++ + + + + + + + + + + + + + +

mi :

The DbusmenuMenuitem who's children to look on

id :

The ID of the child that we're looking for.

Returns :

The menu item with the ID id or NULL if it +can't be found. [transfer none] +
+
+
+
+

dbusmenu_menuitem_find_id ()

+
DbusmenuMenuitem *  dbusmenu_menuitem_find_id           (DbusmenuMenuitem *mi,
+                                                         gint id);
+

+This function searchs the whole tree of children that +are attached to mi. This could be quite a few nodes, all +the way down the tree. It is a depth first search. +

+
++ + + + + + + + + + + + + + +

mi :

+DbusmenuMenuitem at the top of the tree to search

id :

ID of the DbusmenuMenuitem to search for

Returns :

The DbusmenuMenuitem with the ID of id +or NULL if there isn't such a menu item in the tree +represented by mi. [transfer none] +
+
+
+
+

dbusmenu_menuitem_property_set ()

+
gboolean            dbusmenu_menuitem_property_set      (DbusmenuMenuitem *mi,
+                                                         const gchar *property,
+                                                         const gchar *value);
+

+Takes the pair of property and value and places them as a +property on mi. If a property already exists by that name, +then the value is set to the new value. If not, the property +is added. If the value is changed or the property was previously +unset then the signal "prop-changed" will be +emitted by this function. +

+
++ + + + + + + + + + + + + + + + + + +

mi :

The DbusmenuMenuitem to set the property on.

property :

Name of the property to set.

value :

The value of the property.

Returns :

A boolean representing if the property value was set.
+
+
+
+

dbusmenu_menuitem_property_set_bool ()

+
gboolean            dbusmenu_menuitem_property_set_bool (DbusmenuMenuitem *mi,
+                                                         const gchar *property,
+                                                         const gboolean value);
+

+Takes a boolean value and sets it on property as a +property on mi. If a property already exists by that name, +then the value is set to the new value. If not, the property +is added. If the value is changed or the property was previously +unset then the signal "prop-changed" will be +emitted by this function. +

+
++ + + + + + + + + + + + + + + + + + +

mi :

The DbusmenuMenuitem to set the property on.

property :

Name of the property to set.

value :

The value of the property.

Returns :

A boolean representing if the property value was set.
+
+
+
+

dbusmenu_menuitem_property_set_byte_array ()

+
gboolean            dbusmenu_menuitem_property_set_byte_array
+                                                        (DbusmenuMenuitem *mi,
+                                                         const gchar *property,
+                                                         const guchar *value,
+                                                         gsize nelements);
+

+Takes a byte array value and sets it on property as a +property on mi. If a property already exists by that name, +then the value is set to the new value. If not, the property +is added. If the value is changed or the property was previously +unset then the signal "prop-changed" will be +emitted by this function. +

+
++ + + + + + + + + + + + + + + + + + + + + + +

mi :

The DbusmenuMenuitem to set the property on.

property :

Name of the property to set.

value :

The byte array.

nelements :

The number of elements in the byte array.

Returns :

A boolean representing if the property value was set.
+
+
+
+

dbusmenu_menuitem_property_set_int ()

+
gboolean            dbusmenu_menuitem_property_set_int  (DbusmenuMenuitem *mi,
+                                                         const gchar *property,
+                                                         const gint value);
+

+Takes a boolean value and sets it on property as a +property on mi. If a property already exists by that name, +then the value is set to the new value. If not, the property +is added. If the value is changed or the property was previously +unset then the signal "prop-changed" will be +emitted by this function. +

+
++ + + + + + + + + + + + + + + + + + +

mi :

The DbusmenuMenuitem to set the property on.

property :

Name of the property to set.

value :

The value of the property.

Returns :

A boolean representing if the property value was set.
+
+
+
+

dbusmenu_menuitem_property_set_variant ()

+
gboolean            dbusmenu_menuitem_property_set_variant
+                                                        (DbusmenuMenuitem *mi,
+                                                         const gchar *property,
+                                                         GVariant *value);
+

+Takes the pair of property and value and places them as a +property on mi. If a property already exists by that name, +then the value is set to the new value. If not, the property +is added. If the value is changed or the property was previously +unset then the signal "prop-changed" will be +emitted by this function. +

+
++ + + + + + + + + + + + + + + + + + +

mi :

The DbusmenuMenuitem to set the property on.

property :

Name of the property to set.

value :

The value of the property.

Returns :

A boolean representing if the property value was set.
+
+
+
+

dbusmenu_menuitem_property_get ()

+
const gchar *       dbusmenu_menuitem_property_get      (DbusmenuMenuitem *mi,
+                                                         const gchar *property);
+

+Look up a property on mi and return the value of it if +it exits. NULL will be returned if the property doesn't +exist. +

+
++ + + + + + + + + + + + + + +

mi :

The DbusmenuMenuitem to look for the property on.

property :

The property to grab.

Returns :

A string with the value of the property +that shouldn't be free'd. Or NULL if the property +is not set or is not a string. [transfer none] +
+
+
+
+

dbusmenu_menuitem_property_get_bool ()

+
gboolean            dbusmenu_menuitem_property_get_bool (DbusmenuMenuitem *mi,
+                                                         const gchar *property);
+

+Look up a property on mi and return the value of it if +it exits. Returns FALSE if the property doesn't exist. +

+
++ + + + + + + + + + + + + + +

mi :

The DbusmenuMenuitem to look for the property on.

property :

The property to grab.

Returns :

The value of the property or FALSE.
+
+
+
+

dbusmenu_menuitem_property_get_byte_array ()

+
const guchar *      dbusmenu_menuitem_property_get_byte_array
+                                                        (DbusmenuMenuitem *mi,
+                                                         const gchar *property,
+                                                         gsize *nelements);
+

+Look up a property on mi and return the value of it if +it exits. NULL will be returned if the property doesn't +exist. +

+
++ + + + + + + + + + + + + + + + + + +

mi :

The DbusmenuMenuitem to look for the property on.

property :

The property to grab.

nelements :

A pointer to the location to store the number of items (out)

Returns :

A byte array with the +value of the property that shouldn't be free'd. Or NULL if the property +is not set or is not a byte array. [array length=nelements][element-type guint8][transfer none] +
+
+
+
+

dbusmenu_menuitem_property_get_int ()

+
gint                dbusmenu_menuitem_property_get_int  (DbusmenuMenuitem *mi,
+                                                         const gchar *property);
+

+Look up a property on mi and return the value of it if +it exits. Returns zero if the property doesn't exist. +

+
++ + + + + + + + + + + + + + +

mi :

The DbusmenuMenuitem to look for the property on.

property :

The property to grab.

Returns :

The value of the property or zero.
+
+
+
+

dbusmenu_menuitem_property_get_variant ()

+
GVariant *          dbusmenu_menuitem_property_get_variant
+                                                        (DbusmenuMenuitem *mi,
+                                                         const gchar *property);
+

+Look up a property on mi and return the value of it if +it exits. NULL will be returned if the property doesn't +exist. +

+
++ + + + + + + + + + + + + + +

mi :

The DbusmenuMenuitem to look for the property on.

property :

The property to grab.

Returns :

A GVariant for the property. [transfer none] +
+
+
+
+

dbusmenu_menuitem_property_exist ()

+
gboolean            dbusmenu_menuitem_property_exist    (DbusmenuMenuitem *mi,
+                                                         const gchar *property);
+

+Checkes to see if a particular property exists on mi and +returns TRUE if so. +

+
++ + + + + + + + + + + + + + +

mi :

The DbusmenuMenuitem to look for the property on.

property :

The property to look for.

Returns :

A boolean checking to see if the property is available
+
+
+
+

dbusmenu_menuitem_properties_list ()

+
GList *             dbusmenu_menuitem_properties_list   (DbusmenuMenuitem *mi);
+

+This functiong gets a list of the names of all the properties +that are set on this menu item. This data on the list is owned +by the menuitem but the list is not and should be freed using +g_list_free() when the calling function is done with it. +

+
++ + + + + + + + + + +

mi :

+DbusmenuMenuitem to list the properties on

Returns :

A list of +strings or NULL if there are none. [transfer container][element-type utf8] +
+
+
+
+

dbusmenu_menuitem_properties_copy ()

+
GHashTable *        dbusmenu_menuitem_properties_copy   (DbusmenuMenuitem *mi);
+

+This function takes the properties of a DbusmenuMenuitem +and puts them into a GHashTable that is referenced by the +key of a string and has the value of a string. The hash +table may not have any entries if there aren't any or there +is an error in processing. It is the caller's responsibility +to destroy the created GHashTable. +

+
++ + + + + + + + + + +

mi :

+DbusmenuMenuitem that we're interested in the properties of

Returns :

A brand new GHashTable that contains all of +theroperties that are on this DbusmenuMenuitem mi. [transfer full] +
+
+
+
+

dbusmenu_menuitem_property_remove ()

+
void                dbusmenu_menuitem_property_remove   (DbusmenuMenuitem *mi,
+                                                         const gchar *property);
+

+Removes a property from the menuitem. +

+
++ + + + + + + + + + +

mi :

The DbusmenuMenuitem to remove the property on.

property :

The property to look for.
+
+
+
+

dbusmenu_menuitem_set_root ()

+
void                dbusmenu_menuitem_set_root          (DbusmenuMenuitem *mi,
+                                                         gboolean root);
+

+This function sets the internal value of whether this is a +root node or not. +

+
++ + + + + + + + + + +

mi :

+DbusmenuMenuitem to set whether it's root

root :

Whether mi is a root node or not
+
+
+
+

dbusmenu_menuitem_get_root ()

+
gboolean            dbusmenu_menuitem_get_root          (DbusmenuMenuitem *mi);
+

+This function returns the internal value of whether this is a +root node or not. +

+
++ + + + + + + + + + +

mi :

+DbusmenuMenuitem to see whether it's root

Returns :

+TRUE if this is a root node
+
+
+
+

dbusmenu_menuitem_foreach ()

+
void                dbusmenu_menuitem_foreach           (DbusmenuMenuitem *mi,
+                                                         void (*func) (DbusmenuMenuitem * mi, gpointer data),
+                                                         gpointer data);
+

+This calls the function func on this menu item and all +of the children of this item. And their children. And +their children. And... you get the point. It will get +called on the whole tree. +

+
++ + + + + + + + + + + + + + +

mi :

The DbusmenItem to start from

func :

Function to call on every node in the tree

data :

User data to pass to the function. [closure] +
+
+
+
+

dbusmenu_menuitem_handle_event ()

+
void                dbusmenu_menuitem_handle_event      (DbusmenuMenuitem *mi,
+                                                         const gchar *name,
+                                                         GVariant *variant,
+                                                         guint timestamp);
+

+This function is called to create an event. It is likely +to be overrided by subclasses. The default menu item +will respond to the activate signal and do: +

+

+Emits the "item-activate" signal on this +menu item. Called by server objects when they get the +appropriate DBus signals from the client. +

+

+If you subclass this function you should really think +about calling the parent function unless you have a good +reason not to. +

+
++ + + + + + + + + + + + + + + + + + +

mi :

The DbusmenuMenuitem to send the signal on.

name :

The name of the signal

variant :

A value that could be set for the event

timestamp :

The timestamp of when the event happened
+
+
+
+

dbusmenu_menuitem_send_about_to_show ()

+
void                dbusmenu_menuitem_send_about_to_show
+                                                        (DbusmenuMenuitem *mi,
+                                                         void (*cb) (DbusmenuMenuitem * mi, gpointer user_data),
+                                                         gpointer cb_data);
+

+This function is used to send the even that the submenu +of this item is about to be shown. Callers to this event +should delay showing the menu until their callback is +called if possible. +

+
++ + + + + + + + + + + + + + +

mi :

The DbusmenuMenuitem to send the signal on.

cb :

Callback to call when the call has returned.

cb_data :

Data to pass to the callback. [closure] +
+
+
+
+

dbusmenu_menuitem_show_to_user ()

+
void                dbusmenu_menuitem_show_to_user      (DbusmenuMenuitem *mi,
+                                                         guint timestamp);
+

+Signals that this menu item should be shown to the user. If this is +server side the server will then take it and send it over the +bus. +

+
++ + + + + + + + + + +

mi :

+DbusmenuMenuitem to show

timestamp :

The time that the user requested it to be shown
+
+
+
+

dbusmenu_menuitem_get_parent ()

+
DbusmenuMenuitem *  dbusmenu_menuitem_get_parent        (DbusmenuMenuitem *mi);
+

+This function looks up the parent of mi +

+
++ + + + + + + + + + +

mi :

The DbusmenuMenuitem for which to inspect the parent

Returns :

The parent of this menu item. [transfer none] +
+
+
+
+

dbusmenu_menuitem_set_parent ()

+
gboolean            dbusmenu_menuitem_set_parent        (DbusmenuMenuitem *mi,
+                                                         DbusmenuMenuitem *parent);
+

+Sets the parent of mi to parent. If mi already +has a parent, then this call will fail. The parent will +be set automatically when using the usual methods to add a +child menuitem, so this function should not normally be +called directly +

+
++ + + + + + + + + + + + + + +

mi :

The DbusmenuMenuitem for which to set the parent

parent :

The new parent DbusmenuMenuitem +

Returns :

Whether the parent was set successfully
+
+
+
+

dbusmenu_menuitem_unparent ()

+
gboolean            dbusmenu_menuitem_unparent          (DbusmenuMenuitem *mi);
+

+Unparents the menu item mi. If mi doesn't have a +parent, then this call will fail. The menuitem will +be unparented automatically when using the usual methods +to delete a child menuitem, so this function should not +normally be called directly +

+
++ + + + + + + + + + +

mi :

The DbusmenuMenuitem to unparent

Returns :

Whether the menu item was unparented successfully
+
+
+
+ + + \ No newline at end of file === added file 'docs/libdbusmenu-glib/reference/html/libdbusmenu-glib-DbusmenuMenuitemProxy.html' --- docs/libdbusmenu-glib/reference/html/libdbusmenu-glib-DbusmenuMenuitemProxy.html 1970-01-01 00:00:00 +0000 +++ docs/libdbusmenu-glib/reference/html/libdbusmenu-glib-DbusmenuMenuitemProxy.html 2012-06-13 19:49:21 +0000 @@ -0,0 +1,166 @@ + + + + +DbusmenuMenuitemProxy + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

DbusmenuMenuitemProxy

+

DbusmenuMenuitemProxy — A menuitem that proxies from another menuitem

+
+
+

Stability Level

+Unstable, unless otherwise indicated +
+ +
+

Description

+

+This small object allows for proxying all the properties from a remote +menuitem to a new object that can be moved around appropriately within +the new menu structure. +

+
+
+

Details

+
+

DbusmenuMenuitemProxy

+
typedef struct _DbusmenuMenuitemProxy DbusmenuMenuitemProxy;
+

+Public instance data for a DbusmenuMenuitemProxy. +

+
+
+
+

struct DbusmenuMenuitemProxyClass

+
struct DbusmenuMenuitemProxyClass {
+	DbusmenuMenuitemClass parent_class;
+
+	/*< Private >*/
+	void (*reserved1) (void);
+	void (*reserved2) (void);
+	void (*reserved3) (void);
+	void (*reserved4) (void);
+};
+
+

+Functions and signal slots for DbusmenuMenuitemProxy. +

+
++ + + + + + + + + + + + + + + + + + + + + + +

DbusmenuMenuitemClass parent_class;

The Class of DbusmeneMenuitem +

reserved1 ()

Reserved for future use.

reserved2 ()

Reserved for future use.

reserved3 ()

Reserved for future use.

reserved4 ()

Reserved for future use.
+
+
+
+

dbusmenu_menuitem_proxy_new ()

+
DbusmenuMenuitemProxy * dbusmenu_menuitem_proxy_new     (DbusmenuMenuitem *mi);
+

+Builds a new DbusmenuMenuitemProxy object that proxies +all of the values for mi. +

+
++ + + + + + + + + + +

mi :

The DbusmenuMenuitem to proxy

Returns :

A new DbusmenuMenuitemProxy object.
+
+
+
+

dbusmenu_menuitem_proxy_get_wrapped ()

+
DbusmenuMenuitem *  dbusmenu_menuitem_proxy_get_wrapped (DbusmenuMenuitemProxy *pmi);
+

+Accesses the private variable of which DbusmenuMenuitem +we are doing the proxying for. +

+
++ + + + + + + + + + +

pmi :

+DbusmenuMenuitemProxy to look into

Returns :

A DbusmenuMenuitem object or a NULL if we +don't have one or there is an error. [transfer none] +
+
+
+
+ + + \ No newline at end of file === added file 'docs/libdbusmenu-glib/reference/html/libdbusmenu-glib-DbusmenuServer.html' --- docs/libdbusmenu-glib/reference/html/libdbusmenu-glib-DbusmenuServer.html 1970-01-01 00:00:00 +0000 +++ docs/libdbusmenu-glib/reference/html/libdbusmenu-glib-DbusmenuServer.html 2012-06-13 19:49:21 +0000 @@ -0,0 +1,412 @@ + + + + +DbusmenuServer + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

DbusmenuServer

+

DbusmenuServer — The server signals changed and + updates on a tree of DbusmenuMenuitem objecs.

+
+
+

Stability Level

+Unstable, unless otherwise indicated +
+ +
+

Description

+

+A DbusmenuServer is the object that represents the local + tree of DbusmenuMenuitem objects on DBus. It watches the + various signals that those objects emit and correctly + represents them across DBus to a DbusmenuClient so that + the same tree can be maintained in another process. +

+

+ The server needs to have the root set of DbusmenuMenuitem + objects set via dbusmenu_server_set_root but it will query + all of the objects in that tree automatically. After setting + the root there should be no other maintence required by + users of the server class. +

+
+
+

Details

+
+

DBUSMENU_SERVER_SIGNAL_ID_PROP_UPDATE

+
#define DBUSMENU_SERVER_SIGNAL_ID_PROP_UPDATE  "item-property-updated"
+
+

+String to attach to signal "item-property-updated" +

+
+
+
+

DBUSMENU_SERVER_SIGNAL_ID_UPDATE

+
#define DBUSMENU_SERVER_SIGNAL_ID_UPDATE       "item-updated"
+
+

+String to attach to signal "item-updated" +

+
+
+
+

DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATED

+
#define DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATED  "layout-updated"
+
+

+String to attach to signal "layout-updated" +

+
+
+
+

DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATE

+
#define DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATE   DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATED
+
+

+String to attach to signal "layout-updated" +

+
+
+
+

DBUSMENU_SERVER_SIGNAL_ITEM_ACTIVATION

+
#define DBUSMENU_SERVER_SIGNAL_ITEM_ACTIVATION "item-activation-requested"
+
+

+String to attach to signal "item-activation-requested" +

+
+
+
+

DBUSMENU_SERVER_PROP_DBUS_OBJECT

+
#define DBUSMENU_SERVER_PROP_DBUS_OBJECT       "dbus-object"
+
+

+String to access property "dbus-object" +

+
+
+
+

DBUSMENU_SERVER_PROP_ROOT_NODE

+
#define DBUSMENU_SERVER_PROP_ROOT_NODE         "root-node"
+
+

+String to access property "root-node" +

+
+
+
+

DBUSMENU_SERVER_PROP_STATUS

+
#define DBUSMENU_SERVER_PROP_STATUS            "status"
+
+

+String to access property "status" +

+
+
+
+

DBUSMENU_SERVER_PROP_TEXT_DIRECTION

+
#define DBUSMENU_SERVER_PROP_TEXT_DIRECTION    "text-direction"
+
+

+String to access property "text-direction" +

+
+
+
+

DBUSMENU_SERVER_PROP_VERSION

+
#define DBUSMENU_SERVER_PROP_VERSION           "version"
+
+

+String to access property "version" +

+
+
+
+

DbusmenuServer

+
typedef struct _DbusmenuServer DbusmenuServer;
+

+A server which represents a sharing of a set of + DbusmenuMenuitems across DBus to a DbusmenuClient. +

+
+
+
+

struct DbusmenuServerClass

+
struct DbusmenuServerClass {
+	GObjectClass parent_class;
+
+	/* Signals */
+	void (*id_prop_update)(gint id, gchar * property, gchar * value);
+	void (*id_update)(gint id);
+	void (*layout_updated)(gint revision);
+	void (*item_activation)(gint id, guint timestamp);
+
+	/*< Private >*/
+	void (*reserved1) (void);
+	void (*reserved2) (void);
+	void (*reserved3) (void);
+	void (*reserved4) (void);
+	void (*reserved5) (void);
+	void (*reserved6) (void);
+};
+
+

+The class implementing the virtual functions for DbusmenuServer. +

+
++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

GObjectClass parent_class;

GObjectClass

id_prop_update ()

Slot for "id-prop-update".

id_update ()

Slot for "id-update".

layout_updated ()

Slot for "layout-update".

item_activation ()

Slot for "item-activation-requested".

reserved1 ()

Reserved for future use.

reserved2 ()

Reserved for future use.

reserved3 ()

Reserved for future use.

reserved4 ()

Reserved for future use.

reserved5 ()

Reserved for future use.

reserved6 ()

Reserved for future use.
+
+
+
+

dbusmenu_server_new ()

+
DbusmenuServer *    dbusmenu_server_new                 (const gchar *object);
+

+Creates a new DbusmenuServer object with a specific object + path on DBus. If object is set to NULL the default object + name of "/com/canonical/dbusmenu" will be used. +

+
++ + + + + + + + + + +

object :

The object name to show for this menu structure +on DBus. May be NULL.

Returns :

A brand new DbusmenuServer +
+
+
+
+

dbusmenu_server_get_status ()

+
DbusmenuStatus      dbusmenu_server_get_status          (DbusmenuServer *server);
+

+Gets the current statust hat the server is sending out over + DBus. +

+
++ + + + + + + + + + +

server :

The DbusmenuServer to get the status from

Returns :

The current status the server is sending
+
+
+
+

dbusmenu_server_get_text_direction ()

+
DbusmenuTextDirection dbusmenu_server_get_text_direction
+                                                        (DbusmenuServer *server);
+

+Returns the value of the text direction that is being exported + over DBus for this server. It should relate to the direction + of the labels and other text fields that are being exported by + this server. +

+
++ + + + + + + + + + +

server :

The DbusmenuServer object to get the text direction from

Returns :

Text direction exported for this server.
+
+
+
+

dbusmenu_server_set_root ()

+
void                dbusmenu_server_set_root            (DbusmenuServer *self,
+                                                         DbusmenuMenuitem *root);
+

+This function contains all of the GValue wrapping + required to set the property "root-node" + on the server self. +

+
++ + + + + + + + + + +

self :

The DbusmenuServer object to set the root on

root :

The new root DbusmenuMenuitem tree
+
+
+
+

dbusmenu_server_set_status ()

+
void                dbusmenu_server_set_status          (DbusmenuServer *server,
+                                                         DbusmenuStatus status);
+

+Changes the status of the server. +

+
++ + + + + + + + + + +

server :

The DbusmenuServer to set the status on

status :

Status value to set on the server
+
+
+
+

dbusmenu_server_set_text_direction ()

+
void                dbusmenu_server_set_text_direction  (DbusmenuServer *server,
+                                                         DbusmenuTextDirection dir);
+

+Sets the text direction that should be exported over DBus for + this server. If the value is set to DBUSMENU_TEXT_DIRECTION_NONE + the default detection will be used for setting the value and + exported over DBus. +

+
++ + + + + + + + + + +

server :

The DbusmenuServer object to set the text direction on

dir :

Direction of the text
+
+
+
+ + + \ No newline at end of file === added file 'docs/libdbusmenu-glib/reference/html/libdbusmenu-glib-Types.html' --- docs/libdbusmenu-glib/reference/html/libdbusmenu-glib-Types.html 1970-01-01 00:00:00 +0000 +++ docs/libdbusmenu-glib/reference/html/libdbusmenu-glib-Types.html 2012-06-13 19:49:21 +0000 @@ -0,0 +1,276 @@ + + + + +Types + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

Types

+

Types — Types that are used by both client and + server.

+
+
+

Stability Level

+Unstable, unless otherwise indicated +
+ +
+

Description

+

+Enums that are used to describe states of the server across the + bus. They are sent over dbus using their nicks but then turned + back into enums by the client. +

+
+
+

Details

+
+

DBUSMENU_TYPE_STATUS

+
#define DBUSMENU_TYPE_STATUS (dbusmenu_status_get_type())
+
+

+Gets the GType value for the type associated with the + DbusmenuStatus enumerated type. +

+
+
+
+

DBUSMENU_TYPE_TEXT_DIRECTION

+
#define DBUSMENU_TYPE_TEXT_DIRECTION (dbusmenu_text_direction_get_type())
+
+

+Gets the GType value for the type associated with the + DbusmenuTextDirection enumerated type. +

+
+
+
+

enum DbusmenuStatus

+
typedef enum {
+ /*< prefix=DBUSMENU_STATUS >*/
+	DBUSMENU_STATUS_NORMAL,   /*< nick=normal >*/
+	DBUSMENU_STATUS_NOTICE    /*< nick=notice >*/
+} DbusmenuStatus;
+
+

+Tracks how the menus should be presented to the user. +

+
++ + + + + + + + + + +

DBUSMENU_STATUS_NORMAL

Everything is normal +

DBUSMENU_STATUS_NOTICE

The menus should be shown at a higher priority +
+
+
+
+

enum DbusmenuTextDirection

+
typedef enum {
+ /*< prefix=DBUSMENU_TEXT_DIRECTION >*/
+	DBUSMENU_TEXT_DIRECTION_NONE, /*< nick=none >*/
+	DBUSMENU_TEXT_DIRECTION_LTR,  /*< nick=ltr  >*/
+	DBUSMENU_TEXT_DIRECTION_RTL   /*< nick=rtl  >*/
+} DbusmenuTextDirection;
+
+

+The direction of text that the strings that this server + will be sending strings as. +

+
++ + + + + + + + + + + + + + +

DBUSMENU_TEXT_DIRECTION_NONE

Unspecified text direction +

DBUSMENU_TEXT_DIRECTION_LTR

Left-to-right text direction +

DBUSMENU_TEXT_DIRECTION_RTL

Right-to-left text direction +
+
+
+
+

dbusmenu_status_get_nick ()

+
const gchar *       dbusmenu_status_get_nick            (DbusmenuStatus value);
+

+Looks up in the enum table for the nick of value. +

+
++ + + + + + + + + + +

value :

The value of DbusmenuStatus to get the nick of

Returns :

The nick for the given value or NULL on error
+
+
+
+

dbusmenu_status_get_type ()

+
GType               dbusmenu_status_get_type            (void);
+

+Builds a GLib type for the DbusmenuStatus enumeration. +

+
++ + + + +

Returns :

A unique GType for the DbusmenuStatus enum.
+
+
+
+

dbusmenu_status_get_value_from_nick ()

+
DbusmenuStatus      dbusmenu_status_get_value_from_nick (const gchar *nick);
+

+Looks up in the enum table for the value of nick. +

+
++ + + + + + + + + + +

nick :

The enum nick to lookup

Returns :

The value for the given nick +
+
+
+
+

dbusmenu_text_direction_get_nick ()

+
const gchar *       dbusmenu_text_direction_get_nick    (DbusmenuTextDirection value);
+

+Looks up in the enum table for the nick of value. +

+
++ + + + + + + + + + +

value :

The value of DbusmenuTextDirection to get the nick of

Returns :

The nick for the given value or NULL on error
+
+
+
+

dbusmenu_text_direction_get_type ()

+
GType               dbusmenu_text_direction_get_type    (void);
+

+Builds a GLib type for the DbusmenuTextDirection enumeration. +

+
++ + + + +

Returns :

A unique GType for the DbusmenuTextDirection enum.
+
+
+
+

dbusmenu_text_direction_get_value_from_nick ()

+
DbusmenuTextDirection dbusmenu_text_direction_get_value_from_nick
+                                                        (const gchar *nick);
+

+Looks up in the enum table for the value of nick. +

+
++ + + + + + + + + + +

nick :

The enum nick to lookup

Returns :

The value for the given nick +
+
+
+
+ + + \ No newline at end of file === added file 'docs/libdbusmenu-glib/reference/html/libdbusmenu-glib.devhelp2' --- docs/libdbusmenu-glib/reference/html/libdbusmenu-glib.devhelp2 1970-01-01 00:00:00 +0000 +++ docs/libdbusmenu-glib/reference/html/libdbusmenu-glib.devhelp2 2012-06-13 19:49:21 +0000 @@ -0,0 +1,161 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + === added file 'docs/libdbusmenu-glib/reference/html/object-tree.html' --- docs/libdbusmenu-glib/reference/html/object-tree.html 1970-01-01 00:00:00 +0000 +++ docs/libdbusmenu-glib/reference/html/object-tree.html 2012-06-13 19:49:21 +0000 @@ -0,0 +1,32 @@ + + + + +Object Hierarchy + + + + + + + + + + + + + + + + +
+

+Object Hierarchy

+
+
+
+ + + \ No newline at end of file === added file 'docs/libdbusmenu-glib/reference/html/right.png' Binary files docs/libdbusmenu-glib/reference/html/right.png 1970-01-01 00:00:00 +0000 and docs/libdbusmenu-glib/reference/html/right.png 2012-06-13 19:49:21 +0000 differ === added file 'docs/libdbusmenu-glib/reference/html/style.css' --- docs/libdbusmenu-glib/reference/html/style.css 1970-01-01 00:00:00 +0000 +++ docs/libdbusmenu-glib/reference/html/style.css 2012-06-13 19:49:21 +0000 @@ -0,0 +1,266 @@ +.synopsis, .classsynopsis +{ + /* tango:aluminium 1/2 */ + background: #eeeeec; + border: solid 1px #d3d7cf; + padding: 0.5em; +} +.programlisting +{ + /* tango:sky blue 0/1 */ + background: #e6f3ff; + border: solid 1px #729fcf; + padding: 0.5em; +} +.variablelist +{ + padding: 4px; + margin-left: 3em; +} +.variablelist td:first-child +{ + vertical-align: top; +} + +@media screen { + sup a.footnote + { + position: relative; + top: 0em ! important; + + } + /* this is needed so that the local anchors are displayed below the naviagtion */ + div.footnote a[name], div.refnamediv a[name], div.refsect1 a[name], div.refsect2 a[name], div.index a[name], div.glossary a[name], div.sect1 a[name] + { + display: inline-block; + position: relative; + top:-5em; + } + /* this seems to be a bug in the xsl style sheets when generating indexes */ + div.index div.index + { + top: 0em; + } + /* make space for the fixed navigation bar and add space at the bottom so that + * link targets appear somewhat close to top + */ + body + { + padding-top: 3.2em; + padding-bottom: 20em; + } + /* style and size the navigation bar */ + table.navigation#top + { + position: fixed; + /* tango:scarlet red 0/1 */ + background: #ffe6e6; + border: solid 1px #ef2929; + margin-top: 0; + margin-bottom: 0; + top: 0; + left: 0; + height: 3em; + z-index: 10; + } + .navigation a, .navigation a:visited + { + /* tango:scarlet red 3 */ + color: #a40000; + } + .navigation a:hover + { + /* tango:scarlet red 1 */ + color: #ef2929; + } + td.shortcuts + { + /* tango:scarlet red 1 */ + color: #ef2929; + font-size: 80%; + white-space: nowrap; + } +} +@media print { + table.navigation { + visibility: collapse; + display: none; + } + div.titlepage table.navigation { + visibility: visible; + display: table; + /* tango:scarlet red 0/1 */ + background: #ffe6e6; + border: solid 1px #ef2929; + margin-top: 0; + margin-bottom: 0; + top: 0; + left: 0; + height: 3em; + } +} + +.navigation .title +{ + font-size: 200%; +} + +div.gallery-float +{ + float: left; + padding: 10px; +} +div.gallery-float img +{ + border-style: none; +} +div.gallery-spacer +{ + clear: both; +} + +a, a:visited +{ + text-decoration: none; + /* tango:sky blue 2 */ + color: #3465a4; +} +a:hover +{ + text-decoration: underline; + /* tango:sky blue 1 */ + color: #729fcf; +} + +div.table table +{ + border-collapse: collapse; + border-spacing: 0px; + /* tango:aluminium 3 */ + border: solid 1px #babdb6; +} + +div.table table td, div.table table th +{ + /* tango:aluminium 3 */ + border: solid 1px #babdb6; + padding: 3px; + vertical-align: top; +} + +div.table table th +{ + /* tango:aluminium 2 */ + background-color: #d3d7cf; +} + +hr +{ + /* tango:aluminium 3 */ + color: #babdb6; + background: #babdb6; + border: none 0px; + height: 1px; + clear: both; +} + +.footer +{ + padding-top: 3.5em; + /* tango:aluminium 3 */ + color: #babdb6; + text-align: center; + font-size: 80%; +} + +.warning +{ + /* tango:orange 0/1 */ + background: #ffeed9; + border-color: #ffb04f; +} +.note +{ + /* tango:chameleon 0/0.5 */ + background: #d8ffb2; + border-color: #abf562; +} +.note, .warning +{ + padding: 0.5em; + border-width: 1px; + border-style: solid; +} +.note h3, .warning h3 +{ + margin-top: 0.0em +} +.note p, .warning p +{ + margin-bottom: 0.0em +} + +/* blob links */ +h2 .extralinks, h3 .extralinks +{ + float: right; + /* tango:aluminium 3 */ + color: #babdb6; + font-size: 80%; + font-weight: normal; +} + +.annotation +{ + /* tango:aluminium 5 */ + color: #555753; + font-size: 80%; + font-weight: normal; +} + +/* code listings */ + +.listing_code .programlisting .cbracket { color: #a40000; } /* tango: scarlet red 3 */ +.listing_code .programlisting .comment { color: #a1a39d; } /* tango: aluminium 4 */ +.listing_code .programlisting .function { color: #000000; font-weight: bold; } +.listing_code .programlisting .function a { color: #11326b; font-weight: bold; } /* tango: sky blue 4 */ +.listing_code .programlisting .keyword { color: #4e9a06; } /* tango: chameleon 3 */ +.listing_code .programlisting .linenum { color: #babdb6; } /* tango: aluminium 3 */ +.listing_code .programlisting .normal { color: #000000; } +.listing_code .programlisting .number { color: #75507b; } /* tango: plum 2 */ +.listing_code .programlisting .preproc { color: #204a87; } /* tango: sky blue 3 */ +.listing_code .programlisting .string { color: #c17d11; } /* tango: chocolate 2 */ +.listing_code .programlisting .type { color: #000000; } +.listing_code .programlisting .type a { color: #11326b; } /* tango: sky blue 4 */ +.listing_code .programlisting .symbol { color: #ce5c00; } /* tango: orange 3 */ + +.listing_frame { + /* tango:sky blue 1 */ + border: solid 1px #729fcf; + padding: 0px; +} + +.listing_lines, .listing_code { + margin-top: 0px; + margin-bottom: 0px; + padding: 0.5em; +} +.listing_lines { + /* tango:sky blue 0.5 */ + background: #a6c5e3; + /* tango:aluminium 6 */ + color: #2e3436; +} +.listing_code { + /* tango:sky blue 0 */ + background: #e6f3ff; +} +.listing_code .programlisting { + /* override from previous */ + border: none 0px; + padding: 0px; +} +.listing_lines pre, .listing_code pre { + margin: 0px; +} + === added file 'docs/libdbusmenu-glib/reference/html/up.png' Binary files docs/libdbusmenu-glib/reference/html/up.png 1970-01-01 00:00:00 +0000 and docs/libdbusmenu-glib/reference/html/up.png 2012-06-13 19:49:21 +0000 differ === added file 'docs/libdbusmenu-glib/reference/tmpl/client.sgml' --- docs/libdbusmenu-glib/reference/tmpl/client.sgml 1970-01-01 00:00:00 +0000 +++ docs/libdbusmenu-glib/reference/tmpl/client.sgml 2012-06-13 19:49:21 +0000 @@ -0,0 +1,228 @@ + +DbusmenuClient + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@parent_class: +@layout_updated: +@root_changed: +@new_menuitem: +@item_activate: +@event_result: +@icon_theme_dirs: +@reserved1: +@reserved2: +@reserved3: +@reserved4: +@reserved5: + + + + + + +@newitem: +@parent: +@client: +@user_data: +@Returns: + + + + + + + +@name: +@object: +@Returns: + + + + + + + +@client: +@Returns: + + + + + + + +@client: +@Returns: + + + + + + + +@client: +@Returns: + + + + + + + +@client: +@Returns: + + + + + + + +@client: +@type: +@newfunc: +@Returns: + + + + + + + +@client: +@type: +@newfunc: +@user_data: +@destroy_func: +@Returns: + + === added file 'docs/libdbusmenu-glib/reference/tmpl/libdbusmenu-glib-unused.sgml' === added file 'docs/libdbusmenu-glib/reference/tmpl/menuitem-proxy.sgml' --- docs/libdbusmenu-glib/reference/tmpl/menuitem-proxy.sgml 1970-01-01 00:00:00 +0000 +++ docs/libdbusmenu-glib/reference/tmpl/menuitem-proxy.sgml 2012-06-13 19:49:21 +0000 @@ -0,0 +1,59 @@ + +DbusmenuMenuitemProxy + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@parent_class: +@reserved1: +@reserved2: +@reserved3: +@reserved4: + + + + + + +@mi: +@Returns: + + + + + + + +@pmi: +@Returns: + + === added file 'docs/libdbusmenu-glib/reference/tmpl/menuitem.sgml' --- docs/libdbusmenu-glib/reference/tmpl/menuitem.sgml 1970-01-01 00:00:00 +0000 +++ docs/libdbusmenu-glib/reference/tmpl/menuitem.sgml 2012-06-13 19:49:21 +0000 @@ -0,0 +1,721 @@ + +DbusmenuMenuitem + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@parent: +@priv: + + + + + + +@mi: +@user_data: + + + + + + + +@mi: +@properties: +@Returns: + + + + + + + +@parent_class: +@property_changed: +@item_activated: +@child_added: +@child_removed: +@child_moved: +@realized: +@buildvariant: +@handle_event: +@show_to_user: +@about_to_show: +@event: +@reserved1: +@reserved2: +@reserved3: +@reserved4: +@reserved5: + + + + + + +@void: +@Returns: + + + + + + + +@id: +@Returns: + + + + + + + +@mi: +@Returns: + + + + + + + +@mi: +@Returns: + + + + + + + +@mi: +@Returns: + + + + + + + +@mi: +@parent: +@Returns: + + + + + + + +@mi: +@parent: +@Returns: + + + + + + + +@mi: +@child: +@Returns: + + + + + + + +@mi: +@child: +@Returns: + + + + + + + +@mi: +@child: +@Returns: + + + + + + + +@mi: +@child: +@position: +@Returns: + + + + + + + +@mi: +@child: +@position: +@Returns: + + + + + + + +@mi: +@id: +@Returns: + + + + + + + +@mi: +@id: +@Returns: + + + + + + + +@mi: +@property: +@value: +@Returns: + + + + + + + +@mi: +@property: +@value: +@Returns: + + + + + + + +@mi: +@property: +@value: +@nelements: +@Returns: + + + + + + + +@mi: +@property: +@value: +@Returns: + + + + + + + +@mi: +@property: +@value: +@Returns: + + + + + + + +@mi: +@property: +@Returns: + + + + + + + +@mi: +@property: +@Returns: + + + + + + + +@mi: +@property: +@nelements: +@Returns: + + + + + + + +@mi: +@property: +@Returns: + + + + + + + +@mi: +@property: +@Returns: + + + + + + + +@mi: +@property: +@Returns: + + + + + + + +@mi: +@Returns: + + + + + + + +@mi: +@Returns: + + + + + + + +@mi: +@property: + + + + + + + +@mi: +@root: + + + + + + + +@mi: +@Returns: + + + + + + + +@mi: +@func: +@data: + + + + + + + +@mi: +@name: +@variant: +@timestamp: + + + + + + + +@mi: +@cb: +@cb_data: + + + + + + + +@mi: +@timestamp: + + + + + + + +@mi: +@Returns: + + + + + + + +@mi: +@parent: +@Returns: + + + + + + + +@mi: +@Returns: + + === added file 'docs/libdbusmenu-glib/reference/tmpl/server.sgml' --- docs/libdbusmenu-glib/reference/tmpl/server.sgml 1970-01-01 00:00:00 +0000 +++ docs/libdbusmenu-glib/reference/tmpl/server.sgml 2012-06-13 19:49:21 +0000 @@ -0,0 +1,171 @@ + +DbusmenuServer + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@parent_class: +@id_prop_update: +@id_update: +@layout_updated: +@item_activation: +@reserved1: +@reserved2: +@reserved3: +@reserved4: +@reserved5: +@reserved6: + + + + + + +@object: +@Returns: + + + + + + + +@server: +@Returns: + + + + + + + +@server: +@Returns: + + + + + + + +@self: +@root: + + + + + + + +@server: +@status: + + + + + + + +@server: +@dir: + + === added file 'docs/libdbusmenu-glib/reference/tmpl/types.sgml' --- docs/libdbusmenu-glib/reference/tmpl/types.sgml 1970-01-01 00:00:00 +0000 +++ docs/libdbusmenu-glib/reference/tmpl/types.sgml 2012-06-13 19:49:21 +0000 @@ -0,0 +1,109 @@ + +Types + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@DBUSMENU_STATUS_NORMAL: +@DBUSMENU_STATUS_NOTICE: + + + + + + +@DBUSMENU_TEXT_DIRECTION_NONE: +@DBUSMENU_TEXT_DIRECTION_LTR: +@DBUSMENU_TEXT_DIRECTION_RTL: + + + + + + +@value: +@Returns: + + + + + + + +@void: +@Returns: + + + + + + + +@nick: +@Returns: + + + + + + + +@value: +@Returns: + + + + + + + +@void: +@Returns: + + + + + + + +@nick: +@Returns: + + === modified file 'docs/libdbusmenu-glib/reference/version.xml' --- docs/libdbusmenu-glib/reference/version.xml 2012-04-11 16:54:01 +0000 +++ docs/libdbusmenu-glib/reference/version.xml 2012-06-13 19:49:21 +0000 @@ -1,1 +1,1 @@ -0.6.1 +0.6.2 === added file 'docs/libdbusmenu-glib/reference/xml/annotation-glossary.xml' --- docs/libdbusmenu-glib/reference/xml/annotation-glossary.xml 1970-01-01 00:00:00 +0000 +++ docs/libdbusmenu-glib/reference/xml/annotation-glossary.xml 2012-06-13 19:49:21 +0000 @@ -0,0 +1,80 @@ + + +]> + + + Annotation Glossary +A + + allow-none + + NULL is ok, both for passing and for returning. + + + +C + + closure + + This parameter is a 'user_data', for callbacks; many bindings can pass NULL here. + + + +T + + transfer none + + Don't free data after the code is done. + + + +A + + array + + Parameter points to an array of items. + + + +E + + element-type + + Generics and defining elements of containers and arrays. + + + +I + + in + + Parameter for input. Default is transfer none. + + + +T + + transfer container + + Free data container after the code is done. + + + + transfer full + + Free data after the code is done. + + + +S + + scope notified + + The callback is valid until the GDestroyNotify argument is called. + + + + === added file 'docs/libdbusmenu-glib/reference/xml/api-index-deprecated.xml' --- docs/libdbusmenu-glib/reference/xml/api-index-deprecated.xml 1970-01-01 00:00:00 +0000 +++ docs/libdbusmenu-glib/reference/xml/api-index-deprecated.xml 2012-06-13 19:49:21 +0000 @@ -0,0 +1,8 @@ + + +]> + + === added file 'docs/libdbusmenu-glib/reference/xml/api-index-full.xml' --- docs/libdbusmenu-glib/reference/xml/api-index-full.xml 1970-01-01 00:00:00 +0000 +++ docs/libdbusmenu-glib/reference/xml/api-index-full.xml 2012-06-13 19:49:21 +0000 @@ -0,0 +1,153 @@ + + +]> + +C +DbusmenuClient, struct in DbusmenuClient +DbusmenuClientClass, struct in DbusmenuClient +DbusmenuClientTypeHandler, user_function in DbusmenuClient +dbusmenu_client_add_type_handler, function in DbusmenuClient +dbusmenu_client_add_type_handler_full, function in DbusmenuClient +dbusmenu_client_get_icon_paths, function in DbusmenuClient +dbusmenu_client_get_root, function in DbusmenuClient +dbusmenu_client_get_status, function in DbusmenuClient +dbusmenu_client_get_text_direction, function in DbusmenuClient +dbusmenu_client_new, function in DbusmenuClient +DBUSMENU_CLIENT_PROP_DBUS_NAME, macro in DbusmenuClient +DBUSMENU_CLIENT_PROP_DBUS_OBJECT, macro in DbusmenuClient +DBUSMENU_CLIENT_PROP_GROUP_EVENTS, macro in DbusmenuClient +DBUSMENU_CLIENT_PROP_STATUS, macro in DbusmenuClient +DBUSMENU_CLIENT_PROP_TEXT_DIRECTION, macro in DbusmenuClient +DBUSMENU_CLIENT_SIGNAL_EVENT_RESULT, macro in DbusmenuClient +DBUSMENU_CLIENT_SIGNAL_ICON_THEME_DIRS_CHANGED, macro in DbusmenuClient +DBUSMENU_CLIENT_SIGNAL_ITEM_ACTIVATE, macro in DbusmenuClient +DBUSMENU_CLIENT_SIGNAL_LAYOUT_UPDATED, macro in DbusmenuClient +DBUSMENU_CLIENT_SIGNAL_NEW_MENUITEM, macro in DbusmenuClient +DBUSMENU_CLIENT_SIGNAL_ROOT_CHANGED, macro in DbusmenuClient +DBUSMENU_CLIENT_TYPES_DEFAULT, macro in DbusmenuClient +DBUSMENU_CLIENT_TYPES_IMAGE, macro in DbusmenuClient +DBUSMENU_CLIENT_TYPES_SEPARATOR, macro in DbusmenuClient + +M +DbusmenuMenuitem, struct in DbusmenuMenuitem +DbusmenuMenuitemClass, struct in DbusmenuMenuitem +DbusmenuMenuitemProxy, struct in DbusmenuMenuitemProxy +DbusmenuMenuitemProxyClass, struct in DbusmenuMenuitemProxy +dbusmenu_menuitem_about_to_show_cb, user_function in DbusmenuMenuitem +dbusmenu_menuitem_buildvariant_slot_t, user_function in DbusmenuMenuitem +dbusmenu_menuitem_child_add_position, function in DbusmenuMenuitem +dbusmenu_menuitem_child_append, function in DbusmenuMenuitem +dbusmenu_menuitem_child_delete, function in DbusmenuMenuitem +DBUSMENU_MENUITEM_CHILD_DISPLAY_SUBMENU, macro in DbusmenuMenuitem +dbusmenu_menuitem_child_find, function in DbusmenuMenuitem +dbusmenu_menuitem_child_prepend, function in DbusmenuMenuitem +dbusmenu_menuitem_child_reorder, function in DbusmenuMenuitem +DBUSMENU_MENUITEM_DISPOSITION_ALERT, macro in DbusmenuMenuitem +DBUSMENU_MENUITEM_DISPOSITION_INFORMATIVE, macro in DbusmenuMenuitem +DBUSMENU_MENUITEM_DISPOSITION_NORMAL, macro in DbusmenuMenuitem +DBUSMENU_MENUITEM_DISPOSITION_WARNING, macro in DbusmenuMenuitem +DBUSMENU_MENUITEM_EVENT_ACTIVATED, macro in DbusmenuMenuitem +DBUSMENU_MENUITEM_EVENT_CLOSED, macro in DbusmenuMenuitem +DBUSMENU_MENUITEM_EVENT_OPENED, macro in DbusmenuMenuitem +dbusmenu_menuitem_find_id, function in DbusmenuMenuitem +dbusmenu_menuitem_foreach, function in DbusmenuMenuitem +dbusmenu_menuitem_get_children, function in DbusmenuMenuitem +dbusmenu_menuitem_get_id, function in DbusmenuMenuitem +dbusmenu_menuitem_get_parent, function in DbusmenuMenuitem +dbusmenu_menuitem_get_position, function in DbusmenuMenuitem +dbusmenu_menuitem_get_position_realized, function in DbusmenuMenuitem +dbusmenu_menuitem_get_root, function in DbusmenuMenuitem +dbusmenu_menuitem_handle_event, function in DbusmenuMenuitem +DBUSMENU_MENUITEM_ICON_NAME_BLANK, macro in DbusmenuMenuitem +dbusmenu_menuitem_new, function in DbusmenuMenuitem +dbusmenu_menuitem_new_with_id, function in DbusmenuMenuitem +dbusmenu_menuitem_properties_copy, function in DbusmenuMenuitem +dbusmenu_menuitem_properties_list, function in DbusmenuMenuitem +dbusmenu_menuitem_property_exist, function in DbusmenuMenuitem +dbusmenu_menuitem_property_get, function in DbusmenuMenuitem +dbusmenu_menuitem_property_get_bool, function in DbusmenuMenuitem +dbusmenu_menuitem_property_get_byte_array, function in DbusmenuMenuitem +dbusmenu_menuitem_property_get_int, function in DbusmenuMenuitem +dbusmenu_menuitem_property_get_variant, function in DbusmenuMenuitem +dbusmenu_menuitem_property_remove, function in DbusmenuMenuitem +dbusmenu_menuitem_property_set, function in DbusmenuMenuitem +dbusmenu_menuitem_property_set_bool, function in DbusmenuMenuitem +dbusmenu_menuitem_property_set_byte_array, function in DbusmenuMenuitem +dbusmenu_menuitem_property_set_int, function in DbusmenuMenuitem +dbusmenu_menuitem_property_set_variant, function in DbusmenuMenuitem +DBUSMENU_MENUITEM_PROP_ACCESSIBLE_DESC, macro in DbusmenuMenuitem +DBUSMENU_MENUITEM_PROP_CHILD_DISPLAY, macro in DbusmenuMenuitem +DBUSMENU_MENUITEM_PROP_DISPOSITION, macro in DbusmenuMenuitem +DBUSMENU_MENUITEM_PROP_ENABLED, macro in DbusmenuMenuitem +DBUSMENU_MENUITEM_PROP_ICON_DATA, macro in DbusmenuMenuitem +DBUSMENU_MENUITEM_PROP_ICON_NAME, macro in DbusmenuMenuitem +DBUSMENU_MENUITEM_PROP_LABEL, macro in DbusmenuMenuitem +DBUSMENU_MENUITEM_PROP_SHORTCUT, macro in DbusmenuMenuitem +DBUSMENU_MENUITEM_PROP_TOGGLE_STATE, macro in DbusmenuMenuitem +DBUSMENU_MENUITEM_PROP_TOGGLE_TYPE, macro in DbusmenuMenuitem +DBUSMENU_MENUITEM_PROP_TYPE, macro in DbusmenuMenuitem +DBUSMENU_MENUITEM_PROP_VISIBLE, macro in DbusmenuMenuitem +dbusmenu_menuitem_proxy_get_wrapped, function in DbusmenuMenuitemProxy +dbusmenu_menuitem_proxy_new, function in DbusmenuMenuitemProxy +dbusmenu_menuitem_send_about_to_show, function in DbusmenuMenuitem +dbusmenu_menuitem_set_parent, function in DbusmenuMenuitem +dbusmenu_menuitem_set_root, function in DbusmenuMenuitem +DBUSMENU_MENUITEM_SHORTCUT_ALT, macro in DbusmenuMenuitem +DBUSMENU_MENUITEM_SHORTCUT_CONTROL, macro in DbusmenuMenuitem +DBUSMENU_MENUITEM_SHORTCUT_SHIFT, macro in DbusmenuMenuitem +DBUSMENU_MENUITEM_SHORTCUT_SUPER, macro in DbusmenuMenuitem +dbusmenu_menuitem_show_to_user, function in DbusmenuMenuitem +DBUSMENU_MENUITEM_SIGNAL_ABOUT_TO_SHOW, macro in DbusmenuMenuitem +DBUSMENU_MENUITEM_SIGNAL_CHILD_ADDED, macro in DbusmenuMenuitem +DBUSMENU_MENUITEM_SIGNAL_CHILD_MOVED, macro in DbusmenuMenuitem +DBUSMENU_MENUITEM_SIGNAL_CHILD_REMOVED, macro in DbusmenuMenuitem +DBUSMENU_MENUITEM_SIGNAL_EVENT, macro in DbusmenuMenuitem +DBUSMENU_MENUITEM_SIGNAL_ITEM_ACTIVATED, macro in DbusmenuMenuitem +DBUSMENU_MENUITEM_SIGNAL_PROPERTY_CHANGED, macro in DbusmenuMenuitem +DBUSMENU_MENUITEM_SIGNAL_REALIZED, macro in DbusmenuMenuitem +DBUSMENU_MENUITEM_SIGNAL_REALIZED_ID, macro in DbusmenuMenuitem +DBUSMENU_MENUITEM_SIGNAL_SHOW_TO_USER, macro in DbusmenuMenuitem +dbusmenu_menuitem_take_children, function in DbusmenuMenuitem +DBUSMENU_MENUITEM_TOGGLE_CHECK, macro in DbusmenuMenuitem +DBUSMENU_MENUITEM_TOGGLE_RADIO, macro in DbusmenuMenuitem +DBUSMENU_MENUITEM_TOGGLE_STATE_CHECKED, macro in DbusmenuMenuitem +DBUSMENU_MENUITEM_TOGGLE_STATE_UNCHECKED, macro in DbusmenuMenuitem +DBUSMENU_MENUITEM_TOGGLE_STATE_UNKNOWN, macro in DbusmenuMenuitem +dbusmenu_menuitem_unparent, function in DbusmenuMenuitem + +S +DbusmenuServer, struct in DbusmenuServer +DbusmenuServerClass, struct in DbusmenuServer +dbusmenu_server_get_status, function in DbusmenuServer +dbusmenu_server_get_text_direction, function in DbusmenuServer +dbusmenu_server_new, function in DbusmenuServer +DBUSMENU_SERVER_PROP_DBUS_OBJECT, macro in DbusmenuServer +DBUSMENU_SERVER_PROP_ROOT_NODE, macro in DbusmenuServer +DBUSMENU_SERVER_PROP_STATUS, macro in DbusmenuServer +DBUSMENU_SERVER_PROP_TEXT_DIRECTION, macro in DbusmenuServer +DBUSMENU_SERVER_PROP_VERSION, macro in DbusmenuServer +dbusmenu_server_set_root, function in DbusmenuServer +dbusmenu_server_set_status, function in DbusmenuServer +dbusmenu_server_set_text_direction, function in DbusmenuServer +DBUSMENU_SERVER_SIGNAL_ID_PROP_UPDATE, macro in DbusmenuServer +DBUSMENU_SERVER_SIGNAL_ID_UPDATE, macro in DbusmenuServer +DBUSMENU_SERVER_SIGNAL_ITEM_ACTIVATION, macro in DbusmenuServer +DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATE, macro in DbusmenuServer +DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATED, macro in DbusmenuServer +DbusmenuStatus, enum in Types +dbusmenu_status_get_nick, function in Types +dbusmenu_status_get_type, function in Types +dbusmenu_status_get_value_from_nick, function in Types + +T +DbusmenuTextDirection, enum in Types +dbusmenu_text_direction_get_nick, function in Types +dbusmenu_text_direction_get_type, function in Types +dbusmenu_text_direction_get_value_from_nick, function in Types +DBUSMENU_TYPE_STATUS, macro in Types +DBUSMENU_TYPE_TEXT_DIRECTION, macro in Types + + === added file 'docs/libdbusmenu-glib/reference/xml/client.xml' --- docs/libdbusmenu-glib/reference/xml/client.xml 1970-01-01 00:00:00 +0000 +++ docs/libdbusmenu-glib/reference/xml/client.xml 2012-06-13 19:49:21 +0000 @@ -0,0 +1,448 @@ + + +]> + + +DbusmenuClient +3 + + LIBDBUSMENU-GLIB Library + + + +DbusmenuClient +The catcher of all the server traffic + + +Stability Level +Unstable, unless otherwise indicated + + + +Synopsis + + +#include <libdbusmenu-glib/client.h> + +#define DBUSMENU_CLIENT_SIGNAL_LAYOUT_UPDATED +#define DBUSMENU_CLIENT_SIGNAL_ROOT_CHANGED +#define DBUSMENU_CLIENT_SIGNAL_NEW_MENUITEM +#define DBUSMENU_CLIENT_SIGNAL_EVENT_RESULT +#define DBUSMENU_CLIENT_SIGNAL_ITEM_ACTIVATE +#define DBUSMENU_CLIENT_SIGNAL_ICON_THEME_DIRS_CHANGED +#define DBUSMENU_CLIENT_PROP_DBUS_NAME +#define DBUSMENU_CLIENT_PROP_DBUS_OBJECT +#define DBUSMENU_CLIENT_PROP_GROUP_EVENTS +#define DBUSMENU_CLIENT_PROP_STATUS +#define DBUSMENU_CLIENT_PROP_TEXT_DIRECTION +#define DBUSMENU_CLIENT_TYPES_DEFAULT +#define DBUSMENU_CLIENT_TYPES_SEPARATOR +#define DBUSMENU_CLIENT_TYPES_IMAGE + DbusmenuClient; +struct DbusmenuClientClass; +gboolean (*DbusmenuClientTypeHandler) (DbusmenuMenuitem *newitem, + DbusmenuMenuitem *parent, + DbusmenuClient *client, + gpointer user_data); +DbusmenuClient * dbusmenu_client_new (const gchar *name, + const gchar *object); +GStrv dbusmenu_client_get_icon_paths (DbusmenuClient *client); +DbusmenuMenuitem * dbusmenu_client_get_root (DbusmenuClient *client); +DbusmenuStatus dbusmenu_client_get_status (DbusmenuClient *client); +DbusmenuTextDirection dbusmenu_client_get_text_direction + (DbusmenuClient *client); +gboolean dbusmenu_client_add_type_handler (DbusmenuClient *client, + const gchar *type, + DbusmenuClientTypeHandler newfunc); +gboolean dbusmenu_client_add_type_handler_full + (DbusmenuClient *client, + const gchar *type, + DbusmenuClientTypeHandler newfunc, + gpointer user_data, + GDestroyNotify destroy_func); + + + + +Description + +The client exists as a mirror to the server. For most folks + all they will do with a client is set it up to connect to + a server and then watch as the menu items on their side + of the bus change. This is all they should need to know about + the client, that it magically makes their menuitems dance. + + + It does this by setting up signal watchers and adjusting + the menuitems appropriately. Most users should watch the + menu items and the signal "layout-changed" for + larger events so that they can be optimized. It is possible + with that signal that even the root node would change. If + that doesn't happen the normal signals on the individual + nodes should be enough for most users. + + + +Details + +DBUSMENU_CLIENT_SIGNAL_LAYOUT_UPDATED +DBUSMENU_CLIENT_SIGNAL_LAYOUT_UPDATED +#define DBUSMENU_CLIENT_SIGNAL_LAYOUT_UPDATED "layout-updated" + + +String to attach to signal "layout-updated" + + +DBUSMENU_CLIENT_SIGNAL_ROOT_CHANGED +DBUSMENU_CLIENT_SIGNAL_ROOT_CHANGED +#define DBUSMENU_CLIENT_SIGNAL_ROOT_CHANGED "root-changed" + + +String to attach to signal "root-changed" + + +DBUSMENU_CLIENT_SIGNAL_NEW_MENUITEM +DBUSMENU_CLIENT_SIGNAL_NEW_MENUITEM +#define DBUSMENU_CLIENT_SIGNAL_NEW_MENUITEM "new-menuitem" + + +String to attach to signal "new-menuitem" + + +DBUSMENU_CLIENT_SIGNAL_EVENT_RESULT +DBUSMENU_CLIENT_SIGNAL_EVENT_RESULT +#define DBUSMENU_CLIENT_SIGNAL_EVENT_RESULT "event-result" + + +String to attach to signal "event-result" + + +DBUSMENU_CLIENT_SIGNAL_ITEM_ACTIVATE +DBUSMENU_CLIENT_SIGNAL_ITEM_ACTIVATE +#define DBUSMENU_CLIENT_SIGNAL_ITEM_ACTIVATE "item-activate" + + +String to attach to signal "item-activate" + + +DBUSMENU_CLIENT_SIGNAL_ICON_THEME_DIRS_CHANGED +DBUSMENU_CLIENT_SIGNAL_ICON_THEME_DIRS_CHANGED +#define DBUSMENU_CLIENT_SIGNAL_ICON_THEME_DIRS_CHANGED "icon-theme-dirs-changed" + + +String to attach to signal "icon-theme-dirs-changed" + + +DBUSMENU_CLIENT_PROP_DBUS_NAME +DBUSMENU_CLIENT_PROP_DBUS_NAME +#define DBUSMENU_CLIENT_PROP_DBUS_NAME "dbus-name" + + +String to access property "dbus-name" + + +DBUSMENU_CLIENT_PROP_DBUS_OBJECT +DBUSMENU_CLIENT_PROP_DBUS_OBJECT +#define DBUSMENU_CLIENT_PROP_DBUS_OBJECT "dbus-object" + + +String to access property "dbus-object" + + +DBUSMENU_CLIENT_PROP_GROUP_EVENTS +DBUSMENU_CLIENT_PROP_GROUP_EVENTS +#define DBUSMENU_CLIENT_PROP_GROUP_EVENTS "group-events" + + +String to access property "group-events" + + +DBUSMENU_CLIENT_PROP_STATUS +DBUSMENU_CLIENT_PROP_STATUS +#define DBUSMENU_CLIENT_PROP_STATUS "status" + + +String to access property "status" + + +DBUSMENU_CLIENT_PROP_TEXT_DIRECTION +DBUSMENU_CLIENT_PROP_TEXT_DIRECTION +#define DBUSMENU_CLIENT_PROP_TEXT_DIRECTION "text-direction" + + +String to access property "text-direction" + + +DBUSMENU_CLIENT_TYPES_DEFAULT +DBUSMENU_CLIENT_TYPES_DEFAULT +#define DBUSMENU_CLIENT_TYPES_DEFAULT "standard" + + +Used to set the 'type' property on a menu item to create +a standard menu item. + + +DBUSMENU_CLIENT_TYPES_SEPARATOR +DBUSMENU_CLIENT_TYPES_SEPARATOR +#define DBUSMENU_CLIENT_TYPES_SEPARATOR "separator" + + +Used to set the 'type' property on a menu item to create +a separator menu item. + + +DBUSMENU_CLIENT_TYPES_IMAGE +DBUSMENU_CLIENT_TYPES_IMAGE +#define DBUSMENU_CLIENT_TYPES_IMAGE "standard" + + +Used to set the 'type' property on a menu item to create +an image menu item. Deprecated as standard menu items now +support images as well. + + +DbusmenuClient +DbusmenuClient +typedef struct _DbusmenuClient DbusmenuClient; + +The client for a DbusmenuServer creating a shared + object set of DbusmenuMenuitem objects. + + +struct DbusmenuClientClass +DbusmenuClientClass +struct DbusmenuClientClass { + GObjectClass parent_class; + + void (*layout_updated)(void); + void (*root_changed) (DbusmenuMenuitem * newroot); + void (*new_menuitem) (DbusmenuMenuitem * newitem); + void (*item_activate) (DbusmenuMenuitem * item, guint timestamp); + void (*event_result) (DbusmenuMenuitem * item, gchar * event, GVariant * data, guint timestamp, GError * error); + void (*icon_theme_dirs) (DbusmenuMenuitem * item, gpointer theme_dirs, GError * error); + + /*< Private >*/ + void (*reserved1) (void); + void (*reserved2) (void); + void (*reserved3) (void); + void (*reserved4) (void); + void (*reserved5) (void); +}; + + +A simple class that takes all of the information from a + DbusmenuServer over DBus and makes the same set of + DbusmenuMenuitem objects appear on the other side. + +GObjectClass parent_class; +GObjectClass + +layout_updated () +Slot for "layout-updated". + +root_changed () +Slot for "root-changed". + +new_menuitem () +Slot for "new-menuitem". + +item_activate () +Slot for "item-activate". + +event_result () +Slot for "event-error". + +icon_theme_dirs () +Slot for "icon-theme-dirs-changed". + +reserved1 () +Reserved for future use. + +reserved2 () +Reserved for future use. + +reserved3 () +Reserved for future use. + +reserved4 () +Reserved for future use. + +reserved5 () +Reserved for future use. + + + +DbusmenuClientTypeHandler () +DbusmenuClientTypeHandler +gboolean (*DbusmenuClientTypeHandler) (DbusmenuMenuitem *newitem, + DbusmenuMenuitem *parent, + DbusmenuClient *client, + gpointer user_data); + +The type handler is called when a dbusmenu item is created + with a matching type as setup in dbusmenu_client_add_type_handler + +newitem : +The DbusmenuMenuitem that was created +parent : +The parent of newitem or NULL if none +client : +A pointer to the DbusmenuClient +user_data : +The data you gave us +Returns :TRUE if the type has been handled. FALSE if this +function was somehow unable to handle it. + + +dbusmenu_client_new () +dbusmenu_client_new +DbusmenuClient * dbusmenu_client_new (const gchar *name, + const gchar *object); + +This function creates a new client that connects to a specific +server on DBus. That server is at a specific location sharing +a known object. The interface is assumed by the code to be +the DBus menu interface. The newly created client will start +sending out events as it syncs up with the server. + +name : +The DBus name for the server to connect to +object : +The object on the server to monitor +Returns :A brand new DbusmenuClient + + +dbusmenu_client_get_icon_paths () +dbusmenu_client_get_icon_paths +GStrv dbusmenu_client_get_icon_paths (DbusmenuClient *client); + +Gets the stored and exported icon paths from the client. + +client : +The DbusmenuClient to get the icon paths from +Returns :A NULL-terminated list of icon paths with +memory managed by the client. Duplicate if you want +to keep them. [transfer none] + + +dbusmenu_client_get_root () +dbusmenu_client_get_root +DbusmenuMenuitem * dbusmenu_client_get_root (DbusmenuClient *client); + +Grabs the root node for the specified client client. This +function may block. It will block if there is currently a +call to update the layout, it will block on that layout +updated and then return the newly updated layout. Chances +are that this update is in the queue for the mainloop as +it would have been requested some time ago, but in theory +it could block longer. + +client : +The DbusmenuClient to get the root node from +Returns :A DbusmenuMenuitem representing the root of +menu on the server. If there is no server or there is +an error receiving its layout it'll return NULL. [transfer none] + + +dbusmenu_client_get_status () +dbusmenu_client_get_status +DbusmenuStatus dbusmenu_client_get_status (DbusmenuClient *client); + +Gets the recommended current status that the server + is exporting for the menus. In situtations where the + value is DBUSMENU_STATUS_NOTICE it is recommended that + the client show the menus to the user an a more noticible + way. + +client : +DbusmenuClient to check the status on +Returns :Status being exported. + + +dbusmenu_client_get_text_direction () +dbusmenu_client_get_text_direction +DbusmenuTextDirection dbusmenu_client_get_text_direction + (DbusmenuClient *client); + +Gets the text direction that the server is exporting. If + the server is not exporting a direction then the value + DBUSMENU_TEXT_DIRECTION_NONE will be returned. + +client : +DbusmenuClient to check the text direction on +Returns :Text direction being exported. + + +dbusmenu_client_add_type_handler () +dbusmenu_client_add_type_handler +gboolean dbusmenu_client_add_type_handler (DbusmenuClient *client, + const gchar *type, + DbusmenuClientTypeHandler newfunc); + +This function connects into the type handling of the DbusmenuClient. +Every new menuitem that comes in immediately gets asked for it's +properties. When we get those properties we check the 'type' +property and look to see if it matches a handler that is known +by the client. If so, the newfunc function is executed on that +DbusmenuMenuitem. If not, then the DbusmenuClient::new-menuitem +signal is sent. + + +In the future the known types will be sent to the server so that it +can make choices about the menu item types availble. + +client : +Client where we're getting types coming in +type : +A text string that will be matched with the 'type' +property on incoming menu items +newfunc : +The function that will be executed with those new +items when they come in. [scope notified] +Returns :If registering the new type was successful. + + +dbusmenu_client_add_type_handler_full () +dbusmenu_client_add_type_handler_full +gboolean dbusmenu_client_add_type_handler_full + (DbusmenuClient *client, + const gchar *type, + DbusmenuClientTypeHandler newfunc, + gpointer user_data, + GDestroyNotify destroy_func); + +This function connects into the type handling of the DbusmenuClient. +Every new menuitem that comes in immediately gets asked for it's +properties. When we get those properties we check the 'type' +property and look to see if it matches a handler that is known +by the client. If so, the newfunc function is executed on that +DbusmenuMenuitem. If not, then the DbusmenuClient::new-menuitem +signal is sent. + + +In the future the known types will be sent to the server so that it +can make choices about the menu item types availble. + +client : +Client where we're getting types coming in +type : +A text string that will be matched with the 'type' +property on incoming menu items +newfunc : +The function that will be executed with those new +items when they come in. [scope notified] +user_data : +Data passed to newfunc when it is called +destroy_func : +A function that is called when the type handler is +removed (usually on client destruction) which will free +the resources in user_data. +Returns :If registering the new type was successful. + + + + + === added file 'docs/libdbusmenu-glib/reference/xml/menuitem-proxy.xml' --- docs/libdbusmenu-glib/reference/xml/menuitem-proxy.xml 1970-01-01 00:00:00 +0000 +++ docs/libdbusmenu-glib/reference/xml/menuitem-proxy.xml 2012-06-13 19:49:21 +0000 @@ -0,0 +1,114 @@ + + +]> + + +DbusmenuMenuitemProxy +3 + + LIBDBUSMENU-GLIB Library + + + +DbusmenuMenuitemProxy +A menuitem that proxies from another menuitem + + +Stability Level +Unstable, unless otherwise indicated + + + +Synopsis + + +#include <libdbusmenu-glib/menuitem-proxy.h> + + DbusmenuMenuitemProxy; +struct DbusmenuMenuitemProxyClass; +DbusmenuMenuitemProxy * dbusmenu_menuitem_proxy_new (DbusmenuMenuitem *mi); +DbusmenuMenuitem * dbusmenu_menuitem_proxy_get_wrapped (DbusmenuMenuitemProxy *pmi); + + + + +Description + +This small object allows for proxying all the properties from a remote +menuitem to a new object that can be moved around appropriately within +the new menu structure. + + + +Details + +DbusmenuMenuitemProxy +DbusmenuMenuitemProxy +typedef struct _DbusmenuMenuitemProxy DbusmenuMenuitemProxy; + +Public instance data for a DbusmenuMenuitemProxy. + + +struct DbusmenuMenuitemProxyClass +DbusmenuMenuitemProxyClass +struct DbusmenuMenuitemProxyClass { + DbusmenuMenuitemClass parent_class; + + /*< Private >*/ + void (*reserved1) (void); + void (*reserved2) (void); + void (*reserved3) (void); + void (*reserved4) (void); +}; + + +Functions and signal slots for DbusmenuMenuitemProxy. + +DbusmenuMenuitemClass parent_class; +The Class of DbusmeneMenuitem + +reserved1 () +Reserved for future use. + +reserved2 () +Reserved for future use. + +reserved3 () +Reserved for future use. + +reserved4 () +Reserved for future use. + + + +dbusmenu_menuitem_proxy_new () +dbusmenu_menuitem_proxy_new +DbusmenuMenuitemProxy * dbusmenu_menuitem_proxy_new (DbusmenuMenuitem *mi); + +Builds a new DbusmenuMenuitemProxy object that proxies +all of the values for mi. + +mi : +The DbusmenuMenuitem to proxy +Returns :A new DbusmenuMenuitemProxy object. + + +dbusmenu_menuitem_proxy_get_wrapped () +dbusmenu_menuitem_proxy_get_wrapped +DbusmenuMenuitem * dbusmenu_menuitem_proxy_get_wrapped (DbusmenuMenuitemProxy *pmi); + +Accesses the private variable of which DbusmenuMenuitem +we are doing the proxying for. + +pmi : +DbusmenuMenuitemProxy to look into +Returns :A DbusmenuMenuitem object or a NULL if we +don't have one or there is an error. [transfer none] + + + + + === added file 'docs/libdbusmenu-glib/reference/xml/menuitem.xml' --- docs/libdbusmenu-glib/reference/xml/menuitem.xml 1970-01-01 00:00:00 +0000 +++ docs/libdbusmenu-glib/reference/xml/menuitem.xml 2012-06-13 19:49:21 +0000 @@ -0,0 +1,1331 @@ + + +]> + + +DbusmenuMenuitem +3 + + LIBDBUSMENU-GLIB Library + + + +DbusmenuMenuitem +A lowlevel represenation of a menuitem + + +Stability Level +Unstable, unless otherwise indicated + + + +Synopsis + + +#include <libdbusmenu-glib/menuitem.h> + +#define DBUSMENU_MENUITEM_SIGNAL_PROPERTY_CHANGED +#define DBUSMENU_MENUITEM_SIGNAL_ITEM_ACTIVATED +#define DBUSMENU_MENUITEM_SIGNAL_CHILD_ADDED +#define DBUSMENU_MENUITEM_SIGNAL_CHILD_REMOVED +#define DBUSMENU_MENUITEM_SIGNAL_CHILD_MOVED +#define DBUSMENU_MENUITEM_SIGNAL_EVENT +#define DBUSMENU_MENUITEM_SIGNAL_REALIZED +#define DBUSMENU_MENUITEM_SIGNAL_REALIZED_ID +#define DBUSMENU_MENUITEM_SIGNAL_ABOUT_TO_SHOW +#define DBUSMENU_MENUITEM_SIGNAL_SHOW_TO_USER +#define DBUSMENU_MENUITEM_PROP_TYPE +#define DBUSMENU_MENUITEM_PROP_VISIBLE +#define DBUSMENU_MENUITEM_PROP_ENABLED +#define DBUSMENU_MENUITEM_PROP_LABEL +#define DBUSMENU_MENUITEM_PROP_ICON_NAME +#define DBUSMENU_MENUITEM_PROP_ICON_DATA +#define DBUSMENU_MENUITEM_PROP_TOGGLE_TYPE +#define DBUSMENU_MENUITEM_PROP_TOGGLE_STATE +#define DBUSMENU_MENUITEM_PROP_CHILD_DISPLAY +#define DBUSMENU_MENUITEM_PROP_SHORTCUT +#define DBUSMENU_MENUITEM_PROP_DISPOSITION +#define DBUSMENU_MENUITEM_PROP_ACCESSIBLE_DESC +#define DBUSMENU_MENUITEM_TOGGLE_CHECK +#define DBUSMENU_MENUITEM_TOGGLE_RADIO +#define DBUSMENU_MENUITEM_TOGGLE_STATE_UNCHECKED +#define DBUSMENU_MENUITEM_TOGGLE_STATE_CHECKED +#define DBUSMENU_MENUITEM_TOGGLE_STATE_UNKNOWN +#define DBUSMENU_MENUITEM_ICON_NAME_BLANK +#define DBUSMENU_MENUITEM_CHILD_DISPLAY_SUBMENU +#define DBUSMENU_MENUITEM_SHORTCUT_ALT +#define DBUSMENU_MENUITEM_SHORTCUT_CONTROL +#define DBUSMENU_MENUITEM_SHORTCUT_SHIFT +#define DBUSMENU_MENUITEM_SHORTCUT_SUPER +#define DBUSMENU_MENUITEM_DISPOSITION_NORMAL +#define DBUSMENU_MENUITEM_DISPOSITION_INFORMATIVE +#define DBUSMENU_MENUITEM_DISPOSITION_WARNING +#define DBUSMENU_MENUITEM_DISPOSITION_ALERT +#define DBUSMENU_MENUITEM_EVENT_ACTIVATED +#define DBUSMENU_MENUITEM_EVENT_CLOSED +#define DBUSMENU_MENUITEM_EVENT_OPENED +struct DbusmenuMenuitem; +void (*dbusmenu_menuitem_about_to_show_cb) + (DbusmenuMenuitem *mi, + gpointer user_data); +GVariant * (*dbusmenu_menuitem_buildvariant_slot_t) + (DbusmenuMenuitem *mi, + gchar **properties); +struct DbusmenuMenuitemClass; +DbusmenuMenuitem * dbusmenu_menuitem_new (void); +DbusmenuMenuitem * dbusmenu_menuitem_new_with_id (gint id); +gint dbusmenu_menuitem_get_id (DbusmenuMenuitem *mi); +GList * dbusmenu_menuitem_get_children (DbusmenuMenuitem *mi); +GList * dbusmenu_menuitem_take_children (DbusmenuMenuitem *mi); +guint dbusmenu_menuitem_get_position (DbusmenuMenuitem *mi, + DbusmenuMenuitem *parent); +guint dbusmenu_menuitem_get_position_realized + (DbusmenuMenuitem *mi, + DbusmenuMenuitem *parent); +gboolean dbusmenu_menuitem_child_append (DbusmenuMenuitem *mi, + DbusmenuMenuitem *child); +gboolean dbusmenu_menuitem_child_prepend (DbusmenuMenuitem *mi, + DbusmenuMenuitem *child); +gboolean dbusmenu_menuitem_child_delete (DbusmenuMenuitem *mi, + DbusmenuMenuitem *child); +gboolean dbusmenu_menuitem_child_add_position + (DbusmenuMenuitem *mi, + DbusmenuMenuitem *child, + guint position); +gboolean dbusmenu_menuitem_child_reorder (DbusmenuMenuitem *mi, + DbusmenuMenuitem *child, + guint position); +DbusmenuMenuitem * dbusmenu_menuitem_child_find (DbusmenuMenuitem *mi, + gint id); +DbusmenuMenuitem * dbusmenu_menuitem_find_id (DbusmenuMenuitem *mi, + gint id); +gboolean dbusmenu_menuitem_property_set (DbusmenuMenuitem *mi, + const gchar *property, + const gchar *value); +gboolean dbusmenu_menuitem_property_set_bool (DbusmenuMenuitem *mi, + const gchar *property, + const gboolean value); +gboolean dbusmenu_menuitem_property_set_byte_array + (DbusmenuMenuitem *mi, + const gchar *property, + const guchar *value, + gsize nelements); +gboolean dbusmenu_menuitem_property_set_int (DbusmenuMenuitem *mi, + const gchar *property, + const gint value); +gboolean dbusmenu_menuitem_property_set_variant + (DbusmenuMenuitem *mi, + const gchar *property, + GVariant *value); +const gchar * dbusmenu_menuitem_property_get (DbusmenuMenuitem *mi, + const gchar *property); +gboolean dbusmenu_menuitem_property_get_bool (DbusmenuMenuitem *mi, + const gchar *property); +const guchar * dbusmenu_menuitem_property_get_byte_array + (DbusmenuMenuitem *mi, + const gchar *property, + gsize *nelements); +gint dbusmenu_menuitem_property_get_int (DbusmenuMenuitem *mi, + const gchar *property); +GVariant * dbusmenu_menuitem_property_get_variant + (DbusmenuMenuitem *mi, + const gchar *property); +gboolean dbusmenu_menuitem_property_exist (DbusmenuMenuitem *mi, + const gchar *property); +GList * dbusmenu_menuitem_properties_list (DbusmenuMenuitem *mi); +GHashTable * dbusmenu_menuitem_properties_copy (DbusmenuMenuitem *mi); +void dbusmenu_menuitem_property_remove (DbusmenuMenuitem *mi, + const gchar *property); +void dbusmenu_menuitem_set_root (DbusmenuMenuitem *mi, + gboolean root); +gboolean dbusmenu_menuitem_get_root (DbusmenuMenuitem *mi); +void dbusmenu_menuitem_foreach (DbusmenuMenuitem *mi, + void (*func) (DbusmenuMenuitem * mi, gpointer data), + gpointer data); +void dbusmenu_menuitem_handle_event (DbusmenuMenuitem *mi, + const gchar *name, + GVariant *variant, + guint timestamp); +void dbusmenu_menuitem_send_about_to_show + (DbusmenuMenuitem *mi, + void (*cb) (DbusmenuMenuitem * mi, gpointer user_data), + gpointer cb_data); +void dbusmenu_menuitem_show_to_user (DbusmenuMenuitem *mi, + guint timestamp); +DbusmenuMenuitem * dbusmenu_menuitem_get_parent (DbusmenuMenuitem *mi); +gboolean dbusmenu_menuitem_set_parent (DbusmenuMenuitem *mi, + DbusmenuMenuitem *parent); +gboolean dbusmenu_menuitem_unparent (DbusmenuMenuitem *mi); + + + + +Description + +A DbusmenuMenuitem is the lowest level of represenation of a +single item in a menu. It gets created on the server side +and copied over to the client side where it gets rendered. As +the server starts to change it, and grow it, and do all kinds +of fun stuff that information is transfered over DBus and the +client updates it's understanding of the object model. + + +Most people using either the client or the server should be +able to deal mostly with DbusmenuMenuitem objects. These +are simple, but then they can be attached to more complex +objects and handled appropriately. + + + +Details + +DBUSMENU_MENUITEM_SIGNAL_PROPERTY_CHANGED +DBUSMENU_MENUITEM_SIGNAL_PROPERTY_CHANGED +#define DBUSMENU_MENUITEM_SIGNAL_PROPERTY_CHANGED "property-changed" + + +String to attach to signal "property-changed" + + +DBUSMENU_MENUITEM_SIGNAL_ITEM_ACTIVATED +DBUSMENU_MENUITEM_SIGNAL_ITEM_ACTIVATED +#define DBUSMENU_MENUITEM_SIGNAL_ITEM_ACTIVATED "item-activated" + + +String to attach to signal "item-activated" + + +DBUSMENU_MENUITEM_SIGNAL_CHILD_ADDED +DBUSMENU_MENUITEM_SIGNAL_CHILD_ADDED +#define DBUSMENU_MENUITEM_SIGNAL_CHILD_ADDED "child-added" + + +String to attach to signal "child-added" + + +DBUSMENU_MENUITEM_SIGNAL_CHILD_REMOVED +DBUSMENU_MENUITEM_SIGNAL_CHILD_REMOVED +#define DBUSMENU_MENUITEM_SIGNAL_CHILD_REMOVED "child-removed" + + +String to attach to signal "child-removed" + + +DBUSMENU_MENUITEM_SIGNAL_CHILD_MOVED +DBUSMENU_MENUITEM_SIGNAL_CHILD_MOVED +#define DBUSMENU_MENUITEM_SIGNAL_CHILD_MOVED "child-moved" + + +String to attach to signal "child-moved" + + +DBUSMENU_MENUITEM_SIGNAL_EVENT +DBUSMENU_MENUITEM_SIGNAL_EVENT +#define DBUSMENU_MENUITEM_SIGNAL_EVENT "event" + + +String to attach to signal "event" + + +DBUSMENU_MENUITEM_SIGNAL_REALIZED +DBUSMENU_MENUITEM_SIGNAL_REALIZED +#define DBUSMENU_MENUITEM_SIGNAL_REALIZED "realized" + + +String to attach to signal "realized" + + +DBUSMENU_MENUITEM_SIGNAL_REALIZED_ID +DBUSMENU_MENUITEM_SIGNAL_REALIZED_ID +#define DBUSMENU_MENUITEM_SIGNAL_REALIZED_ID (g_signal_lookup(DBUSMENU_MENUITEM_SIGNAL_REALIZED, DBUSMENU_TYPE_MENUITEM)) + + +ID to attach to signal "realized" + + +DBUSMENU_MENUITEM_SIGNAL_ABOUT_TO_SHOW +DBUSMENU_MENUITEM_SIGNAL_ABOUT_TO_SHOW +#define DBUSMENU_MENUITEM_SIGNAL_ABOUT_TO_SHOW "about-to-show" + + +String to attach to signal "about-to-show" + + +DBUSMENU_MENUITEM_SIGNAL_SHOW_TO_USER +DBUSMENU_MENUITEM_SIGNAL_SHOW_TO_USER +#define DBUSMENU_MENUITEM_SIGNAL_SHOW_TO_USER "show-to-user" + + +String to attach to signal "show-to-user" + + +DBUSMENU_MENUITEM_PROP_TYPE +DBUSMENU_MENUITEM_PROP_TYPE +#define DBUSMENU_MENUITEM_PROP_TYPE "type" + + +DbusmenuMenuitem property used to represent what type of menuitem +this object represents. Type: G_VARIANT_TYPE_STRING. + + +DBUSMENU_MENUITEM_PROP_VISIBLE +DBUSMENU_MENUITEM_PROP_VISIBLE +#define DBUSMENU_MENUITEM_PROP_VISIBLE "visible" + + +DbusmenuMenuitem property used to represent whether the menuitem +should be shown or not. Type: G_VARIANT_TYPE_BOOLEAN. + + +DBUSMENU_MENUITEM_PROP_ENABLED +DBUSMENU_MENUITEM_PROP_ENABLED +#define DBUSMENU_MENUITEM_PROP_ENABLED "enabled" + + +DbusmenuMenuitem property used to represent whether the menuitem +is clickable or not. Type: G_VARIANT_TYPE_BOOLEAN. + + +DBUSMENU_MENUITEM_PROP_LABEL +DBUSMENU_MENUITEM_PROP_LABEL +#define DBUSMENU_MENUITEM_PROP_LABEL "label" + + +DbusmenuMenuitem property used for the text on the menu item. +Type: G_VARIANT_TYPE_STRING + + +DBUSMENU_MENUITEM_PROP_ICON_NAME +DBUSMENU_MENUITEM_PROP_ICON_NAME +#define DBUSMENU_MENUITEM_PROP_ICON_NAME "icon-name" + + +DbusmenuMenuitem property that is the name of the icon under the +Freedesktop.org icon naming spec. Type: G_VARIANT_TYPE_STRING + + +DBUSMENU_MENUITEM_PROP_ICON_DATA +DBUSMENU_MENUITEM_PROP_ICON_DATA +#define DBUSMENU_MENUITEM_PROP_ICON_DATA "icon-data" + + +DbusmenuMenuitem property that is the raw data of a custom icon +used in the application. Type: G_VARIANT_TYPE_VARIANT + + +It is recommended that this is not set directly but instead the +libdbusmenu-gtk library is used with the function dbusmenu_menuitem_property_set_image() + + +DBUSMENU_MENUITEM_PROP_TOGGLE_TYPE +DBUSMENU_MENUITEM_PROP_TOGGLE_TYPE +#define DBUSMENU_MENUITEM_PROP_TOGGLE_TYPE "toggle-type" + + +DbusmenuMenuitem property that says what type of toggle entry should +be shown in the menu. Should be either DBUSMENU_MENUITEM_TOGGLE_CHECK +or DBUSMENU_MENUITEM_TOGGLE_RADIO. Type: G_VARIANT_TYPE_STRING + + +DBUSMENU_MENUITEM_PROP_TOGGLE_STATE +DBUSMENU_MENUITEM_PROP_TOGGLE_STATE +#define DBUSMENU_MENUITEM_PROP_TOGGLE_STATE "toggle-state" + + +DbusmenuMenuitem property that says what state a toggle entry should +be shown as the menu. Should be either DBUSMENU_MENUITEM_TOGGLE_STATE_UNCHECKED +DBUSMENU_MENUITEM_TOGGLE_STATE_CHECKED or DBUSMENU_MENUITEM_TOGGLE_STATUE_UNKNOWN. +Type: G_VARIANT_TYPE_INT32 + + +DBUSMENU_MENUITEM_PROP_CHILD_DISPLAY +DBUSMENU_MENUITEM_PROP_CHILD_DISPLAY +#define DBUSMENU_MENUITEM_PROP_CHILD_DISPLAY "children-display" + + +DbusmenuMenuitem property that tells how the children of this menuitem +should be displayed. Most likely this will be unset or of the value +DBUSMENU_MENUITEM_CHILD_DISPLAY_SUBMENU. Type: G_VARIANT_TYPE_STRING + + +DBUSMENU_MENUITEM_PROP_SHORTCUT +DBUSMENU_MENUITEM_PROP_SHORTCUT +#define DBUSMENU_MENUITEM_PROP_SHORTCUT "shortcut" + + +DbusmenuMenuitem property that is the entries that represent a shortcut +to activate the menuitem. It is an array of arrays of strings. +Type: G_VARIANT_TYPE_ARRAY + + +It is recommended that this is not set directly but instead the +libdbusmenu-gtk library is used with the function dbusmenu_menuitem_property_set_shortcut() + + +DBUSMENU_MENUITEM_PROP_DISPOSITION +DBUSMENU_MENUITEM_PROP_DISPOSITION +#define DBUSMENU_MENUITEM_PROP_DISPOSITION "disposition" + + +DbusmenuMenuitem property to tell what type of information that the +menu item is displaying to the user. Type: G_VARIANT_TYPE_STRING + + +DBUSMENU_MENUITEM_PROP_ACCESSIBLE_DESC +DBUSMENU_MENUITEM_PROP_ACCESSIBLE_DESC +#define DBUSMENU_MENUITEM_PROP_ACCESSIBLE_DESC "accessible-desc" + + +DbusmenuMenuitem property used to provide a textual description of any +information that the icon may convey. The contents of this property are +passed through to assistive technologies such as the Orca screen reader. +The contents of this property will not be visible in the menu item. If +this property is set, Orca will use this property instead of the label +property. +Type: G_VARIANT_TYPE_STRING + + +DBUSMENU_MENUITEM_TOGGLE_CHECK +DBUSMENU_MENUITEM_TOGGLE_CHECK +#define DBUSMENU_MENUITEM_TOGGLE_CHECK "checkmark" + + +Used to set DBUSMENU_MENUITEM_PROP_TOGGLE_TYPE to be a standard +check mark item. + + +DBUSMENU_MENUITEM_TOGGLE_RADIO +DBUSMENU_MENUITEM_TOGGLE_RADIO +#define DBUSMENU_MENUITEM_TOGGLE_RADIO "radio" + + +Used to set DBUSMENU_MENUITEM_PROP_TOGGLE_TYPE to be a standard +radio item. + + +DBUSMENU_MENUITEM_TOGGLE_STATE_UNCHECKED +DBUSMENU_MENUITEM_TOGGLE_STATE_UNCHECKED +#define DBUSMENU_MENUITEM_TOGGLE_STATE_UNCHECKED 0 + + +Used to set DBUSMENU_MENUITEM_PROP_TOGGLE_STATE so that the menu's +toggle item is empty. + + +DBUSMENU_MENUITEM_TOGGLE_STATE_CHECKED +DBUSMENU_MENUITEM_TOGGLE_STATE_CHECKED +#define DBUSMENU_MENUITEM_TOGGLE_STATE_CHECKED 1 + + +Used to set DBUSMENU_MENUITEM_PROP_TOGGLE_STATE so that the menu's +toggle item is filled. + + +DBUSMENU_MENUITEM_TOGGLE_STATE_UNKNOWN +DBUSMENU_MENUITEM_TOGGLE_STATE_UNKNOWN +#define DBUSMENU_MENUITEM_TOGGLE_STATE_UNKNOWN -1 + + +Used to set DBUSMENU_MENUITEM_PROP_TOGGLE_STATE so that the menu's +toggle item is undecided. + + +DBUSMENU_MENUITEM_ICON_NAME_BLANK +DBUSMENU_MENUITEM_ICON_NAME_BLANK +#define DBUSMENU_MENUITEM_ICON_NAME_BLANK "blank-icon" + + +Used to set DBUSMENU_MENUITEM_PROP_TOGGLE_STATE so that the menu's +toggle item is undecided. + + +DBUSMENU_MENUITEM_CHILD_DISPLAY_SUBMENU +DBUSMENU_MENUITEM_CHILD_DISPLAY_SUBMENU +#define DBUSMENU_MENUITEM_CHILD_DISPLAY_SUBMENU "submenu" + + +Used in DBUSMENU_MENUITEM_PROP_CHILD_DISPLAY to have the +subitems displayed as a submenu. + + +DBUSMENU_MENUITEM_SHORTCUT_ALT +DBUSMENU_MENUITEM_SHORTCUT_ALT +#define DBUSMENU_MENUITEM_SHORTCUT_ALT "Alt" + + +Used in DBUSMENU_MENUITEM_PROP_SHORTCUT to represent the +alternate key. + + +DBUSMENU_MENUITEM_SHORTCUT_CONTROL +DBUSMENU_MENUITEM_SHORTCUT_CONTROL +#define DBUSMENU_MENUITEM_SHORTCUT_CONTROL "Control" + + +Used in DBUSMENU_MENUITEM_PROP_SHORTCUT to represent the +control key. + + +DBUSMENU_MENUITEM_SHORTCUT_SHIFT +DBUSMENU_MENUITEM_SHORTCUT_SHIFT +#define DBUSMENU_MENUITEM_SHORTCUT_SHIFT "Shift" + + +Used in DBUSMENU_MENUITEM_PROP_SHORTCUT to represent the +shift key. + + +DBUSMENU_MENUITEM_SHORTCUT_SUPER +DBUSMENU_MENUITEM_SHORTCUT_SUPER +#define DBUSMENU_MENUITEM_SHORTCUT_SUPER "Super" + + +Used in DBUSMENU_MENUITEM_PROP_SHORTCUT to represent the +super key. + + +DBUSMENU_MENUITEM_DISPOSITION_NORMAL +DBUSMENU_MENUITEM_DISPOSITION_NORMAL +#define DBUSMENU_MENUITEM_DISPOSITION_NORMAL "normal" + + +Used in DBUSMENU_MENUITEM_PROP_DISPOSITION to have a menu +item displayed in the normal manner. Default value. + + +DBUSMENU_MENUITEM_DISPOSITION_INFORMATIVE +DBUSMENU_MENUITEM_DISPOSITION_INFORMATIVE +#define DBUSMENU_MENUITEM_DISPOSITION_INFORMATIVE "informative" + + +Used in DBUSMENU_MENUITEM_PROP_DISPOSITION to have a menu +item displayed in a way that conveys it's giving additional +information to the user. + + +DBUSMENU_MENUITEM_DISPOSITION_WARNING +DBUSMENU_MENUITEM_DISPOSITION_WARNING +#define DBUSMENU_MENUITEM_DISPOSITION_WARNING "warning" + + +Used in DBUSMENU_MENUITEM_PROP_DISPOSITION to have a menu +item displayed in a way that conveys it's giving a warning +to the user. + + +DBUSMENU_MENUITEM_DISPOSITION_ALERT +DBUSMENU_MENUITEM_DISPOSITION_ALERT +#define DBUSMENU_MENUITEM_DISPOSITION_ALERT "alert" + + +Used in DBUSMENU_MENUITEM_PROP_DISPOSITION to have a menu +item displayed in a way that conveys it's giving an alert +to the user. + + +DBUSMENU_MENUITEM_EVENT_ACTIVATED +DBUSMENU_MENUITEM_EVENT_ACTIVATED +#define DBUSMENU_MENUITEM_EVENT_ACTIVATED "clicked" + + +String for the event identifier when a menu item is clicked +on by the user. + + +DBUSMENU_MENUITEM_EVENT_CLOSED +DBUSMENU_MENUITEM_EVENT_CLOSED +#define DBUSMENU_MENUITEM_EVENT_CLOSED "closed" + + +String for the event identifier when a menu is closed and +displayed to the user. Only valid for items that contain +submenus. + + +DBUSMENU_MENUITEM_EVENT_OPENED +DBUSMENU_MENUITEM_EVENT_OPENED +#define DBUSMENU_MENUITEM_EVENT_OPENED "opened" + + +String for the event identifier when a menu is opened and +displayed to the user. Only valid for items that contain +submenus. + + +struct DbusmenuMenuitem +DbusmenuMenuitem +struct DbusmenuMenuitem { + GObject parent; + + /*< Private >*/ + DbusmenuMenuitemPrivate * priv; +}; + + +This is the GObject based object that represents a menu +item. It gets created the same on both the client and +the server side and libdbusmenu-glib does the work of making +this object model appear on both sides of DBus. Simple +really, though through updates and people coming on and off +the bus it can lead to lots of fun complex scenarios. + +GObject parent; +Parent object + +DbusmenuMenuitemPrivate *priv; +Private data + + + +dbusmenu_menuitem_about_to_show_cb () +dbusmenu_menuitem_about_to_show_cb +void (*dbusmenu_menuitem_about_to_show_cb) + (DbusmenuMenuitem *mi, + gpointer user_data); + +Callback prototype for a callback that is called when the +menu should be shown. + +mi : +Menu item that should be shown +user_data : +Extra user data sent with the function. [closure] + + +dbusmenu_menuitem_buildvariant_slot_t () +dbusmenu_menuitem_buildvariant_slot_t +GVariant * (*dbusmenu_menuitem_buildvariant_slot_t) + (DbusmenuMenuitem *mi, + gchar **properties); + +This is the function that is called to represent this menu item +as a variant. Should call it's own children. + +mi : +Menu item that should be built from. [in] +properties : +A list of properties that should be the only ones in the resulting variant structure. [allow-none] +Returns :A variant representing this item and it's children. [transfer full] + + +struct DbusmenuMenuitemClass +DbusmenuMenuitemClass +struct DbusmenuMenuitemClass { + GObjectClass parent_class; + + /* Signals */ + void (*property_changed) (gchar * property, GVariant * value); + void (*item_activated) (guint timestamp); + void (*child_added) (DbusmenuMenuitem * child, guint position); + void (*child_removed) (DbusmenuMenuitem * child); + void (*child_moved) (DbusmenuMenuitem * child, guint newpos, guint oldpos); + void (*realized) (void); + + /* Virtual functions */ + dbusmenu_menuitem_buildvariant_slot_t buildvariant; + void (*handle_event) (DbusmenuMenuitem * mi, const gchar * name, GVariant * variant, guint timestamp); + void (*send_about_to_show) (DbusmenuMenuitem * mi, void (*cb) (DbusmenuMenuitem * mi, gpointer user_data), gpointer cb_data); + + void (*show_to_user) (DbusmenuMenuitem * mi, guint timestamp, gpointer cb_data); + gboolean (*about_to_show) (void); + + void (*event) (const gchar * name, GVariant * value, guint timestamp); + + /*< Private >*/ + void (*reserved1) (void); + void (*reserved2) (void); + void (*reserved3) (void); + void (*reserved4) (void); + void (*reserved5) (void); +}; + + +Functions and signals that every menuitem should know something +about. + +GObjectClass parent_class; +Functions and signals from our parent + +property_changed () +Slot for "property-changed". + +item_activated () +Slot for "item-activated". + +child_added () +Slot for "child-added". + +child_removed () +Slot for "child-removed". + +child_moved () +Slot for "child-moved". + +realized () +Slot for "realized". + +dbusmenu_menuitem_buildvariant_slot_t buildvariant; +Virtual function that appends the strings required to represent this menu item in the menu variant. + +handle_event () +This function is to override how events are handled by subclasses. Look at dbusmenu_menuitem_handle_event for lots of good information. + +show_to_user () +Slot for "show-to-user". + +about_to_show () +Slot for "about-to-show". + +event () +Slot for "event". + +reserved1 () +Reserved for future use. + +reserved2 () +Reserved for future use. + +reserved3 () +Reserved for future use. + +reserved4 () +Reserved for future use. + +reserved5 () +Reserved for future use. + + + +dbusmenu_menuitem_new () +dbusmenu_menuitem_new +DbusmenuMenuitem * dbusmenu_menuitem_new (void); + +Create a new DbusmenuMenuitem with all default values. + +Returns :A newly allocated DbusmenuMenuitem. + + +dbusmenu_menuitem_new_with_id () +dbusmenu_menuitem_new_with_id +DbusmenuMenuitem * dbusmenu_menuitem_new_with_id (gint id); + +This creates a blank DbusmenuMenuitem with a specific ID. + +id : +ID to use for this menuitem +Returns :A newly allocated DbusmenuMenuitem. + + +dbusmenu_menuitem_get_id () +dbusmenu_menuitem_get_id +gint dbusmenu_menuitem_get_id (DbusmenuMenuitem *mi); + +Gets the unique ID for mi. + +mi : +The DbusmenuMenuitem to query. +Returns :The ID of the mi. + + +dbusmenu_menuitem_get_children () +dbusmenu_menuitem_get_children +GList * dbusmenu_menuitem_get_children (DbusmenuMenuitem *mi); + +Returns simply the list of children that this menu item +has. The list is valid until another child related function +is called, where it might be changed. + +mi : +The DbusmenuMenuitem to query. +Returns :A GList of pointers to DbusmenuMenuitem objects. [transfer none][element-type Dbusmenu.Menuitem] + + +dbusmenu_menuitem_take_children () +dbusmenu_menuitem_take_children +GList * dbusmenu_menuitem_take_children (DbusmenuMenuitem *mi); + +While the name sounds devious that's exactly what this function +does. It takes the list of children from the mi and clears the +internal list. The calling function is now in charge of the ref's +on the children it has taken. A lot of responsibility involved +in taking children. + +mi : +The DbusmenMenuitem to take the children from. +Returns :A GList of pointers to DbusmenuMenuitem objects. [transfer full][element-type Dbusmenu.Menuitem] + + +dbusmenu_menuitem_get_position () +dbusmenu_menuitem_get_position +guint dbusmenu_menuitem_get_position (DbusmenuMenuitem *mi, + DbusmenuMenuitem *parent); + +This function returns the position of the menu item mi +in the children of parent. It will return zero if the +menu item can't be found. + +mi : +The DbusmenuMenuitem to find the position of +parent : +The DbusmenuMenuitem who's children contain mi +Returns :The position of mi in the children of parent. + + +dbusmenu_menuitem_get_position_realized () +dbusmenu_menuitem_get_position_realized +guint dbusmenu_menuitem_get_position_realized + (DbusmenuMenuitem *mi, + DbusmenuMenuitem *parent); + +This function is very similar to dbusmenu_menuitem_get_position +except that it only counts in the children that have been realized. + +mi : +The DbusmenuMenuitem to find the position of +parent : +The DbusmenuMenuitem who's children contain mi +Returns :The position of mi in the realized children of parent. + + +dbusmenu_menuitem_child_append () +dbusmenu_menuitem_child_append +gboolean dbusmenu_menuitem_child_append (DbusmenuMenuitem *mi, + DbusmenuMenuitem *child); + +This function adds child to the list of children on mi at +the end of that list. + +mi : +The DbusmenuMenuitem which will become a new parent +child : +The DbusmenMenuitem that will be a child +Returns :Whether the child has been added successfully. + + +dbusmenu_menuitem_child_prepend () +dbusmenu_menuitem_child_prepend +gboolean dbusmenu_menuitem_child_prepend (DbusmenuMenuitem *mi, + DbusmenuMenuitem *child); + +This function adds child to the list of children on mi at +the beginning of that list. + +mi : +The DbusmenuMenuitem which will become a new parent +child : +The DbusmenMenuitem that will be a child +Returns :Whether the child has been added successfully. + + +dbusmenu_menuitem_child_delete () +dbusmenu_menuitem_child_delete +gboolean dbusmenu_menuitem_child_delete (DbusmenuMenuitem *mi, + DbusmenuMenuitem *child); + +This function removes child from the children list of mi. It does +not call g_object_unref on child. + +mi : +The DbusmenuMenuitem which has child as a child +child : +The child DbusmenuMenuitem that you want to no longer +be a child of mi. +Returns :If we were able to delete child. + + +dbusmenu_menuitem_child_add_position () +dbusmenu_menuitem_child_add_position +gboolean dbusmenu_menuitem_child_add_position + (DbusmenuMenuitem *mi, + DbusmenuMenuitem *child, + guint position); + +Puts child in the list of children for mi at the location +specified in position. If there is not enough entires available +then child will be placed at the end of the list. + +mi : +The DbusmenuMenuitem that we're adding the child child to. +child : +The DbusmenuMenuitem to make a child of mi. +position : +Where in mi object's list of chidren child should be placed. +Returns :Whether child was added successfully. + + +dbusmenu_menuitem_child_reorder () +dbusmenu_menuitem_child_reorder +gboolean dbusmenu_menuitem_child_reorder (DbusmenuMenuitem *mi, + DbusmenuMenuitem *child, + guint position); + +This function moves a child on the list of children. It is +for a child that is already in the list, but simply needs a +new location. + +mi : +The DbusmenuMenuitem that has children needing realignment +child : +The DbusmenuMenuitem that is a child needing to be moved +position : +The position in the list to place it in +Returns :Whether the move was successful. + + +dbusmenu_menuitem_child_find () +dbusmenu_menuitem_child_find +DbusmenuMenuitem * dbusmenu_menuitem_child_find (DbusmenuMenuitem *mi, + gint id); + +Search the children of mi to find one with the ID of id. +If it doesn't exist then we return NULL. + +mi : +The DbusmenuMenuitem who's children to look on +id : +The ID of the child that we're looking for. +Returns :The menu item with the ID id or NULL if it +can't be found. [transfer none] + + +dbusmenu_menuitem_find_id () +dbusmenu_menuitem_find_id +DbusmenuMenuitem * dbusmenu_menuitem_find_id (DbusmenuMenuitem *mi, + gint id); + +This function searchs the whole tree of children that +are attached to mi. This could be quite a few nodes, all +the way down the tree. It is a depth first search. + +mi : +DbusmenuMenuitem at the top of the tree to search +id : +ID of the DbusmenuMenuitem to search for +Returns :The DbusmenuMenuitem with the ID of id +or NULL if there isn't such a menu item in the tree +represented by mi. [transfer none] + + +dbusmenu_menuitem_property_set () +dbusmenu_menuitem_property_set +gboolean dbusmenu_menuitem_property_set (DbusmenuMenuitem *mi, + const gchar *property, + const gchar *value); + +Takes the pair of property and value and places them as a +property on mi. If a property already exists by that name, +then the value is set to the new value. If not, the property +is added. If the value is changed or the property was previously +unset then the signal "prop-changed" will be +emitted by this function. + +mi : +The DbusmenuMenuitem to set the property on. +property : +Name of the property to set. +value : +The value of the property. +Returns :A boolean representing if the property value was set. + + +dbusmenu_menuitem_property_set_bool () +dbusmenu_menuitem_property_set_bool +gboolean dbusmenu_menuitem_property_set_bool (DbusmenuMenuitem *mi, + const gchar *property, + const gboolean value); + +Takes a boolean value and sets it on property as a +property on mi. If a property already exists by that name, +then the value is set to the new value. If not, the property +is added. If the value is changed or the property was previously +unset then the signal "prop-changed" will be +emitted by this function. + +mi : +The DbusmenuMenuitem to set the property on. +property : +Name of the property to set. +value : +The value of the property. +Returns :A boolean representing if the property value was set. + + +dbusmenu_menuitem_property_set_byte_array () +dbusmenu_menuitem_property_set_byte_array +gboolean dbusmenu_menuitem_property_set_byte_array + (DbusmenuMenuitem *mi, + const gchar *property, + const guchar *value, + gsize nelements); + +Takes a byte array value and sets it on property as a +property on mi. If a property already exists by that name, +then the value is set to the new value. If not, the property +is added. If the value is changed or the property was previously +unset then the signal "prop-changed" will be +emitted by this function. + +mi : +The DbusmenuMenuitem to set the property on. +property : +Name of the property to set. +value : +The byte array. +nelements : +The number of elements in the byte array. +Returns :A boolean representing if the property value was set. + + +dbusmenu_menuitem_property_set_int () +dbusmenu_menuitem_property_set_int +gboolean dbusmenu_menuitem_property_set_int (DbusmenuMenuitem *mi, + const gchar *property, + const gint value); + +Takes a boolean value and sets it on property as a +property on mi. If a property already exists by that name, +then the value is set to the new value. If not, the property +is added. If the value is changed or the property was previously +unset then the signal "prop-changed" will be +emitted by this function. + +mi : +The DbusmenuMenuitem to set the property on. +property : +Name of the property to set. +value : +The value of the property. +Returns :A boolean representing if the property value was set. + + +dbusmenu_menuitem_property_set_variant () +dbusmenu_menuitem_property_set_variant +gboolean dbusmenu_menuitem_property_set_variant + (DbusmenuMenuitem *mi, + const gchar *property, + GVariant *value); + +Takes the pair of property and value and places them as a +property on mi. If a property already exists by that name, +then the value is set to the new value. If not, the property +is added. If the value is changed or the property was previously +unset then the signal "prop-changed" will be +emitted by this function. + +mi : +The DbusmenuMenuitem to set the property on. +property : +Name of the property to set. +value : +The value of the property. +Returns :A boolean representing if the property value was set. + + +dbusmenu_menuitem_property_get () +dbusmenu_menuitem_property_get +const gchar * dbusmenu_menuitem_property_get (DbusmenuMenuitem *mi, + const gchar *property); + +Look up a property on mi and return the value of it if +it exits. NULL will be returned if the property doesn't +exist. + +mi : +The DbusmenuMenuitem to look for the property on. +property : +The property to grab. +Returns :A string with the value of the property +that shouldn't be free'd. Or NULL if the property +is not set or is not a string. [transfer none] + + +dbusmenu_menuitem_property_get_bool () +dbusmenu_menuitem_property_get_bool +gboolean dbusmenu_menuitem_property_get_bool (DbusmenuMenuitem *mi, + const gchar *property); + +Look up a property on mi and return the value of it if +it exits. Returns FALSE if the property doesn't exist. + +mi : +The DbusmenuMenuitem to look for the property on. +property : +The property to grab. +Returns :The value of the property or FALSE. + + +dbusmenu_menuitem_property_get_byte_array () +dbusmenu_menuitem_property_get_byte_array +const guchar * dbusmenu_menuitem_property_get_byte_array + (DbusmenuMenuitem *mi, + const gchar *property, + gsize *nelements); + +Look up a property on mi and return the value of it if +it exits. NULL will be returned if the property doesn't +exist. + +mi : +The DbusmenuMenuitem to look for the property on. +property : +The property to grab. +nelements : +A pointer to the location to store the number of items (out) +Returns :A byte array with the +value of the property that shouldn't be free'd. Or NULL if the property +is not set or is not a byte array. [array length=nelements][element-type guint8][transfer none] + + +dbusmenu_menuitem_property_get_int () +dbusmenu_menuitem_property_get_int +gint dbusmenu_menuitem_property_get_int (DbusmenuMenuitem *mi, + const gchar *property); + +Look up a property on mi and return the value of it if +it exits. Returns zero if the property doesn't exist. + +mi : +The DbusmenuMenuitem to look for the property on. +property : +The property to grab. +Returns :The value of the property or zero. + + +dbusmenu_menuitem_property_get_variant () +dbusmenu_menuitem_property_get_variant +GVariant * dbusmenu_menuitem_property_get_variant + (DbusmenuMenuitem *mi, + const gchar *property); + +Look up a property on mi and return the value of it if +it exits. NULL will be returned if the property doesn't +exist. + +mi : +The DbusmenuMenuitem to look for the property on. +property : +The property to grab. +Returns :A GVariant for the property. [transfer none] + + +dbusmenu_menuitem_property_exist () +dbusmenu_menuitem_property_exist +gboolean dbusmenu_menuitem_property_exist (DbusmenuMenuitem *mi, + const gchar *property); + +Checkes to see if a particular property exists on mi and +returns TRUE if so. + +mi : +The DbusmenuMenuitem to look for the property on. +property : +The property to look for. +Returns :A boolean checking to see if the property is available + + +dbusmenu_menuitem_properties_list () +dbusmenu_menuitem_properties_list +GList * dbusmenu_menuitem_properties_list (DbusmenuMenuitem *mi); + +This functiong gets a list of the names of all the properties +that are set on this menu item. This data on the list is owned +by the menuitem but the list is not and should be freed using +g_list_free() when the calling function is done with it. + +mi : +DbusmenuMenuitem to list the properties on +Returns :A list of +strings or NULL if there are none. [transfer container][element-type utf8] + + +dbusmenu_menuitem_properties_copy () +dbusmenu_menuitem_properties_copy +GHashTable * dbusmenu_menuitem_properties_copy (DbusmenuMenuitem *mi); + +This function takes the properties of a DbusmenuMenuitem +and puts them into a GHashTable that is referenced by the +key of a string and has the value of a string. The hash +table may not have any entries if there aren't any or there +is an error in processing. It is the caller's responsibility +to destroy the created GHashTable. + +mi : +DbusmenuMenuitem that we're interested in the properties of +Returns :A brand new GHashTable that contains all of +theroperties that are on this DbusmenuMenuitem mi. [transfer full] + + +dbusmenu_menuitem_property_remove () +dbusmenu_menuitem_property_remove +void dbusmenu_menuitem_property_remove (DbusmenuMenuitem *mi, + const gchar *property); + +Removes a property from the menuitem. + +mi : +The DbusmenuMenuitem to remove the property on. +property : +The property to look for. + + +dbusmenu_menuitem_set_root () +dbusmenu_menuitem_set_root +void dbusmenu_menuitem_set_root (DbusmenuMenuitem *mi, + gboolean root); + +This function sets the internal value of whether this is a +root node or not. + +mi : +DbusmenuMenuitem to set whether it's root +root : +Whether mi is a root node or not + + +dbusmenu_menuitem_get_root () +dbusmenu_menuitem_get_root +gboolean dbusmenu_menuitem_get_root (DbusmenuMenuitem *mi); + +This function returns the internal value of whether this is a +root node or not. + +mi : +DbusmenuMenuitem to see whether it's root +Returns :TRUE if this is a root node + + +dbusmenu_menuitem_foreach () +dbusmenu_menuitem_foreach +void dbusmenu_menuitem_foreach (DbusmenuMenuitem *mi, + void (*func) (DbusmenuMenuitem * mi, gpointer data), + gpointer data); + +This calls the function func on this menu item and all +of the children of this item. And their children. And +their children. And... you get the point. It will get +called on the whole tree. + +mi : +The DbusmenItem to start from +func : +Function to call on every node in the tree +data : +User data to pass to the function. [closure] + + +dbusmenu_menuitem_handle_event () +dbusmenu_menuitem_handle_event +void dbusmenu_menuitem_handle_event (DbusmenuMenuitem *mi, + const gchar *name, + GVariant *variant, + guint timestamp); + +This function is called to create an event. It is likely +to be overrided by subclasses. The default menu item +will respond to the activate signal and do: + + +Emits the "item-activate" signal on this +menu item. Called by server objects when they get the +appropriate DBus signals from the client. + + +If you subclass this function you should really think +about calling the parent function unless you have a good +reason not to. + +mi : +The DbusmenuMenuitem to send the signal on. +name : +The name of the signal +variant : +A value that could be set for the event +timestamp : +The timestamp of when the event happened + + +dbusmenu_menuitem_send_about_to_show () +dbusmenu_menuitem_send_about_to_show +void dbusmenu_menuitem_send_about_to_show + (DbusmenuMenuitem *mi, + void (*cb) (DbusmenuMenuitem * mi, gpointer user_data), + gpointer cb_data); + +This function is used to send the even that the submenu +of this item is about to be shown. Callers to this event +should delay showing the menu until their callback is +called if possible. + +mi : +The DbusmenuMenuitem to send the signal on. +cb : +Callback to call when the call has returned. +cb_data : +Data to pass to the callback. [closure] + + +dbusmenu_menuitem_show_to_user () +dbusmenu_menuitem_show_to_user +void dbusmenu_menuitem_show_to_user (DbusmenuMenuitem *mi, + guint timestamp); + +Signals that this menu item should be shown to the user. If this is +server side the server will then take it and send it over the +bus. + +mi : +DbusmenuMenuitem to show +timestamp : +The time that the user requested it to be shown + + +dbusmenu_menuitem_get_parent () +dbusmenu_menuitem_get_parent +DbusmenuMenuitem * dbusmenu_menuitem_get_parent (DbusmenuMenuitem *mi); + +This function looks up the parent of mi + +mi : +The DbusmenuMenuitem for which to inspect the parent +Returns :The parent of this menu item. [transfer none] + + +dbusmenu_menuitem_set_parent () +dbusmenu_menuitem_set_parent +gboolean dbusmenu_menuitem_set_parent (DbusmenuMenuitem *mi, + DbusmenuMenuitem *parent); + +Sets the parent of mi to parent. If mi already +has a parent, then this call will fail. The parent will +be set automatically when using the usual methods to add a +child menuitem, so this function should not normally be +called directly + +mi : +The DbusmenuMenuitem for which to set the parent +parent : +The new parent DbusmenuMenuitem +Returns :Whether the parent was set successfully + + +dbusmenu_menuitem_unparent () +dbusmenu_menuitem_unparent +gboolean dbusmenu_menuitem_unparent (DbusmenuMenuitem *mi); + +Unparents the menu item mi. If mi doesn't have a +parent, then this call will fail. The menuitem will +be unparented automatically when using the usual methods +to delete a child menuitem, so this function should not +normally be called directly + +mi : +The DbusmenuMenuitem to unparent +Returns :Whether the menu item was unparented successfully + + + + + === added file 'docs/libdbusmenu-glib/reference/xml/server.xml' --- docs/libdbusmenu-glib/reference/xml/server.xml 1970-01-01 00:00:00 +0000 +++ docs/libdbusmenu-glib/reference/xml/server.xml 2012-06-13 19:49:21 +0000 @@ -0,0 +1,309 @@ + + +]> + + +DbusmenuServer +3 + + LIBDBUSMENU-GLIB Library + + + +DbusmenuServer +The server signals changed and + updates on a tree of DbusmenuMenuitem objecs. + + +Stability Level +Unstable, unless otherwise indicated + + + +Synopsis + + +#include <libdbusmenu-glib/server.h> + +#define DBUSMENU_SERVER_SIGNAL_ID_PROP_UPDATE +#define DBUSMENU_SERVER_SIGNAL_ID_UPDATE +#define DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATED +#define DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATE +#define DBUSMENU_SERVER_SIGNAL_ITEM_ACTIVATION +#define DBUSMENU_SERVER_PROP_DBUS_OBJECT +#define DBUSMENU_SERVER_PROP_ROOT_NODE +#define DBUSMENU_SERVER_PROP_STATUS +#define DBUSMENU_SERVER_PROP_TEXT_DIRECTION +#define DBUSMENU_SERVER_PROP_VERSION + DbusmenuServer; +struct DbusmenuServerClass; +DbusmenuServer * dbusmenu_server_new (const gchar *object); +DbusmenuStatus dbusmenu_server_get_status (DbusmenuServer *server); +DbusmenuTextDirection dbusmenu_server_get_text_direction + (DbusmenuServer *server); +void dbusmenu_server_set_root (DbusmenuServer *self, + DbusmenuMenuitem *root); +void dbusmenu_server_set_status (DbusmenuServer *server, + DbusmenuStatus status); +void dbusmenu_server_set_text_direction (DbusmenuServer *server, + DbusmenuTextDirection dir); + + + + +Description + +A DbusmenuServer is the object that represents the local + tree of DbusmenuMenuitem objects on DBus. It watches the + various signals that those objects emit and correctly + represents them across DBus to a DbusmenuClient so that + the same tree can be maintained in another process. + + + The server needs to have the root set of DbusmenuMenuitem + objects set via dbusmenu_server_set_root but it will query + all of the objects in that tree automatically. After setting + the root there should be no other maintence required by + users of the server class. + + + +Details + +DBUSMENU_SERVER_SIGNAL_ID_PROP_UPDATE +DBUSMENU_SERVER_SIGNAL_ID_PROP_UPDATE +#define DBUSMENU_SERVER_SIGNAL_ID_PROP_UPDATE "item-property-updated" + + +String to attach to signal "item-property-updated" + + +DBUSMENU_SERVER_SIGNAL_ID_UPDATE +DBUSMENU_SERVER_SIGNAL_ID_UPDATE +#define DBUSMENU_SERVER_SIGNAL_ID_UPDATE "item-updated" + + +String to attach to signal "item-updated" + + +DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATED +DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATED +#define DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATED "layout-updated" + + +String to attach to signal "layout-updated" + + +DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATE +DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATE +#define DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATE DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATED + + +String to attach to signal "layout-updated" + + +DBUSMENU_SERVER_SIGNAL_ITEM_ACTIVATION +DBUSMENU_SERVER_SIGNAL_ITEM_ACTIVATION +#define DBUSMENU_SERVER_SIGNAL_ITEM_ACTIVATION "item-activation-requested" + + +String to attach to signal "item-activation-requested" + + +DBUSMENU_SERVER_PROP_DBUS_OBJECT +DBUSMENU_SERVER_PROP_DBUS_OBJECT +#define DBUSMENU_SERVER_PROP_DBUS_OBJECT "dbus-object" + + +String to access property "dbus-object" + + +DBUSMENU_SERVER_PROP_ROOT_NODE +DBUSMENU_SERVER_PROP_ROOT_NODE +#define DBUSMENU_SERVER_PROP_ROOT_NODE "root-node" + + +String to access property "root-node" + + +DBUSMENU_SERVER_PROP_STATUS +DBUSMENU_SERVER_PROP_STATUS +#define DBUSMENU_SERVER_PROP_STATUS "status" + + +String to access property "status" + + +DBUSMENU_SERVER_PROP_TEXT_DIRECTION +DBUSMENU_SERVER_PROP_TEXT_DIRECTION +#define DBUSMENU_SERVER_PROP_TEXT_DIRECTION "text-direction" + + +String to access property "text-direction" + + +DBUSMENU_SERVER_PROP_VERSION +DBUSMENU_SERVER_PROP_VERSION +#define DBUSMENU_SERVER_PROP_VERSION "version" + + +String to access property "version" + + +DbusmenuServer +DbusmenuServer +typedef struct _DbusmenuServer DbusmenuServer; + +A server which represents a sharing of a set of + DbusmenuMenuitems across DBus to a DbusmenuClient. + + +struct DbusmenuServerClass +DbusmenuServerClass +struct DbusmenuServerClass { + GObjectClass parent_class; + + /* Signals */ + void (*id_prop_update)(gint id, gchar * property, gchar * value); + void (*id_update)(gint id); + void (*layout_updated)(gint revision); + void (*item_activation)(gint id, guint timestamp); + + /*< Private >*/ + void (*reserved1) (void); + void (*reserved2) (void); + void (*reserved3) (void); + void (*reserved4) (void); + void (*reserved5) (void); + void (*reserved6) (void); +}; + + +The class implementing the virtual functions for DbusmenuServer. + +GObjectClass parent_class; +GObjectClass + +id_prop_update () +Slot for "id-prop-update". + +id_update () +Slot for "id-update". + +layout_updated () +Slot for "layout-update". + +item_activation () +Slot for "item-activation-requested". + +reserved1 () +Reserved for future use. + +reserved2 () +Reserved for future use. + +reserved3 () +Reserved for future use. + +reserved4 () +Reserved for future use. + +reserved5 () +Reserved for future use. + +reserved6 () +Reserved for future use. + + + +dbusmenu_server_new () +dbusmenu_server_new +DbusmenuServer * dbusmenu_server_new (const gchar *object); + +Creates a new DbusmenuServer object with a specific object + path on DBus. If object is set to NULL the default object + name of "/com/canonical/dbusmenu" will be used. + +object : +The object name to show for this menu structure +on DBus. May be NULL. +Returns :A brand new DbusmenuServer + + +dbusmenu_server_get_status () +dbusmenu_server_get_status +DbusmenuStatus dbusmenu_server_get_status (DbusmenuServer *server); + +Gets the current statust hat the server is sending out over + DBus. + +server : +The DbusmenuServer to get the status from +Returns :The current status the server is sending + + +dbusmenu_server_get_text_direction () +dbusmenu_server_get_text_direction +DbusmenuTextDirection dbusmenu_server_get_text_direction + (DbusmenuServer *server); + +Returns the value of the text direction that is being exported + over DBus for this server. It should relate to the direction + of the labels and other text fields that are being exported by + this server. + +server : +The DbusmenuServer object to get the text direction from +Returns :Text direction exported for this server. + + +dbusmenu_server_set_root () +dbusmenu_server_set_root +void dbusmenu_server_set_root (DbusmenuServer *self, + DbusmenuMenuitem *root); + +This function contains all of the GValue wrapping + required to set the property "root-node" + on the server self. + +self : +The DbusmenuServer object to set the root on +root : +The new root DbusmenuMenuitem tree + + +dbusmenu_server_set_status () +dbusmenu_server_set_status +void dbusmenu_server_set_status (DbusmenuServer *server, + DbusmenuStatus status); + +Changes the status of the server. + +server : +The DbusmenuServer to set the status on +status : +Status value to set on the server + + +dbusmenu_server_set_text_direction () +dbusmenu_server_set_text_direction +void dbusmenu_server_set_text_direction (DbusmenuServer *server, + DbusmenuTextDirection dir); + +Sets the text direction that should be exported over DBus for + this server. If the value is set to DBUSMENU_TEXT_DIRECTION_NONE + the default detection will be used for setting the value and + exported over DBus. + +server : +The DbusmenuServer object to set the text direction on +dir : +Direction of the text + + + + + === added file 'docs/libdbusmenu-glib/reference/xml/types.xml' --- docs/libdbusmenu-glib/reference/xml/types.xml 1970-01-01 00:00:00 +0000 +++ docs/libdbusmenu-glib/reference/xml/types.xml 2012-06-13 19:49:21 +0000 @@ -0,0 +1,192 @@ + + +]> + + +Types +3 + + LIBDBUSMENU-GLIB Library + + + +Types +Types that are used by both client and + server. + + +Stability Level +Unstable, unless otherwise indicated + + + +Synopsis + + +#include <libdbusmenu-glib/types.h> + +#define DBUSMENU_TYPE_STATUS +#define DBUSMENU_TYPE_TEXT_DIRECTION +enum DbusmenuStatus; +enum DbusmenuTextDirection; +const gchar * dbusmenu_status_get_nick (DbusmenuStatus value); +GType dbusmenu_status_get_type (void); +DbusmenuStatus dbusmenu_status_get_value_from_nick (const gchar *nick); +const gchar * dbusmenu_text_direction_get_nick (DbusmenuTextDirection value); +GType dbusmenu_text_direction_get_type (void); +DbusmenuTextDirection dbusmenu_text_direction_get_value_from_nick + (const gchar *nick); + + + + +Description + +Enums that are used to describe states of the server across the + bus. They are sent over dbus using their nicks but then turned + back into enums by the client. + + + +Details + +DBUSMENU_TYPE_STATUS +DBUSMENU_TYPE_STATUS +#define DBUSMENU_TYPE_STATUS (dbusmenu_status_get_type()) + + +Gets the GType value for the type associated with the + DbusmenuStatus enumerated type. + + +DBUSMENU_TYPE_TEXT_DIRECTION +DBUSMENU_TYPE_TEXT_DIRECTION +#define DBUSMENU_TYPE_TEXT_DIRECTION (dbusmenu_text_direction_get_type()) + + +Gets the GType value for the type associated with the + DbusmenuTextDirection enumerated type. + + +enum DbusmenuStatus +DbusmenuStatus +typedef enum { + /*< prefix=DBUSMENU_STATUS >*/ + DBUSMENU_STATUS_NORMAL, /*< nick=normal >*/ + DBUSMENU_STATUS_NOTICE /*< nick=notice >*/ +} DbusmenuStatus; + + +Tracks how the menus should be presented to the user. + + +DBUSMENU_STATUS_NORMAL +Everything is normal + + + +DBUSMENU_STATUS_NOTICE +The menus should be shown at a higher priority + + + + +enum DbusmenuTextDirection +DbusmenuTextDirection +typedef enum { + /*< prefix=DBUSMENU_TEXT_DIRECTION >*/ + DBUSMENU_TEXT_DIRECTION_NONE, /*< nick=none >*/ + DBUSMENU_TEXT_DIRECTION_LTR, /*< nick=ltr >*/ + DBUSMENU_TEXT_DIRECTION_RTL /*< nick=rtl >*/ +} DbusmenuTextDirection; + + +The direction of text that the strings that this server + will be sending strings as. + + +DBUSMENU_TEXT_DIRECTION_NONE +Unspecified text direction + + + +DBUSMENU_TEXT_DIRECTION_LTR +Left-to-right text direction + + + +DBUSMENU_TEXT_DIRECTION_RTL +Right-to-left text direction + + + + +dbusmenu_status_get_nick () +dbusmenu_status_get_nick +const gchar * dbusmenu_status_get_nick (DbusmenuStatus value); + +Looks up in the enum table for the nick of value. + +value : +The value of DbusmenuStatus to get the nick of +Returns :The nick for the given value or NULL on error + + +dbusmenu_status_get_type () +dbusmenu_status_get_type +GType dbusmenu_status_get_type (void); + +Builds a GLib type for the DbusmenuStatus enumeration. + +Returns :A unique GType for the DbusmenuStatus enum. + + +dbusmenu_status_get_value_from_nick () +dbusmenu_status_get_value_from_nick +DbusmenuStatus dbusmenu_status_get_value_from_nick (const gchar *nick); + +Looks up in the enum table for the value of nick. + +nick : +The enum nick to lookup +Returns :The value for the given nick + + +dbusmenu_text_direction_get_nick () +dbusmenu_text_direction_get_nick +const gchar * dbusmenu_text_direction_get_nick (DbusmenuTextDirection value); + +Looks up in the enum table for the nick of value. + +value : +The value of DbusmenuTextDirection to get the nick of +Returns :The nick for the given value or NULL on error + + +dbusmenu_text_direction_get_type () +dbusmenu_text_direction_get_type +GType dbusmenu_text_direction_get_type (void); + +Builds a GLib type for the DbusmenuTextDirection enumeration. + +Returns :A unique GType for the DbusmenuTextDirection enum. + + +dbusmenu_text_direction_get_value_from_nick () +dbusmenu_text_direction_get_value_from_nick +DbusmenuTextDirection dbusmenu_text_direction_get_value_from_nick + (const gchar *nick); + +Looks up in the enum table for the value of nick. + +nick : +The enum nick to lookup +Returns :The value for the given nick + + + + + === added file 'docs/libdbusmenu-gtk/reference/html/annotation-glossary.html' --- docs/libdbusmenu-gtk/reference/html/annotation-glossary.html 1970-01-01 00:00:00 +0000 +++ docs/libdbusmenu-gtk/reference/html/annotation-glossary.html 2012-06-13 19:49:21 +0000 @@ -0,0 +1,47 @@ + + + + +Annotation Glossary + + + + + + + + + + + + + + + + + + +
+

+Annotation Glossary

+

O

+
+out
+

Parameter for returning results. Default is transfer full.

+

T

+
+transfer full
+

Free data after the code is done.

+
+transfer none
+

Don't free data after the code is done.

+
+ + + \ No newline at end of file === added file 'docs/libdbusmenu-gtk/reference/html/api-index-deprecated.html' --- docs/libdbusmenu-gtk/reference/html/api-index-deprecated.html 1970-01-01 00:00:00 +0000 +++ docs/libdbusmenu-gtk/reference/html/api-index-deprecated.html 2012-06-13 19:49:21 +0000 @@ -0,0 +1,31 @@ + + + + +Deprecated API Index + + + + + + + + + + + + + + + + +
+

+Deprecated API Index

+ +
+ + + \ No newline at end of file === added file 'docs/libdbusmenu-gtk/reference/html/api-index-full.html' --- docs/libdbusmenu-gtk/reference/html/api-index-full.html 1970-01-01 00:00:00 +0000 +++ docs/libdbusmenu-gtk/reference/html/api-index-full.html 2012-06-13 19:49:21 +0000 @@ -0,0 +1,119 @@ + + + + +API Index + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file === added file 'docs/libdbusmenu-gtk/reference/html/ch01.html' --- docs/libdbusmenu-gtk/reference/html/ch01.html 1970-01-01 00:00:00 +0000 +++ docs/libdbusmenu-gtk/reference/html/ch01.html 2012-06-13 19:49:21 +0000 @@ -0,0 +1,45 @@ + + + + +API + + + + + + + + + + + + + + + + +
+

+API

+
+
+DbusmenuGtkMenu — A GTK Menu Object that syncronizes over DBus +
+
+menuitem — Helpers for DbusmenuMenuitem properties that require a GTK dependency +
+
+DbusmenuGtkClient — A subclass of DbusmenuClient adding GTK level features +
+
+parser — A parser of in-memory GTK menu trees +
+
+<xi:include></xi:include> +
+ + + \ No newline at end of file === added file 'docs/libdbusmenu-gtk/reference/html/home.png' Binary files docs/libdbusmenu-gtk/reference/html/home.png 1970-01-01 00:00:00 +0000 and docs/libdbusmenu-gtk/reference/html/home.png 2012-06-13 19:49:21 +0000 differ === added file 'docs/libdbusmenu-gtk/reference/html/index.html' --- docs/libdbusmenu-gtk/reference/html/index.html 1970-01-01 00:00:00 +0000 +++ docs/libdbusmenu-gtk/reference/html/index.html 2012-06-13 19:49:21 +0000 @@ -0,0 +1,44 @@ + + + + +libdbusmenu-gtk Reference Manual + + + + + + + +
+
+
+
+
+
+
API
+
+
+DbusmenuGtkMenu — A GTK Menu Object that syncronizes over DBus +
+
+menuitem — Helpers for DbusmenuMenuitem properties that require a GTK dependency +
+
+DbusmenuGtkClient — A subclass of DbusmenuClient adding GTK level features +
+
+parser — A parser of in-memory GTK menu trees +
+
+
Object Hierarchy
+
API Index
+
Deprecated API Index
+
Annotation Glossary
+
+
+ + + \ No newline at end of file === added file 'docs/libdbusmenu-gtk/reference/html/index.sgml' --- docs/libdbusmenu-gtk/reference/html/index.sgml 1970-01-01 00:00:00 +0000 +++ docs/libdbusmenu-gtk/reference/html/index.sgml 2012-06-13 19:49:21 +0000 @@ -0,0 +1,43 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + === added file 'docs/libdbusmenu-gtk/reference/html/left.png' Binary files docs/libdbusmenu-gtk/reference/html/left.png 1970-01-01 00:00:00 +0000 and docs/libdbusmenu-gtk/reference/html/left.png 2012-06-13 19:49:21 +0000 differ === added file 'docs/libdbusmenu-gtk/reference/html/libdbusmenu-gtk-DbusmenuGtkClient.html' --- docs/libdbusmenu-gtk/reference/html/libdbusmenu-gtk-DbusmenuGtkClient.html 1970-01-01 00:00:00 +0000 +++ docs/libdbusmenu-gtk/reference/html/libdbusmenu-gtk-DbusmenuGtkClient.html 2012-06-13 19:49:21 +0000 @@ -0,0 +1,347 @@ + + + + +DbusmenuGtkClient + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

DbusmenuGtkClient

+

DbusmenuGtkClient — A subclass of DbusmenuClient adding GTK level features

+
+
+

Stability Level

+Unstable, unless otherwise indicated +
+ +
+

Description

+

+In general, this is just a GtkMenu, why else would you care? Oh, + because this menu is created by someone else on a server that exists + on the other side of DBus. You need a DbusmenuServer to be able + push the data into this menu. +

+

+ The first thing you need to know is how to find that DbusmenuServer + on DBus. This involves both the DBus name and the DBus object that + the menu interface can be found on. Those two value should be set + when creating the object using dbusmenu_gtkmenu_new(). They are then + stored on two properties "dbus-name" and "dbus-object". +

+

+ After creation the DbusmenuGtkClient it will continue to keep in + synchronization with the DbusmenuServer object across Dbus. If the + number of entries change, the menus change, if they change thier + properties change, they update in the items. All of this should + be handled transparently to the user of this object. +

+
+
+

Details

+
+

DBUSMENU_GTKCLIENT_SIGNAL_ROOT_CHANGED

+
#define DBUSMENU_GTKCLIENT_SIGNAL_ROOT_CHANGED  DBUSMENU_CLIENT_SIGNAL_ROOT_CHANGED
+
+

+String to attach to signal "root-changed" +

+
+
+
+

DbusmenuGtkClient

+
typedef struct _DbusmenuGtkClient DbusmenuGtkClient;
+

+A subclass of DbusmenuClient to add functionality with regarding +building GTK items out of the abstract tree. +

+
+
+
+

struct DbusmenuGtkClientClass

+
struct DbusmenuGtkClientClass {
+	DbusmenuClientClass parent_class;
+
+	/* Signals */
+	void (*root_changed) (DbusmenuMenuitem * newroot);
+
+	/*< Private >*/
+	void (*reserved1) (void);
+	void (*reserved2) (void);
+	void (*reserved3) (void);
+	void (*reserved4) (void);
+	void (*reserved5) (void);
+	void (*reserved6) (void);
+};
+
+

+Functions and signal slots for using a DbusmenuGtkClient +

+
++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

DbusmenuClientClass parent_class;

GtkMenuClass

root_changed ()

Slot for signal "root-changed" +

reserved1 ()

Reserved for future use.

reserved2 ()

Reserved for future use.

reserved3 ()

Reserved for future use.

reserved4 ()

Reserved for future use.

reserved5 ()

Reserved for future use.

reserved6 ()

Reserved for future use.
+
+
+
+

dbusmenu_gtkclient_new ()

+
DbusmenuGtkClient * dbusmenu_gtkclient_new              (gchar *dbus_name,
+                                                         gchar *dbus_object);
+

+Creates a new DbusmenuGtkClient object and creates a DbusmenuClient +that connects across DBus to a DbusmenuServer. +

+
++ + + + + + + + + + + + + + +

dbus_name :

Name of the DbusmenuServer on DBus

dbus_object :

Name of the object on the DbusmenuServer +

Returns :

A new DbusmenuGtkClient sync'd with a server
+
+
+
+

dbusmenu_gtkclient_menuitem_get ()

+
GtkMenuItem *       dbusmenu_gtkclient_menuitem_get     (DbusmenuGtkClient *client,
+                                                         DbusmenuMenuitem *item);
+

+This grabs the GtkMenuItem that is associated with the +DbusmenuMenuitem. +

+
++ + + + + + + + + + + + + + +

client :

A DbusmenuGtkClient with the item in it.

item :

+DbusmenuMenuitem to get associated GtkMenuItem on.

Returns :

The GtkMenuItem that can be played with. [transfer none] +
+
+
+
+

dbusmenu_gtkclient_menuitem_get_submenu ()

+
GtkMenu *           dbusmenu_gtkclient_menuitem_get_submenu
+                                                        (DbusmenuGtkClient *client,
+                                                         DbusmenuMenuitem *item);
+

+This grabs the submenu associated with the menuitem. +

+
++ + + + + + + + + + + + + + +

client :

A DbusmenuGtkClient with the item in it.

item :

+DbusmenuMenuitem to get associated GtkMenu on.

Returns :

The GtkMenu if there is one. [transfer none] +
+
+
+
+

dbusmenu_gtkclient_set_accel_group ()

+
void                dbusmenu_gtkclient_set_accel_group  (DbusmenuGtkClient *client,
+                                                         GtkAccelGroup *agroup);
+

+Sets the acceleration group for the menu items with accelerators +on this client. +

+
++ + + + + + + + + + +

client :

To set the group on

agroup :

The new acceleration group
+
+
+
+

dbusmenu_gtkclient_get_accel_group ()

+
GtkAccelGroup *     dbusmenu_gtkclient_get_accel_group  (DbusmenuGtkClient *client);
+

+Gets the accel group for this client. +

+
++ + + + + + + + + + +

client :

Client to query for an accelerator group

Returns :

Either a valid group or NULL on error or +none set. [transfer none] +
+
+
+
+

dbusmenu_gtkclient_newitem_base ()

+
void                dbusmenu_gtkclient_newitem_base     (DbusmenuGtkClient *client,
+                                                         DbusmenuMenuitem *item,
+                                                         GtkMenuItem *gmi,
+                                                         DbusmenuMenuitem *parent);
+

+This function provides some of the basic connectivity for being in +the GTK world. Things like visibility and sensitivity of the item are +handled here so that the subclasses don't have to. If you're building +your on GTK menu item you can use this function to apply those basic +attributes so that you don't have to deal with them either. +

+

+This also handles passing the "activate" signal back to the +DbusmenuMenuitem side of thing. +

+
++ + + + + + + + + + + + + + + + + + +

client :

The client handling everything on this connection

item :

The DbusmenuMenuitem to attach the GTK-isms to

gmi :

A GtkMenuItem representing the GTK world's view of this menuitem

parent :

The parent DbusmenuMenuitem +
+
+
+
+ + + \ No newline at end of file === added file 'docs/libdbusmenu-gtk/reference/html/libdbusmenu-gtk-DbusmenuGtkMenu.html' --- docs/libdbusmenu-gtk/reference/html/libdbusmenu-gtk-DbusmenuGtkMenu.html 1970-01-01 00:00:00 +0000 +++ docs/libdbusmenu-gtk/reference/html/libdbusmenu-gtk-DbusmenuGtkMenu.html 2012-06-13 19:49:21 +0000 @@ -0,0 +1,187 @@ + + + + +DbusmenuGtkMenu + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

DbusmenuGtkMenu

+

DbusmenuGtkMenu — A GTK Menu Object that syncronizes over DBus

+
+
+

Stability Level

+Unstable, unless otherwise indicated +
+
+

Synopsis

+
+#include <libdbusmenu-gtk/menu.h>
+
+struct              DbusmenuGtkMenuClass;
+DbusmenuGtkMenu *   dbusmenu_gtkmenu_new                (gchar *dbus_name,
+                                                         gchar *dbus_object);
+DbusmenuGtkClient * dbusmenu_gtkmenu_get_client         (DbusmenuGtkMenu *menu);
+
+
+
+

Description

+

+In general, this is just a GtkMenu, why else would you care? Oh, + because this menu is created by someone else on a server that exists + on the other side of DBus. You need a DbusmenuServer to be able + push the data into this menu. +

+

+ The first thing you need to know is how to find that DbusmenuServer + on DBus. This involves both the DBus name and the DBus object that + the menu interface can be found on. Those two value should be set + when creating the object using dbusmenu_gtkmenu_new(). They are then + stored on two properties "dbus-name" and "dbus-object". +

+

+ After creation the DbusmenuGtkMenu it will continue to keep in + synchronization with the DbusmenuServer object across Dbus. If the + number of entries change, the menus change, if they change thier + properties change, they update in the items. All of this should + be handled transparently to the user of this object. +

+
+
+

Details

+
+

struct DbusmenuGtkMenuClass

+
struct DbusmenuGtkMenuClass {
+	GtkMenuClass parent_class;
+
+	/*< Private >*/
+	void (*reserved1) (void);
+	void (*reserved2) (void);
+	void (*reserved3) (void);
+	void (*reserved4) (void);
+	void (*reserved5) (void);
+	void (*reserved6) (void);
+};
+
+

+All of the subclassable functions and signal slots for a +DbusmenuGtkMenu. +

+
++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

GtkMenuClass parent_class;

GtkMenuClass

reserved1 ()

Reserved for future use.

reserved2 ()

Reserved for future use.

reserved3 ()

Reserved for future use.

reserved4 ()

Reserved for future use.

reserved5 ()

Reserved for future use.

reserved6 ()

Reserved for future use.
+
+
+
+

dbusmenu_gtkmenu_new ()

+
DbusmenuGtkMenu *   dbusmenu_gtkmenu_new                (gchar *dbus_name,
+                                                         gchar *dbus_object);
+

+Creates a new DbusmenuGtkMenu object and creates a DbusmenuClient +that connects across DBus to a DbusmenuServer. +

+
++ + + + + + + + + + + + + + +

dbus_name :

Name of the DbusmenuServer on DBus

dbus_object :

Name of the object on the DbusmenuServer +

Returns :

A new DbusmenuGtkMenu sync'd with a server
+
+
+
+

dbusmenu_gtkmenu_get_client ()

+
DbusmenuGtkClient * dbusmenu_gtkmenu_get_client         (DbusmenuGtkMenu *menu);
+

+An accessor for the client that this menu is using to +communicate with the server. +

+
++ + + + + + + + + + +

menu :

The DbusmenuGtkMenu to get the client from

Returns :

A valid DbusmenuGtkClient or NULL on error. [transfer none] +
+
+
+
+ + + \ No newline at end of file === added file 'docs/libdbusmenu-gtk/reference/html/libdbusmenu-gtk-menuitem.html' --- docs/libdbusmenu-gtk/reference/html/libdbusmenu-gtk-menuitem.html 1970-01-01 00:00:00 +0000 +++ docs/libdbusmenu-gtk/reference/html/libdbusmenu-gtk-menuitem.html 2012-06-13 19:49:21 +0000 @@ -0,0 +1,274 @@ + + + + +menuitem + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

menuitem

+

menuitem — Helpers for DbusmenuMenuitem properties that require a GTK dependency

+
+
+

Stability Level

+Unstable, unless otherwise indicated +
+
+

Synopsis

+
+#include <libdbusmenu-gtk/menuitem.h>
+
+gboolean            dbusmenu_menuitem_property_set_image
+                                                        (DbusmenuMenuitem *menuitem,
+                                                         const gchar *property,
+                                                         const GdkPixbuf *data);
+GdkPixbuf *         dbusmenu_menuitem_property_get_image
+                                                        (DbusmenuMenuitem *menuitem,
+                                                         const gchar *property);
+gboolean            dbusmenu_menuitem_property_set_shortcut
+                                                        (DbusmenuMenuitem *menuitem,
+                                                         guint key,
+                                                         GdkModifierType modifier);
+gboolean            dbusmenu_menuitem_property_set_shortcut_string
+                                                        (DbusmenuMenuitem *menuitem,
+                                                         const gchar *shortcut);
+gboolean            dbusmenu_menuitem_property_set_shortcut_menuitem
+                                                        (DbusmenuMenuitem *menuitem,
+                                                         const GtkMenuItem *gmi);
+void                dbusmenu_menuitem_property_get_shortcut
+                                                        (DbusmenuMenuitem *menuitem,
+                                                         guint *key,
+                                                         GdkModifierType *modifier);
+
+
+
+

Description

+

+Some property helpers can't be done without picking up a GTK+ + dependency. So those sit in libdbusmenu-gtk but have very similar + prototypes to the code in libdbusmenu-glib so your code will + look consistent, just with the extra depedency. +

+
+
+

Details

+
+

dbusmenu_menuitem_property_set_image ()

+
gboolean            dbusmenu_menuitem_property_set_image
+                                                        (DbusmenuMenuitem *menuitem,
+                                                         const gchar *property,
+                                                         const GdkPixbuf *data);
+

+This function takes the pixbuf that is stored in data and +turns it into a base64 encoded PNG so that it can be placed +onto a standard DbusmenuMenuitem property. +

+
++ + + + + + + + + + + + + + + + + + +

menuitem :

The DbusmenuMenuitem to set the property on.

property :

Name of the property to set.

data :

The image to place on the property.

Returns :

Whether the function was able to set the property +or not.
+
+
+
+

dbusmenu_menuitem_property_get_image ()

+
GdkPixbuf *         dbusmenu_menuitem_property_get_image
+                                                        (DbusmenuMenuitem *menuitem,
+                                                         const gchar *property);
+

+This function looks on the menu item for a property by the +name of property. If one exists it tries to turn it into +a GdkPixbuf. It assumes that the property is a base64 encoded +PNG file like the one created by dbusmenu_menuite_property_set_image. +

+
++ + + + + + + + + + + + + + +

menuitem :

The DbusmenuMenuitem to look for the property on

property :

The name of the property to look for.

Returns :

A pixbuf or NULL to signal error. [transfer full] +
+
+
+
+

dbusmenu_menuitem_property_set_shortcut ()

+
gboolean            dbusmenu_menuitem_property_set_shortcut
+                                                        (DbusmenuMenuitem *menuitem,
+                                                         guint key,
+                                                         GdkModifierType modifier);
+

+Takes the modifer described by key and modifier and places that into +the format sending across Dbus for shortcuts. +

+
++ + + + + + + + + + + + + + + + + + +

menuitem :

The DbusmenuMenuitem to set the shortcut on

key :

The keycode of the key to send

modifier :

A bitmask of modifiers used to activate the item

Returns :

Whether it was successful at setting the property.
+
+
+
+

dbusmenu_menuitem_property_set_shortcut_string ()

+
gboolean            dbusmenu_menuitem_property_set_shortcut_string
+                                                        (DbusmenuMenuitem *menuitem,
+                                                         const gchar *shortcut);
+

+This function takes a GTK shortcut string as defined in +gtk_accelerator_parse and turns that into the information +required to send it over DBusmenu. +

+
++ + + + + + + + + + + + + + +

menuitem :

The DbusmenuMenuitem to set the shortcut on

shortcut :

String describing the shortcut

Returns :

Whether it was successful at setting the property.
+
+
+
+

dbusmenu_menuitem_property_set_shortcut_menuitem ()

+
gboolean            dbusmenu_menuitem_property_set_shortcut_menuitem
+                                                        (DbusmenuMenuitem *menuitem,
+                                                         const GtkMenuItem *gmi);
+

+Takes the shortcut that is installed on a menu item and calls +dbusmenu_menuitem_property_set_shortcut with it. It also sets +up listeners to watch it change. +

+
++ + + + + + + + + + + + + + +

menuitem :

The DbusmenuMenuitem to set the shortcut on

gmi :

A menu item to steal the shortcut off of

Returns :

Whether it was successful at setting the property.
+
+
+
+

dbusmenu_menuitem_property_get_shortcut ()

+
void                dbusmenu_menuitem_property_get_shortcut
+                                                        (DbusmenuMenuitem *menuitem,
+                                                         guint *key,
+                                                         GdkModifierType *modifier);
+

+This function gets a GTK shortcut as a key and a mask +for use to set the accelerators. +

+
++ + + + + + + + + + + + + + +

menuitem :

The DbusmenuMenuitem to get the shortcut off

key :

Location to put the key value. [out] +

modifier :

Location to put the modifier mask. [out] +
+
+
+
+ + + \ No newline at end of file === added file 'docs/libdbusmenu-gtk/reference/html/libdbusmenu-gtk-parser.html' --- docs/libdbusmenu-gtk/reference/html/libdbusmenu-gtk-parser.html 1970-01-01 00:00:00 +0000 +++ docs/libdbusmenu-gtk/reference/html/libdbusmenu-gtk-parser.html 2012-06-13 19:49:21 +0000 @@ -0,0 +1,118 @@ + + + + +parser + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

parser

+

parser — A parser of in-memory GTK menu trees

+
+
+

Stability Level

+Unstable, unless otherwise indicated +
+
+

Synopsis

+
+#include <libdbusmenu-gtk/parser.h>
+
+DbusmenuMenuitem *  dbusmenu_gtk_parse_menu_structure   (GtkWidget *widget);
+DbusmenuMenuitem *  dbusmenu_gtk_parse_get_cached_item  (GtkWidget *widget);
+
+
+
+

Description

+

+The parser will take a GTK menu tree and attach it to a Dbusmenu menu + tree. Along with setting up all the signals for updates and destruction. + The returned item would be the root item of the given tree. +

+
+
+

Details

+
+

dbusmenu_gtk_parse_menu_structure ()

+
DbusmenuMenuitem *  dbusmenu_gtk_parse_menu_structure   (GtkWidget *widget);
+

+Goes through the GTK structures and turns them into the appropraite +Dbusmenu structures along with setting up all the relationships +between the objects. It also stores the dbusmenu items as a cache +on the GTK items so that they'll be reused if necissary. +

+
++ + + + + + + + + + +

widget :

A GtkMenuItem or GtkMenuShell to turn into a DbusmenuMenuitem +

Returns :

A dbusmenu item representing the menu structure. [transfer full] +
+
+
+
+

dbusmenu_gtk_parse_get_cached_item ()

+
DbusmenuMenuitem *  dbusmenu_gtk_parse_get_cached_item  (GtkWidget *widget);
+

+The Dbusmenu GTK parser adds cached items on the various +menu items throughout the tree. Sometimes it can be useful +to get that cached item to use directly. This function +will retrieve it for you. +

+
++ + + + + + + + + + +

widget :

A GtkMenuItem that may have a cached DbusmenuMenuitem from the parser

Returns :

A pointer to the cached item +or NULL if it isn't there. [transfer none] +
+
+
+
+ + + \ No newline at end of file === added file 'docs/libdbusmenu-gtk/reference/html/libdbusmenu-gtk.devhelp2' --- docs/libdbusmenu-gtk/reference/html/libdbusmenu-gtk.devhelp2 1970-01-01 00:00:00 +0000 +++ docs/libdbusmenu-gtk/reference/html/libdbusmenu-gtk.devhelp2 2012-06-13 19:49:21 +0000 @@ -0,0 +1,38 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + === added file 'docs/libdbusmenu-gtk/reference/html/object-tree.html' --- docs/libdbusmenu-gtk/reference/html/object-tree.html 1970-01-01 00:00:00 +0000 +++ docs/libdbusmenu-gtk/reference/html/object-tree.html 2012-06-13 19:49:21 +0000 @@ -0,0 +1,32 @@ + + + + +Object Hierarchy + + + + + + + + + + + + + + + + +
+

+Object Hierarchy

+
+
+
+ + + \ No newline at end of file === added file 'docs/libdbusmenu-gtk/reference/html/right.png' Binary files docs/libdbusmenu-gtk/reference/html/right.png 1970-01-01 00:00:00 +0000 and docs/libdbusmenu-gtk/reference/html/right.png 2012-06-13 19:49:21 +0000 differ === added file 'docs/libdbusmenu-gtk/reference/html/style.css' --- docs/libdbusmenu-gtk/reference/html/style.css 1970-01-01 00:00:00 +0000 +++ docs/libdbusmenu-gtk/reference/html/style.css 2012-06-13 19:49:21 +0000 @@ -0,0 +1,266 @@ +.synopsis, .classsynopsis +{ + /* tango:aluminium 1/2 */ + background: #eeeeec; + border: solid 1px #d3d7cf; + padding: 0.5em; +} +.programlisting +{ + /* tango:sky blue 0/1 */ + background: #e6f3ff; + border: solid 1px #729fcf; + padding: 0.5em; +} +.variablelist +{ + padding: 4px; + margin-left: 3em; +} +.variablelist td:first-child +{ + vertical-align: top; +} + +@media screen { + sup a.footnote + { + position: relative; + top: 0em ! important; + + } + /* this is needed so that the local anchors are displayed below the naviagtion */ + div.footnote a[name], div.refnamediv a[name], div.refsect1 a[name], div.refsect2 a[name], div.index a[name], div.glossary a[name], div.sect1 a[name] + { + display: inline-block; + position: relative; + top:-5em; + } + /* this seems to be a bug in the xsl style sheets when generating indexes */ + div.index div.index + { + top: 0em; + } + /* make space for the fixed navigation bar and add space at the bottom so that + * link targets appear somewhat close to top + */ + body + { + padding-top: 3.2em; + padding-bottom: 20em; + } + /* style and size the navigation bar */ + table.navigation#top + { + position: fixed; + /* tango:scarlet red 0/1 */ + background: #ffe6e6; + border: solid 1px #ef2929; + margin-top: 0; + margin-bottom: 0; + top: 0; + left: 0; + height: 3em; + z-index: 10; + } + .navigation a, .navigation a:visited + { + /* tango:scarlet red 3 */ + color: #a40000; + } + .navigation a:hover + { + /* tango:scarlet red 1 */ + color: #ef2929; + } + td.shortcuts + { + /* tango:scarlet red 1 */ + color: #ef2929; + font-size: 80%; + white-space: nowrap; + } +} +@media print { + table.navigation { + visibility: collapse; + display: none; + } + div.titlepage table.navigation { + visibility: visible; + display: table; + /* tango:scarlet red 0/1 */ + background: #ffe6e6; + border: solid 1px #ef2929; + margin-top: 0; + margin-bottom: 0; + top: 0; + left: 0; + height: 3em; + } +} + +.navigation .title +{ + font-size: 200%; +} + +div.gallery-float +{ + float: left; + padding: 10px; +} +div.gallery-float img +{ + border-style: none; +} +div.gallery-spacer +{ + clear: both; +} + +a, a:visited +{ + text-decoration: none; + /* tango:sky blue 2 */ + color: #3465a4; +} +a:hover +{ + text-decoration: underline; + /* tango:sky blue 1 */ + color: #729fcf; +} + +div.table table +{ + border-collapse: collapse; + border-spacing: 0px; + /* tango:aluminium 3 */ + border: solid 1px #babdb6; +} + +div.table table td, div.table table th +{ + /* tango:aluminium 3 */ + border: solid 1px #babdb6; + padding: 3px; + vertical-align: top; +} + +div.table table th +{ + /* tango:aluminium 2 */ + background-color: #d3d7cf; +} + +hr +{ + /* tango:aluminium 3 */ + color: #babdb6; + background: #babdb6; + border: none 0px; + height: 1px; + clear: both; +} + +.footer +{ + padding-top: 3.5em; + /* tango:aluminium 3 */ + color: #babdb6; + text-align: center; + font-size: 80%; +} + +.warning +{ + /* tango:orange 0/1 */ + background: #ffeed9; + border-color: #ffb04f; +} +.note +{ + /* tango:chameleon 0/0.5 */ + background: #d8ffb2; + border-color: #abf562; +} +.note, .warning +{ + padding: 0.5em; + border-width: 1px; + border-style: solid; +} +.note h3, .warning h3 +{ + margin-top: 0.0em +} +.note p, .warning p +{ + margin-bottom: 0.0em +} + +/* blob links */ +h2 .extralinks, h3 .extralinks +{ + float: right; + /* tango:aluminium 3 */ + color: #babdb6; + font-size: 80%; + font-weight: normal; +} + +.annotation +{ + /* tango:aluminium 5 */ + color: #555753; + font-size: 80%; + font-weight: normal; +} + +/* code listings */ + +.listing_code .programlisting .cbracket { color: #a40000; } /* tango: scarlet red 3 */ +.listing_code .programlisting .comment { color: #a1a39d; } /* tango: aluminium 4 */ +.listing_code .programlisting .function { color: #000000; font-weight: bold; } +.listing_code .programlisting .function a { color: #11326b; font-weight: bold; } /* tango: sky blue 4 */ +.listing_code .programlisting .keyword { color: #4e9a06; } /* tango: chameleon 3 */ +.listing_code .programlisting .linenum { color: #babdb6; } /* tango: aluminium 3 */ +.listing_code .programlisting .normal { color: #000000; } +.listing_code .programlisting .number { color: #75507b; } /* tango: plum 2 */ +.listing_code .programlisting .preproc { color: #204a87; } /* tango: sky blue 3 */ +.listing_code .programlisting .string { color: #c17d11; } /* tango: chocolate 2 */ +.listing_code .programlisting .type { color: #000000; } +.listing_code .programlisting .type a { color: #11326b; } /* tango: sky blue 4 */ +.listing_code .programlisting .symbol { color: #ce5c00; } /* tango: orange 3 */ + +.listing_frame { + /* tango:sky blue 1 */ + border: solid 1px #729fcf; + padding: 0px; +} + +.listing_lines, .listing_code { + margin-top: 0px; + margin-bottom: 0px; + padding: 0.5em; +} +.listing_lines { + /* tango:sky blue 0.5 */ + background: #a6c5e3; + /* tango:aluminium 6 */ + color: #2e3436; +} +.listing_code { + /* tango:sky blue 0 */ + background: #e6f3ff; +} +.listing_code .programlisting { + /* override from previous */ + border: none 0px; + padding: 0px; +} +.listing_lines pre, .listing_code pre { + margin: 0px; +} + === added file 'docs/libdbusmenu-gtk/reference/html/up.png' Binary files docs/libdbusmenu-gtk/reference/html/up.png 1970-01-01 00:00:00 +0000 and docs/libdbusmenu-gtk/reference/html/up.png 2012-06-13 19:49:21 +0000 differ === added file 'docs/libdbusmenu-gtk/reference/tmpl/client.sgml' --- docs/libdbusmenu-gtk/reference/tmpl/client.sgml 1970-01-01 00:00:00 +0000 +++ docs/libdbusmenu-gtk/reference/tmpl/client.sgml 2012-06-13 19:49:21 +0000 @@ -0,0 +1,110 @@ + +DbusmenuGtkClient + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@parent_class: +@root_changed: +@reserved1: +@reserved2: +@reserved3: +@reserved4: +@reserved5: +@reserved6: + + + + + + +@dbus_name: +@dbus_object: +@Returns: + + + + + + + +@client: +@item: +@Returns: + + + + + + + +@client: +@item: +@Returns: + + + + + + + +@client: +@agroup: + + + + + + + +@client: +@Returns: + + + + + + + +@client: +@item: +@gmi: +@parent: + + === added file 'docs/libdbusmenu-gtk/reference/tmpl/libdbusmenu-gtk-unused.sgml' === added file 'docs/libdbusmenu-gtk/reference/tmpl/menu.sgml' --- docs/libdbusmenu-gtk/reference/tmpl/menu.sgml 1970-01-01 00:00:00 +0000 +++ docs/libdbusmenu-gtk/reference/tmpl/menu.sgml 2012-06-13 19:49:21 +0000 @@ -0,0 +1,56 @@ + +DbusmenuGtkMenu + + + + + + + + + + + + + + + + + + + + + + + + + + + +@parent_class: +@reserved1: +@reserved2: +@reserved3: +@reserved4: +@reserved5: +@reserved6: + + + + + + +@dbus_name: +@dbus_object: +@Returns: + + + + + + + +@menu: +@Returns: + + === added file 'docs/libdbusmenu-gtk/reference/tmpl/menuitem.sgml' --- docs/libdbusmenu-gtk/reference/tmpl/menuitem.sgml 1970-01-01 00:00:00 +0000 +++ docs/libdbusmenu-gtk/reference/tmpl/menuitem.sgml 2012-06-13 19:49:21 +0000 @@ -0,0 +1,86 @@ + +menuitem + + + + + + + + + + + + + + + + + + + + + + + + + + + +@menuitem: +@property: +@data: +@Returns: + + + + + + + +@menuitem: +@property: +@Returns: + + + + + + + +@menuitem: +@key: +@modifier: +@Returns: + + + + + + + +@menuitem: +@shortcut: +@Returns: + + + + + + + +@menuitem: +@gmi: +@Returns: + + + + + + + +@menuitem: +@key: +@modifier: + + === added file 'docs/libdbusmenu-gtk/reference/tmpl/parser.sgml' --- docs/libdbusmenu-gtk/reference/tmpl/parser.sgml 1970-01-01 00:00:00 +0000 +++ docs/libdbusmenu-gtk/reference/tmpl/parser.sgml 2012-06-13 19:49:21 +0000 @@ -0,0 +1,42 @@ + +parser + + + + + + + + + + + + + + + + + + + + + + + + + + + +@widget: +@Returns: + + + + + + + +@widget: +@Returns: + + === modified file 'docs/libdbusmenu-gtk/reference/version.xml' --- docs/libdbusmenu-gtk/reference/version.xml 2012-04-11 16:54:01 +0000 +++ docs/libdbusmenu-gtk/reference/version.xml 2012-06-13 19:49:21 +0000 @@ -1,1 +1,1 @@ -0.6.1 +0.6.2 === added file 'docs/libdbusmenu-gtk/reference/xml/annotation-glossary.xml' --- docs/libdbusmenu-gtk/reference/xml/annotation-glossary.xml 1970-01-01 00:00:00 +0000 +++ docs/libdbusmenu-gtk/reference/xml/annotation-glossary.xml 2012-06-13 19:49:21 +0000 @@ -0,0 +1,32 @@ + + +]> + + + Annotation Glossary +O + + out + + Parameter for returning results. Default is transfer full. + + + +T + + transfer full + + Free data after the code is done. + + + + transfer none + + Don't free data after the code is done. + + + + === added file 'docs/libdbusmenu-gtk/reference/xml/api-index-deprecated.xml' --- docs/libdbusmenu-gtk/reference/xml/api-index-deprecated.xml 1970-01-01 00:00:00 +0000 +++ docs/libdbusmenu-gtk/reference/xml/api-index-deprecated.xml 2012-06-13 19:49:21 +0000 @@ -0,0 +1,8 @@ + + +]> + + === added file 'docs/libdbusmenu-gtk/reference/xml/api-index-full.xml' --- docs/libdbusmenu-gtk/reference/xml/api-index-full.xml 1970-01-01 00:00:00 +0000 +++ docs/libdbusmenu-gtk/reference/xml/api-index-full.xml 2012-06-13 19:49:21 +0000 @@ -0,0 +1,32 @@ + + +]> + +G +DbusmenuGtkClient, struct in DbusmenuGtkClient +DbusmenuGtkClientClass, struct in DbusmenuGtkClient +dbusmenu_gtkclient_get_accel_group, function in DbusmenuGtkClient +dbusmenu_gtkclient_menuitem_get, function in DbusmenuGtkClient +dbusmenu_gtkclient_menuitem_get_submenu, function in DbusmenuGtkClient +dbusmenu_gtkclient_new, function in DbusmenuGtkClient +dbusmenu_gtkclient_newitem_base, function in DbusmenuGtkClient +dbusmenu_gtkclient_set_accel_group, function in DbusmenuGtkClient +DBUSMENU_GTKCLIENT_SIGNAL_ROOT_CHANGED, macro in DbusmenuGtkClient +DbusmenuGtkMenuClass, struct in DbusmenuGtkMenu +dbusmenu_gtkmenu_get_client, function in DbusmenuGtkMenu +dbusmenu_gtkmenu_new, function in DbusmenuGtkMenu +dbusmenu_gtk_parse_get_cached_item, function in parser +dbusmenu_gtk_parse_menu_structure, function in parser + +M +dbusmenu_menuitem_property_get_image, function in menuitem +dbusmenu_menuitem_property_get_shortcut, function in menuitem +dbusmenu_menuitem_property_set_image, function in menuitem +dbusmenu_menuitem_property_set_shortcut, function in menuitem +dbusmenu_menuitem_property_set_shortcut_menuitem, function in menuitem +dbusmenu_menuitem_property_set_shortcut_string, function in menuitem + + === added file 'docs/libdbusmenu-gtk/reference/xml/client.xml' --- docs/libdbusmenu-gtk/reference/xml/client.xml 1970-01-01 00:00:00 +0000 +++ docs/libdbusmenu-gtk/reference/xml/client.xml 2012-06-13 19:49:21 +0000 @@ -0,0 +1,238 @@ + + +]> + + +DbusmenuGtkClient +3 + + LIBDBUSMENU-GTK Library + + + +DbusmenuGtkClient +A subclass of DbusmenuClient adding GTK level features + + +Stability Level +Unstable, unless otherwise indicated + + + +Synopsis + + +#include <libdbusmenu-gtk/client.h> + +#define DBUSMENU_GTKCLIENT_SIGNAL_ROOT_CHANGED + DbusmenuGtkClient; +struct DbusmenuGtkClientClass; +DbusmenuGtkClient * dbusmenu_gtkclient_new (gchar *dbus_name, + gchar *dbus_object); +GtkMenuItem * dbusmenu_gtkclient_menuitem_get (DbusmenuGtkClient *client, + DbusmenuMenuitem *item); +GtkMenu * dbusmenu_gtkclient_menuitem_get_submenu + (DbusmenuGtkClient *client, + DbusmenuMenuitem *item); +void dbusmenu_gtkclient_set_accel_group (DbusmenuGtkClient *client, + GtkAccelGroup *agroup); +GtkAccelGroup * dbusmenu_gtkclient_get_accel_group (DbusmenuGtkClient *client); +void dbusmenu_gtkclient_newitem_base (DbusmenuGtkClient *client, + DbusmenuMenuitem *item, + GtkMenuItem *gmi, + DbusmenuMenuitem *parent); + + + + +Description + +In general, this is just a GtkMenu, why else would you care? Oh, + because this menu is created by someone else on a server that exists + on the other side of DBus. You need a DbusmenuServer to be able + push the data into this menu. + + + The first thing you need to know is how to find that DbusmenuServer + on DBus. This involves both the DBus name and the DBus object that + the menu interface can be found on. Those two value should be set + when creating the object using dbusmenu_gtkmenu_new(). They are then + stored on two properties "dbus-name" and "dbus-object". + + + After creation the DbusmenuGtkClient it will continue to keep in + synchronization with the DbusmenuServer object across Dbus. If the + number of entries change, the menus change, if they change thier + properties change, they update in the items. All of this should + be handled transparently to the user of this object. + + + +Details + +DBUSMENU_GTKCLIENT_SIGNAL_ROOT_CHANGED +DBUSMENU_GTKCLIENT_SIGNAL_ROOT_CHANGED +#define DBUSMENU_GTKCLIENT_SIGNAL_ROOT_CHANGED DBUSMENU_CLIENT_SIGNAL_ROOT_CHANGED + + +String to attach to signal "root-changed" + + +DbusmenuGtkClient +DbusmenuGtkClient +typedef struct _DbusmenuGtkClient DbusmenuGtkClient; + +A subclass of DbusmenuClient to add functionality with regarding +building GTK items out of the abstract tree. + + +struct DbusmenuGtkClientClass +DbusmenuGtkClientClass +struct DbusmenuGtkClientClass { + DbusmenuClientClass parent_class; + + /* Signals */ + void (*root_changed) (DbusmenuMenuitem * newroot); + + /*< Private >*/ + void (*reserved1) (void); + void (*reserved2) (void); + void (*reserved3) (void); + void (*reserved4) (void); + void (*reserved5) (void); + void (*reserved6) (void); +}; + + +Functions and signal slots for using a DbusmenuGtkClient + +DbusmenuClientClass parent_class; +GtkMenuClass + +root_changed () +Slot for signal "root-changed" + +reserved1 () +Reserved for future use. + +reserved2 () +Reserved for future use. + +reserved3 () +Reserved for future use. + +reserved4 () +Reserved for future use. + +reserved5 () +Reserved for future use. + +reserved6 () +Reserved for future use. + + + +dbusmenu_gtkclient_new () +dbusmenu_gtkclient_new +DbusmenuGtkClient * dbusmenu_gtkclient_new (gchar *dbus_name, + gchar *dbus_object); + +Creates a new DbusmenuGtkClient object and creates a DbusmenuClient +that connects across DBus to a DbusmenuServer. + +dbus_name : +Name of the DbusmenuServer on DBus +dbus_object : +Name of the object on the DbusmenuServer +Returns :A new DbusmenuGtkClient sync'd with a server + + +dbusmenu_gtkclient_menuitem_get () +dbusmenu_gtkclient_menuitem_get +GtkMenuItem * dbusmenu_gtkclient_menuitem_get (DbusmenuGtkClient *client, + DbusmenuMenuitem *item); + +This grabs the GtkMenuItem that is associated with the +DbusmenuMenuitem. + +client : +A DbusmenuGtkClient with the item in it. +item : +DbusmenuMenuitem to get associated GtkMenuItem on. +Returns :The GtkMenuItem that can be played with. [transfer none] + + +dbusmenu_gtkclient_menuitem_get_submenu () +dbusmenu_gtkclient_menuitem_get_submenu +GtkMenu * dbusmenu_gtkclient_menuitem_get_submenu + (DbusmenuGtkClient *client, + DbusmenuMenuitem *item); + +This grabs the submenu associated with the menuitem. + +client : +A DbusmenuGtkClient with the item in it. +item : +DbusmenuMenuitem to get associated GtkMenu on. +Returns :The GtkMenu if there is one. [transfer none] + + +dbusmenu_gtkclient_set_accel_group () +dbusmenu_gtkclient_set_accel_group +void dbusmenu_gtkclient_set_accel_group (DbusmenuGtkClient *client, + GtkAccelGroup *agroup); + +Sets the acceleration group for the menu items with accelerators +on this client. + +client : +To set the group on +agroup : +The new acceleration group + + +dbusmenu_gtkclient_get_accel_group () +dbusmenu_gtkclient_get_accel_group +GtkAccelGroup * dbusmenu_gtkclient_get_accel_group (DbusmenuGtkClient *client); + +Gets the accel group for this client. + +client : +Client to query for an accelerator group +Returns :Either a valid group or NULL on error or +none set. [transfer none] + + +dbusmenu_gtkclient_newitem_base () +dbusmenu_gtkclient_newitem_base +void dbusmenu_gtkclient_newitem_base (DbusmenuGtkClient *client, + DbusmenuMenuitem *item, + GtkMenuItem *gmi, + DbusmenuMenuitem *parent); + +This function provides some of the basic connectivity for being in +the GTK world. Things like visibility and sensitivity of the item are +handled here so that the subclasses don't have to. If you're building +your on GTK menu item you can use this function to apply those basic +attributes so that you don't have to deal with them either. + + +This also handles passing the "activate" signal back to the +DbusmenuMenuitem side of thing. + +client : +The client handling everything on this connection +item : +The DbusmenuMenuitem to attach the GTK-isms to +gmi : +A GtkMenuItem representing the GTK world's view of this menuitem +parent : +The parent DbusmenuMenuitem + + + + + === added file 'docs/libdbusmenu-gtk/reference/xml/menu.xml' --- docs/libdbusmenu-gtk/reference/xml/menu.xml 1970-01-01 00:00:00 +0000 +++ docs/libdbusmenu-gtk/reference/xml/menu.xml 2012-06-13 19:49:21 +0000 @@ -0,0 +1,133 @@ + + +]> + + +DbusmenuGtkMenu +3 + + LIBDBUSMENU-GTK Library + + + +DbusmenuGtkMenu +A GTK Menu Object that syncronizes over DBus + + +Stability Level +Unstable, unless otherwise indicated + + + +Synopsis + + +#include <libdbusmenu-gtk/menu.h> + +struct DbusmenuGtkMenuClass; +DbusmenuGtkMenu * dbusmenu_gtkmenu_new (gchar *dbus_name, + gchar *dbus_object); +DbusmenuGtkClient * dbusmenu_gtkmenu_get_client (DbusmenuGtkMenu *menu); + + + + +Description + +In general, this is just a GtkMenu, why else would you care? Oh, + because this menu is created by someone else on a server that exists + on the other side of DBus. You need a DbusmenuServer to be able + push the data into this menu. + + + The first thing you need to know is how to find that DbusmenuServer + on DBus. This involves both the DBus name and the DBus object that + the menu interface can be found on. Those two value should be set + when creating the object using dbusmenu_gtkmenu_new(). They are then + stored on two properties "dbus-name" and "dbus-object". + + + After creation the DbusmenuGtkMenu it will continue to keep in + synchronization with the DbusmenuServer object across Dbus. If the + number of entries change, the menus change, if they change thier + properties change, they update in the items. All of this should + be handled transparently to the user of this object. + + + +Details + +struct DbusmenuGtkMenuClass +DbusmenuGtkMenuClass +struct DbusmenuGtkMenuClass { + GtkMenuClass parent_class; + + /*< Private >*/ + void (*reserved1) (void); + void (*reserved2) (void); + void (*reserved3) (void); + void (*reserved4) (void); + void (*reserved5) (void); + void (*reserved6) (void); +}; + + +All of the subclassable functions and signal slots for a +DbusmenuGtkMenu. + +GtkMenuClass parent_class; +GtkMenuClass + +reserved1 () +Reserved for future use. + +reserved2 () +Reserved for future use. + +reserved3 () +Reserved for future use. + +reserved4 () +Reserved for future use. + +reserved5 () +Reserved for future use. + +reserved6 () +Reserved for future use. + + + +dbusmenu_gtkmenu_new () +dbusmenu_gtkmenu_new +DbusmenuGtkMenu * dbusmenu_gtkmenu_new (gchar *dbus_name, + gchar *dbus_object); + +Creates a new DbusmenuGtkMenu object and creates a DbusmenuClient +that connects across DBus to a DbusmenuServer. + +dbus_name : +Name of the DbusmenuServer on DBus +dbus_object : +Name of the object on the DbusmenuServer +Returns :A new DbusmenuGtkMenu sync'd with a server + + +dbusmenu_gtkmenu_get_client () +dbusmenu_gtkmenu_get_client +DbusmenuGtkClient * dbusmenu_gtkmenu_get_client (DbusmenuGtkMenu *menu); + +An accessor for the client that this menu is using to +communicate with the server. + +menu : +The DbusmenuGtkMenu to get the client from +Returns :A valid DbusmenuGtkClient or NULL on error. [transfer none] + + + + + === added file 'docs/libdbusmenu-gtk/reference/xml/menuitem.xml' --- docs/libdbusmenu-gtk/reference/xml/menuitem.xml 1970-01-01 00:00:00 +0000 +++ docs/libdbusmenu-gtk/reference/xml/menuitem.xml 2012-06-13 19:49:21 +0000 @@ -0,0 +1,178 @@ + + +]> + + +menuitem +3 + + LIBDBUSMENU-GTK Library + + + +menuitem +Helpers for DbusmenuMenuitem properties that require a GTK dependency + + +Stability Level +Unstable, unless otherwise indicated + + + +Synopsis + + +#include <libdbusmenu-gtk/menuitem.h> + +gboolean dbusmenu_menuitem_property_set_image + (DbusmenuMenuitem *menuitem, + const gchar *property, + const GdkPixbuf *data); +GdkPixbuf * dbusmenu_menuitem_property_get_image + (DbusmenuMenuitem *menuitem, + const gchar *property); +gboolean dbusmenu_menuitem_property_set_shortcut + (DbusmenuMenuitem *menuitem, + guint key, + GdkModifierType modifier); +gboolean dbusmenu_menuitem_property_set_shortcut_string + (DbusmenuMenuitem *menuitem, + const gchar *shortcut); +gboolean dbusmenu_menuitem_property_set_shortcut_menuitem + (DbusmenuMenuitem *menuitem, + const GtkMenuItem *gmi); +void dbusmenu_menuitem_property_get_shortcut + (DbusmenuMenuitem *menuitem, + guint *key, + GdkModifierType *modifier); + + + + +Description + +Some property helpers can't be done without picking up a GTK+ + dependency. So those sit in libdbusmenu-gtk but have very similar + prototypes to the code in libdbusmenu-glib so your code will + look consistent, just with the extra depedency. + + + +Details + +dbusmenu_menuitem_property_set_image () +dbusmenu_menuitem_property_set_image +gboolean dbusmenu_menuitem_property_set_image + (DbusmenuMenuitem *menuitem, + const gchar *property, + const GdkPixbuf *data); + +This function takes the pixbuf that is stored in data and +turns it into a base64 encoded PNG so that it can be placed +onto a standard DbusmenuMenuitem property. + +menuitem : +The DbusmenuMenuitem to set the property on. +property : +Name of the property to set. +data : +The image to place on the property. +Returns :Whether the function was able to set the property +or not. + + +dbusmenu_menuitem_property_get_image () +dbusmenu_menuitem_property_get_image +GdkPixbuf * dbusmenu_menuitem_property_get_image + (DbusmenuMenuitem *menuitem, + const gchar *property); + +This function looks on the menu item for a property by the +name of property. If one exists it tries to turn it into +a GdkPixbuf. It assumes that the property is a base64 encoded +PNG file like the one created by dbusmenu_menuite_property_set_image. + +menuitem : +The DbusmenuMenuitem to look for the property on +property : +The name of the property to look for. +Returns :A pixbuf or NULL to signal error. [transfer full] + + +dbusmenu_menuitem_property_set_shortcut () +dbusmenu_menuitem_property_set_shortcut +gboolean dbusmenu_menuitem_property_set_shortcut + (DbusmenuMenuitem *menuitem, + guint key, + GdkModifierType modifier); + +Takes the modifer described by key and modifier and places that into +the format sending across Dbus for shortcuts. + +menuitem : +The DbusmenuMenuitem to set the shortcut on +key : +The keycode of the key to send +modifier : +A bitmask of modifiers used to activate the item +Returns :Whether it was successful at setting the property. + + +dbusmenu_menuitem_property_set_shortcut_string () +dbusmenu_menuitem_property_set_shortcut_string +gboolean dbusmenu_menuitem_property_set_shortcut_string + (DbusmenuMenuitem *menuitem, + const gchar *shortcut); + +This function takes a GTK shortcut string as defined in +gtk_accelerator_parse and turns that into the information +required to send it over DBusmenu. + +menuitem : +The DbusmenuMenuitem to set the shortcut on +shortcut : +String describing the shortcut +Returns :Whether it was successful at setting the property. + + +dbusmenu_menuitem_property_set_shortcut_menuitem () +dbusmenu_menuitem_property_set_shortcut_menuitem +gboolean dbusmenu_menuitem_property_set_shortcut_menuitem + (DbusmenuMenuitem *menuitem, + const GtkMenuItem *gmi); + +Takes the shortcut that is installed on a menu item and calls +dbusmenu_menuitem_property_set_shortcut with it. It also sets +up listeners to watch it change. + +menuitem : +The DbusmenuMenuitem to set the shortcut on +gmi : +A menu item to steal the shortcut off of +Returns :Whether it was successful at setting the property. + + +dbusmenu_menuitem_property_get_shortcut () +dbusmenu_menuitem_property_get_shortcut +void dbusmenu_menuitem_property_get_shortcut + (DbusmenuMenuitem *menuitem, + guint *key, + GdkModifierType *modifier); + +This function gets a GTK shortcut as a key and a mask +for use to set the accelerators. + +menuitem : +The DbusmenuMenuitem to get the shortcut off +key : +Location to put the key value. [out] +modifier : +Location to put the modifier mask. [out] + + + + + === added file 'docs/libdbusmenu-gtk/reference/xml/parser.xml' --- docs/libdbusmenu-gtk/reference/xml/parser.xml 1970-01-01 00:00:00 +0000 +++ docs/libdbusmenu-gtk/reference/xml/parser.xml 2012-06-13 19:49:21 +0000 @@ -0,0 +1,77 @@ + + +]> + + +parser +3 + + LIBDBUSMENU-GTK Library + + + +parser +A parser of in-memory GTK menu trees + + +Stability Level +Unstable, unless otherwise indicated + + + +Synopsis + + +#include <libdbusmenu-gtk/parser.h> + +DbusmenuMenuitem * dbusmenu_gtk_parse_menu_structure (GtkWidget *widget); +DbusmenuMenuitem * dbusmenu_gtk_parse_get_cached_item (GtkWidget *widget); + + + + +Description + +The parser will take a GTK menu tree and attach it to a Dbusmenu menu + tree. Along with setting up all the signals for updates and destruction. + The returned item would be the root item of the given tree. + + + +Details + +dbusmenu_gtk_parse_menu_structure () +dbusmenu_gtk_parse_menu_structure +DbusmenuMenuitem * dbusmenu_gtk_parse_menu_structure (GtkWidget *widget); + +Goes through the GTK structures and turns them into the appropraite +Dbusmenu structures along with setting up all the relationships +between the objects. It also stores the dbusmenu items as a cache +on the GTK items so that they'll be reused if necissary. + +widget : +A GtkMenuItem or GtkMenuShell to turn into a DbusmenuMenuitem +Returns :A dbusmenu item representing the menu structure. [transfer full] + + +dbusmenu_gtk_parse_get_cached_item () +dbusmenu_gtk_parse_get_cached_item +DbusmenuMenuitem * dbusmenu_gtk_parse_get_cached_item (GtkWidget *widget); + +The Dbusmenu GTK parser adds cached items on the various +menu items throughout the tree. Sometimes it can be useful +to get that cached item to use directly. This function +will retrieve it for you. + +widget : +A GtkMenuItem that may have a cached DbusmenuMenuitem from the parser +Returns :A pointer to the cached item +or NULL if it isn't there. [transfer none] + + + + + === modified file 'libdbusmenu-glib/enum-types.h' --- libdbusmenu-glib/enum-types.h 2011-03-16 19:02:13 +0000 +++ libdbusmenu-glib/enum-types.h 2012-06-13 19:49:21 +0000 @@ -35,7 +35,7 @@ G_BEGIN_DECLS -/* Enumerations from file: "./types.h" */ +/* Enumerations from file: "types.h" */ #include "types.h" === modified file 'libdbusmenu-glib/enum-types.h.in' --- libdbusmenu-glib/enum-types.h.in 2011-03-04 15:01:20 +0000 +++ libdbusmenu-glib/enum-types.h.in 2012-06-13 19:49:21 +0000 @@ -43,7 +43,7 @@ /*** END file-tail ***/ /*** BEGIN file-production ***/ -/* Enumerations from file: "@filename@" */ +/* Enumerations from file: "@basename@" */ #include "@basename@" /*** END file-production ***/ === modified file 'libdbusmenu-gtk/genericmenuitem-enum-types.h' --- libdbusmenu-gtk/genericmenuitem-enum-types.h 2011-08-24 20:55:17 +0000 +++ libdbusmenu-gtk/genericmenuitem-enum-types.h 2012-06-13 19:49:21 +0000 @@ -35,7 +35,7 @@ G_BEGIN_DECLS -/* Enumerations from file: "./genericmenuitem.h" */ +/* Enumerations from file: "genericmenuitem.h" */ #include "genericmenuitem.h" === modified file 'libdbusmenu-gtk/genericmenuitem-enum-types.h.in' --- libdbusmenu-gtk/genericmenuitem-enum-types.h.in 2011-08-22 19:31:31 +0000 +++ libdbusmenu-gtk/genericmenuitem-enum-types.h.in 2012-06-13 19:49:21 +0000 @@ -43,7 +43,7 @@ /*** END file-tail ***/ /*** BEGIN file-production ***/ -/* Enumerations from file: "@filename@" */ +/* Enumerations from file: "@basename@" */ #include "@basename@" /*** END file-production ***/ === modified file 'libdbusmenu-gtk/genericmenuitem.c' --- libdbusmenu-gtk/genericmenuitem.c 2012-04-16 19:27:40 +0000 +++ libdbusmenu-gtk/genericmenuitem.c 2012-06-13 19:49:21 +0000 @@ -242,7 +242,7 @@ } /* Sanitize the label by removing "__" meaning "_" */ -G_INLINE_FUNC gchar * +static gchar * sanitize_label (const gchar * in_label) { static GRegex * underscore_regex = NULL; @@ -279,7 +279,7 @@ gchar * local_label = NULL; switch (GENERICMENUITEM(menu_item)->priv->disposition) { case GENERICMENUITEM_DISPOSITION_NORMAL: - local_label = g_strdup(in_label); + local_label = g_markup_escape_text(in_label, -1); break; case GENERICMENUITEM_DISPOSITION_INFORMATIONAL: case GENERICMENUITEM_DISPOSITION_WARNING: