diff options
| author | Ted Gould <ted@gould.cx> | 2010-06-09 15:08:32 -0500 |
|---|---|---|
| committer | Ted Gould <ted@gould.cx> | 2010-06-09 15:08:32 -0500 |
| commit | 59c214159f0017b5c623772d4d6f34f940ac1113 (patch) | |
| tree | 09d75c905dffa02ba2517871ad00319743ebd3a2 /docs/libdbusmenu-glib/reference/xml | |
| parent | e35a0324bf0060b250bfc4a4a8b07465c6aafc6f (diff) | |
| download | libdbusmenu-59c214159f0017b5c623772d4d6f34f940ac1113.tar.gz libdbusmenu-59c214159f0017b5c623772d4d6f34f940ac1113.tar.bz2 libdbusmenu-59c214159f0017b5c623772d4d6f34f940ac1113.zip | |
Autogen and adding new Makefiles
Diffstat (limited to 'docs/libdbusmenu-glib/reference/xml')
| -rw-r--r-- | docs/libdbusmenu-glib/reference/xml/annotation-glossary.xml | 54 | ||||
| -rw-r--r-- | docs/libdbusmenu-glib/reference/xml/api-index-deprecated.xml | 8 | ||||
| -rw-r--r-- | docs/libdbusmenu-glib/reference/xml/api-index-full.xml | 158 | ||||
| -rw-r--r-- | docs/libdbusmenu-glib/reference/xml/client-menuitem.xml | 87 | ||||
| -rw-r--r-- | docs/libdbusmenu-glib/reference/xml/client.xml | 336 | ||||
| -rw-r--r-- | docs/libdbusmenu-glib/reference/xml/dbusmenu-client.xml | 657 | ||||
| -rw-r--r-- | docs/libdbusmenu-glib/reference/xml/dbusmenu-server.xml | 462 | ||||
| -rw-r--r-- | docs/libdbusmenu-glib/reference/xml/menuitem-proxy.xml | 111 | ||||
| -rw-r--r-- | docs/libdbusmenu-glib/reference/xml/menuitem.xml | 1166 | ||||
| -rw-r--r-- | docs/libdbusmenu-glib/reference/xml/server.xml | 183 |
10 files changed, 3222 insertions, 0 deletions
diff --git a/docs/libdbusmenu-glib/reference/xml/annotation-glossary.xml b/docs/libdbusmenu-glib/reference/xml/annotation-glossary.xml new file mode 100644 index 0000000..2dfb261 --- /dev/null +++ b/docs/libdbusmenu-glib/reference/xml/annotation-glossary.xml @@ -0,0 +1,54 @@ +<?xml version="1.0"?> +<!DOCTYPE glossary PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" + "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" +[ + <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'"> +]> + +<glossary id="annotation-glossary"> + <title>Annotation Glossary</title> +<glossdiv><title>A</title> + <glossentry> + <glossterm><anchor id="annotation-glossterm-array"/>array</glossterm> + <glossdef> + <para>Parameter points to an array of items.</para> + </glossdef> + </glossentry> +</glossdiv> +<glossdiv><title>E</title> + <glossentry> + <glossterm><anchor id="annotation-glossterm-element-type"/>element-type</glossterm> + <glossdef> + <para>Generics and defining elements of containers and arrays.</para> + </glossdef> + </glossentry> +</glossdiv> +<glossdiv><title>I</title> + <glossentry> + <glossterm><anchor id="annotation-glossterm-inout"/>inout</glossterm> + <glossdef> + <para>Parameter for input and for returning results. Default is <acronym>transfer full</acronym>.</para> + </glossdef> + </glossentry> + <glossentry> + <glossterm><anchor id="annotation-glossterm-in"/>in</glossterm> + <glossdef> + <para>Parameter for input. Default is <acronym>transfer none</acronym>.</para> + </glossdef> + </glossentry> +</glossdiv> +<glossdiv><title>T</title> + <glossentry> + <glossterm><anchor id="annotation-glossterm-transfer full"/>transfer full</glossterm> + <glossdef> + <para>Free data after the code is done.</para> + </glossdef> + </glossentry> + <glossentry> + <glossterm><anchor id="annotation-glossterm-transfer none"/>transfer none</glossterm> + <glossdef> + <para>Don't free data after the code is done.</para> + </glossdef> + </glossentry> +</glossdiv> +</glossary> diff --git a/docs/libdbusmenu-glib/reference/xml/api-index-deprecated.xml b/docs/libdbusmenu-glib/reference/xml/api-index-deprecated.xml new file mode 100644 index 0000000..8ec0fe4 --- /dev/null +++ b/docs/libdbusmenu-glib/reference/xml/api-index-deprecated.xml @@ -0,0 +1,8 @@ +<?xml version="1.0"?> +<!DOCTYPE indexdiv PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" + "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" +[ + <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'"> +]> +<indexdiv> +</indexdiv> diff --git a/docs/libdbusmenu-glib/reference/xml/api-index-full.xml b/docs/libdbusmenu-glib/reference/xml/api-index-full.xml new file mode 100644 index 0000000..84ae6cb --- /dev/null +++ b/docs/libdbusmenu-glib/reference/xml/api-index-full.xml @@ -0,0 +1,158 @@ +<?xml version="1.0"?> +<!DOCTYPE indexdiv PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" + "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" +[ + <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'"> +]> +<indexdiv> +<indexdiv><title>G</title> +<indexentry><primaryie linkends="DBUS-GLIB-CLIENT-WRAPPERS-org-ayatana-dbusmenu"><link linkend="DBUS-GLIB-CLIENT-WRAPPERS-org-ayatana-dbusmenu">DBUS_GLIB_CLIENT_WRAPPERS_org_ayatana_dbusmenu</link>, macro in <link linkend="libdbusmenu-glib-dbusmenu-client">dbusmenu-client</link></primaryie></indexentry> +<indexentry><primaryie linkends="dbus-glib-marshal--dbusmenu-server-BOOLEAN--BOXED-BOXED-POINTER-POINTER"><link linkend="dbus-glib-marshal--dbusmenu-server-BOOLEAN--BOXED-BOXED-POINTER-POINTER">dbus_glib_marshal__dbusmenu_server_BOOLEAN__BOXED_BOXED_POINTER_POINTER</link>, function in <link linkend="libdbusmenu-glib-dbusmenu-server">dbusmenu-server</link></primaryie></indexentry> +<indexentry><primaryie linkends="dbus-glib-marshal--dbusmenu-server-BOOLEAN--INT-BOXED-POINTER-POINTER"><link linkend="dbus-glib-marshal--dbusmenu-server-BOOLEAN--INT-BOXED-POINTER-POINTER">dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_BOXED_POINTER_POINTER</link>, function in <link linkend="libdbusmenu-glib-dbusmenu-server">dbusmenu-server</link></primaryie></indexentry> +<indexentry><primaryie linkends="dbus-glib-marshal--dbusmenu-server-BOOLEAN--INT-POINTER-POINTER"><link linkend="dbus-glib-marshal--dbusmenu-server-BOOLEAN--INT-POINTER-POINTER">dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_POINTER_POINTER</link>, function in <link linkend="libdbusmenu-glib-dbusmenu-server">dbusmenu-server</link></primaryie></indexentry> +<indexentry><primaryie linkends="dbus-glib-marshal--dbusmenu-server-BOOLEAN--INT-POINTER-POINTER-POINTER"><link linkend="dbus-glib-marshal--dbusmenu-server-BOOLEAN--INT-POINTER-POINTER-POINTER">dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_POINTER_POINTER_POINTER</link>, function in <link linkend="libdbusmenu-glib-dbusmenu-server">dbusmenu-server</link></primaryie></indexentry> +<indexentry><primaryie linkends="dbus-glib-marshal--dbusmenu-server-BOOLEAN--INT-STRING-BOXED-UINT-POINTER"><link linkend="dbus-glib-marshal--dbusmenu-server-BOOLEAN--INT-STRING-BOXED-UINT-POINTER">dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_STRING_BOXED_UINT_POINTER</link>, function in <link linkend="libdbusmenu-glib-dbusmenu-server">dbusmenu-server</link></primaryie></indexentry> +<indexentry><primaryie linkends="dbus-glib-marshal--dbusmenu-server-BOOLEAN--INT-STRING-POINTER-POINTER"><link linkend="dbus-glib-marshal--dbusmenu-server-BOOLEAN--INT-STRING-POINTER-POINTER">dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_STRING_POINTER_POINTER</link>, function in <link linkend="libdbusmenu-glib-dbusmenu-server">dbusmenu-server</link></primaryie></indexentry> +<indexentry><primaryie linkends="g-marshal-value-peek-boolean"><link linkend="g-marshal-value-peek-boolean">g_marshal_value_peek_boolean</link>, macro in <link linkend="libdbusmenu-glib-dbusmenu-server">dbusmenu-server</link></primaryie></indexentry> +<indexentry><primaryie linkends="g-marshal-value-peek-boxed"><link linkend="g-marshal-value-peek-boxed">g_marshal_value_peek_boxed</link>, macro in <link linkend="libdbusmenu-glib-dbusmenu-server">dbusmenu-server</link></primaryie></indexentry> +<indexentry><primaryie linkends="g-marshal-value-peek-char"><link linkend="g-marshal-value-peek-char">g_marshal_value_peek_char</link>, macro in <link linkend="libdbusmenu-glib-dbusmenu-server">dbusmenu-server</link></primaryie></indexentry> +<indexentry><primaryie linkends="g-marshal-value-peek-double"><link linkend="g-marshal-value-peek-double">g_marshal_value_peek_double</link>, macro in <link linkend="libdbusmenu-glib-dbusmenu-server">dbusmenu-server</link></primaryie></indexentry> +<indexentry><primaryie linkends="g-marshal-value-peek-enum"><link linkend="g-marshal-value-peek-enum">g_marshal_value_peek_enum</link>, macro in <link linkend="libdbusmenu-glib-dbusmenu-server">dbusmenu-server</link></primaryie></indexentry> +<indexentry><primaryie linkends="g-marshal-value-peek-flags"><link linkend="g-marshal-value-peek-flags">g_marshal_value_peek_flags</link>, macro in <link linkend="libdbusmenu-glib-dbusmenu-server">dbusmenu-server</link></primaryie></indexentry> +<indexentry><primaryie linkends="g-marshal-value-peek-float"><link linkend="g-marshal-value-peek-float">g_marshal_value_peek_float</link>, macro in <link linkend="libdbusmenu-glib-dbusmenu-server">dbusmenu-server</link></primaryie></indexentry> +<indexentry><primaryie linkends="g-marshal-value-peek-int"><link linkend="g-marshal-value-peek-int">g_marshal_value_peek_int</link>, macro in <link linkend="libdbusmenu-glib-dbusmenu-server">dbusmenu-server</link></primaryie></indexentry> +<indexentry><primaryie linkends="g-marshal-value-peek-int64"><link linkend="g-marshal-value-peek-int64">g_marshal_value_peek_int64</link>, macro in <link linkend="libdbusmenu-glib-dbusmenu-server">dbusmenu-server</link></primaryie></indexentry> +<indexentry><primaryie linkends="g-marshal-value-peek-long"><link linkend="g-marshal-value-peek-long">g_marshal_value_peek_long</link>, macro in <link linkend="libdbusmenu-glib-dbusmenu-server">dbusmenu-server</link></primaryie></indexentry> +<indexentry><primaryie linkends="g-marshal-value-peek-object"><link linkend="g-marshal-value-peek-object">g_marshal_value_peek_object</link>, macro in <link linkend="libdbusmenu-glib-dbusmenu-server">dbusmenu-server</link></primaryie></indexentry> +<indexentry><primaryie linkends="g-marshal-value-peek-param"><link linkend="g-marshal-value-peek-param">g_marshal_value_peek_param</link>, macro in <link linkend="libdbusmenu-glib-dbusmenu-server">dbusmenu-server</link></primaryie></indexentry> +<indexentry><primaryie linkends="g-marshal-value-peek-pointer"><link linkend="g-marshal-value-peek-pointer">g_marshal_value_peek_pointer</link>, macro in <link linkend="libdbusmenu-glib-dbusmenu-server">dbusmenu-server</link></primaryie></indexentry> +<indexentry><primaryie linkends="g-marshal-value-peek-string"><link linkend="g-marshal-value-peek-string">g_marshal_value_peek_string</link>, macro in <link linkend="libdbusmenu-glib-dbusmenu-server">dbusmenu-server</link></primaryie></indexentry> +<indexentry><primaryie linkends="g-marshal-value-peek-uchar"><link linkend="g-marshal-value-peek-uchar">g_marshal_value_peek_uchar</link>, macro in <link linkend="libdbusmenu-glib-dbusmenu-server">dbusmenu-server</link></primaryie></indexentry> +<indexentry><primaryie linkends="g-marshal-value-peek-uint"><link linkend="g-marshal-value-peek-uint">g_marshal_value_peek_uint</link>, macro in <link linkend="libdbusmenu-glib-dbusmenu-server">dbusmenu-server</link></primaryie></indexentry> +<indexentry><primaryie linkends="g-marshal-value-peek-uint64"><link linkend="g-marshal-value-peek-uint64">g_marshal_value_peek_uint64</link>, macro in <link linkend="libdbusmenu-glib-dbusmenu-server">dbusmenu-server</link></primaryie></indexentry> +<indexentry><primaryie linkends="g-marshal-value-peek-ulong"><link linkend="g-marshal-value-peek-ulong">g_marshal_value_peek_ulong</link>, macro in <link linkend="libdbusmenu-glib-dbusmenu-server">dbusmenu-server</link></primaryie></indexentry> +<indexentry><primaryie linkends="dbus-g-proxy-begin-call"><link linkend="dbus-g-proxy-begin-call">dbus_g_proxy_begin_call</link>, function in <link linkend="libdbusmenu-glib-dbusmenu-client">dbusmenu-client</link></primaryie></indexentry> +</indexdiv> +<indexdiv><title>M</title> +<indexentry><primaryie linkends="DbusmenuClientClass"><link linkend="DbusmenuClientClass">DbusmenuClientClass</link>, struct in <link linkend="libdbusmenu-glib-DbusmenuClient">DbusmenuClient</link></primaryie></indexentry> +<indexentry><primaryie linkends="DbusmenuClientMenuitem-struct"><link linkend="DbusmenuClientMenuitem-struct">DbusmenuClientMenuitem</link>, struct in <link linkend="DbusmenuClientMenuitem">DbusmenuClientMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="DbusmenuClientMenuitemClass"><link linkend="DbusmenuClientMenuitemClass">DbusmenuClientMenuitemClass</link>, struct in <link linkend="DbusmenuClientMenuitem">DbusmenuClientMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="DbusmenuClientTypeHandler"><link linkend="DbusmenuClientTypeHandler">DbusmenuClientTypeHandler</link>, user_function in <link linkend="libdbusmenu-glib-DbusmenuClient">DbusmenuClient</link></primaryie></indexentry> +<indexentry><primaryie linkends="DbusmenuMenuitem-struct"><link linkend="DbusmenuMenuitem-struct">DbusmenuMenuitem</link>, struct in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="DbusmenuMenuitem-child-added"><link linkend="DbusmenuMenuitem-child-added">DbusmenuMenuitem::child-added</link>, object signal in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="DbusmenuMenuitem-child-moved"><link linkend="DbusmenuMenuitem-child-moved">DbusmenuMenuitem::child-moved</link>, object signal in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="DbusmenuMenuitem-child-removed"><link linkend="DbusmenuMenuitem-child-removed">DbusmenuMenuitem::child-removed</link>, object signal in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="DbusmenuMenuitem-item-activated"><link linkend="DbusmenuMenuitem-item-activated">DbusmenuMenuitem::item-activated</link>, object signal in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="DbusmenuMenuitem-property-changed"><link linkend="DbusmenuMenuitem-property-changed">DbusmenuMenuitem::property-changed</link>, object signal in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="DbusmenuMenuitem-realized"><link linkend="DbusmenuMenuitem-realized">DbusmenuMenuitem::realized</link>, object signal in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="DbusmenuMenuitem--id"><link linkend="DbusmenuMenuitem--id">DbusmenuMenuitem:id</link>, object property in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="DbusmenuMenuitemClass"><link linkend="DbusmenuMenuitemClass">DbusmenuMenuitemClass</link>, struct in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="DbusmenuMenuitemProxy-struct"><link linkend="DbusmenuMenuitemProxy-struct">DbusmenuMenuitemProxy</link>, struct in <link linkend="DbusmenuMenuitemProxy">DbusmenuMenuitemProxy</link></primaryie></indexentry> +<indexentry><primaryie linkends="DbusmenuMenuitemProxy--menu-item"><link linkend="DbusmenuMenuitemProxy--menu-item">DbusmenuMenuitemProxy:menu-item</link>, object property in <link linkend="DbusmenuMenuitemProxy">DbusmenuMenuitemProxy</link></primaryie></indexentry> +<indexentry><primaryie linkends="DbusmenuMenuitemProxyClass"><link linkend="DbusmenuMenuitemProxyClass">DbusmenuMenuitemProxyClass</link>, struct in <link linkend="DbusmenuMenuitemProxy">DbusmenuMenuitemProxy</link></primaryie></indexentry> +<indexentry><primaryie linkends="DbusmenuServerClass"><link linkend="DbusmenuServerClass">DbusmenuServerClass</link>, struct in <link linkend="libdbusmenu-glib-DbusmenuServer">DbusmenuServer</link></primaryie></indexentry> +<indexentry><primaryie linkends="dbusmenu-client-add-type-handler"><link linkend="dbusmenu-client-add-type-handler">dbusmenu_client_add_type_handler</link>, function in <link linkend="libdbusmenu-glib-DbusmenuClient">DbusmenuClient</link></primaryie></indexentry> +<indexentry><primaryie linkends="dbusmenu-client-get-root"><link linkend="dbusmenu-client-get-root">dbusmenu_client_get_root</link>, function in <link linkend="libdbusmenu-glib-DbusmenuClient">DbusmenuClient</link></primaryie></indexentry> +<indexentry><primaryie linkends="dbusmenu-client-menuitem-new"><link linkend="dbusmenu-client-menuitem-new">dbusmenu_client_menuitem_new</link>, function in <link linkend="DbusmenuClientMenuitem">DbusmenuClientMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="DBUSMENU-CLIENT-MENUITEM-TYPE:CAPS"><link linkend="DBUSMENU-CLIENT-MENUITEM-TYPE:CAPS">DBUSMENU_CLIENT_MENUITEM_TYPE</link>, macro in <link linkend="DbusmenuClientMenuitem">DbusmenuClientMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="dbusmenu-client-new"><link linkend="dbusmenu-client-new">dbusmenu_client_new</link>, function in <link linkend="libdbusmenu-glib-DbusmenuClient">DbusmenuClient</link></primaryie></indexentry> +<indexentry><primaryie linkends="DBUSMENU-CLIENT-PROP-DBUS-NAME:CAPS"><link linkend="DBUSMENU-CLIENT-PROP-DBUS-NAME:CAPS">DBUSMENU_CLIENT_PROP_DBUS_NAME</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuClient">DbusmenuClient</link></primaryie></indexentry> +<indexentry><primaryie linkends="DBUSMENU-CLIENT-PROP-DBUS-OBJECT:CAPS"><link linkend="DBUSMENU-CLIENT-PROP-DBUS-OBJECT:CAPS">DBUSMENU_CLIENT_PROP_DBUS_OBJECT</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuClient">DbusmenuClient</link></primaryie></indexentry> +<indexentry><primaryie linkends="dbusmenu-client-send-about-to-show"><link linkend="dbusmenu-client-send-about-to-show">dbusmenu_client_send_about_to_show</link>, function in <link linkend="libdbusmenu-glib-DbusmenuClient">DbusmenuClient</link></primaryie></indexentry> +<indexentry><primaryie linkends="dbusmenu-client-send-event"><link linkend="dbusmenu-client-send-event">dbusmenu_client_send_event</link>, function in <link linkend="libdbusmenu-glib-DbusmenuClient">DbusmenuClient</link></primaryie></indexentry> +<indexentry><primaryie linkends="DBUSMENU-CLIENT-SIGNAL-LAYOUT-UPDATED:CAPS"><link linkend="DBUSMENU-CLIENT-SIGNAL-LAYOUT-UPDATED:CAPS">DBUSMENU_CLIENT_SIGNAL_LAYOUT_UPDATED</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuClient">DbusmenuClient</link></primaryie></indexentry> +<indexentry><primaryie linkends="DBUSMENU-CLIENT-SIGNAL-NEW-MENUITEM:CAPS"><link linkend="DBUSMENU-CLIENT-SIGNAL-NEW-MENUITEM:CAPS">DBUSMENU_CLIENT_SIGNAL_NEW_MENUITEM</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuClient">DbusmenuClient</link></primaryie></indexentry> +<indexentry><primaryie linkends="DBUSMENU-CLIENT-SIGNAL-ROOT-CHANGED:CAPS"><link linkend="DBUSMENU-CLIENT-SIGNAL-ROOT-CHANGED:CAPS">DBUSMENU_CLIENT_SIGNAL_ROOT_CHANGED</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuClient">DbusmenuClient</link></primaryie></indexentry> +<indexentry><primaryie linkends="DBUSMENU-CLIENT-TYPES-DEFAULT:CAPS"><link linkend="DBUSMENU-CLIENT-TYPES-DEFAULT:CAPS">DBUSMENU_CLIENT_TYPES_DEFAULT</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuClient">DbusmenuClient</link></primaryie></indexentry> +<indexentry><primaryie linkends="DBUSMENU-CLIENT-TYPES-IMAGE:CAPS"><link linkend="DBUSMENU-CLIENT-TYPES-IMAGE:CAPS">DBUSMENU_CLIENT_TYPES_IMAGE</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuClient">DbusmenuClient</link></primaryie></indexentry> +<indexentry><primaryie linkends="DBUSMENU-CLIENT-TYPES-SEPARATOR:CAPS"><link linkend="DBUSMENU-CLIENT-TYPES-SEPARATOR:CAPS">DBUSMENU_CLIENT_TYPES_SEPARATOR</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuClient">DbusmenuClient</link></primaryie></indexentry> +<indexentry><primaryie linkends="dbusmenu-menuitem-about-to-show-cb"><link linkend="dbusmenu-menuitem-about-to-show-cb">dbusmenu_menuitem_about_to_show_cb</link>, user_function in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="dbusmenu-menuitem-buildxml-slot-t"><link linkend="dbusmenu-menuitem-buildxml-slot-t">dbusmenu_menuitem_buildxml_slot_t</link>, user_function in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="dbusmenu-menuitem-child-add-position"><link linkend="dbusmenu-menuitem-child-add-position">dbusmenu_menuitem_child_add_position</link>, function in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="dbusmenu-menuitem-child-append"><link linkend="dbusmenu-menuitem-child-append">dbusmenu_menuitem_child_append</link>, function in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="dbusmenu-menuitem-child-delete"><link linkend="dbusmenu-menuitem-child-delete">dbusmenu_menuitem_child_delete</link>, function in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="dbusmenu-menuitem-child-find"><link linkend="dbusmenu-menuitem-child-find">dbusmenu_menuitem_child_find</link>, function in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="dbusmenu-menuitem-child-prepend"><link linkend="dbusmenu-menuitem-child-prepend">dbusmenu_menuitem_child_prepend</link>, function in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="dbusmenu-menuitem-child-reorder"><link linkend="dbusmenu-menuitem-child-reorder">dbusmenu_menuitem_child_reorder</link>, function in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="dbusmenu-menuitem-find-id"><link linkend="dbusmenu-menuitem-find-id">dbusmenu_menuitem_find_id</link>, function in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="dbusmenu-menuitem-foreach"><link linkend="dbusmenu-menuitem-foreach">dbusmenu_menuitem_foreach</link>, function in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="dbusmenu-menuitem-get-children"><link linkend="dbusmenu-menuitem-get-children">dbusmenu_menuitem_get_children</link>, function in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="dbusmenu-menuitem-get-id"><link linkend="dbusmenu-menuitem-get-id">dbusmenu_menuitem_get_id</link>, function in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="dbusmenu-menuitem-get-position"><link linkend="dbusmenu-menuitem-get-position">dbusmenu_menuitem_get_position</link>, function in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="dbusmenu-menuitem-get-position-realized"><link linkend="dbusmenu-menuitem-get-position-realized">dbusmenu_menuitem_get_position_realized</link>, function in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="dbusmenu-menuitem-get-root"><link linkend="dbusmenu-menuitem-get-root">dbusmenu_menuitem_get_root</link>, function in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="dbusmenu-menuitem-handle-event"><link linkend="dbusmenu-menuitem-handle-event">dbusmenu_menuitem_handle_event</link>, function in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="DBUSMENU-MENUITEM-ICON-NAME-BLANK:CAPS"><link linkend="DBUSMENU-MENUITEM-ICON-NAME-BLANK:CAPS">DBUSMENU_MENUITEM_ICON_NAME_BLANK</link>, macro in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="dbusmenu-menuitem-new"><link linkend="dbusmenu-menuitem-new">dbusmenu_menuitem_new</link>, function in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="dbusmenu-menuitem-new-with-id"><link linkend="dbusmenu-menuitem-new-with-id">dbusmenu_menuitem_new_with_id</link>, function in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="dbusmenu-menuitem-properties-copy"><link linkend="dbusmenu-menuitem-properties-copy">dbusmenu_menuitem_properties_copy</link>, function in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="dbusmenu-menuitem-properties-list"><link linkend="dbusmenu-menuitem-properties-list">dbusmenu_menuitem_properties_list</link>, function in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="dbusmenu-menuitem-property-exist"><link linkend="dbusmenu-menuitem-property-exist">dbusmenu_menuitem_property_exist</link>, function in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="dbusmenu-menuitem-property-get"><link linkend="dbusmenu-menuitem-property-get">dbusmenu_menuitem_property_get</link>, function in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="dbusmenu-menuitem-property-get-bool"><link linkend="dbusmenu-menuitem-property-get-bool">dbusmenu_menuitem_property_get_bool</link>, function in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="dbusmenu-menuitem-property-get-int"><link linkend="dbusmenu-menuitem-property-get-int">dbusmenu_menuitem_property_get_int</link>, function in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="dbusmenu-menuitem-property-get-value"><link linkend="dbusmenu-menuitem-property-get-value">dbusmenu_menuitem_property_get_value</link>, function in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="dbusmenu-menuitem-property-remove"><link linkend="dbusmenu-menuitem-property-remove">dbusmenu_menuitem_property_remove</link>, function in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="dbusmenu-menuitem-property-set"><link linkend="dbusmenu-menuitem-property-set">dbusmenu_menuitem_property_set</link>, function in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="dbusmenu-menuitem-property-set-bool"><link linkend="dbusmenu-menuitem-property-set-bool">dbusmenu_menuitem_property_set_bool</link>, function in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="dbusmenu-menuitem-property-set-int"><link linkend="dbusmenu-menuitem-property-set-int">dbusmenu_menuitem_property_set_int</link>, function in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="dbusmenu-menuitem-property-set-value"><link linkend="dbusmenu-menuitem-property-set-value">dbusmenu_menuitem_property_set_value</link>, function in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="DBUSMENU-MENUITEM-PROP-ENABLED:CAPS"><link linkend="DBUSMENU-MENUITEM-PROP-ENABLED:CAPS">DBUSMENU_MENUITEM_PROP_ENABLED</link>, macro in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="DBUSMENU-MENUITEM-PROP-ICON-DATA:CAPS"><link linkend="DBUSMENU-MENUITEM-PROP-ICON-DATA:CAPS">DBUSMENU_MENUITEM_PROP_ICON_DATA</link>, macro in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="DBUSMENU-MENUITEM-PROP-ICON-NAME:CAPS"><link linkend="DBUSMENU-MENUITEM-PROP-ICON-NAME:CAPS">DBUSMENU_MENUITEM_PROP_ICON_NAME</link>, macro in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="DBUSMENU-MENUITEM-PROP-LABEL:CAPS"><link linkend="DBUSMENU-MENUITEM-PROP-LABEL:CAPS">DBUSMENU_MENUITEM_PROP_LABEL</link>, macro in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="DBUSMENU-MENUITEM-PROP-TOGGLE-STATE:CAPS"><link linkend="DBUSMENU-MENUITEM-PROP-TOGGLE-STATE:CAPS">DBUSMENU_MENUITEM_PROP_TOGGLE_STATE</link>, macro in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="DBUSMENU-MENUITEM-PROP-TOGGLE-TYPE:CAPS"><link linkend="DBUSMENU-MENUITEM-PROP-TOGGLE-TYPE:CAPS">DBUSMENU_MENUITEM_PROP_TOGGLE_TYPE</link>, macro in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="DBUSMENU-MENUITEM-PROP-TYPE:CAPS"><link linkend="DBUSMENU-MENUITEM-PROP-TYPE:CAPS">DBUSMENU_MENUITEM_PROP_TYPE</link>, macro in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="DBUSMENU-MENUITEM-PROP-VISIBLE:CAPS"><link linkend="DBUSMENU-MENUITEM-PROP-VISIBLE:CAPS">DBUSMENU_MENUITEM_PROP_VISIBLE</link>, macro in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="dbusmenu-menuitem-proxy-get-wrapped"><link linkend="dbusmenu-menuitem-proxy-get-wrapped">dbusmenu_menuitem_proxy_get_wrapped</link>, function in <link linkend="DbusmenuMenuitemProxy">DbusmenuMenuitemProxy</link></primaryie></indexentry> +<indexentry><primaryie linkends="dbusmenu-menuitem-proxy-new"><link linkend="dbusmenu-menuitem-proxy-new">dbusmenu_menuitem_proxy_new</link>, function in <link linkend="DbusmenuMenuitemProxy">DbusmenuMenuitemProxy</link></primaryie></indexentry> +<indexentry><primaryie linkends="dbusmenu-menuitem-send-about-to-show"><link linkend="dbusmenu-menuitem-send-about-to-show">dbusmenu_menuitem_send_about_to_show</link>, function in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="dbusmenu-menuitem-set-root"><link linkend="dbusmenu-menuitem-set-root">dbusmenu_menuitem_set_root</link>, function in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="DBUSMENU-MENUITEM-SIGNAL-CHILD-ADDED:CAPS"><link linkend="DBUSMENU-MENUITEM-SIGNAL-CHILD-ADDED:CAPS">DBUSMENU_MENUITEM_SIGNAL_CHILD_ADDED</link>, macro in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="DBUSMENU-MENUITEM-SIGNAL-CHILD-MOVED:CAPS"><link linkend="DBUSMENU-MENUITEM-SIGNAL-CHILD-MOVED:CAPS">DBUSMENU_MENUITEM_SIGNAL_CHILD_MOVED</link>, macro in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="DBUSMENU-MENUITEM-SIGNAL-CHILD-REMOVED:CAPS"><link linkend="DBUSMENU-MENUITEM-SIGNAL-CHILD-REMOVED:CAPS">DBUSMENU_MENUITEM_SIGNAL_CHILD_REMOVED</link>, macro in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="DBUSMENU-MENUITEM-SIGNAL-ITEM-ACTIVATED:CAPS"><link linkend="DBUSMENU-MENUITEM-SIGNAL-ITEM-ACTIVATED:CAPS">DBUSMENU_MENUITEM_SIGNAL_ITEM_ACTIVATED</link>, macro in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="DBUSMENU-MENUITEM-SIGNAL-PROPERTY-CHANGED:CAPS"><link linkend="DBUSMENU-MENUITEM-SIGNAL-PROPERTY-CHANGED:CAPS">DBUSMENU_MENUITEM_SIGNAL_PROPERTY_CHANGED</link>, macro in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="DBUSMENU-MENUITEM-SIGNAL-REALIZED:CAPS"><link linkend="DBUSMENU-MENUITEM-SIGNAL-REALIZED:CAPS">DBUSMENU_MENUITEM_SIGNAL_REALIZED</link>, macro in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="DBUSMENU-MENUITEM-SIGNAL-REALIZED-ID:CAPS"><link linkend="DBUSMENU-MENUITEM-SIGNAL-REALIZED-ID:CAPS">DBUSMENU_MENUITEM_SIGNAL_REALIZED_ID</link>, macro in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="dbusmenu-menuitem-take-children"><link linkend="dbusmenu-menuitem-take-children">dbusmenu_menuitem_take_children</link>, function in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="DBUSMENU-MENUITEM-TOGGLE-CHECK:CAPS"><link linkend="DBUSMENU-MENUITEM-TOGGLE-CHECK:CAPS">DBUSMENU_MENUITEM_TOGGLE_CHECK</link>, macro in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="DBUSMENU-MENUITEM-TOGGLE-RADIO:CAPS"><link linkend="DBUSMENU-MENUITEM-TOGGLE-RADIO:CAPS">DBUSMENU_MENUITEM_TOGGLE_RADIO</link>, macro in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="DBUSMENU-MENUITEM-TOGGLE-STATE-CHECKED:CAPS"><link linkend="DBUSMENU-MENUITEM-TOGGLE-STATE-CHECKED:CAPS">DBUSMENU_MENUITEM_TOGGLE_STATE_CHECKED</link>, macro in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="DBUSMENU-MENUITEM-TOGGLE-STATE-UNCHECKED:CAPS"><link linkend="DBUSMENU-MENUITEM-TOGGLE-STATE-UNCHECKED:CAPS">DBUSMENU_MENUITEM_TOGGLE_STATE_UNCHECKED</link>, macro in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="DBUSMENU-MENUITEM-TOGGLE-STATE-UNKNOWN:CAPS"><link linkend="DBUSMENU-MENUITEM-TOGGLE-STATE-UNKNOWN:CAPS">DBUSMENU_MENUITEM_TOGGLE_STATE_UNKNOWN</link>, macro in <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="dbusmenu-server-new"><link linkend="dbusmenu-server-new">dbusmenu_server_new</link>, function in <link linkend="libdbusmenu-glib-DbusmenuServer">DbusmenuServer</link></primaryie></indexentry> +<indexentry><primaryie linkends="DBUSMENU-SERVER-PROP-DBUS-OBJECT:CAPS"><link linkend="DBUSMENU-SERVER-PROP-DBUS-OBJECT:CAPS">DBUSMENU_SERVER_PROP_DBUS_OBJECT</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuServer">DbusmenuServer</link></primaryie></indexentry> +<indexentry><primaryie linkends="DBUSMENU-SERVER-PROP-ROOT-NODE:CAPS"><link linkend="DBUSMENU-SERVER-PROP-ROOT-NODE:CAPS">DBUSMENU_SERVER_PROP_ROOT_NODE</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuServer">DbusmenuServer</link></primaryie></indexentry> +<indexentry><primaryie linkends="DBUSMENU-SERVER-PROP-VERSION:CAPS"><link linkend="DBUSMENU-SERVER-PROP-VERSION:CAPS">DBUSMENU_SERVER_PROP_VERSION</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuServer">DbusmenuServer</link></primaryie></indexentry> +<indexentry><primaryie linkends="dbusmenu-server-set-root"><link linkend="dbusmenu-server-set-root">dbusmenu_server_set_root</link>, function in <link linkend="libdbusmenu-glib-DbusmenuServer">DbusmenuServer</link></primaryie></indexentry> +<indexentry><primaryie linkends="DBUSMENU-SERVER-SIGNAL-ID-PROP-UPDATE:CAPS"><link linkend="DBUSMENU-SERVER-SIGNAL-ID-PROP-UPDATE:CAPS">DBUSMENU_SERVER_SIGNAL_ID_PROP_UPDATE</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuServer">DbusmenuServer</link></primaryie></indexentry> +<indexentry><primaryie linkends="DBUSMENU-SERVER-SIGNAL-ID-UPDATE:CAPS"><link linkend="DBUSMENU-SERVER-SIGNAL-ID-UPDATE:CAPS">DBUSMENU_SERVER_SIGNAL_ID_UPDATE</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuServer">DbusmenuServer</link></primaryie></indexentry> +<indexentry><primaryie linkends="DBUSMENU-SERVER-SIGNAL-LAYOUT-UPDATE:CAPS"><link linkend="DBUSMENU-SERVER-SIGNAL-LAYOUT-UPDATE:CAPS">DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATE</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuServer">DbusmenuServer</link></primaryie></indexentry> +<indexentry><primaryie linkends="DBUSMENU-SERVER-SIGNAL-LAYOUT-UPDATED:CAPS"><link linkend="DBUSMENU-SERVER-SIGNAL-LAYOUT-UPDATED:CAPS">DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATED</link>, macro in <link linkend="libdbusmenu-glib-DbusmenuServer">DbusmenuServer</link></primaryie></indexentry> +</indexdiv> +<indexdiv><title>O</title> +<indexentry><primaryie linkends="org-ayatana-dbusmenu-about-to-show"><link linkend="org-ayatana-dbusmenu-about-to-show">org_ayatana_dbusmenu_about_to_show</link>, function in <link linkend="libdbusmenu-glib-dbusmenu-client">dbusmenu-client</link></primaryie></indexentry> +<indexentry><primaryie linkends="org-ayatana-dbusmenu-about-to-show-async"><link linkend="org-ayatana-dbusmenu-about-to-show-async">org_ayatana_dbusmenu_about_to_show_async</link>, function in <link linkend="libdbusmenu-glib-dbusmenu-client">dbusmenu-client</link></primaryie></indexentry> +<indexentry><primaryie linkends="org-ayatana-dbusmenu-about-to-show-reply"><link linkend="org-ayatana-dbusmenu-about-to-show-reply">org_ayatana_dbusmenu_about_to_show_reply</link>, user_function in <link linkend="libdbusmenu-glib-dbusmenu-client">dbusmenu-client</link></primaryie></indexentry> +<indexentry><primaryie linkends="org-ayatana-dbusmenu-event"><link linkend="org-ayatana-dbusmenu-event">org_ayatana_dbusmenu_event</link>, function in <link linkend="libdbusmenu-glib-dbusmenu-client">dbusmenu-client</link></primaryie></indexentry> +<indexentry><primaryie linkends="org-ayatana-dbusmenu-event-async"><link linkend="org-ayatana-dbusmenu-event-async">org_ayatana_dbusmenu_event_async</link>, function in <link linkend="libdbusmenu-glib-dbusmenu-client">dbusmenu-client</link></primaryie></indexentry> +<indexentry><primaryie linkends="org-ayatana-dbusmenu-event-reply"><link linkend="org-ayatana-dbusmenu-event-reply">org_ayatana_dbusmenu_event_reply</link>, user_function in <link linkend="libdbusmenu-glib-dbusmenu-client">dbusmenu-client</link></primaryie></indexentry> +<indexentry><primaryie linkends="org-ayatana-dbusmenu-get-children"><link linkend="org-ayatana-dbusmenu-get-children">org_ayatana_dbusmenu_get_children</link>, function in <link linkend="libdbusmenu-glib-dbusmenu-client">dbusmenu-client</link></primaryie></indexentry> +<indexentry><primaryie linkends="org-ayatana-dbusmenu-get-children-async"><link linkend="org-ayatana-dbusmenu-get-children-async">org_ayatana_dbusmenu_get_children_async</link>, function in <link linkend="libdbusmenu-glib-dbusmenu-client">dbusmenu-client</link></primaryie></indexentry> +<indexentry><primaryie linkends="org-ayatana-dbusmenu-get-children-reply"><link linkend="org-ayatana-dbusmenu-get-children-reply">org_ayatana_dbusmenu_get_children_reply</link>, user_function in <link linkend="libdbusmenu-glib-dbusmenu-client">dbusmenu-client</link></primaryie></indexentry> +<indexentry><primaryie linkends="org-ayatana-dbusmenu-get-group-properties"><link linkend="org-ayatana-dbusmenu-get-group-properties">org_ayatana_dbusmenu_get_group_properties</link>, function in <link linkend="libdbusmenu-glib-dbusmenu-client">dbusmenu-client</link></primaryie></indexentry> +<indexentry><primaryie linkends="org-ayatana-dbusmenu-get-group-properties-async"><link linkend="org-ayatana-dbusmenu-get-group-properties-async">org_ayatana_dbusmenu_get_group_properties_async</link>, function in <link linkend="libdbusmenu-glib-dbusmenu-client">dbusmenu-client</link></primaryie></indexentry> +<indexentry><primaryie linkends="org-ayatana-dbusmenu-get-group-properties-reply"><link linkend="org-ayatana-dbusmenu-get-group-properties-reply">org_ayatana_dbusmenu_get_group_properties_reply</link>, user_function in <link linkend="libdbusmenu-glib-dbusmenu-client">dbusmenu-client</link></primaryie></indexentry> +<indexentry><primaryie linkends="org-ayatana-dbusmenu-get-layout"><link linkend="org-ayatana-dbusmenu-get-layout">org_ayatana_dbusmenu_get_layout</link>, function in <link linkend="libdbusmenu-glib-dbusmenu-client">dbusmenu-client</link></primaryie></indexentry> +<indexentry><primaryie linkends="org-ayatana-dbusmenu-get-layout-async"><link linkend="org-ayatana-dbusmenu-get-layout-async">org_ayatana_dbusmenu_get_layout_async</link>, function in <link linkend="libdbusmenu-glib-dbusmenu-client">dbusmenu-client</link></primaryie></indexentry> +<indexentry><primaryie linkends="org-ayatana-dbusmenu-get-layout-reply"><link linkend="org-ayatana-dbusmenu-get-layout-reply">org_ayatana_dbusmenu_get_layout_reply</link>, user_function in <link linkend="libdbusmenu-glib-dbusmenu-client">dbusmenu-client</link></primaryie></indexentry> +<indexentry><primaryie linkends="org-ayatana-dbusmenu-get-properties"><link linkend="org-ayatana-dbusmenu-get-properties">org_ayatana_dbusmenu_get_properties</link>, function in <link linkend="libdbusmenu-glib-dbusmenu-client">dbusmenu-client</link></primaryie></indexentry> +<indexentry><primaryie linkends="org-ayatana-dbusmenu-get-properties-async"><link linkend="org-ayatana-dbusmenu-get-properties-async">org_ayatana_dbusmenu_get_properties_async</link>, function in <link linkend="libdbusmenu-glib-dbusmenu-client">dbusmenu-client</link></primaryie></indexentry> +<indexentry><primaryie linkends="org-ayatana-dbusmenu-get-properties-reply"><link linkend="org-ayatana-dbusmenu-get-properties-reply">org_ayatana_dbusmenu_get_properties_reply</link>, user_function in <link linkend="libdbusmenu-glib-dbusmenu-client">dbusmenu-client</link></primaryie></indexentry> +<indexentry><primaryie linkends="org-ayatana-dbusmenu-get-property"><link linkend="org-ayatana-dbusmenu-get-property">org_ayatana_dbusmenu_get_property</link>, function in <link linkend="libdbusmenu-glib-dbusmenu-client">dbusmenu-client</link></primaryie></indexentry> +<indexentry><primaryie linkends="org-ayatana-dbusmenu-get-property-async"><link linkend="org-ayatana-dbusmenu-get-property-async">org_ayatana_dbusmenu_get_property_async</link>, function in <link linkend="libdbusmenu-glib-dbusmenu-client">dbusmenu-client</link></primaryie></indexentry> +<indexentry><primaryie linkends="org-ayatana-dbusmenu-get-property-reply"><link linkend="org-ayatana-dbusmenu-get-property-reply">org_ayatana_dbusmenu_get_property_reply</link>, user_function in <link linkend="libdbusmenu-glib-dbusmenu-client">dbusmenu-client</link></primaryie></indexentry> +</indexdiv> +</indexdiv> diff --git a/docs/libdbusmenu-glib/reference/xml/client-menuitem.xml b/docs/libdbusmenu-glib/reference/xml/client-menuitem.xml new file mode 100644 index 0000000..06208c9 --- /dev/null +++ b/docs/libdbusmenu-glib/reference/xml/client-menuitem.xml @@ -0,0 +1,87 @@ +<?xml version="1.0"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" + "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" +[ + <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'"> +]> +<refentry id="DbusmenuClientMenuitem"> +<refmeta> +<refentrytitle role="top_of_page" id="DbusmenuClientMenuitem.top_of_page">DbusmenuClientMenuitem</refentrytitle> +<manvolnum>3</manvolnum> +<refmiscinfo> + LIBDBUSMENU-GLIB Library +</refmiscinfo> +</refmeta> +<refnamediv> +<refname>DbusmenuClientMenuitem</refname> +<refpurpose></refpurpose> +</refnamediv> + +<refsynopsisdiv id="DbusmenuClientMenuitem.synopsis" role="synopsis"> +<title role="synopsis.title">Synopsis</title> + +<synopsis>#define <link linkend="DBUSMENU-CLIENT-MENUITEM-TYPE:CAPS">DBUSMENU_CLIENT_MENUITEM_TYPE</link> + <link linkend="DbusmenuClientMenuitem-struct">DbusmenuClientMenuitem</link>; + <link linkend="DbusmenuClientMenuitemClass">DbusmenuClientMenuitemClass</link>; +<link linkend="DbusmenuClientMenuitem"><returnvalue>DbusmenuClientMenuitem</returnvalue></link> * <link linkend="dbusmenu-client-menuitem-new">dbusmenu_client_menuitem_new</link> (<parameter><link linkend="gint"><type>gint</type></link> id</parameter>, + <parameter><link linkend="DbusmenuClient"><type>DbusmenuClient</type></link> *client</parameter>); +</synopsis> +</refsynopsisdiv> +<refsect1 id="DbusmenuClientMenuitem.object-hierarchy" role="object_hierarchy"> +<title role="object_hierarchy.title">Object Hierarchy</title> +<synopsis> + <link linkend="GObject">GObject</link> + +----<link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link> + +----DbusmenuClientMenuitem +</synopsis> +</refsect1> + +<refsect1 id="DbusmenuClientMenuitem.description" role="desc"> +<title role="desc.title">Description</title> +<para> +</para> +</refsect1> +<refsect1 id="DbusmenuClientMenuitem.details" role="details"> +<title role="details.title">Details</title> +<refsect2 id="DBUSMENU-CLIENT-MENUITEM-TYPE:CAPS" role="macro"> +<title>DBUSMENU_CLIENT_MENUITEM_TYPE</title> +<indexterm zone="DBUSMENU-CLIENT-MENUITEM-TYPE:CAPS"><primary>DBUSMENU_CLIENT_MENUITEM_TYPE</primary></indexterm> +<programlisting>#define DBUSMENU_CLIENT_MENUITEM_TYPE (dbusmenu_client_menuitem_get_type ()) +</programlisting> +<para> +</para></refsect2> +<refsect2 id="DbusmenuClientMenuitem-struct" role="struct"> +<title>DbusmenuClientMenuitem</title> +<indexterm zone="DbusmenuClientMenuitem-struct"><primary>DbusmenuClientMenuitem</primary></indexterm> +<programlisting>typedef struct _DbusmenuClientMenuitem DbusmenuClientMenuitem;</programlisting> +<para> +</para></refsect2> +<refsect2 id="DbusmenuClientMenuitemClass" role="struct"> +<title>DbusmenuClientMenuitemClass</title> +<indexterm zone="DbusmenuClientMenuitemClass"><primary>DbusmenuClientMenuitemClass</primary></indexterm> +<programlisting>typedef struct { + DbusmenuMenuitemClass parent_class; +} DbusmenuClientMenuitemClass; +</programlisting> +<para> +</para></refsect2> +<refsect2 id="dbusmenu-client-menuitem-new" role="function"> +<title>dbusmenu_client_menuitem_new ()</title> +<indexterm zone="dbusmenu-client-menuitem-new"><primary>dbusmenu_client_menuitem_new</primary></indexterm> +<programlisting><link linkend="DbusmenuClientMenuitem"><returnvalue>DbusmenuClientMenuitem</returnvalue></link> * dbusmenu_client_menuitem_new (<parameter><link linkend="gint"><type>gint</type></link> id</parameter>, + <parameter><link linkend="DbusmenuClient"><type>DbusmenuClient</type></link> *client</parameter>);</programlisting> +<para> +</para><variablelist role="params"> +<varlistentry><term><parameter>id</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>client</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> +</simpara></listitem></varlistentry> +</variablelist></refsect2> + +</refsect1> + +</refentry> diff --git a/docs/libdbusmenu-glib/reference/xml/client.xml b/docs/libdbusmenu-glib/reference/xml/client.xml new file mode 100644 index 0000000..a8d62bf --- /dev/null +++ b/docs/libdbusmenu-glib/reference/xml/client.xml @@ -0,0 +1,336 @@ +<?xml version="1.0"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" + "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" +[ + <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'"> +]> +<refentry id="libdbusmenu-glib-DbusmenuClient"> +<refmeta> +<refentrytitle role="top_of_page" id="libdbusmenu-glib-DbusmenuClient.top_of_page">DbusmenuClient</refentrytitle> +<manvolnum>3</manvolnum> +<refmiscinfo> + LIBDBUSMENU-GLIB Library +</refmiscinfo> +</refmeta> +<refnamediv> +<refname>DbusmenuClient</refname> +<refpurpose>The catcher of all the server traffic</refpurpose> +</refnamediv> +<refsect1 id="libdbusmenu-glib-DbusmenuClient.stability-level"> +<title>Stability Level</title> +Unstable, unless otherwise indicated +</refsect1> + +<refsynopsisdiv id="libdbusmenu-glib-DbusmenuClient.synopsis" role="synopsis"> +<title role="synopsis.title">Synopsis</title> + +<synopsis> +#include <libdbusmenu-glib/client.h> + +#define <link linkend="DBUSMENU-CLIENT-SIGNAL-LAYOUT-UPDATED:CAPS">DBUSMENU_CLIENT_SIGNAL_LAYOUT_UPDATED</link> +#define <link linkend="DBUSMENU-CLIENT-SIGNAL-ROOT-CHANGED:CAPS">DBUSMENU_CLIENT_SIGNAL_ROOT_CHANGED</link> +#define <link linkend="DBUSMENU-CLIENT-SIGNAL-NEW-MENUITEM:CAPS">DBUSMENU_CLIENT_SIGNAL_NEW_MENUITEM</link> +#define <link linkend="DBUSMENU-CLIENT-PROP-DBUS-NAME:CAPS">DBUSMENU_CLIENT_PROP_DBUS_NAME</link> +#define <link linkend="DBUSMENU-CLIENT-PROP-DBUS-OBJECT:CAPS">DBUSMENU_CLIENT_PROP_DBUS_OBJECT</link> +#define <link linkend="DBUSMENU-CLIENT-TYPES-DEFAULT:CAPS">DBUSMENU_CLIENT_TYPES_DEFAULT</link> +#define <link linkend="DBUSMENU-CLIENT-TYPES-SEPARATOR:CAPS">DBUSMENU_CLIENT_TYPES_SEPARATOR</link> +#define <link linkend="DBUSMENU-CLIENT-TYPES-IMAGE:CAPS">DBUSMENU_CLIENT_TYPES_IMAGE</link> + <link linkend="DbusmenuClientClass">DbusmenuClientClass</link>; +<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> (<link linkend="DbusmenuClientTypeHandler">*DbusmenuClientTypeHandler</link>) (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *newitem</parameter>, + <parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *parent</parameter>, + <parameter><link linkend="DbusmenuClient"><type>DbusmenuClient</type></link> *client</parameter>); +<link linkend="DbusmenuClient"><returnvalue>DbusmenuClient</returnvalue></link> * <link linkend="dbusmenu-client-new">dbusmenu_client_new</link> (<parameter>const <link linkend="gchar"><type>gchar</type></link> *name</parameter>, + <parameter>const <link linkend="gchar"><type>gchar</type></link> *object</parameter>); +<link linkend="DbusmenuMenuitem"><returnvalue>DbusmenuMenuitem</returnvalue></link> * <link linkend="dbusmenu-client-get-root">dbusmenu_client_get_root</link> (<parameter><link linkend="DbusmenuClient"><type>DbusmenuClient</type></link> *client</parameter>); +<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="dbusmenu-client-add-type-handler">dbusmenu_client_add_type_handler</link> (<parameter><link linkend="DbusmenuClient"><type>DbusmenuClient</type></link> *client</parameter>, + <parameter>const <link linkend="gchar"><type>gchar</type></link> *type</parameter>, + <parameter><link linkend="DbusmenuClientTypeHandler"><type>DbusmenuClientTypeHandler</type></link> newfunc</parameter>); +<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="dbusmenu-client-send-event">dbusmenu_client_send_event</link> (<parameter><link linkend="DbusmenuClient"><type>DbusmenuClient</type></link> *client</parameter>, + <parameter><link linkend="gint"><type>gint</type></link> id</parameter>, + <parameter>const <link linkend="gchar"><type>gchar</type></link> *name</parameter>, + <parameter>const <link linkend="GValue"><type>GValue</type></link> *value</parameter>, + <parameter><link linkend="guint"><type>guint</type></link> timestamp</parameter>); +<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="dbusmenu-client-send-about-to-show">dbusmenu_client_send_about_to_show</link> (<parameter><link linkend="DbusmenuClient"><type>DbusmenuClient</type></link> *client</parameter>, + <parameter><link linkend="gint"><type>gint</type></link> id</parameter>, + <parameter><link linkend="void"><type>void</type></link> (cbgpointer user_data) ()</parameter>, + <parameter><link linkend="gpointer"><type>gpointer</type></link> cb_data</parameter>); +</synopsis> +</refsynopsisdiv> + +<refsect1 id="libdbusmenu-glib-DbusmenuClient.description" role="desc"> +<title role="desc.title">Description</title> +<para> +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. +</para> +<para> + It does this by setting up signal watchers and adjusting + the menuitems appropriately. Most users should watch the + menu items and the signal <link linkend="DbusmenuClient-layout-changed"><type>"layout-changed"</type></link> 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. +</para> +</refsect1> +<refsect1 id="libdbusmenu-glib-DbusmenuClient.details" role="details"> +<title role="details.title">Details</title> +<refsect2 id="DBUSMENU-CLIENT-SIGNAL-LAYOUT-UPDATED:CAPS" role="macro"> +<title>DBUSMENU_CLIENT_SIGNAL_LAYOUT_UPDATED</title> +<indexterm zone="DBUSMENU-CLIENT-SIGNAL-LAYOUT-UPDATED:CAPS"><primary>DBUSMENU_CLIENT_SIGNAL_LAYOUT_UPDATED</primary></indexterm> +<programlisting>#define DBUSMENU_CLIENT_SIGNAL_LAYOUT_UPDATED "layout-updated" +</programlisting> +<para> +</para></refsect2> +<refsect2 id="DBUSMENU-CLIENT-SIGNAL-ROOT-CHANGED:CAPS" role="macro"> +<title>DBUSMENU_CLIENT_SIGNAL_ROOT_CHANGED</title> +<indexterm zone="DBUSMENU-CLIENT-SIGNAL-ROOT-CHANGED:CAPS"><primary>DBUSMENU_CLIENT_SIGNAL_ROOT_CHANGED</primary></indexterm> +<programlisting>#define DBUSMENU_CLIENT_SIGNAL_ROOT_CHANGED "root-changed" +</programlisting> +<para> +</para></refsect2> +<refsect2 id="DBUSMENU-CLIENT-SIGNAL-NEW-MENUITEM:CAPS" role="macro"> +<title>DBUSMENU_CLIENT_SIGNAL_NEW_MENUITEM</title> +<indexterm zone="DBUSMENU-CLIENT-SIGNAL-NEW-MENUITEM:CAPS"><primary>DBUSMENU_CLIENT_SIGNAL_NEW_MENUITEM</primary></indexterm> +<programlisting>#define DBUSMENU_CLIENT_SIGNAL_NEW_MENUITEM "new-menuitem" +</programlisting> +<para> +</para></refsect2> +<refsect2 id="DBUSMENU-CLIENT-PROP-DBUS-NAME:CAPS" role="macro"> +<title>DBUSMENU_CLIENT_PROP_DBUS_NAME</title> +<indexterm zone="DBUSMENU-CLIENT-PROP-DBUS-NAME:CAPS"><primary>DBUSMENU_CLIENT_PROP_DBUS_NAME</primary></indexterm> +<programlisting>#define DBUSMENU_CLIENT_PROP_DBUS_NAME "dbus-name" +</programlisting> +<para> +</para></refsect2> +<refsect2 id="DBUSMENU-CLIENT-PROP-DBUS-OBJECT:CAPS" role="macro"> +<title>DBUSMENU_CLIENT_PROP_DBUS_OBJECT</title> +<indexterm zone="DBUSMENU-CLIENT-PROP-DBUS-OBJECT:CAPS"><primary>DBUSMENU_CLIENT_PROP_DBUS_OBJECT</primary></indexterm> +<programlisting>#define DBUSMENU_CLIENT_PROP_DBUS_OBJECT "dbus-object" +</programlisting> +<para> +</para></refsect2> +<refsect2 id="DBUSMENU-CLIENT-TYPES-DEFAULT:CAPS" role="macro"> +<title>DBUSMENU_CLIENT_TYPES_DEFAULT</title> +<indexterm zone="DBUSMENU-CLIENT-TYPES-DEFAULT:CAPS"><primary>DBUSMENU_CLIENT_TYPES_DEFAULT</primary></indexterm> +<programlisting>#define DBUSMENU_CLIENT_TYPES_DEFAULT "standard" +</programlisting> +<para> +</para></refsect2> +<refsect2 id="DBUSMENU-CLIENT-TYPES-SEPARATOR:CAPS" role="macro"> +<title>DBUSMENU_CLIENT_TYPES_SEPARATOR</title> +<indexterm zone="DBUSMENU-CLIENT-TYPES-SEPARATOR:CAPS"><primary>DBUSMENU_CLIENT_TYPES_SEPARATOR</primary></indexterm> +<programlisting>#define DBUSMENU_CLIENT_TYPES_SEPARATOR "separator" +</programlisting> +<para> +</para></refsect2> +<refsect2 id="DBUSMENU-CLIENT-TYPES-IMAGE:CAPS" role="macro"> +<title>DBUSMENU_CLIENT_TYPES_IMAGE</title> +<indexterm zone="DBUSMENU-CLIENT-TYPES-IMAGE:CAPS"><primary>DBUSMENU_CLIENT_TYPES_IMAGE</primary></indexterm> +<programlisting>#define DBUSMENU_CLIENT_TYPES_IMAGE "standard" +</programlisting> +<para> +</para></refsect2> +<refsect2 id="DbusmenuClientClass" role="struct"> +<title>DbusmenuClientClass</title> +<indexterm zone="DbusmenuClientClass"><primary>DbusmenuClientClass</primary></indexterm> +<programlisting>typedef struct { + GObjectClass parent_class; + + void (*layout_updated)(void); + void (*root_changed) (DbusmenuMenuitem * newroot); + void (*new_menuitem) (DbusmenuMenuitem * newitem); + + /* Reserved for future use */ + void (*reserved1) (void); + void (*reserved2) (void); + void (*reserved3) (void); + void (*reserved4) (void); +} DbusmenuClientClass; +</programlisting> +<para> +A simple class that takes all of the information from a + <link linkend="DbusmenuServer"><type>DbusmenuServer</type></link> over DBus and makes the same set of + <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> objects appear on the other side. +</para><variablelist role="struct"> +<varlistentry><term><link linkend="GObjectClass"><type>GObjectClass</type></link> <structfield id="DbusmenuClientClass.parent-class">parent_class</structfield>;</term> +<listitem><simpara><link linkend="GObjectClass"><type>GObjectClass</type></link> +</simpara></listitem> +</varlistentry> +<varlistentry><term><structfield id="DbusmenuClientClass.layout-updated">layout_updated</structfield> ()</term> +<listitem><simpara>Slot for <link linkend="DbusmenuClient-layout-updated"><type>"layout-updated"</type></link>. +</simpara></listitem> +</varlistentry> +<varlistentry><term><structfield id="DbusmenuClientClass.root-changed">root_changed</structfield> ()</term> +<listitem><simpara> +</simpara></listitem> +</varlistentry> +<varlistentry><term><structfield id="DbusmenuClientClass.new-menuitem">new_menuitem</structfield> ()</term> +<listitem><simpara>Slot for <link linkend="DbusmenuClient-new-menuitem"><type>"new-menuitem"</type></link>. +</simpara></listitem> +</varlistentry> +<varlistentry><term><structfield id="DbusmenuClientClass.reserved1">reserved1</structfield> ()</term> +<listitem><simpara>Reserved for future use. +</simpara></listitem> +</varlistentry> +<varlistentry><term><structfield id="DbusmenuClientClass.reserved2">reserved2</structfield> ()</term> +<listitem><simpara>Reserved for future use. +</simpara></listitem> +</varlistentry> +<varlistentry><term><structfield id="DbusmenuClientClass.reserved3">reserved3</structfield> ()</term> +<listitem><simpara>Reserved for future use. +</simpara></listitem> +</varlistentry> +<varlistentry><term><structfield id="DbusmenuClientClass.reserved4">reserved4</structfield> ()</term> +<listitem><simpara>Reserved for future use. +</simpara></listitem> +</varlistentry> +</variablelist></refsect2> +<refsect2 id="DbusmenuClientTypeHandler" role="function"> +<title>DbusmenuClientTypeHandler ()</title> +<indexterm zone="DbusmenuClientTypeHandler"><primary>DbusmenuClientTypeHandler</primary></indexterm> +<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> (*DbusmenuClientTypeHandler) (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *newitem</parameter>, + <parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *parent</parameter>, + <parameter><link linkend="DbusmenuClient"><type>DbusmenuClient</type></link> *client</parameter>);</programlisting> +<para> +</para><variablelist role="params"> +<varlistentry><term><parameter>newitem</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>parent</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>client</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="dbusmenu-client-new" role="function"> +<title>dbusmenu_client_new ()</title> +<indexterm zone="dbusmenu-client-new"><primary>dbusmenu_client_new</primary></indexterm> +<programlisting><link linkend="DbusmenuClient"><returnvalue>DbusmenuClient</returnvalue></link> * dbusmenu_client_new (<parameter>const <link linkend="gchar"><type>gchar</type></link> *name</parameter>, + <parameter>const <link linkend="gchar"><type>gchar</type></link> *object</parameter>);</programlisting> +<para> +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. +</para><variablelist role="params"> +<varlistentry><term><parameter>name</parameter> :</term> +<listitem><simpara>The DBus name for the server to connect to +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>object</parameter> :</term> +<listitem><simpara>The object on the server to monitor +</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A brand new <link linkend="DbusmenuClient"><type>DbusmenuClient</type></link> +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="dbusmenu-client-get-root" role="function"> +<title>dbusmenu_client_get_root ()</title> +<indexterm zone="dbusmenu-client-get-root"><primary>dbusmenu_client_get_root</primary></indexterm> +<programlisting><link linkend="DbusmenuMenuitem"><returnvalue>DbusmenuMenuitem</returnvalue></link> * dbusmenu_client_get_root (<parameter><link linkend="DbusmenuClient"><type>DbusmenuClient</type></link> *client</parameter>);</programlisting> +<para> +Grabs the root node for the specified client <parameter>client</parameter>. 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. +</para><variablelist role="params"> +<varlistentry><term><parameter>client</parameter> :</term> +<listitem><simpara>The <link linkend="DbusmenuClient"><type>DbusmenuClient</type></link> to get the root node from +</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> representing the root of + menu on the server. If there is no server or there is + an error receiving its layout it'll return <link linkend="NULL:CAPS"><type>NULL</type></link>. +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="dbusmenu-client-add-type-handler" role="function"> +<title>dbusmenu_client_add_type_handler ()</title> +<indexterm zone="dbusmenu-client-add-type-handler"><primary>dbusmenu_client_add_type_handler</primary></indexterm> +<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> dbusmenu_client_add_type_handler (<parameter><link linkend="DbusmenuClient"><type>DbusmenuClient</type></link> *client</parameter>, + <parameter>const <link linkend="gchar"><type>gchar</type></link> *type</parameter>, + <parameter><link linkend="DbusmenuClientTypeHandler"><type>DbusmenuClientTypeHandler</type></link> newfunc</parameter>);</programlisting> +<para> +This function connects into the type handling of the <link linkend="DbusmenuClient"><type>DbusmenuClient</type></link>. + 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 <parameter>newfunc</parameter> function is executed on that + <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link>. If not, then the DbusmenuClient::new-menuitem + signal is sent. +</para> +<para> + In the future the known types will be sent to the server so that it + can make choices about the menu item types availble. +</para><variablelist role="params"> +<varlistentry><term><parameter>client</parameter> :</term> +<listitem><simpara>Client where we're getting types coming in +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>type</parameter> :</term> +<listitem><simpara>A text string that will be matched with the 'type' + property on incoming menu items +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>newfunc</parameter> :</term> +<listitem><simpara>The function that will be executed with those new + items when they come in. +</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> If registering the new type was successful. +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="dbusmenu-client-send-event" role="function"> +<title>dbusmenu_client_send_event ()</title> +<indexterm zone="dbusmenu-client-send-event"><primary>dbusmenu_client_send_event</primary></indexterm> +<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> dbusmenu_client_send_event (<parameter><link linkend="DbusmenuClient"><type>DbusmenuClient</type></link> *client</parameter>, + <parameter><link linkend="gint"><type>gint</type></link> id</parameter>, + <parameter>const <link linkend="gchar"><type>gchar</type></link> *name</parameter>, + <parameter>const <link linkend="GValue"><type>GValue</type></link> *value</parameter>, + <parameter><link linkend="guint"><type>guint</type></link> timestamp</parameter>);</programlisting> +<para> +</para><variablelist role="params"> +<varlistentry><term><parameter>client</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>id</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>name</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>value</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>timestamp</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="dbusmenu-client-send-about-to-show" role="function"> +<title>dbusmenu_client_send_about_to_show ()</title> +<indexterm zone="dbusmenu-client-send-about-to-show"><primary>dbusmenu_client_send_about_to_show</primary></indexterm> +<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> dbusmenu_client_send_about_to_show (<parameter><link linkend="DbusmenuClient"><type>DbusmenuClient</type></link> *client</parameter>, + <parameter><link linkend="gint"><type>gint</type></link> id</parameter>, + <parameter><link linkend="void"><type>void</type></link> (cbgpointer user_data) ()</parameter>, + <parameter><link linkend="gpointer"><type>gpointer</type></link> cb_data</parameter>);</programlisting> +<para> +</para><variablelist role="params"> +<varlistentry><term><parameter>client</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>id</parameter> :</term> +<listitem><simpara> +<parameter>gpointer</parameter> user_data: +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>cb_data</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +</variablelist></refsect2> + +</refsect1> + +</refentry> diff --git a/docs/libdbusmenu-glib/reference/xml/dbusmenu-client.xml b/docs/libdbusmenu-glib/reference/xml/dbusmenu-client.xml new file mode 100644 index 0000000..f7244f7 --- /dev/null +++ b/docs/libdbusmenu-glib/reference/xml/dbusmenu-client.xml @@ -0,0 +1,657 @@ +<?xml version="1.0"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" + "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" +[ + <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'"> +]> +<refentry id="libdbusmenu-glib-dbusmenu-client"> +<refmeta> +<refentrytitle role="top_of_page" id="libdbusmenu-glib-dbusmenu-client.top_of_page">dbusmenu-client</refentrytitle> +<manvolnum>3</manvolnum> +<refmiscinfo> + LIBDBUSMENU-GLIB Library +</refmiscinfo> +</refmeta> +<refnamediv> +<refname>dbusmenu-client</refname> +<refpurpose></refpurpose> +</refnamediv> + +<refsynopsisdiv id="libdbusmenu-glib-dbusmenu-client.synopsis" role="synopsis"> +<title role="synopsis.title">Synopsis</title> + +<synopsis>#define <link linkend="DBUS-GLIB-CLIENT-WRAPPERS-org-ayatana-dbusmenu">DBUS_GLIB_CLIENT_WRAPPERS_org_ayatana_dbusmenu</link> +<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="org-ayatana-dbusmenu-get-layout">org_ayatana_dbusmenu_get_layout</link> (<parameter><link linkend="DBusGProxy"><type>DBusGProxy</type></link> *proxy</parameter>, + <parameter>const <link linkend="gint"><type>gint</type></link> IN_parentId</parameter>, + <parameter><link linkend="guint"><type>guint</type></link> *OUT_revision</parameter>, + <parameter><link linkend="char"><type>char</type></link> **OUT_layout</parameter>); +<link linkend="void"><returnvalue>void</returnvalue></link> (<link linkend="org-ayatana-dbusmenu-get-layout-reply">*org_ayatana_dbusmenu_get_layout_reply</link>) + (<parameter><link linkend="DBusGProxy"><type>DBusGProxy</type></link> *proxy</parameter>, + <parameter><link linkend="guint"><type>guint</type></link> OUT_revision</parameter>, + <parameter><link linkend="char"><type>char</type></link> *OUT_layout</parameter>, + <parameter><link linkend="GError"><type>GError</type></link> *error</parameter>, + <parameter><link linkend="gpointer"><type>gpointer</type></link> userdata</parameter>); +<link linkend="DBusGProxyCall"><returnvalue>DBusGProxyCall</returnvalue></link> * <link linkend="org-ayatana-dbusmenu-get-layout-async">org_ayatana_dbusmenu_get_layout_async</link> + (<parameter><link linkend="DBusGProxy"><type>DBusGProxy</type></link> *proxy</parameter>, + <parameter>const <link linkend="gint"><type>gint</type></link> IN_parentId</parameter>, + <parameter><link linkend="org-ayatana-dbusmenu-get-layout-reply"><type>org_ayatana_dbusmenu_get_layout_reply</type></link> callback</parameter>); +<link linkend="return"><returnvalue>return</returnvalue></link> <link linkend="dbus-g-proxy-begin-call">dbus_g_proxy_begin_call</link> (<parameter><link linkend="proxy"><type>proxy</type></link> Param1</parameter>); +<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="org-ayatana-dbusmenu-get-group-properties">org_ayatana_dbusmenu_get_group_properties</link> + (<parameter><link linkend="DBusGProxy"><type>DBusGProxy</type></link> *proxy</parameter>, + <parameter>const <link linkend="GArray"><type>GArray</type></link> *IN_ids</parameter>, + <parameter>const <link linkend="char"><type>char</type></link> **IN_propertyNames</parameter>, + <parameter><link linkend="GPtrArray"><type>GPtrArray</type></link> **OUT_properties</parameter>); +<link linkend="void"><returnvalue>void</returnvalue></link> (<link linkend="org-ayatana-dbusmenu-get-group-properties-reply">*org_ayatana_dbusmenu_get_group_properties_reply</link>) + (<parameter><link linkend="DBusGProxy"><type>DBusGProxy</type></link> *proxy</parameter>, + <parameter><link linkend="GPtrArray"><type>GPtrArray</type></link> *OUT_properties</parameter>, + <parameter><link linkend="GError"><type>GError</type></link> *error</parameter>, + <parameter><link linkend="gpointer"><type>gpointer</type></link> userdata</parameter>); +<link linkend="DBusGProxyCall"><returnvalue>DBusGProxyCall</returnvalue></link> * <link linkend="org-ayatana-dbusmenu-get-group-properties-async">org_ayatana_dbusmenu_get_group_properties_async</link> + (<parameter><link linkend="DBusGProxy"><type>DBusGProxy</type></link> *proxy</parameter>, + <parameter>const <link linkend="GArray"><type>GArray</type></link> *IN_ids</parameter>, + <parameter>const <link linkend="char"><type>char</type></link> **IN_propertyNames</parameter>, + <parameter><link linkend="org-ayatana-dbusmenu-get-group-properties-reply"><type>org_ayatana_dbusmenu_get_group_properties_reply</type></link> callback</parameter>); +<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="org-ayatana-dbusmenu-get-children">org_ayatana_dbusmenu_get_children</link> (<parameter><link linkend="DBusGProxy"><type>DBusGProxy</type></link> *proxy</parameter>, + <parameter>const <link linkend="gint"><type>gint</type></link> IN_id</parameter>, + <parameter>const <link linkend="char"><type>char</type></link> **IN_propertyNames</parameter>, + <parameter><link linkend="GPtrArray"><type>GPtrArray</type></link> **OUT_properties</parameter>); +<link linkend="void"><returnvalue>void</returnvalue></link> (<link linkend="org-ayatana-dbusmenu-get-children-reply">*org_ayatana_dbusmenu_get_children_reply</link>) + (<parameter><link linkend="DBusGProxy"><type>DBusGProxy</type></link> *proxy</parameter>, + <parameter><link linkend="GPtrArray"><type>GPtrArray</type></link> *OUT_properties</parameter>, + <parameter><link linkend="GError"><type>GError</type></link> *error</parameter>, + <parameter><link linkend="gpointer"><type>gpointer</type></link> userdata</parameter>); +<link linkend="DBusGProxyCall"><returnvalue>DBusGProxyCall</returnvalue></link> * <link linkend="org-ayatana-dbusmenu-get-children-async">org_ayatana_dbusmenu_get_children_async</link> + (<parameter><link linkend="DBusGProxy"><type>DBusGProxy</type></link> *proxy</parameter>, + <parameter>const <link linkend="gint"><type>gint</type></link> IN_id</parameter>, + <parameter>const <link linkend="char"><type>char</type></link> **IN_propertyNames</parameter>, + <parameter><link linkend="org-ayatana-dbusmenu-get-children-reply"><type>org_ayatana_dbusmenu_get_children_reply</type></link> callback</parameter>); +<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="org-ayatana-dbusmenu-get-property">org_ayatana_dbusmenu_get_property</link> (<parameter><link linkend="DBusGProxy"><type>DBusGProxy</type></link> *proxy</parameter>, + <parameter>const <link linkend="gint"><type>gint</type></link> IN_id</parameter>, + <parameter>const <link linkend="char"><type>char</type></link> *IN_name</parameter>, + <parameter><link linkend="GValue"><type>GValue</type></link> *OUT_value</parameter>); +<link linkend="void"><returnvalue>void</returnvalue></link> (<link linkend="org-ayatana-dbusmenu-get-property-reply">*org_ayatana_dbusmenu_get_property_reply</link>) + (<parameter><link linkend="DBusGProxy"><type>DBusGProxy</type></link> *proxy</parameter>, + <parameter><link linkend="GValue"><type>GValue</type></link> OUT_value</parameter>, + <parameter><link linkend="GError"><type>GError</type></link> *error</parameter>, + <parameter><link linkend="gpointer"><type>gpointer</type></link> userdata</parameter>); +<link linkend="DBusGProxyCall"><returnvalue>DBusGProxyCall</returnvalue></link> * <link linkend="org-ayatana-dbusmenu-get-property-async">org_ayatana_dbusmenu_get_property_async</link> + (<parameter><link linkend="DBusGProxy"><type>DBusGProxy</type></link> *proxy</parameter>, + <parameter>const <link linkend="gint"><type>gint</type></link> IN_id</parameter>, + <parameter>const <link linkend="char"><type>char</type></link> *IN_name</parameter>, + <parameter><link linkend="org-ayatana-dbusmenu-get-property-reply"><type>org_ayatana_dbusmenu_get_property_reply</type></link> callback</parameter>); +<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="org-ayatana-dbusmenu-get-properties">org_ayatana_dbusmenu_get_properties</link> (<parameter><link linkend="DBusGProxy"><type>DBusGProxy</type></link> *proxy</parameter>, + <parameter>const <link linkend="gint"><type>gint</type></link> IN_id</parameter>, + <parameter>const <link linkend="char"><type>char</type></link> **IN_propertyNames</parameter>, + <parameter><link linkend="GHashTable"><type>GHashTable</type></link> **OUT_properties</parameter>); +<link linkend="void"><returnvalue>void</returnvalue></link> (<link linkend="org-ayatana-dbusmenu-get-properties-reply">*org_ayatana_dbusmenu_get_properties_reply</link>) + (<parameter><link linkend="DBusGProxy"><type>DBusGProxy</type></link> *proxy</parameter>, + <parameter><link linkend="GHashTable"><type>GHashTable</type></link> *OUT_properties</parameter>, + <parameter><link linkend="GError"><type>GError</type></link> *error</parameter>, + <parameter><link linkend="gpointer"><type>gpointer</type></link> userdata</parameter>); +<link linkend="DBusGProxyCall"><returnvalue>DBusGProxyCall</returnvalue></link> * <link linkend="org-ayatana-dbusmenu-get-properties-async">org_ayatana_dbusmenu_get_properties_async</link> + (<parameter><link linkend="DBusGProxy"><type>DBusGProxy</type></link> *proxy</parameter>, + <parameter>const <link linkend="gint"><type>gint</type></link> IN_id</parameter>, + <parameter>const <link linkend="char"><type>char</type></link> **IN_propertyNames</parameter>, + <parameter><link linkend="org-ayatana-dbusmenu-get-properties-reply"><type>org_ayatana_dbusmenu_get_properties_reply</type></link> callback</parameter>); +<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="org-ayatana-dbusmenu-event">org_ayatana_dbusmenu_event</link> (<parameter><link linkend="DBusGProxy"><type>DBusGProxy</type></link> *proxy</parameter>, + <parameter>const <link linkend="gint"><type>gint</type></link> IN_id</parameter>, + <parameter>const <link linkend="char"><type>char</type></link> *IN_eventId</parameter>, + <parameter>const <link linkend="GValue"><type>GValue</type></link> *IN_data</parameter>, + <parameter>const <link linkend="guint"><type>guint</type></link> IN_timestamp</parameter>); +<link linkend="void"><returnvalue>void</returnvalue></link> (<link linkend="org-ayatana-dbusmenu-event-reply">*org_ayatana_dbusmenu_event_reply</link>) (<parameter><link linkend="DBusGProxy"><type>DBusGProxy</type></link> *proxy</parameter>, + <parameter><link linkend="GError"><type>GError</type></link> *error</parameter>, + <parameter><link linkend="gpointer"><type>gpointer</type></link> userdata</parameter>); +<link linkend="DBusGProxyCall"><returnvalue>DBusGProxyCall</returnvalue></link> * <link linkend="org-ayatana-dbusmenu-event-async">org_ayatana_dbusmenu_event_async</link> (<parameter><link linkend="DBusGProxy"><type>DBusGProxy</type></link> *proxy</parameter>, + <parameter>const <link linkend="gint"><type>gint</type></link> IN_id</parameter>, + <parameter>const <link linkend="char"><type>char</type></link> *IN_eventId</parameter>, + <parameter>const <link linkend="GValue"><type>GValue</type></link> *IN_data</parameter>, + <parameter>const <link linkend="guint"><type>guint</type></link> IN_timestamp</parameter>, + <parameter><link linkend="org-ayatana-dbusmenu-event-reply"><type>org_ayatana_dbusmenu_event_reply</type></link> callback</parameter>); +<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="org-ayatana-dbusmenu-about-to-show">org_ayatana_dbusmenu_about_to_show</link> (<parameter><link linkend="DBusGProxy"><type>DBusGProxy</type></link> *proxy</parameter>, + <parameter>const <link linkend="gint"><type>gint</type></link> IN_id</parameter>, + <parameter><link linkend="gboolean"><type>gboolean</type></link> *OUT_needUpdate</parameter>); +<link linkend="void"><returnvalue>void</returnvalue></link> (<link linkend="org-ayatana-dbusmenu-about-to-show-reply">*org_ayatana_dbusmenu_about_to_show_reply</link>) + (<parameter><link linkend="DBusGProxy"><type>DBusGProxy</type></link> *proxy</parameter>, + <parameter><link linkend="gboolean"><type>gboolean</type></link> OUT_needUpdate</parameter>, + <parameter><link linkend="GError"><type>GError</type></link> *error</parameter>, + <parameter><link linkend="gpointer"><type>gpointer</type></link> userdata</parameter>); +<link linkend="DBusGProxyCall"><returnvalue>DBusGProxyCall</returnvalue></link> * <link linkend="org-ayatana-dbusmenu-about-to-show-async">org_ayatana_dbusmenu_about_to_show_async</link> + (<parameter><link linkend="DBusGProxy"><type>DBusGProxy</type></link> *proxy</parameter>, + <parameter>const <link linkend="gint"><type>gint</type></link> IN_id</parameter>, + <parameter><link linkend="org-ayatana-dbusmenu-about-to-show-reply"><type>org_ayatana_dbusmenu_about_to_show_reply</type></link> callback</parameter>); +</synopsis> +</refsynopsisdiv> + +<refsect1 id="libdbusmenu-glib-dbusmenu-client.description" role="desc"> +<title role="desc.title">Description</title> +<para> +</para> +</refsect1> +<refsect1 id="libdbusmenu-glib-dbusmenu-client.details" role="details"> +<title role="details.title">Details</title> +<refsect2 id="DBUS-GLIB-CLIENT-WRAPPERS-org-ayatana-dbusmenu" role="macro"> +<title>DBUS_GLIB_CLIENT_WRAPPERS_org_ayatana_dbusmenu</title> +<indexterm zone="DBUS-GLIB-CLIENT-WRAPPERS-org-ayatana-dbusmenu"><primary>DBUS_GLIB_CLIENT_WRAPPERS_org_ayatana_dbusmenu</primary></indexterm> +<programlisting>#define DBUS_GLIB_CLIENT_WRAPPERS_org_ayatana_dbusmenu +</programlisting> +<para> +</para></refsect2> +<refsect2 id="org-ayatana-dbusmenu-get-layout" role="function"> +<title>org_ayatana_dbusmenu_get_layout ()</title> +<indexterm zone="org-ayatana-dbusmenu-get-layout"><primary>org_ayatana_dbusmenu_get_layout</primary></indexterm> +<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> org_ayatana_dbusmenu_get_layout (<parameter><link linkend="DBusGProxy"><type>DBusGProxy</type></link> *proxy</parameter>, + <parameter>const <link linkend="gint"><type>gint</type></link> IN_parentId</parameter>, + <parameter><link linkend="guint"><type>guint</type></link> *OUT_revision</parameter>, + <parameter><link linkend="char"><type>char</type></link> **OUT_layout</parameter>);</programlisting> +<para> +</para><variablelist role="params"> +<varlistentry><term><parameter>proxy</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>IN_parentId</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>OUT_revision</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>OUT_layout</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="org-ayatana-dbusmenu-get-layout-reply" role="function"> +<title>org_ayatana_dbusmenu_get_layout_reply ()</title> +<indexterm zone="org-ayatana-dbusmenu-get-layout-reply"><primary>org_ayatana_dbusmenu_get_layout_reply</primary></indexterm> +<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> (*org_ayatana_dbusmenu_get_layout_reply) + (<parameter><link linkend="DBusGProxy"><type>DBusGProxy</type></link> *proxy</parameter>, + <parameter><link linkend="guint"><type>guint</type></link> OUT_revision</parameter>, + <parameter><link linkend="char"><type>char</type></link> *OUT_layout</parameter>, + <parameter><link linkend="GError"><type>GError</type></link> *error</parameter>, + <parameter><link linkend="gpointer"><type>gpointer</type></link> userdata</parameter>);</programlisting> +<para> +</para><variablelist role="params"> +<varlistentry><term><parameter>proxy</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>OUT_revision</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>OUT_layout</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>error</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>userdata</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="org-ayatana-dbusmenu-get-layout-async" role="function"> +<title>org_ayatana_dbusmenu_get_layout_async ()</title> +<indexterm zone="org-ayatana-dbusmenu-get-layout-async"><primary>org_ayatana_dbusmenu_get_layout_async</primary></indexterm> +<programlisting><link linkend="DBusGProxyCall"><returnvalue>DBusGProxyCall</returnvalue></link> * org_ayatana_dbusmenu_get_layout_async + (<parameter><link linkend="DBusGProxy"><type>DBusGProxy</type></link> *proxy</parameter>, + <parameter>const <link linkend="gint"><type>gint</type></link> IN_parentId</parameter>, + <parameter><link linkend="org-ayatana-dbusmenu-get-layout-reply"><type>org_ayatana_dbusmenu_get_layout_reply</type></link> callback</parameter>);</programlisting> +<para> +</para><variablelist role="params"> +<varlistentry><term><parameter>proxy</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>IN_parentId</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>callback</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="dbus-g-proxy-begin-call" role="function"> +<title>dbus_g_proxy_begin_call ()</title> +<indexterm zone="dbus-g-proxy-begin-call"><primary>dbus_g_proxy_begin_call</primary></indexterm> +<programlisting><link linkend="return"><returnvalue>return</returnvalue></link> dbus_g_proxy_begin_call (<parameter><link linkend="proxy"><type>proxy</type></link> Param1</parameter>);</programlisting> +<para> +</para><variablelist role="params"> +<varlistentry><term><parameter>Param1</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="org-ayatana-dbusmenu-get-group-properties" role="function"> +<title>org_ayatana_dbusmenu_get_group_properties ()</title> +<indexterm zone="org-ayatana-dbusmenu-get-group-properties"><primary>org_ayatana_dbusmenu_get_group_properties</primary></indexterm> +<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> org_ayatana_dbusmenu_get_group_properties + (<parameter><link linkend="DBusGProxy"><type>DBusGProxy</type></link> *proxy</parameter>, + <parameter>const <link linkend="GArray"><type>GArray</type></link> *IN_ids</parameter>, + <parameter>const <link linkend="char"><type>char</type></link> **IN_propertyNames</parameter>, + <parameter><link linkend="GPtrArray"><type>GPtrArray</type></link> **OUT_properties</parameter>);</programlisting> +<para> +</para><variablelist role="params"> +<varlistentry><term><parameter>proxy</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>IN_ids</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>IN_propertyNames</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>OUT_properties</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="org-ayatana-dbusmenu-get-group-properties-reply" role="function"> +<title>org_ayatana_dbusmenu_get_group_properties_reply ()</title> +<indexterm zone="org-ayatana-dbusmenu-get-group-properties-reply"><primary>org_ayatana_dbusmenu_get_group_properties_reply</primary></indexterm> +<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> (*org_ayatana_dbusmenu_get_group_properties_reply) + (<parameter><link linkend="DBusGProxy"><type>DBusGProxy</type></link> *proxy</parameter>, + <parameter><link linkend="GPtrArray"><type>GPtrArray</type></link> *OUT_properties</parameter>, + <parameter><link linkend="GError"><type>GError</type></link> *error</parameter>, + <parameter><link linkend="gpointer"><type>gpointer</type></link> userdata</parameter>);</programlisting> +<para> +</para><variablelist role="params"> +<varlistentry><term><parameter>proxy</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>OUT_properties</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>error</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>userdata</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="org-ayatana-dbusmenu-get-group-properties-async" role="function"> +<title>org_ayatana_dbusmenu_get_group_properties_async ()</title> +<indexterm zone="org-ayatana-dbusmenu-get-group-properties-async"><primary>org_ayatana_dbusmenu_get_group_properties_async</primary></indexterm> +<programlisting><link linkend="DBusGProxyCall"><returnvalue>DBusGProxyCall</returnvalue></link> * org_ayatana_dbusmenu_get_group_properties_async + (<parameter><link linkend="DBusGProxy"><type>DBusGProxy</type></link> *proxy</parameter>, + <parameter>const <link linkend="GArray"><type>GArray</type></link> *IN_ids</parameter>, + <parameter>const <link linkend="char"><type>char</type></link> **IN_propertyNames</parameter>, + <parameter><link linkend="org-ayatana-dbusmenu-get-group-properties-reply"><type>org_ayatana_dbusmenu_get_group_properties_reply</type></link> callback</parameter>);</programlisting> +<para> +</para><variablelist role="params"> +<varlistentry><term><parameter>proxy</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>IN_ids</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>IN_propertyNames</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>callback</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="org-ayatana-dbusmenu-get-children" role="function"> +<title>org_ayatana_dbusmenu_get_children ()</title> +<indexterm zone="org-ayatana-dbusmenu-get-children"><primary>org_ayatana_dbusmenu_get_children</primary></indexterm> +<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> org_ayatana_dbusmenu_get_children (<parameter><link linkend="DBusGProxy"><type>DBusGProxy</type></link> *proxy</parameter>, + <parameter>const <link linkend="gint"><type>gint</type></link> IN_id</parameter>, + <parameter>const <link linkend="char"><type>char</type></link> **IN_propertyNames</parameter>, + <parameter><link linkend="GPtrArray"><type>GPtrArray</type></link> **OUT_properties</parameter>);</programlisting> +<para> +</para><variablelist role="params"> +<varlistentry><term><parameter>proxy</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>IN_id</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>IN_propertyNames</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>OUT_properties</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="org-ayatana-dbusmenu-get-children-reply" role="function"> +<title>org_ayatana_dbusmenu_get_children_reply ()</title> +<indexterm zone="org-ayatana-dbusmenu-get-children-reply"><primary>org_ayatana_dbusmenu_get_children_reply</primary></indexterm> +<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> (*org_ayatana_dbusmenu_get_children_reply) + (<parameter><link linkend="DBusGProxy"><type>DBusGProxy</type></link> *proxy</parameter>, + <parameter><link linkend="GPtrArray"><type>GPtrArray</type></link> *OUT_properties</parameter>, + <parameter><link linkend="GError"><type>GError</type></link> *error</parameter>, + <parameter><link linkend="gpointer"><type>gpointer</type></link> userdata</parameter>);</programlisting> +<para> +</para><variablelist role="params"> +<varlistentry><term><parameter>proxy</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>OUT_properties</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>error</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>userdata</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="org-ayatana-dbusmenu-get-children-async" role="function"> +<title>org_ayatana_dbusmenu_get_children_async ()</title> +<indexterm zone="org-ayatana-dbusmenu-get-children-async"><primary>org_ayatana_dbusmenu_get_children_async</primary></indexterm> +<programlisting><link linkend="DBusGProxyCall"><returnvalue>DBusGProxyCall</returnvalue></link> * org_ayatana_dbusmenu_get_children_async + (<parameter><link linkend="DBusGProxy"><type>DBusGProxy</type></link> *proxy</parameter>, + <parameter>const <link linkend="gint"><type>gint</type></link> IN_id</parameter>, + <parameter>const <link linkend="char"><type>char</type></link> **IN_propertyNames</parameter>, + <parameter><link linkend="org-ayatana-dbusmenu-get-children-reply"><type>org_ayatana_dbusmenu_get_children_reply</type></link> callback</parameter>);</programlisting> +<para> +</para><variablelist role="params"> +<varlistentry><term><parameter>proxy</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>IN_id</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>IN_propertyNames</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>callback</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="org-ayatana-dbusmenu-get-property" role="function"> +<title>org_ayatana_dbusmenu_get_property ()</title> +<indexterm zone="org-ayatana-dbusmenu-get-property"><primary>org_ayatana_dbusmenu_get_property</primary></indexterm> +<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> org_ayatana_dbusmenu_get_property (<parameter><link linkend="DBusGProxy"><type>DBusGProxy</type></link> *proxy</parameter>, + <parameter>const <link linkend="gint"><type>gint</type></link> IN_id</parameter>, + <parameter>const <link linkend="char"><type>char</type></link> *IN_name</parameter>, + <parameter><link linkend="GValue"><type>GValue</type></link> *OUT_value</parameter>);</programlisting> +<para> +</para><variablelist role="params"> +<varlistentry><term><parameter>proxy</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>IN_id</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>IN_name</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>OUT_value</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="org-ayatana-dbusmenu-get-property-reply" role="function"> +<title>org_ayatana_dbusmenu_get_property_reply ()</title> +<indexterm zone="org-ayatana-dbusmenu-get-property-reply"><primary>org_ayatana_dbusmenu_get_property_reply</primary></indexterm> +<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> (*org_ayatana_dbusmenu_get_property_reply) + (<parameter><link linkend="DBusGProxy"><type>DBusGProxy</type></link> *proxy</parameter>, + <parameter><link linkend="GValue"><type>GValue</type></link> OUT_value</parameter>, + <parameter><link linkend="GError"><type>GError</type></link> *error</parameter>, + <parameter><link linkend="gpointer"><type>gpointer</type></link> userdata</parameter>);</programlisting> +<para> +</para><variablelist role="params"> +<varlistentry><term><parameter>proxy</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>OUT_value</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>error</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>userdata</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="org-ayatana-dbusmenu-get-property-async" role="function"> +<title>org_ayatana_dbusmenu_get_property_async ()</title> +<indexterm zone="org-ayatana-dbusmenu-get-property-async"><primary>org_ayatana_dbusmenu_get_property_async</primary></indexterm> +<programlisting><link linkend="DBusGProxyCall"><returnvalue>DBusGProxyCall</returnvalue></link> * org_ayatana_dbusmenu_get_property_async + (<parameter><link linkend="DBusGProxy"><type>DBusGProxy</type></link> *proxy</parameter>, + <parameter>const <link linkend="gint"><type>gint</type></link> IN_id</parameter>, + <parameter>const <link linkend="char"><type>char</type></link> *IN_name</parameter>, + <parameter><link linkend="org-ayatana-dbusmenu-get-property-reply"><type>org_ayatana_dbusmenu_get_property_reply</type></link> callback</parameter>);</programlisting> +<para> +</para><variablelist role="params"> +<varlistentry><term><parameter>proxy</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>IN_id</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>IN_name</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>callback</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="org-ayatana-dbusmenu-get-properties" role="function"> +<title>org_ayatana_dbusmenu_get_properties ()</title> +<indexterm zone="org-ayatana-dbusmenu-get-properties"><primary>org_ayatana_dbusmenu_get_properties</primary></indexterm> +<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> org_ayatana_dbusmenu_get_properties (<parameter><link linkend="DBusGProxy"><type>DBusGProxy</type></link> *proxy</parameter>, + <parameter>const <link linkend="gint"><type>gint</type></link> IN_id</parameter>, + <parameter>const <link linkend="char"><type>char</type></link> **IN_propertyNames</parameter>, + <parameter><link linkend="GHashTable"><type>GHashTable</type></link> **OUT_properties</parameter>);</programlisting> +<para> +</para><variablelist role="params"> +<varlistentry><term><parameter>proxy</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>IN_id</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>IN_propertyNames</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>OUT_properties</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="org-ayatana-dbusmenu-get-properties-reply" role="function"> +<title>org_ayatana_dbusmenu_get_properties_reply ()</title> +<indexterm zone="org-ayatana-dbusmenu-get-properties-reply"><primary>org_ayatana_dbusmenu_get_properties_reply</primary></indexterm> +<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> (*org_ayatana_dbusmenu_get_properties_reply) + (<parameter><link linkend="DBusGProxy"><type>DBusGProxy</type></link> *proxy</parameter>, + <parameter><link linkend="GHashTable"><type>GHashTable</type></link> *OUT_properties</parameter>, + <parameter><link linkend="GError"><type>GError</type></link> *error</parameter>, + <parameter><link linkend="gpointer"><type>gpointer</type></link> userdata</parameter>);</programlisting> +<para> +</para><variablelist role="params"> +<varlistentry><term><parameter>proxy</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>OUT_properties</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>error</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>userdata</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="org-ayatana-dbusmenu-get-properties-async" role="function"> +<title>org_ayatana_dbusmenu_get_properties_async ()</title> +<indexterm zone="org-ayatana-dbusmenu-get-properties-async"><primary>org_ayatana_dbusmenu_get_properties_async</primary></indexterm> +<programlisting><link linkend="DBusGProxyCall"><returnvalue>DBusGProxyCall</returnvalue></link> * org_ayatana_dbusmenu_get_properties_async + (<parameter><link linkend="DBusGProxy"><type>DBusGProxy</type></link> *proxy</parameter>, + <parameter>const <link linkend="gint"><type>gint</type></link> IN_id</parameter>, + <parameter>const <link linkend="char"><type>char</type></link> **IN_propertyNames</parameter>, + <parameter><link linkend="org-ayatana-dbusmenu-get-properties-reply"><type>org_ayatana_dbusmenu_get_properties_reply</type></link> callback</parameter>);</programlisting> +<para> +</para><variablelist role="params"> +<varlistentry><term><parameter>proxy</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>IN_id</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>IN_propertyNames</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>callback</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="org-ayatana-dbusmenu-event" role="function"> +<title>org_ayatana_dbusmenu_event ()</title> +<indexterm zone="org-ayatana-dbusmenu-event"><primary>org_ayatana_dbusmenu_event</primary></indexterm> +<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> org_ayatana_dbusmenu_event (<parameter><link linkend="DBusGProxy"><type>DBusGProxy</type></link> *proxy</parameter>, + <parameter>const <link linkend="gint"><type>gint</type></link> IN_id</parameter>, + <parameter>const <link linkend="char"><type>char</type></link> *IN_eventId</parameter>, + <parameter>const <link linkend="GValue"><type>GValue</type></link> *IN_data</parameter>, + <parameter>const <link linkend="guint"><type>guint</type></link> IN_timestamp</parameter>);</programlisting> +<para> +</para><variablelist role="params"> +<varlistentry><term><parameter>proxy</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>IN_id</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>IN_eventId</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>IN_data</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>IN_timestamp</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="org-ayatana-dbusmenu-event-reply" role="function"> +<title>org_ayatana_dbusmenu_event_reply ()</title> +<indexterm zone="org-ayatana-dbusmenu-event-reply"><primary>org_ayatana_dbusmenu_event_reply</primary></indexterm> +<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> (*org_ayatana_dbusmenu_event_reply) (<parameter><link linkend="DBusGProxy"><type>DBusGProxy</type></link> *proxy</parameter>, + <parameter><link linkend="GError"><type>GError</type></link> *error</parameter>, + <parameter><link linkend="gpointer"><type>gpointer</type></link> userdata</parameter>);</programlisting> +<para> +</para><variablelist role="params"> +<varlistentry><term><parameter>proxy</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>error</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>userdata</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="org-ayatana-dbusmenu-event-async" role="function"> +<title>org_ayatana_dbusmenu_event_async ()</title> +<indexterm zone="org-ayatana-dbusmenu-event-async"><primary>org_ayatana_dbusmenu_event_async</primary></indexterm> +<programlisting><link linkend="DBusGProxyCall"><returnvalue>DBusGProxyCall</returnvalue></link> * org_ayatana_dbusmenu_event_async (<parameter><link linkend="DBusGProxy"><type>DBusGProxy</type></link> *proxy</parameter>, + <parameter>const <link linkend="gint"><type>gint</type></link> IN_id</parameter>, + <parameter>const <link linkend="char"><type>char</type></link> *IN_eventId</parameter>, + <parameter>const <link linkend="GValue"><type>GValue</type></link> *IN_data</parameter>, + <parameter>const <link linkend="guint"><type>guint</type></link> IN_timestamp</parameter>, + <parameter><link linkend="org-ayatana-dbusmenu-event-reply"><type>org_ayatana_dbusmenu_event_reply</type></link> callback</parameter>);</programlisting> +<para> +</para><variablelist role="params"> +<varlistentry><term><parameter>proxy</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>IN_id</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>IN_eventId</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>IN_data</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>IN_timestamp</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>callback</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="org-ayatana-dbusmenu-about-to-show" role="function"> +<title>org_ayatana_dbusmenu_about_to_show ()</title> +<indexterm zone="org-ayatana-dbusmenu-about-to-show"><primary>org_ayatana_dbusmenu_about_to_show</primary></indexterm> +<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> org_ayatana_dbusmenu_about_to_show (<parameter><link linkend="DBusGProxy"><type>DBusGProxy</type></link> *proxy</parameter>, + <parameter>const <link linkend="gint"><type>gint</type></link> IN_id</parameter>, + <parameter><link linkend="gboolean"><type>gboolean</type></link> *OUT_needUpdate</parameter>);</programlisting> +<para> +</para><variablelist role="params"> +<varlistentry><term><parameter>proxy</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>IN_id</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>OUT_needUpdate</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="org-ayatana-dbusmenu-about-to-show-reply" role="function"> +<title>org_ayatana_dbusmenu_about_to_show_reply ()</title> +<indexterm zone="org-ayatana-dbusmenu-about-to-show-reply"><primary>org_ayatana_dbusmenu_about_to_show_reply</primary></indexterm> +<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> (*org_ayatana_dbusmenu_about_to_show_reply) + (<parameter><link linkend="DBusGProxy"><type>DBusGProxy</type></link> *proxy</parameter>, + <parameter><link linkend="gboolean"><type>gboolean</type></link> OUT_needUpdate</parameter>, + <parameter><link linkend="GError"><type>GError</type></link> *error</parameter>, + <parameter><link linkend="gpointer"><type>gpointer</type></link> userdata</parameter>);</programlisting> +<para> +</para><variablelist role="params"> +<varlistentry><term><parameter>proxy</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>OUT_needUpdate</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>error</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>userdata</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="org-ayatana-dbusmenu-about-to-show-async" role="function"> +<title>org_ayatana_dbusmenu_about_to_show_async ()</title> +<indexterm zone="org-ayatana-dbusmenu-about-to-show-async"><primary>org_ayatana_dbusmenu_about_to_show_async</primary></indexterm> +<programlisting><link linkend="DBusGProxyCall"><returnvalue>DBusGProxyCall</returnvalue></link> * org_ayatana_dbusmenu_about_to_show_async + (<parameter><link linkend="DBusGProxy"><type>DBusGProxy</type></link> *proxy</parameter>, + <parameter>const <link linkend="gint"><type>gint</type></link> IN_id</parameter>, + <parameter><link linkend="org-ayatana-dbusmenu-about-to-show-reply"><type>org_ayatana_dbusmenu_about_to_show_reply</type></link> callback</parameter>);</programlisting> +<para> +</para><variablelist role="params"> +<varlistentry><term><parameter>proxy</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>IN_id</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>callback</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> +</simpara></listitem></varlistentry> +</variablelist></refsect2> + +</refsect1> + +</refentry> diff --git a/docs/libdbusmenu-glib/reference/xml/dbusmenu-server.xml b/docs/libdbusmenu-glib/reference/xml/dbusmenu-server.xml new file mode 100644 index 0000000..836e1d6 --- /dev/null +++ b/docs/libdbusmenu-glib/reference/xml/dbusmenu-server.xml @@ -0,0 +1,462 @@ +<?xml version="1.0"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" + "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" +[ + <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'"> +]> +<refentry id="libdbusmenu-glib-dbusmenu-server"> +<refmeta> +<refentrytitle role="top_of_page" id="libdbusmenu-glib-dbusmenu-server.top_of_page">dbusmenu-server</refentrytitle> +<manvolnum>3</manvolnum> +<refmiscinfo> + LIBDBUSMENU-GLIB Library +</refmiscinfo> +</refmeta> +<refnamediv> +<refname>dbusmenu-server</refname> +<refpurpose></refpurpose> +</refnamediv> + +<refsynopsisdiv id="libdbusmenu-glib-dbusmenu-server.synopsis" role="synopsis"> +<title role="synopsis.title">Synopsis</title> + +<synopsis>#define <link linkend="g-marshal-value-peek-boolean">g_marshal_value_peek_boolean</link> (v) +#define <link linkend="g-marshal-value-peek-char">g_marshal_value_peek_char</link> (v) +#define <link linkend="g-marshal-value-peek-uchar">g_marshal_value_peek_uchar</link> (v) +#define <link linkend="g-marshal-value-peek-int">g_marshal_value_peek_int</link> (v) +#define <link linkend="g-marshal-value-peek-uint">g_marshal_value_peek_uint</link> (v) +#define <link linkend="g-marshal-value-peek-long">g_marshal_value_peek_long</link> (v) +#define <link linkend="g-marshal-value-peek-ulong">g_marshal_value_peek_ulong</link> (v) +#define <link linkend="g-marshal-value-peek-int64">g_marshal_value_peek_int64</link> (v) +#define <link linkend="g-marshal-value-peek-uint64">g_marshal_value_peek_uint64</link> (v) +#define <link linkend="g-marshal-value-peek-enum">g_marshal_value_peek_enum</link> (v) +#define <link linkend="g-marshal-value-peek-flags">g_marshal_value_peek_flags</link> (v) +#define <link linkend="g-marshal-value-peek-float">g_marshal_value_peek_float</link> (v) +#define <link linkend="g-marshal-value-peek-double">g_marshal_value_peek_double</link> (v) +#define <link linkend="g-marshal-value-peek-string">g_marshal_value_peek_string</link> (v) +#define <link linkend="g-marshal-value-peek-param">g_marshal_value_peek_param</link> (v) +#define <link linkend="g-marshal-value-peek-boxed">g_marshal_value_peek_boxed</link> (v) +#define <link linkend="g-marshal-value-peek-pointer">g_marshal_value_peek_pointer</link> (v) +#define <link linkend="g-marshal-value-peek-object">g_marshal_value_peek_object</link> (v) +<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="dbus-glib-marshal--dbusmenu-server-BOOLEAN--INT-STRING-POINTER-POINTER">dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_STRING_POINTER_POINTER</link> + (<parameter><link linkend="GClosure"><type>GClosure</type></link> *closure</parameter>, + <parameter><link linkend="GValue"><type>GValue</type></link> *return_value</parameter>, + <parameter><link linkend="guint"><type>guint</type></link> n_param_values</parameter>, + <parameter>const <link linkend="GValue"><type>GValue</type></link> *param_values</parameter>, + <parameter><link linkend="gpointer"><type>gpointer</type></link> invocation_hint</parameter>, + <parameter><link linkend="gpointer"><type>gpointer</type></link> marshal_data</parameter>); +<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="dbus-glib-marshal--dbusmenu-server-BOOLEAN--INT-POINTER-POINTER-POINTER">dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_POINTER_POINTER_POINTER</link> + (<parameter><link linkend="GClosure"><type>GClosure</type></link> *closure</parameter>, + <parameter><link linkend="GValue"><type>GValue</type></link> *return_value</parameter>, + <parameter><link linkend="guint"><type>guint</type></link> n_param_values</parameter>, + <parameter>const <link linkend="GValue"><type>GValue</type></link> *param_values</parameter>, + <parameter><link linkend="gpointer"><type>gpointer</type></link> invocation_hint</parameter>, + <parameter><link linkend="gpointer"><type>gpointer</type></link> marshal_data</parameter>); +<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="dbus-glib-marshal--dbusmenu-server-BOOLEAN--INT-BOXED-POINTER-POINTER">dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_BOXED_POINTER_POINTER</link> + (<parameter><link linkend="GClosure"><type>GClosure</type></link> *closure</parameter>, + <parameter><link linkend="GValue"><type>GValue</type></link> *return_value</parameter>, + <parameter><link linkend="guint"><type>guint</type></link> n_param_values</parameter>, + <parameter>const <link linkend="GValue"><type>GValue</type></link> *param_values</parameter>, + <parameter><link linkend="gpointer"><type>gpointer</type></link> invocation_hint</parameter>, + <parameter><link linkend="gpointer"><type>gpointer</type></link> marshal_data</parameter>); +<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="dbus-glib-marshal--dbusmenu-server-BOOLEAN--INT-STRING-BOXED-UINT-POINTER">dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_STRING_BOXED_UINT_POINTER</link> + (<parameter><link linkend="GClosure"><type>GClosure</type></link> *closure</parameter>, + <parameter><link linkend="GValue"><type>GValue</type></link> *return_value</parameter>, + <parameter><link linkend="guint"><type>guint</type></link> n_param_values</parameter>, + <parameter>const <link linkend="GValue"><type>GValue</type></link> *param_values</parameter>, + <parameter><link linkend="gpointer"><type>gpointer</type></link> invocation_hint</parameter>, + <parameter><link linkend="gpointer"><type>gpointer</type></link> marshal_data</parameter>); +<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="dbus-glib-marshal--dbusmenu-server-BOOLEAN--INT-POINTER-POINTER">dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_POINTER_POINTER</link> + (<parameter><link linkend="GClosure"><type>GClosure</type></link> *closure</parameter>, + <parameter><link linkend="GValue"><type>GValue</type></link> *return_value</parameter>, + <parameter><link linkend="guint"><type>guint</type></link> n_param_values</parameter>, + <parameter>const <link linkend="GValue"><type>GValue</type></link> *param_values</parameter>, + <parameter><link linkend="gpointer"><type>gpointer</type></link> invocation_hint</parameter>, + <parameter><link linkend="gpointer"><type>gpointer</type></link> marshal_data</parameter>); +<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="dbus-glib-marshal--dbusmenu-server-BOOLEAN--BOXED-BOXED-POINTER-POINTER">dbus_glib_marshal__dbusmenu_server_BOOLEAN__BOXED_BOXED_POINTER_POINTER</link> + (<parameter><link linkend="GClosure"><type>GClosure</type></link> *closure</parameter>, + <parameter><link linkend="GValue"><type>GValue</type></link> *return_value</parameter>, + <parameter><link linkend="guint"><type>guint</type></link> n_param_values</parameter>, + <parameter>const <link linkend="GValue"><type>GValue</type></link> *param_values</parameter>, + <parameter><link linkend="gpointer"><type>gpointer</type></link> invocation_hint</parameter>, + <parameter><link linkend="gpointer"><type>gpointer</type></link> marshal_data</parameter>); +</synopsis> +</refsynopsisdiv> + +<refsect1 id="libdbusmenu-glib-dbusmenu-server.description" role="desc"> +<title role="desc.title">Description</title> +<para> +</para> +</refsect1> +<refsect1 id="libdbusmenu-glib-dbusmenu-server.details" role="details"> +<title role="details.title">Details</title> +<refsect2 id="g-marshal-value-peek-boolean" role="macro"> +<title>g_marshal_value_peek_boolean()</title> +<indexterm zone="g-marshal-value-peek-boolean"><primary>g_marshal_value_peek_boolean</primary></indexterm> +<programlisting>#define g_marshal_value_peek_boolean(v)</programlisting> +<para> +</para><variablelist role="params"> +<varlistentry><term><parameter>v</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="g-marshal-value-peek-char" role="macro"> +<title>g_marshal_value_peek_char()</title> +<indexterm zone="g-marshal-value-peek-char"><primary>g_marshal_value_peek_char</primary></indexterm> +<programlisting>#define g_marshal_value_peek_char(v)</programlisting> +<para> +</para><variablelist role="params"> +<varlistentry><term><parameter>v</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="g-marshal-value-peek-uchar" role="macro"> +<title>g_marshal_value_peek_uchar()</title> +<indexterm zone="g-marshal-value-peek-uchar"><primary>g_marshal_value_peek_uchar</primary></indexterm> +<programlisting>#define g_marshal_value_peek_uchar(v)</programlisting> +<para> +</para><variablelist role="params"> +<varlistentry><term><parameter>v</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="g-marshal-value-peek-int" role="macro"> +<title>g_marshal_value_peek_int()</title> +<indexterm zone="g-marshal-value-peek-int"><primary>g_marshal_value_peek_int</primary></indexterm> +<programlisting>#define g_marshal_value_peek_int(v)</programlisting> +<para> +</para><variablelist role="params"> +<varlistentry><term><parameter>v</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="g-marshal-value-peek-uint" role="macro"> +<title>g_marshal_value_peek_uint()</title> +<indexterm zone="g-marshal-value-peek-uint"><primary>g_marshal_value_peek_uint</primary></indexterm> +<programlisting>#define g_marshal_value_peek_uint(v)</programlisting> +<para> +</para><variablelist role="params"> +<varlistentry><term><parameter>v</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="g-marshal-value-peek-long" role="macro"> +<title>g_marshal_value_peek_long()</title> +<indexterm zone="g-marshal-value-peek-long"><primary>g_marshal_value_peek_long</primary></indexterm> +<programlisting>#define g_marshal_value_peek_long(v)</programlisting> +<para> +</para><variablelist role="params"> +<varlistentry><term><parameter>v</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="g-marshal-value-peek-ulong" role="macro"> +<title>g_marshal_value_peek_ulong()</title> +<indexterm zone="g-marshal-value-peek-ulong"><primary>g_marshal_value_peek_ulong</primary></indexterm> +<programlisting>#define g_marshal_value_peek_ulong(v)</programlisting> +<para> +</para><variablelist role="params"> +<varlistentry><term><parameter>v</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="g-marshal-value-peek-int64" role="macro"> +<title>g_marshal_value_peek_int64()</title> +<indexterm zone="g-marshal-value-peek-int64"><primary>g_marshal_value_peek_int64</primary></indexterm> +<programlisting>#define g_marshal_value_peek_int64(v)</programlisting> +<para> +</para><variablelist role="params"> +<varlistentry><term><parameter>v</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="g-marshal-value-peek-uint64" role="macro"> +<title>g_marshal_value_peek_uint64()</title> +<indexterm zone="g-marshal-value-peek-uint64"><primary>g_marshal_value_peek_uint64</primary></indexterm> +<programlisting>#define g_marshal_value_peek_uint64(v)</programlisting> +<para> +</para><variablelist role="params"> +<varlistentry><term><parameter>v</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="g-marshal-value-peek-enum" role="macro"> +<title>g_marshal_value_peek_enum()</title> +<indexterm zone="g-marshal-value-peek-enum"><primary>g_marshal_value_peek_enum</primary></indexterm> +<programlisting>#define g_marshal_value_peek_enum(v)</programlisting> +<para> +</para><variablelist role="params"> +<varlistentry><term><parameter>v</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="g-marshal-value-peek-flags" role="macro"> +<title>g_marshal_value_peek_flags()</title> +<indexterm zone="g-marshal-value-peek-flags"><primary>g_marshal_value_peek_flags</primary></indexterm> +<programlisting>#define g_marshal_value_peek_flags(v)</programlisting> +<para> +</para><variablelist role="params"> +<varlistentry><term><parameter>v</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="g-marshal-value-peek-float" role="macro"> +<title>g_marshal_value_peek_float()</title> +<indexterm zone="g-marshal-value-peek-float"><primary>g_marshal_value_peek_float</primary></indexterm> +<programlisting>#define g_marshal_value_peek_float(v)</programlisting> +<para> +</para><variablelist role="params"> +<varlistentry><term><parameter>v</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="g-marshal-value-peek-double" role="macro"> +<title>g_marshal_value_peek_double()</title> +<indexterm zone="g-marshal-value-peek-double"><primary>g_marshal_value_peek_double</primary></indexterm> +<programlisting>#define g_marshal_value_peek_double(v)</programlisting> +<para> +</para><variablelist role="params"> +<varlistentry><term><parameter>v</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="g-marshal-value-peek-string" role="macro"> +<title>g_marshal_value_peek_string()</title> +<indexterm zone="g-marshal-value-peek-string"><primary>g_marshal_value_peek_string</primary></indexterm> +<programlisting>#define g_marshal_value_peek_string(v)</programlisting> +<para> +</para><variablelist role="params"> +<varlistentry><term><parameter>v</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="g-marshal-value-peek-param" role="macro"> +<title>g_marshal_value_peek_param()</title> +<indexterm zone="g-marshal-value-peek-param"><primary>g_marshal_value_peek_param</primary></indexterm> +<programlisting>#define g_marshal_value_peek_param(v)</programlisting> +<para> +</para><variablelist role="params"> +<varlistentry><term><parameter>v</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="g-marshal-value-peek-boxed" role="macro"> +<title>g_marshal_value_peek_boxed()</title> +<indexterm zone="g-marshal-value-peek-boxed"><primary>g_marshal_value_peek_boxed</primary></indexterm> +<programlisting>#define g_marshal_value_peek_boxed(v)</programlisting> +<para> +</para><variablelist role="params"> +<varlistentry><term><parameter>v</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="g-marshal-value-peek-pointer" role="macro"> +<title>g_marshal_value_peek_pointer()</title> +<indexterm zone="g-marshal-value-peek-pointer"><primary>g_marshal_value_peek_pointer</primary></indexterm> +<programlisting>#define g_marshal_value_peek_pointer(v)</programlisting> +<para> +</para><variablelist role="params"> +<varlistentry><term><parameter>v</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="g-marshal-value-peek-object" role="macro"> +<title>g_marshal_value_peek_object()</title> +<indexterm zone="g-marshal-value-peek-object"><primary>g_marshal_value_peek_object</primary></indexterm> +<programlisting>#define g_marshal_value_peek_object(v)</programlisting> +<para> +</para><variablelist role="params"> +<varlistentry><term><parameter>v</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="dbus-glib-marshal--dbusmenu-server-BOOLEAN--INT-STRING-POINTER-POINTER" role="function"> +<title>dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_STRING_POINTER_POINTER ()</title> +<indexterm zone="dbus-glib-marshal--dbusmenu-server-BOOLEAN--INT-STRING-POINTER-POINTER"><primary>dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_STRING_POINTER_POINTER</primary></indexterm> +<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_STRING_POINTER_POINTER + (<parameter><link linkend="GClosure"><type>GClosure</type></link> *closure</parameter>, + <parameter><link linkend="GValue"><type>GValue</type></link> *return_value</parameter>, + <parameter><link linkend="guint"><type>guint</type></link> n_param_values</parameter>, + <parameter>const <link linkend="GValue"><type>GValue</type></link> *param_values</parameter>, + <parameter><link linkend="gpointer"><type>gpointer</type></link> invocation_hint</parameter>, + <parameter><link linkend="gpointer"><type>gpointer</type></link> marshal_data</parameter>);</programlisting> +<para> +</para><variablelist role="params"> +<varlistentry><term><parameter>closure</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>return_value</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>n_param_values</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>param_values</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>invocation_hint</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>marshal_data</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="dbus-glib-marshal--dbusmenu-server-BOOLEAN--INT-POINTER-POINTER-POINTER" role="function"> +<title>dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_POINTER_POINTER_POINTER ()</title> +<indexterm zone="dbus-glib-marshal--dbusmenu-server-BOOLEAN--INT-POINTER-POINTER-POINTER"><primary>dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_POINTER_POINTER_POINTER</primary></indexterm> +<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_POINTER_POINTER_POINTER + (<parameter><link linkend="GClosure"><type>GClosure</type></link> *closure</parameter>, + <parameter><link linkend="GValue"><type>GValue</type></link> *return_value</parameter>, + <parameter><link linkend="guint"><type>guint</type></link> n_param_values</parameter>, + <parameter>const <link linkend="GValue"><type>GValue</type></link> *param_values</parameter>, + <parameter><link linkend="gpointer"><type>gpointer</type></link> invocation_hint</parameter>, + <parameter><link linkend="gpointer"><type>gpointer</type></link> marshal_data</parameter>);</programlisting> +<para> +</para><variablelist role="params"> +<varlistentry><term><parameter>closure</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>return_value</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>n_param_values</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>param_values</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>invocation_hint</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>marshal_data</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="dbus-glib-marshal--dbusmenu-server-BOOLEAN--INT-BOXED-POINTER-POINTER" role="function"> +<title>dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_BOXED_POINTER_POINTER ()</title> +<indexterm zone="dbus-glib-marshal--dbusmenu-server-BOOLEAN--INT-BOXED-POINTER-POINTER"><primary>dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_BOXED_POINTER_POINTER</primary></indexterm> +<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_BOXED_POINTER_POINTER + (<parameter><link linkend="GClosure"><type>GClosure</type></link> *closure</parameter>, + <parameter><link linkend="GValue"><type>GValue</type></link> *return_value</parameter>, + <parameter><link linkend="guint"><type>guint</type></link> n_param_values</parameter>, + <parameter>const <link linkend="GValue"><type>GValue</type></link> *param_values</parameter>, + <parameter><link linkend="gpointer"><type>gpointer</type></link> invocation_hint</parameter>, + <parameter><link linkend="gpointer"><type>gpointer</type></link> marshal_data</parameter>);</programlisting> +<para> +</para><variablelist role="params"> +<varlistentry><term><parameter>closure</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>return_value</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>n_param_values</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>param_values</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>invocation_hint</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>marshal_data</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="dbus-glib-marshal--dbusmenu-server-BOOLEAN--INT-STRING-BOXED-UINT-POINTER" role="function"> +<title>dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_STRING_BOXED_UINT_POINTER ()</title> +<indexterm zone="dbus-glib-marshal--dbusmenu-server-BOOLEAN--INT-STRING-BOXED-UINT-POINTER"><primary>dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_STRING_BOXED_UINT_POINTER</primary></indexterm> +<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_STRING_BOXED_UINT_POINTER + (<parameter><link linkend="GClosure"><type>GClosure</type></link> *closure</parameter>, + <parameter><link linkend="GValue"><type>GValue</type></link> *return_value</parameter>, + <parameter><link linkend="guint"><type>guint</type></link> n_param_values</parameter>, + <parameter>const <link linkend="GValue"><type>GValue</type></link> *param_values</parameter>, + <parameter><link linkend="gpointer"><type>gpointer</type></link> invocation_hint</parameter>, + <parameter><link linkend="gpointer"><type>gpointer</type></link> marshal_data</parameter>);</programlisting> +<para> +</para><variablelist role="params"> +<varlistentry><term><parameter>closure</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>return_value</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>n_param_values</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>param_values</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>invocation_hint</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>marshal_data</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="dbus-glib-marshal--dbusmenu-server-BOOLEAN--INT-POINTER-POINTER" role="function"> +<title>dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_POINTER_POINTER ()</title> +<indexterm zone="dbus-glib-marshal--dbusmenu-server-BOOLEAN--INT-POINTER-POINTER"><primary>dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_POINTER_POINTER</primary></indexterm> +<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> dbus_glib_marshal__dbusmenu_server_BOOLEAN__INT_POINTER_POINTER + (<parameter><link linkend="GClosure"><type>GClosure</type></link> *closure</parameter>, + <parameter><link linkend="GValue"><type>GValue</type></link> *return_value</parameter>, + <parameter><link linkend="guint"><type>guint</type></link> n_param_values</parameter>, + <parameter>const <link linkend="GValue"><type>GValue</type></link> *param_values</parameter>, + <parameter><link linkend="gpointer"><type>gpointer</type></link> invocation_hint</parameter>, + <parameter><link linkend="gpointer"><type>gpointer</type></link> marshal_data</parameter>);</programlisting> +<para> +</para><variablelist role="params"> +<varlistentry><term><parameter>closure</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>return_value</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>n_param_values</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>param_values</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>invocation_hint</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>marshal_data</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="dbus-glib-marshal--dbusmenu-server-BOOLEAN--BOXED-BOXED-POINTER-POINTER" role="function"> +<title>dbus_glib_marshal__dbusmenu_server_BOOLEAN__BOXED_BOXED_POINTER_POINTER ()</title> +<indexterm zone="dbus-glib-marshal--dbusmenu-server-BOOLEAN--BOXED-BOXED-POINTER-POINTER"><primary>dbus_glib_marshal__dbusmenu_server_BOOLEAN__BOXED_BOXED_POINTER_POINTER</primary></indexterm> +<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> dbus_glib_marshal__dbusmenu_server_BOOLEAN__BOXED_BOXED_POINTER_POINTER + (<parameter><link linkend="GClosure"><type>GClosure</type></link> *closure</parameter>, + <parameter><link linkend="GValue"><type>GValue</type></link> *return_value</parameter>, + <parameter><link linkend="guint"><type>guint</type></link> n_param_values</parameter>, + <parameter>const <link linkend="GValue"><type>GValue</type></link> *param_values</parameter>, + <parameter><link linkend="gpointer"><type>gpointer</type></link> invocation_hint</parameter>, + <parameter><link linkend="gpointer"><type>gpointer</type></link> marshal_data</parameter>);</programlisting> +<para> +</para><variablelist role="params"> +<varlistentry><term><parameter>closure</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>return_value</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>n_param_values</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>param_values</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>invocation_hint</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>marshal_data</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +</variablelist></refsect2> + +</refsect1> + +</refentry> diff --git a/docs/libdbusmenu-glib/reference/xml/menuitem-proxy.xml b/docs/libdbusmenu-glib/reference/xml/menuitem-proxy.xml new file mode 100644 index 0000000..7d8b431 --- /dev/null +++ b/docs/libdbusmenu-glib/reference/xml/menuitem-proxy.xml @@ -0,0 +1,111 @@ +<?xml version="1.0"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" + "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" +[ + <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'"> +]> +<refentry id="DbusmenuMenuitemProxy"> +<refmeta> +<refentrytitle role="top_of_page" id="DbusmenuMenuitemProxy.top_of_page">DbusmenuMenuitemProxy</refentrytitle> +<manvolnum>3</manvolnum> +<refmiscinfo> + LIBDBUSMENU-GLIB Library +</refmiscinfo> +</refmeta> +<refnamediv> +<refname>DbusmenuMenuitemProxy</refname> +<refpurpose></refpurpose> +</refnamediv> + +<refsynopsisdiv id="DbusmenuMenuitemProxy.synopsis" role="synopsis"> +<title role="synopsis.title">Synopsis</title> + +<synopsis> <link linkend="DbusmenuMenuitemProxy-struct">DbusmenuMenuitemProxy</link>; + <link linkend="DbusmenuMenuitemProxyClass">DbusmenuMenuitemProxyClass</link>; +<link linkend="DbusmenuMenuitemProxy"><returnvalue>DbusmenuMenuitemProxy</returnvalue></link> * <link linkend="dbusmenu-menuitem-proxy-new">dbusmenu_menuitem_proxy_new</link> (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>); +<link linkend="DbusmenuMenuitem"><returnvalue>DbusmenuMenuitem</returnvalue></link> * <link linkend="dbusmenu-menuitem-proxy-get-wrapped">dbusmenu_menuitem_proxy_get_wrapped</link> (<parameter><link linkend="DbusmenuMenuitemProxy"><type>DbusmenuMenuitemProxy</type></link> *pmi</parameter>); +</synopsis> +</refsynopsisdiv> +<refsect1 id="DbusmenuMenuitemProxy.object-hierarchy" role="object_hierarchy"> +<title role="object_hierarchy.title">Object Hierarchy</title> +<synopsis> + <link linkend="GObject">GObject</link> + +----<link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link> + +----DbusmenuMenuitemProxy +</synopsis> +</refsect1> +<refsect1 id="DbusmenuMenuitemProxy.properties" role="properties"> +<title role="properties.title">Properties</title> +<synopsis> + "<link linkend="DbusmenuMenuitemProxy--menu-item">menu-item</link>" <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link>* : Read / Write / Construct Only +</synopsis> +</refsect1> + +<refsect1 id="DbusmenuMenuitemProxy.description" role="desc"> +<title role="desc.title">Description</title> +<para> +</para> +</refsect1> +<refsect1 id="DbusmenuMenuitemProxy.details" role="details"> +<title role="details.title">Details</title> +<refsect2 id="DbusmenuMenuitemProxy-struct" role="struct"> +<title>DbusmenuMenuitemProxy</title> +<indexterm zone="DbusmenuMenuitemProxy-struct"><primary>DbusmenuMenuitemProxy</primary></indexterm> +<programlisting>typedef struct _DbusmenuMenuitemProxy DbusmenuMenuitemProxy;</programlisting> +<para> +</para></refsect2> +<refsect2 id="DbusmenuMenuitemProxyClass" role="struct"> +<title>DbusmenuMenuitemProxyClass</title> +<indexterm zone="DbusmenuMenuitemProxyClass"><primary>DbusmenuMenuitemProxyClass</primary></indexterm> +<programlisting>typedef struct { + DbusmenuMenuitemClass parent_class; +} DbusmenuMenuitemProxyClass; +</programlisting> +<para> +Functions and signal slots for <link linkend="DbusmenuMenuitemProxy"><type>DbusmenuMenuitemProxy</type></link>. +</para><variablelist role="struct"> +<varlistentry><term><link linkend="DbusmenuMenuitemClass"><type>DbusmenuMenuitemClass</type></link> <structfield id="DbusmenuMenuitemProxyClass.parent-class">parent_class</structfield>;</term> +<listitem><simpara>The Class of <link linkend="DbusmeneMenuitem"><type>DbusmeneMenuitem</type></link> +</simpara></listitem> +</varlistentry> +</variablelist></refsect2> +<refsect2 id="dbusmenu-menuitem-proxy-new" role="function"> +<title>dbusmenu_menuitem_proxy_new ()</title> +<indexterm zone="dbusmenu-menuitem-proxy-new"><primary>dbusmenu_menuitem_proxy_new</primary></indexterm> +<programlisting><link linkend="DbusmenuMenuitemProxy"><returnvalue>DbusmenuMenuitemProxy</returnvalue></link> * dbusmenu_menuitem_proxy_new (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>);</programlisting> +<para> +Builds a new <link linkend="DbusmenuMenuitemProxy"><type>DbusmenuMenuitemProxy</type></link> object that proxies + all of the values for <parameter>mi</parameter>. +</para><variablelist role="params"> +<varlistentry><term><parameter>mi</parameter> :</term> +<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to proxy +</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new <link linkend="DbusmenuMenuitemProxy"><type>DbusmenuMenuitemProxy</type></link> object. +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="dbusmenu-menuitem-proxy-get-wrapped" role="function"> +<title>dbusmenu_menuitem_proxy_get_wrapped ()</title> +<indexterm zone="dbusmenu-menuitem-proxy-get-wrapped"><primary>dbusmenu_menuitem_proxy_get_wrapped</primary></indexterm> +<programlisting><link linkend="DbusmenuMenuitem"><returnvalue>DbusmenuMenuitem</returnvalue></link> * dbusmenu_menuitem_proxy_get_wrapped (<parameter><link linkend="DbusmenuMenuitemProxy"><type>DbusmenuMenuitemProxy</type></link> *pmi</parameter>);</programlisting> +<para> +Accesses the private variable of which <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> + we are doing the proxying for. +</para><variablelist role="params"> +<varlistentry><term><parameter>pmi</parameter> :</term> +<listitem><simpara><link linkend="DbusmenuMenuitemProxy"><type>DbusmenuMenuitemProxy</type></link> to look into +</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> object or a <link linkend="NULL:CAPS"><type>NULL</type></link> if we + don't have one or there is an error. +</simpara></listitem></varlistentry> +</variablelist></refsect2> + +</refsect1> +<refsect1 id="DbusmenuMenuitemProxy.property-details" role="property_details"> +<title role="property_details.title">Property Details</title> +<refsect2 id="DbusmenuMenuitemProxy--menu-item" role="property"><title>The <literal>"menu-item"</literal> property</title> +<indexterm zone="DbusmenuMenuitemProxy--menu-item"><primary>DbusmenuMenuitemProxy:menu-item</primary></indexterm> +<programlisting> "menu-item" <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link>* : Read / Write / Construct Only</programlisting> +<para>An instance of the DbusmenuMenuitem class that this menuitem will mimic.</para></refsect2> +</refsect1> + +</refentry> diff --git a/docs/libdbusmenu-glib/reference/xml/menuitem.xml b/docs/libdbusmenu-glib/reference/xml/menuitem.xml new file mode 100644 index 0000000..75f77d6 --- /dev/null +++ b/docs/libdbusmenu-glib/reference/xml/menuitem.xml @@ -0,0 +1,1166 @@ +<?xml version="1.0"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" + "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" +[ + <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'"> +]> +<refentry id="DbusmenuMenuitem"> +<refmeta> +<refentrytitle role="top_of_page" id="DbusmenuMenuitem.top_of_page">DbusmenuMenuitem</refentrytitle> +<manvolnum>3</manvolnum> +<refmiscinfo> + LIBDBUSMENU-GLIB Library +</refmiscinfo> +</refmeta> +<refnamediv> +<refname>DbusmenuMenuitem</refname> +<refpurpose>A lowlevel represenation of a menuitem</refpurpose> +</refnamediv> +<refsect1 id="DbusmenuMenuitem.stability-level"> +<title>Stability Level</title> +Unstable, unless otherwise indicated +</refsect1> + +<refsynopsisdiv id="DbusmenuMenuitem.synopsis" role="synopsis"> +<title role="synopsis.title">Synopsis</title> + +<synopsis> +#include <libdbusmenu-glib/menuitem.h> + +#define <link linkend="DBUSMENU-MENUITEM-SIGNAL-PROPERTY-CHANGED:CAPS">DBUSMENU_MENUITEM_SIGNAL_PROPERTY_CHANGED</link> +#define <link linkend="DBUSMENU-MENUITEM-SIGNAL-ITEM-ACTIVATED:CAPS">DBUSMENU_MENUITEM_SIGNAL_ITEM_ACTIVATED</link> +#define <link linkend="DBUSMENU-MENUITEM-SIGNAL-CHILD-ADDED:CAPS">DBUSMENU_MENUITEM_SIGNAL_CHILD_ADDED</link> +#define <link linkend="DBUSMENU-MENUITEM-SIGNAL-CHILD-REMOVED:CAPS">DBUSMENU_MENUITEM_SIGNAL_CHILD_REMOVED</link> +#define <link linkend="DBUSMENU-MENUITEM-SIGNAL-CHILD-MOVED:CAPS">DBUSMENU_MENUITEM_SIGNAL_CHILD_MOVED</link> +#define <link linkend="DBUSMENU-MENUITEM-SIGNAL-REALIZED:CAPS">DBUSMENU_MENUITEM_SIGNAL_REALIZED</link> +#define <link linkend="DBUSMENU-MENUITEM-SIGNAL-REALIZED-ID:CAPS">DBUSMENU_MENUITEM_SIGNAL_REALIZED_ID</link> +#define <link linkend="DBUSMENU-MENUITEM-PROP-TYPE:CAPS">DBUSMENU_MENUITEM_PROP_TYPE</link> +#define <link linkend="DBUSMENU-MENUITEM-PROP-VISIBLE:CAPS">DBUSMENU_MENUITEM_PROP_VISIBLE</link> +#define <link linkend="DBUSMENU-MENUITEM-PROP-ENABLED:CAPS">DBUSMENU_MENUITEM_PROP_ENABLED</link> +#define <link linkend="DBUSMENU-MENUITEM-PROP-LABEL:CAPS">DBUSMENU_MENUITEM_PROP_LABEL</link> +#define <link linkend="DBUSMENU-MENUITEM-PROP-ICON-NAME:CAPS">DBUSMENU_MENUITEM_PROP_ICON_NAME</link> +#define <link linkend="DBUSMENU-MENUITEM-PROP-ICON-DATA:CAPS">DBUSMENU_MENUITEM_PROP_ICON_DATA</link> +#define <link linkend="DBUSMENU-MENUITEM-PROP-TOGGLE-TYPE:CAPS">DBUSMENU_MENUITEM_PROP_TOGGLE_TYPE</link> +#define <link linkend="DBUSMENU-MENUITEM-PROP-TOGGLE-STATE:CAPS">DBUSMENU_MENUITEM_PROP_TOGGLE_STATE</link> +#define <link linkend="DBUSMENU-MENUITEM-TOGGLE-CHECK:CAPS">DBUSMENU_MENUITEM_TOGGLE_CHECK</link> +#define <link linkend="DBUSMENU-MENUITEM-TOGGLE-RADIO:CAPS">DBUSMENU_MENUITEM_TOGGLE_RADIO</link> +#define <link linkend="DBUSMENU-MENUITEM-TOGGLE-STATE-UNCHECKED:CAPS">DBUSMENU_MENUITEM_TOGGLE_STATE_UNCHECKED</link> +#define <link linkend="DBUSMENU-MENUITEM-TOGGLE-STATE-CHECKED:CAPS">DBUSMENU_MENUITEM_TOGGLE_STATE_CHECKED</link> +#define <link linkend="DBUSMENU-MENUITEM-TOGGLE-STATE-UNKNOWN:CAPS">DBUSMENU_MENUITEM_TOGGLE_STATE_UNKNOWN</link> +#define <link linkend="DBUSMENU-MENUITEM-ICON-NAME-BLANK:CAPS">DBUSMENU_MENUITEM_ICON_NAME_BLANK</link> + <link linkend="DbusmenuMenuitem-struct">DbusmenuMenuitem</link>; +<link linkend="void"><returnvalue>void</returnvalue></link> (<link linkend="dbusmenu-menuitem-about-to-show-cb">*dbusmenu_menuitem_about_to_show_cb</link>) + (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, + <parameter><link linkend="gpointer"><type>gpointer</type></link> user_data</parameter>); +<link linkend="void"><returnvalue>void</returnvalue></link> (<link linkend="dbusmenu-menuitem-buildxml-slot-t">*dbusmenu_menuitem_buildxml_slot_t</link>) + (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, + <parameter><link linkend="GPtrArray"><type>GPtrArray</type></link> *stringarray</parameter>); + <link linkend="DbusmenuMenuitemClass">DbusmenuMenuitemClass</link>; +<link linkend="DbusmenuMenuitem"><returnvalue>DbusmenuMenuitem</returnvalue></link> * <link linkend="dbusmenu-menuitem-new">dbusmenu_menuitem_new</link> (<parameter><type>void</type></parameter>); +<link linkend="DbusmenuMenuitem"><returnvalue>DbusmenuMenuitem</returnvalue></link> * <link linkend="dbusmenu-menuitem-new-with-id">dbusmenu_menuitem_new_with_id</link> (<parameter><link linkend="gint"><type>gint</type></link> id</parameter>); +<link linkend="gint"><returnvalue>gint</returnvalue></link> <link linkend="dbusmenu-menuitem-get-id">dbusmenu_menuitem_get_id</link> (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>); +<link linkend="GList"><returnvalue>GList</returnvalue></link> * <link linkend="dbusmenu-menuitem-get-children">dbusmenu_menuitem_get_children</link> (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>); +<link linkend="GList"><returnvalue>GList</returnvalue></link> * <link linkend="dbusmenu-menuitem-take-children">dbusmenu_menuitem_take_children</link> (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>); +<link linkend="guint"><returnvalue>guint</returnvalue></link> <link linkend="dbusmenu-menuitem-get-position">dbusmenu_menuitem_get_position</link> (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, + <parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *parent</parameter>); +<link linkend="guint"><returnvalue>guint</returnvalue></link> <link linkend="dbusmenu-menuitem-get-position-realized">dbusmenu_menuitem_get_position_realized</link> + (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, + <parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *parent</parameter>); +<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="dbusmenu-menuitem-child-append">dbusmenu_menuitem_child_append</link> (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, + <parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *child</parameter>); +<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="dbusmenu-menuitem-child-prepend">dbusmenu_menuitem_child_prepend</link> (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, + <parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *child</parameter>); +<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="dbusmenu-menuitem-child-delete">dbusmenu_menuitem_child_delete</link> (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, + <parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *child</parameter>); +<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="dbusmenu-menuitem-child-add-position">dbusmenu_menuitem_child_add_position</link> + (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, + <parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *child</parameter>, + <parameter><link linkend="guint"><type>guint</type></link> position</parameter>); +<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="dbusmenu-menuitem-child-reorder">dbusmenu_menuitem_child_reorder</link> (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, + <parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *child</parameter>, + <parameter><link linkend="guint"><type>guint</type></link> position</parameter>); +<link linkend="DbusmenuMenuitem"><returnvalue>DbusmenuMenuitem</returnvalue></link> * <link linkend="dbusmenu-menuitem-child-find">dbusmenu_menuitem_child_find</link> (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, + <parameter><link linkend="gint"><type>gint</type></link> id</parameter>); +<link linkend="DbusmenuMenuitem"><returnvalue>DbusmenuMenuitem</returnvalue></link> * <link linkend="dbusmenu-menuitem-find-id">dbusmenu_menuitem_find_id</link> (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, + <parameter><link linkend="gint"><type>gint</type></link> id</parameter>); +<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="dbusmenu-menuitem-property-set">dbusmenu_menuitem_property_set</link> (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, + <parameter>const <link linkend="gchar"><type>gchar</type></link> *property</parameter>, + <parameter>const <link linkend="gchar"><type>gchar</type></link> *value</parameter>); +<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="dbusmenu-menuitem-property-set-value">dbusmenu_menuitem_property_set_value</link> + (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, + <parameter>const <link linkend="gchar"><type>gchar</type></link> *property</parameter>, + <parameter>const <link linkend="GValue"><type>GValue</type></link> *value</parameter>); +<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="dbusmenu-menuitem-property-set-bool">dbusmenu_menuitem_property_set_bool</link> (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, + <parameter>const <link linkend="gchar"><type>gchar</type></link> *property</parameter>, + <parameter>const <link linkend="gboolean"><type>gboolean</type></link> value</parameter>); +<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="dbusmenu-menuitem-property-set-int">dbusmenu_menuitem_property_set_int</link> (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, + <parameter>const <link linkend="gchar"><type>gchar</type></link> *property</parameter>, + <parameter>const <link linkend="gint"><type>gint</type></link> value</parameter>); +const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="dbusmenu-menuitem-property-get">dbusmenu_menuitem_property_get</link> (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, + <parameter>const <link linkend="gchar"><type>gchar</type></link> *property</parameter>); +const <link linkend="GValue"><returnvalue>GValue</returnvalue></link> * <link linkend="dbusmenu-menuitem-property-get-value">dbusmenu_menuitem_property_get_value</link> + (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, + <parameter>const <link linkend="gchar"><type>gchar</type></link> *property</parameter>); +<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="dbusmenu-menuitem-property-get-bool">dbusmenu_menuitem_property_get_bool</link> (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, + <parameter>const <link linkend="gchar"><type>gchar</type></link> *property</parameter>); +<link linkend="gint"><returnvalue>gint</returnvalue></link> <link linkend="dbusmenu-menuitem-property-get-int">dbusmenu_menuitem_property_get_int</link> (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, + <parameter>const <link linkend="gchar"><type>gchar</type></link> *property</parameter>); +<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="dbusmenu-menuitem-property-exist">dbusmenu_menuitem_property_exist</link> (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, + <parameter>const <link linkend="gchar"><type>gchar</type></link> *property</parameter>); +<link linkend="GList"><returnvalue>GList</returnvalue></link> * <link linkend="dbusmenu-menuitem-properties-list">dbusmenu_menuitem_properties_list</link> (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>); +<link linkend="GHashTable"><returnvalue>GHashTable</returnvalue></link> * <link linkend="dbusmenu-menuitem-properties-copy">dbusmenu_menuitem_properties_copy</link> (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>); +<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="dbusmenu-menuitem-property-remove">dbusmenu_menuitem_property_remove</link> (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, + <parameter>const <link linkend="gchar"><type>gchar</type></link> *property</parameter>); +<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="dbusmenu-menuitem-set-root">dbusmenu_menuitem_set_root</link> (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, + <parameter><link linkend="gboolean"><type>gboolean</type></link> root</parameter>); +<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="dbusmenu-menuitem-get-root">dbusmenu_menuitem_get_root</link> (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>); +<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="dbusmenu-menuitem-foreach">dbusmenu_menuitem_foreach</link> (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, + <parameter><link linkend="void"><type>void</type></link> (funcDbusmenuMenuitem * mi, gpointer data) ()</parameter>, + <parameter><link linkend="gpointer"><type>gpointer</type></link> data</parameter>); +<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="dbusmenu-menuitem-handle-event">dbusmenu_menuitem_handle_event</link> (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, + <parameter>const <link linkend="gchar"><type>gchar</type></link> *name</parameter>, + <parameter>const <link linkend="GValue"><type>GValue</type></link> *value</parameter>, + <parameter><link linkend="guint"><type>guint</type></link> timestamp</parameter>); +<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="dbusmenu-menuitem-send-about-to-show">dbusmenu_menuitem_send_about_to_show</link> + (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, + <parameter><link linkend="dbusmenu-menuitem-about-to-show-cb"><type>dbusmenu_menuitem_about_to_show_cb</type></link> cb</parameter>, + <parameter><link linkend="gpointer"><type>gpointer</type></link> cb_data</parameter>); +</synopsis> +</refsynopsisdiv> +<refsect1 id="DbusmenuMenuitem.object-hierarchy" role="object_hierarchy"> +<title role="object_hierarchy.title">Object Hierarchy</title> +<synopsis> + <link linkend="GObject">GObject</link> + +----DbusmenuMenuitem + +----<link linkend="DbusmenuClientMenuitem">DbusmenuClientMenuitem</link> + +----<link linkend="DbusmenuMenuitemProxy">DbusmenuMenuitemProxy</link> +</synopsis> +</refsect1> +<refsect1 id="DbusmenuMenuitem.properties" role="properties"> +<title role="properties.title">Properties</title> +<synopsis> + "<link linkend="DbusmenuMenuitem--id">id</link>" <link linkend="gint"><type>gint</type></link> : Read / Write / Construct Only +</synopsis> +</refsect1> +<refsect1 id="DbusmenuMenuitem.signals" role="signal_proto"> +<title role="signal_proto.title">Signals</title> +<synopsis> + "<link linkend="DbusmenuMenuitem-child-added">child-added</link>" : Run Last + "<link linkend="DbusmenuMenuitem-child-moved">child-moved</link>" : Run Last + "<link linkend="DbusmenuMenuitem-child-removed">child-removed</link>" : Run Last + "<link linkend="DbusmenuMenuitem-item-activated">item-activated</link>" : Run Last + "<link linkend="DbusmenuMenuitem-property-changed">property-changed</link>" : Run Last + "<link linkend="DbusmenuMenuitem-realized">realized</link>" : Run Last +</synopsis> +</refsect1> + +<refsect1 id="DbusmenuMenuitem.description" role="desc"> +<title role="desc.title">Description</title> +<para> +A <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> 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. +</para> +<para> +Most people using either the client or the server should be +able to deal mostly with <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> objects. These +are simple, but then they can be attached to more complex +objects and handled appropriately. +</para> +</refsect1> +<refsect1 id="DbusmenuMenuitem.details" role="details"> +<title role="details.title">Details</title> +<refsect2 id="DBUSMENU-MENUITEM-SIGNAL-PROPERTY-CHANGED:CAPS" role="macro"> +<title>DBUSMENU_MENUITEM_SIGNAL_PROPERTY_CHANGED</title> +<indexterm zone="DBUSMENU-MENUITEM-SIGNAL-PROPERTY-CHANGED:CAPS"><primary>DBUSMENU_MENUITEM_SIGNAL_PROPERTY_CHANGED</primary></indexterm> +<programlisting>#define DBUSMENU_MENUITEM_SIGNAL_PROPERTY_CHANGED "property-changed" +</programlisting> +<para> +</para></refsect2> +<refsect2 id="DBUSMENU-MENUITEM-SIGNAL-ITEM-ACTIVATED:CAPS" role="macro"> +<title>DBUSMENU_MENUITEM_SIGNAL_ITEM_ACTIVATED</title> +<indexterm zone="DBUSMENU-MENUITEM-SIGNAL-ITEM-ACTIVATED:CAPS"><primary>DBUSMENU_MENUITEM_SIGNAL_ITEM_ACTIVATED</primary></indexterm> +<programlisting>#define DBUSMENU_MENUITEM_SIGNAL_ITEM_ACTIVATED "item-activated" +</programlisting> +<para> +</para></refsect2> +<refsect2 id="DBUSMENU-MENUITEM-SIGNAL-CHILD-ADDED:CAPS" role="macro"> +<title>DBUSMENU_MENUITEM_SIGNAL_CHILD_ADDED</title> +<indexterm zone="DBUSMENU-MENUITEM-SIGNAL-CHILD-ADDED:CAPS"><primary>DBUSMENU_MENUITEM_SIGNAL_CHILD_ADDED</primary></indexterm> +<programlisting>#define DBUSMENU_MENUITEM_SIGNAL_CHILD_ADDED "child-added" +</programlisting> +<para> +</para></refsect2> +<refsect2 id="DBUSMENU-MENUITEM-SIGNAL-CHILD-REMOVED:CAPS" role="macro"> +<title>DBUSMENU_MENUITEM_SIGNAL_CHILD_REMOVED</title> +<indexterm zone="DBUSMENU-MENUITEM-SIGNAL-CHILD-REMOVED:CAPS"><primary>DBUSMENU_MENUITEM_SIGNAL_CHILD_REMOVED</primary></indexterm> +<programlisting>#define DBUSMENU_MENUITEM_SIGNAL_CHILD_REMOVED "child-removed" +</programlisting> +<para> +</para></refsect2> +<refsect2 id="DBUSMENU-MENUITEM-SIGNAL-CHILD-MOVED:CAPS" role="macro"> +<title>DBUSMENU_MENUITEM_SIGNAL_CHILD_MOVED</title> +<indexterm zone="DBUSMENU-MENUITEM-SIGNAL-CHILD-MOVED:CAPS"><primary>DBUSMENU_MENUITEM_SIGNAL_CHILD_MOVED</primary></indexterm> +<programlisting>#define DBUSMENU_MENUITEM_SIGNAL_CHILD_MOVED "child-moved" +</programlisting> +<para> +</para></refsect2> +<refsect2 id="DBUSMENU-MENUITEM-SIGNAL-REALIZED:CAPS" role="macro"> +<title>DBUSMENU_MENUITEM_SIGNAL_REALIZED</title> +<indexterm zone="DBUSMENU-MENUITEM-SIGNAL-REALIZED:CAPS"><primary>DBUSMENU_MENUITEM_SIGNAL_REALIZED</primary></indexterm> +<programlisting>#define DBUSMENU_MENUITEM_SIGNAL_REALIZED "realized" +</programlisting> +<para> +</para></refsect2> +<refsect2 id="DBUSMENU-MENUITEM-SIGNAL-REALIZED-ID:CAPS" role="macro"> +<title>DBUSMENU_MENUITEM_SIGNAL_REALIZED_ID</title> +<indexterm zone="DBUSMENU-MENUITEM-SIGNAL-REALIZED-ID:CAPS"><primary>DBUSMENU_MENUITEM_SIGNAL_REALIZED_ID</primary></indexterm> +<programlisting>#define DBUSMENU_MENUITEM_SIGNAL_REALIZED_ID (g_signal_lookup(DBUSMENU_MENUITEM_SIGNAL_REALIZED, DBUSMENU_TYPE_MENUITEM)) +</programlisting> +<para> +</para></refsect2> +<refsect2 id="DBUSMENU-MENUITEM-PROP-TYPE:CAPS" role="macro"> +<title>DBUSMENU_MENUITEM_PROP_TYPE</title> +<indexterm zone="DBUSMENU-MENUITEM-PROP-TYPE:CAPS"><primary>DBUSMENU_MENUITEM_PROP_TYPE</primary></indexterm> +<programlisting>#define DBUSMENU_MENUITEM_PROP_TYPE "type" +</programlisting> +<para> +</para></refsect2> +<refsect2 id="DBUSMENU-MENUITEM-PROP-VISIBLE:CAPS" role="macro"> +<title>DBUSMENU_MENUITEM_PROP_VISIBLE</title> +<indexterm zone="DBUSMENU-MENUITEM-PROP-VISIBLE:CAPS"><primary>DBUSMENU_MENUITEM_PROP_VISIBLE</primary></indexterm> +<programlisting>#define DBUSMENU_MENUITEM_PROP_VISIBLE "visible" +</programlisting> +<para> +</para></refsect2> +<refsect2 id="DBUSMENU-MENUITEM-PROP-ENABLED:CAPS" role="macro"> +<title>DBUSMENU_MENUITEM_PROP_ENABLED</title> +<indexterm zone="DBUSMENU-MENUITEM-PROP-ENABLED:CAPS"><primary>DBUSMENU_MENUITEM_PROP_ENABLED</primary></indexterm> +<programlisting>#define DBUSMENU_MENUITEM_PROP_ENABLED "enabled" +</programlisting> +<para> +</para></refsect2> +<refsect2 id="DBUSMENU-MENUITEM-PROP-LABEL:CAPS" role="macro"> +<title>DBUSMENU_MENUITEM_PROP_LABEL</title> +<indexterm zone="DBUSMENU-MENUITEM-PROP-LABEL:CAPS"><primary>DBUSMENU_MENUITEM_PROP_LABEL</primary></indexterm> +<programlisting>#define DBUSMENU_MENUITEM_PROP_LABEL "label" +</programlisting> +<para> +</para></refsect2> +<refsect2 id="DBUSMENU-MENUITEM-PROP-ICON-NAME:CAPS" role="macro"> +<title>DBUSMENU_MENUITEM_PROP_ICON_NAME</title> +<indexterm zone="DBUSMENU-MENUITEM-PROP-ICON-NAME:CAPS"><primary>DBUSMENU_MENUITEM_PROP_ICON_NAME</primary></indexterm> +<programlisting>#define DBUSMENU_MENUITEM_PROP_ICON_NAME "icon-name" +</programlisting> +<para> +</para></refsect2> +<refsect2 id="DBUSMENU-MENUITEM-PROP-ICON-DATA:CAPS" role="macro"> +<title>DBUSMENU_MENUITEM_PROP_ICON_DATA</title> +<indexterm zone="DBUSMENU-MENUITEM-PROP-ICON-DATA:CAPS"><primary>DBUSMENU_MENUITEM_PROP_ICON_DATA</primary></indexterm> +<programlisting>#define DBUSMENU_MENUITEM_PROP_ICON_DATA "icon-data" +</programlisting> +<para> +</para></refsect2> +<refsect2 id="DBUSMENU-MENUITEM-PROP-TOGGLE-TYPE:CAPS" role="macro"> +<title>DBUSMENU_MENUITEM_PROP_TOGGLE_TYPE</title> +<indexterm zone="DBUSMENU-MENUITEM-PROP-TOGGLE-TYPE:CAPS"><primary>DBUSMENU_MENUITEM_PROP_TOGGLE_TYPE</primary></indexterm> +<programlisting>#define DBUSMENU_MENUITEM_PROP_TOGGLE_TYPE "toggle-type" +</programlisting> +<para> +</para></refsect2> +<refsect2 id="DBUSMENU-MENUITEM-PROP-TOGGLE-STATE:CAPS" role="macro"> +<title>DBUSMENU_MENUITEM_PROP_TOGGLE_STATE</title> +<indexterm zone="DBUSMENU-MENUITEM-PROP-TOGGLE-STATE:CAPS"><primary>DBUSMENU_MENUITEM_PROP_TOGGLE_STATE</primary></indexterm> +<programlisting>#define DBUSMENU_MENUITEM_PROP_TOGGLE_STATE "toggle-state" +</programlisting> +<para> +</para></refsect2> +<refsect2 id="DBUSMENU-MENUITEM-TOGGLE-CHECK:CAPS" role="macro"> +<title>DBUSMENU_MENUITEM_TOGGLE_CHECK</title> +<indexterm zone="DBUSMENU-MENUITEM-TOGGLE-CHECK:CAPS"><primary>DBUSMENU_MENUITEM_TOGGLE_CHECK</primary></indexterm> +<programlisting>#define DBUSMENU_MENUITEM_TOGGLE_CHECK "checkmark" +</programlisting> +<para> +</para></refsect2> +<refsect2 id="DBUSMENU-MENUITEM-TOGGLE-RADIO:CAPS" role="macro"> +<title>DBUSMENU_MENUITEM_TOGGLE_RADIO</title> +<indexterm zone="DBUSMENU-MENUITEM-TOGGLE-RADIO:CAPS"><primary>DBUSMENU_MENUITEM_TOGGLE_RADIO</primary></indexterm> +<programlisting>#define DBUSMENU_MENUITEM_TOGGLE_RADIO "radio" +</programlisting> +<para> +</para></refsect2> +<refsect2 id="DBUSMENU-MENUITEM-TOGGLE-STATE-UNCHECKED:CAPS" role="macro"> +<title>DBUSMENU_MENUITEM_TOGGLE_STATE_UNCHECKED</title> +<indexterm zone="DBUSMENU-MENUITEM-TOGGLE-STATE-UNCHECKED:CAPS"><primary>DBUSMENU_MENUITEM_TOGGLE_STATE_UNCHECKED</primary></indexterm> +<programlisting>#define DBUSMENU_MENUITEM_TOGGLE_STATE_UNCHECKED 0 +</programlisting> +<para> +</para></refsect2> +<refsect2 id="DBUSMENU-MENUITEM-TOGGLE-STATE-CHECKED:CAPS" role="macro"> +<title>DBUSMENU_MENUITEM_TOGGLE_STATE_CHECKED</title> +<indexterm zone="DBUSMENU-MENUITEM-TOGGLE-STATE-CHECKED:CAPS"><primary>DBUSMENU_MENUITEM_TOGGLE_STATE_CHECKED</primary></indexterm> +<programlisting>#define DBUSMENU_MENUITEM_TOGGLE_STATE_CHECKED 1 +</programlisting> +<para> +</para></refsect2> +<refsect2 id="DBUSMENU-MENUITEM-TOGGLE-STATE-UNKNOWN:CAPS" role="macro"> +<title>DBUSMENU_MENUITEM_TOGGLE_STATE_UNKNOWN</title> +<indexterm zone="DBUSMENU-MENUITEM-TOGGLE-STATE-UNKNOWN:CAPS"><primary>DBUSMENU_MENUITEM_TOGGLE_STATE_UNKNOWN</primary></indexterm> +<programlisting>#define DBUSMENU_MENUITEM_TOGGLE_STATE_UNKNOWN -1 +</programlisting> +<para> +</para></refsect2> +<refsect2 id="DBUSMENU-MENUITEM-ICON-NAME-BLANK:CAPS" role="macro"> +<title>DBUSMENU_MENUITEM_ICON_NAME_BLANK</title> +<indexterm zone="DBUSMENU-MENUITEM-ICON-NAME-BLANK:CAPS"><primary>DBUSMENU_MENUITEM_ICON_NAME_BLANK</primary></indexterm> +<programlisting>#define DBUSMENU_MENUITEM_ICON_NAME_BLANK "blank-icon" +</programlisting> +<para> +</para></refsect2> +<refsect2 id="DbusmenuMenuitem-struct" role="struct"> +<title>DbusmenuMenuitem</title> +<indexterm zone="DbusmenuMenuitem-struct"><primary>DbusmenuMenuitem</primary></indexterm> +<programlisting>typedef struct _DbusmenuMenuitem DbusmenuMenuitem;</programlisting> +<para> +This is the <link linkend="GObject"><type>GObject</type></link> 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. +</para></refsect2> +<refsect2 id="dbusmenu-menuitem-about-to-show-cb" role="function"> +<title>dbusmenu_menuitem_about_to_show_cb ()</title> +<indexterm zone="dbusmenu-menuitem-about-to-show-cb"><primary>dbusmenu_menuitem_about_to_show_cb</primary></indexterm> +<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> (*dbusmenu_menuitem_about_to_show_cb) + (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, + <parameter><link linkend="gpointer"><type>gpointer</type></link> user_data</parameter>);</programlisting> +<para> +Callback prototype for a callback that is called when the +menu should be shown. +</para><variablelist role="params"> +<varlistentry><term><parameter>mi</parameter> :</term> +<listitem><simpara>Menu item that should be shown +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>user_data</parameter> :</term> +<listitem><simpara> Extra user data sent with the function. closure</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="dbusmenu-menuitem-buildxml-slot-t" role="function"> +<title>dbusmenu_menuitem_buildxml_slot_t ()</title> +<indexterm zone="dbusmenu-menuitem-buildxml-slot-t"><primary>dbusmenu_menuitem_buildxml_slot_t</primary></indexterm> +<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> (*dbusmenu_menuitem_buildxml_slot_t) + (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, + <parameter><link linkend="GPtrArray"><type>GPtrArray</type></link> *stringarray</parameter>);</programlisting> +<para> +This is the function that is called to represent this menu item +as an XML fragment. Should call it's own children. +</para><variablelist role="params"> +<varlistentry><term><parameter>mi</parameter> :</term> +<listitem><simpara> Menu item that should be built from. <acronym>in</acronym>. </simpara></listitem></varlistentry> +<varlistentry><term><parameter>stringarray</parameter> :</term> +<listitem><simpara> An array of strings that can be combined into an XML file.. <acronym>inout</acronym>. <acronym>transfer none</acronym>. <acronym>array</acronym>. <acronym>element-type</acronym> utf8. </simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="DbusmenuMenuitemClass" role="struct"> +<title>DbusmenuMenuitemClass</title> +<indexterm zone="DbusmenuMenuitemClass"><primary>DbusmenuMenuitemClass</primary></indexterm> +<programlisting>typedef struct { + GObjectClass parent_class; + + /* Signals */ + void (*property_changed) (gchar * property, GValue * 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_buildxml_slot_t buildxml; + void (*handle_event) (DbusmenuMenuitem * mi, const gchar * name, const GValue * value, guint timestamp); + void (*send_about_to_show) (DbusmenuMenuitem * mi, dbusmenu_menuitem_about_to_show_cb cb, gpointer cb_data); + + void (*reserved1) (void); + /* void (*reserved2) (void); */ + /* void (*reserved3) (void); */ + /* void (*reserved4) (void); -- realized, realloc when bumping lib version */ +} DbusmenuMenuitemClass; +</programlisting> +<variablelist role="struct"> +<varlistentry><term><link linkend="GObjectClass"><type>GObjectClass</type></link> <structfield id="DbusmenuMenuitemClass.parent-class">parent_class</structfield>;</term> +<listitem><simpara> +</simpara></listitem> +</varlistentry> +<varlistentry><term><structfield id="DbusmenuMenuitemClass.property-changed">property_changed</structfield> ()</term> +<listitem><simpara>Slot for <link linkend="DbusmenuMenuitem-property-changed"><type>"property-changed"</type></link>. +</simpara></listitem> +</varlistentry> +<varlistentry><term><structfield id="DbusmenuMenuitemClass.item-activated">item_activated</structfield> ()</term> +<listitem><simpara>Slot for <link linkend="DbusmenuMenuitem-item-activated"><type>"item-activated"</type></link>. +</simpara></listitem> +</varlistentry> +<varlistentry><term><structfield id="DbusmenuMenuitemClass.child-added">child_added</structfield> ()</term> +<listitem><simpara>Slot for <link linkend="DbusmenuMenuitem-child-added"><type>"child-added"</type></link>. +</simpara></listitem> +</varlistentry> +<varlistentry><term><structfield id="DbusmenuMenuitemClass.child-removed">child_removed</structfield> ()</term> +<listitem><simpara>Slot for <link linkend="DbusmenuMenuitem-child-removed"><type>"child-removed"</type></link>. +</simpara></listitem> +</varlistentry> +<varlistentry><term><structfield id="DbusmenuMenuitemClass.child-moved">child_moved</structfield> ()</term> +<listitem><simpara>Slot for <link linkend="DbusmenuMenuitem-child-moved"><type>"child-moved"</type></link>. +</simpara></listitem> +</varlistentry> +<varlistentry><term><structfield id="DbusmenuMenuitemClass.realized">realized</structfield> ()</term> +<listitem><simpara>Slot for <link linkend="DbusmenuMenuitem-realized"><type>"realized"</type></link>. +</simpara></listitem> +</varlistentry> +<varlistentry><term><link linkend="dbusmenu-menuitem-buildxml-slot-t"><type>dbusmenu_menuitem_buildxml_slot_t</type></link> <structfield id="DbusmenuMenuitemClass.buildxml">buildxml</structfield>;</term> +<listitem><simpara>Virtual function that appends the strings required to represent this menu item in the menu XML file. +</simpara></listitem> +</varlistentry> +<varlistentry><term><structfield id="DbusmenuMenuitemClass.handle-event">handle_event</structfield> ()</term> +<listitem><simpara>This function is to override how events are handled by subclasses. Look at <link linkend="dbusmenu-menuitem-handle-event"><type>dbusmenu_menuitem_handle_event</type></link> for lots of good information. +</simpara></listitem> +</varlistentry> +<varlistentry><term><structfield id="DbusmenuMenuitemClass.send-about-to-show">send_about_to_show</structfield> ()</term> +<listitem><simpara>Virtual function that notifies server that the client is about to show a menu. +</simpara></listitem> +</varlistentry> +<varlistentry><term><structfield id="DbusmenuMenuitemClass.reserved1">reserved1</structfield> ()</term> +<listitem><simpara>Reserved for future use. +</simpara></listitem> +</varlistentry> +</variablelist></refsect2> +<refsect2 id="dbusmenu-menuitem-new" role="function"> +<title>dbusmenu_menuitem_new ()</title> +<indexterm zone="dbusmenu-menuitem-new"><primary>dbusmenu_menuitem_new</primary></indexterm> +<programlisting><link linkend="DbusmenuMenuitem"><returnvalue>DbusmenuMenuitem</returnvalue></link> * dbusmenu_menuitem_new (<parameter><type>void</type></parameter>);</programlisting> +<para> +Create a new <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> with all default values. +</para><variablelist role="params"> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A newly allocated <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link>. +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="dbusmenu-menuitem-new-with-id" role="function"> +<title>dbusmenu_menuitem_new_with_id ()</title> +<indexterm zone="dbusmenu-menuitem-new-with-id"><primary>dbusmenu_menuitem_new_with_id</primary></indexterm> +<programlisting><link linkend="DbusmenuMenuitem"><returnvalue>DbusmenuMenuitem</returnvalue></link> * dbusmenu_menuitem_new_with_id (<parameter><link linkend="gint"><type>gint</type></link> id</parameter>);</programlisting> +<para> +This creates a blank <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> with a specific ID. +</para><variablelist role="params"> +<varlistentry><term><parameter>id</parameter> :</term> +<listitem><simpara>ID to use for this menuitem +</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A newly allocated <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link>. +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="dbusmenu-menuitem-get-id" role="function"> +<title>dbusmenu_menuitem_get_id ()</title> +<indexterm zone="dbusmenu-menuitem-get-id"><primary>dbusmenu_menuitem_get_id</primary></indexterm> +<programlisting><link linkend="gint"><returnvalue>gint</returnvalue></link> dbusmenu_menuitem_get_id (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>);</programlisting> +<para> +Gets the unique ID for <parameter>mi</parameter>. +</para><variablelist role="params"> +<varlistentry><term><parameter>mi</parameter> :</term> +<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to query. +</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The ID of the <parameter>mi</parameter>. +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="dbusmenu-menuitem-get-children" role="function"> +<title>dbusmenu_menuitem_get_children ()</title> +<indexterm zone="dbusmenu-menuitem-get-children"><primary>dbusmenu_menuitem_get_children</primary></indexterm> +<programlisting><link linkend="GList"><returnvalue>GList</returnvalue></link> * dbusmenu_menuitem_get_children (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>);</programlisting> +<para> +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. +</para><variablelist role="params"> +<varlistentry><term><parameter>mi</parameter> :</term> +<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to query. +</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A <link linkend="GList"><type>GList</type></link> of pointers to <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> objects. +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="dbusmenu-menuitem-take-children" role="function"> +<title>dbusmenu_menuitem_take_children ()</title> +<indexterm zone="dbusmenu-menuitem-take-children"><primary>dbusmenu_menuitem_take_children</primary></indexterm> +<programlisting><link linkend="GList"><returnvalue>GList</returnvalue></link> * dbusmenu_menuitem_take_children (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>);</programlisting> +<para> +While the name sounds devious that's exactly what this function + does. It takes the list of children from the <parameter>mi</parameter> 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. +</para><variablelist role="params"> +<varlistentry><term><parameter>mi</parameter> :</term> +<listitem><simpara>The <link linkend="DbusmenMenuitem"><type>DbusmenMenuitem</type></link> to take the children from. +</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A <link linkend="GList"><type>GList</type></link> of pointers to <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> objects. +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="dbusmenu-menuitem-get-position" role="function"> +<title>dbusmenu_menuitem_get_position ()</title> +<indexterm zone="dbusmenu-menuitem-get-position"><primary>dbusmenu_menuitem_get_position</primary></indexterm> +<programlisting><link linkend="guint"><returnvalue>guint</returnvalue></link> dbusmenu_menuitem_get_position (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, + <parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *parent</parameter>);</programlisting> +<para> +This function returns the position of the menu item <parameter>mi</parameter> + in the children of <parameter>parent</parameter>. It will return zero if the + menu item can't be found. +</para><variablelist role="params"> +<varlistentry><term><parameter>mi</parameter> :</term> +<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to find the position of +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>parent</parameter> :</term> +<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> who's children contain <parameter>mi</parameter> +</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The position of <parameter>mi</parameter> in the children of <parameter>parent</parameter>. +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="dbusmenu-menuitem-get-position-realized" role="function"> +<title>dbusmenu_menuitem_get_position_realized ()</title> +<indexterm zone="dbusmenu-menuitem-get-position-realized"><primary>dbusmenu_menuitem_get_position_realized</primary></indexterm> +<programlisting><link linkend="guint"><returnvalue>guint</returnvalue></link> dbusmenu_menuitem_get_position_realized + (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, + <parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *parent</parameter>);</programlisting> +<para> +This function is very similar to <link linkend="dbusmenu-menuitem-get-position"><type>dbusmenu_menuitem_get_position</type></link> + except that it only counts in the children that have been realized. +</para><variablelist role="params"> +<varlistentry><term><parameter>mi</parameter> :</term> +<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to find the position of +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>parent</parameter> :</term> +<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> who's children contain <parameter>mi</parameter> +</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The position of <parameter>mi</parameter> in the realized children of <parameter>parent</parameter>. +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="dbusmenu-menuitem-child-append" role="function"> +<title>dbusmenu_menuitem_child_append ()</title> +<indexterm zone="dbusmenu-menuitem-child-append"><primary>dbusmenu_menuitem_child_append</primary></indexterm> +<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> dbusmenu_menuitem_child_append (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, + <parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *child</parameter>);</programlisting> +<para> +This function adds <parameter>child</parameter> to the list of children on <parameter>mi</parameter> at + the end of that list. +</para><variablelist role="params"> +<varlistentry><term><parameter>mi</parameter> :</term> +<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> which will become a new parent +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>child</parameter> :</term> +<listitem><simpara>The <link linkend="DbusmenMenuitem"><type>DbusmenMenuitem</type></link> that will be a child +</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Whether the child has been added successfully. +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="dbusmenu-menuitem-child-prepend" role="function"> +<title>dbusmenu_menuitem_child_prepend ()</title> +<indexterm zone="dbusmenu-menuitem-child-prepend"><primary>dbusmenu_menuitem_child_prepend</primary></indexterm> +<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> dbusmenu_menuitem_child_prepend (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, + <parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *child</parameter>);</programlisting> +<para> +This function adds <parameter>child</parameter> to the list of children on <parameter>mi</parameter> at + the beginning of that list. +</para><variablelist role="params"> +<varlistentry><term><parameter>mi</parameter> :</term> +<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> which will become a new parent +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>child</parameter> :</term> +<listitem><simpara>The <link linkend="DbusmenMenuitem"><type>DbusmenMenuitem</type></link> that will be a child +</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Whether the child has been added successfully. +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="dbusmenu-menuitem-child-delete" role="function"> +<title>dbusmenu_menuitem_child_delete ()</title> +<indexterm zone="dbusmenu-menuitem-child-delete"><primary>dbusmenu_menuitem_child_delete</primary></indexterm> +<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> dbusmenu_menuitem_child_delete (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, + <parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *child</parameter>);</programlisting> +<para> +This function removes <parameter>child</parameter> from the children list of <parameter>mi</parameter>. It does + not call <link linkend="g-object-unref"><type>g_object_unref</type></link> on <parameter>child</parameter>. +</para><variablelist role="params"> +<varlistentry><term><parameter>mi</parameter> :</term> +<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> which has <parameter>child</parameter> as a child +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>child</parameter> :</term> +<listitem><simpara>The child <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> that you want to no longer + be a child of <parameter>mi</parameter>. +</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> If we were able to delete <parameter>child</parameter>. +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="dbusmenu-menuitem-child-add-position" role="function"> +<title>dbusmenu_menuitem_child_add_position ()</title> +<indexterm zone="dbusmenu-menuitem-child-add-position"><primary>dbusmenu_menuitem_child_add_position</primary></indexterm> +<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> dbusmenu_menuitem_child_add_position + (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, + <parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *child</parameter>, + <parameter><link linkend="guint"><type>guint</type></link> position</parameter>);</programlisting> +<para> +Puts <parameter>child</parameter> in the list of children for <parameter>mi</parameter> at the location + specified in <parameter>position</parameter>. If there is not enough entires available + then <parameter>child</parameter> will be placed at the end of the list. +</para><variablelist role="params"> +<varlistentry><term><parameter>mi</parameter> :</term> +<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> that we're adding the child <parameter>child</parameter> to. +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>child</parameter> :</term> +<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to make a child of <parameter>mi</parameter>. +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>position</parameter> :</term> +<listitem><simpara>Where in <parameter>mi</parameter> object's list of chidren <parameter>child</parameter> should be placed. +</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Whether <parameter>child</parameter> was added successfully. +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="dbusmenu-menuitem-child-reorder" role="function"> +<title>dbusmenu_menuitem_child_reorder ()</title> +<indexterm zone="dbusmenu-menuitem-child-reorder"><primary>dbusmenu_menuitem_child_reorder</primary></indexterm> +<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> dbusmenu_menuitem_child_reorder (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, + <parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *child</parameter>, + <parameter><link linkend="guint"><type>guint</type></link> position</parameter>);</programlisting> +<para> +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. +</para><variablelist role="params"> +<varlistentry><term><parameter>mi</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>child</parameter> :</term> +<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> that is a child needing to be moved +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>position</parameter> :</term> +<listitem><simpara>The position in the list to place it in +</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Whether the move was successful. +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="dbusmenu-menuitem-child-find" role="function"> +<title>dbusmenu_menuitem_child_find ()</title> +<indexterm zone="dbusmenu-menuitem-child-find"><primary>dbusmenu_menuitem_child_find</primary></indexterm> +<programlisting><link linkend="DbusmenuMenuitem"><returnvalue>DbusmenuMenuitem</returnvalue></link> * dbusmenu_menuitem_child_find (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, + <parameter><link linkend="gint"><type>gint</type></link> id</parameter>);</programlisting> +<para> +Search the children of <parameter>mi</parameter> to find one with the ID of <parameter>id</parameter>. + If it doesn't exist then we return <link linkend="NULL:CAPS"><type>NULL</type></link>. +</para><variablelist role="params"> +<varlistentry><term><parameter>mi</parameter> :</term> +<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> who's children to look on +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>id</parameter> :</term> +<listitem><simpara>The ID of the child that we're looking for. +</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The menu item with the ID <parameter>id</parameter> or <link linkend="NULL:CAPS"><type>NULL</type></link> if it + can't be found. +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="dbusmenu-menuitem-find-id" role="function"> +<title>dbusmenu_menuitem_find_id ()</title> +<indexterm zone="dbusmenu-menuitem-find-id"><primary>dbusmenu_menuitem_find_id</primary></indexterm> +<programlisting><link linkend="DbusmenuMenuitem"><returnvalue>DbusmenuMenuitem</returnvalue></link> * dbusmenu_menuitem_find_id (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, + <parameter><link linkend="gint"><type>gint</type></link> id</parameter>);</programlisting> +<para> +This function searchs the whole tree of children that + are attached to <parameter>mi</parameter>. This could be quite a few nodes, all + the way down the tree. It is a depth first search. +</para><variablelist role="params"> +<varlistentry><term><parameter>mi</parameter> :</term> +<listitem><simpara><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> at the top of the tree to search +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>id</parameter> :</term> +<listitem><simpara>ID of the <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to search for +</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> with the ID of <parameter>id</parameter> + or <link linkend="NULL:CAPS"><type>NULL</type></link> if there isn't such a menu item in the tree + represented by <parameter>mi</parameter>. +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="dbusmenu-menuitem-property-set" role="function"> +<title>dbusmenu_menuitem_property_set ()</title> +<indexterm zone="dbusmenu-menuitem-property-set"><primary>dbusmenu_menuitem_property_set</primary></indexterm> +<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> dbusmenu_menuitem_property_set (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, + <parameter>const <link linkend="gchar"><type>gchar</type></link> *property</parameter>, + <parameter>const <link linkend="gchar"><type>gchar</type></link> *value</parameter>);</programlisting> +<para> +Takes the pair of <parameter>property</parameter> and <parameter>value</parameter> and places them as a + property on <parameter>mi</parameter>. 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 <link linkend="DbusmenuMenuitem-prop-changed"><type>"prop-changed"</type></link> will be + emitted by this function. +</para><variablelist role="params"> +<varlistentry><term><parameter>mi</parameter> :</term> +<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to set the property on. +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>property</parameter> :</term> +<listitem><simpara>Name of the property to set. +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>value</parameter> :</term> +<listitem><simpara>The value of the property. +</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A boolean representing if the property value was set. +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="dbusmenu-menuitem-property-set-value" role="function"> +<title>dbusmenu_menuitem_property_set_value ()</title> +<indexterm zone="dbusmenu-menuitem-property-set-value"><primary>dbusmenu_menuitem_property_set_value</primary></indexterm> +<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> dbusmenu_menuitem_property_set_value + (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, + <parameter>const <link linkend="gchar"><type>gchar</type></link> *property</parameter>, + <parameter>const <link linkend="GValue"><type>GValue</type></link> *value</parameter>);</programlisting> +<para> +</para><variablelist role="params"> +<varlistentry><term><parameter>mi</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>property</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>value</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="dbusmenu-menuitem-property-set-bool" role="function"> +<title>dbusmenu_menuitem_property_set_bool ()</title> +<indexterm zone="dbusmenu-menuitem-property-set-bool"><primary>dbusmenu_menuitem_property_set_bool</primary></indexterm> +<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> dbusmenu_menuitem_property_set_bool (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, + <parameter>const <link linkend="gchar"><type>gchar</type></link> *property</parameter>, + <parameter>const <link linkend="gboolean"><type>gboolean</type></link> value</parameter>);</programlisting> +<para> +Takes a boolean <parameter>value</parameter> and sets it on <parameter>property</parameter> as a + property on <parameter>mi</parameter>. 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 <link linkend="DbusmenuMenuitem-prop-changed"><type>"prop-changed"</type></link> will be + emitted by this function. +</para><variablelist role="params"> +<varlistentry><term><parameter>mi</parameter> :</term> +<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to set the property on. +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>property</parameter> :</term> +<listitem><simpara>Name of the property to set. +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>value</parameter> :</term> +<listitem><simpara>The value of the property. +</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A boolean representing if the property value was set. +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="dbusmenu-menuitem-property-set-int" role="function"> +<title>dbusmenu_menuitem_property_set_int ()</title> +<indexterm zone="dbusmenu-menuitem-property-set-int"><primary>dbusmenu_menuitem_property_set_int</primary></indexterm> +<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> dbusmenu_menuitem_property_set_int (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, + <parameter>const <link linkend="gchar"><type>gchar</type></link> *property</parameter>, + <parameter>const <link linkend="gint"><type>gint</type></link> value</parameter>);</programlisting> +<para> +Takes a boolean <parameter>value</parameter> and sets it on <parameter>property</parameter> as a + property on <parameter>mi</parameter>. 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 <link linkend="DbusmenuMenuitem-prop-changed"><type>"prop-changed"</type></link> will be + emitted by this function. +</para><variablelist role="params"> +<varlistentry><term><parameter>mi</parameter> :</term> +<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to set the property on. +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>property</parameter> :</term> +<listitem><simpara>Name of the property to set. +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>value</parameter> :</term> +<listitem><simpara>The value of the property. +</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A boolean representing if the property value was set. +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="dbusmenu-menuitem-property-get" role="function"> +<title>dbusmenu_menuitem_property_get ()</title> +<indexterm zone="dbusmenu-menuitem-property-get"><primary>dbusmenu_menuitem_property_get</primary></indexterm> +<programlisting>const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * dbusmenu_menuitem_property_get (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, + <parameter>const <link linkend="gchar"><type>gchar</type></link> *property</parameter>);</programlisting> +<para> +Look up a property on <parameter>mi</parameter> and return the value of it if + it exits. <link linkend="NULL:CAPS"><type>NULL</type></link> will be returned if the property doesn't + exist. +</para><variablelist role="params"> +<varlistentry><term><parameter>mi</parameter> :</term> +<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to look for the property on. +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>property</parameter> :</term> +<listitem><simpara>The property to grab. +</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A string with the value of the property + that shouldn't be free'd. Or <link linkend="NULL:CAPS"><type>NULL</type></link> if the property + is not set or is not a string. +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="dbusmenu-menuitem-property-get-value" role="function"> +<title>dbusmenu_menuitem_property_get_value ()</title> +<indexterm zone="dbusmenu-menuitem-property-get-value"><primary>dbusmenu_menuitem_property_get_value</primary></indexterm> +<programlisting>const <link linkend="GValue"><returnvalue>GValue</returnvalue></link> * dbusmenu_menuitem_property_get_value + (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, + <parameter>const <link linkend="gchar"><type>gchar</type></link> *property</parameter>);</programlisting> +<para> +Look up a property on <parameter>mi</parameter> and return the value of it if + it exits. <link linkend="NULL:CAPS"><type>NULL</type></link> will be returned if the property doesn't + exist. +</para><variablelist role="params"> +<varlistentry><term><parameter>mi</parameter> :</term> +<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to look for the property on. +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>property</parameter> :</term> +<listitem><simpara>The property to grab. +</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A GValue for the property. +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="dbusmenu-menuitem-property-get-bool" role="function"> +<title>dbusmenu_menuitem_property_get_bool ()</title> +<indexterm zone="dbusmenu-menuitem-property-get-bool"><primary>dbusmenu_menuitem_property_get_bool</primary></indexterm> +<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> dbusmenu_menuitem_property_get_bool (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, + <parameter>const <link linkend="gchar"><type>gchar</type></link> *property</parameter>);</programlisting> +<para> +Look up a property on <parameter>mi</parameter> and return the value of it if + it exits. Returns <link linkend="FALSE:CAPS"><type>FALSE</type></link> if the property doesn't exist. +</para><variablelist role="params"> +<varlistentry><term><parameter>mi</parameter> :</term> +<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to look for the property on. +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>property</parameter> :</term> +<listitem><simpara>The property to grab. +</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The value of the property or <link linkend="FALSE:CAPS"><type>FALSE</type></link>. +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="dbusmenu-menuitem-property-get-int" role="function"> +<title>dbusmenu_menuitem_property_get_int ()</title> +<indexterm zone="dbusmenu-menuitem-property-get-int"><primary>dbusmenu_menuitem_property_get_int</primary></indexterm> +<programlisting><link linkend="gint"><returnvalue>gint</returnvalue></link> dbusmenu_menuitem_property_get_int (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, + <parameter>const <link linkend="gchar"><type>gchar</type></link> *property</parameter>);</programlisting> +<para> +Look up a property on <parameter>mi</parameter> and return the value of it if + it exits. Returns zero if the property doesn't exist. +</para><variablelist role="params"> +<varlistentry><term><parameter>mi</parameter> :</term> +<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to look for the property on. +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>property</parameter> :</term> +<listitem><simpara>The property to grab. +</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The value of the property or zero. +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="dbusmenu-menuitem-property-exist" role="function"> +<title>dbusmenu_menuitem_property_exist ()</title> +<indexterm zone="dbusmenu-menuitem-property-exist"><primary>dbusmenu_menuitem_property_exist</primary></indexterm> +<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> dbusmenu_menuitem_property_exist (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, + <parameter>const <link linkend="gchar"><type>gchar</type></link> *property</parameter>);</programlisting> +<para> +</para><variablelist role="params"> +<varlistentry><term><parameter>mi</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>property</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="dbusmenu-menuitem-properties-list" role="function"> +<title>dbusmenu_menuitem_properties_list ()</title> +<indexterm zone="dbusmenu-menuitem-properties-list"><primary>dbusmenu_menuitem_properties_list</primary></indexterm> +<programlisting><link linkend="GList"><returnvalue>GList</returnvalue></link> * dbusmenu_menuitem_properties_list (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>);</programlisting> +<para> +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 + <link linkend="g-list-free"><function>g_list_free()</function></link> when the calling function is done with it. +</para><variablelist role="params"> +<varlistentry><term><parameter>mi</parameter> :</term> +<listitem><simpara><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to list the properties on +</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A list of strings or NULL if there are none. +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="dbusmenu-menuitem-properties-copy" role="function"> +<title>dbusmenu_menuitem_properties_copy ()</title> +<indexterm zone="dbusmenu-menuitem-properties-copy"><primary>dbusmenu_menuitem_properties_copy</primary></indexterm> +<programlisting><link linkend="GHashTable"><returnvalue>GHashTable</returnvalue></link> * dbusmenu_menuitem_properties_copy (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>);</programlisting> +<para> +This function takes the properties of a <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> + and puts them into a <link linkend="GHashTable"><type>GHashTable</type></link> 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 <link linkend="GHashTable"><type>GHashTable</type></link>. +</para><variablelist role="params"> +<varlistentry><term><parameter>mi</parameter> :</term> +<listitem><simpara><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> that we're interested in the properties of +</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A brand new <link linkend="GHashTable"><type>GHashTable</type></link> that contains all of the + properties that are on this <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> <parameter>mi</parameter>. +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="dbusmenu-menuitem-property-remove" role="function"> +<title>dbusmenu_menuitem_property_remove ()</title> +<indexterm zone="dbusmenu-menuitem-property-remove"><primary>dbusmenu_menuitem_property_remove</primary></indexterm> +<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> dbusmenu_menuitem_property_remove (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, + <parameter>const <link linkend="gchar"><type>gchar</type></link> *property</parameter>);</programlisting> +<para> +Removes a property from the menuitem. +</para><variablelist role="params"> +<varlistentry><term><parameter>mi</parameter> :</term> +<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to remove the property on. +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>property</parameter> :</term> +<listitem><simpara>The property to look for. +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="dbusmenu-menuitem-set-root" role="function"> +<title>dbusmenu_menuitem_set_root ()</title> +<indexterm zone="dbusmenu-menuitem-set-root"><primary>dbusmenu_menuitem_set_root</primary></indexterm> +<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> dbusmenu_menuitem_set_root (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, + <parameter><link linkend="gboolean"><type>gboolean</type></link> root</parameter>);</programlisting> +<para> +This function sets the internal value of whether this is a + root node or not. +</para><variablelist role="params"> +<varlistentry><term><parameter>mi</parameter> :</term> +<listitem><simpara><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to set whether it's root +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>root</parameter> :</term> +<listitem><simpara>Whether <parameter>mi</parameter> is a root node or not +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="dbusmenu-menuitem-get-root" role="function"> +<title>dbusmenu_menuitem_get_root ()</title> +<indexterm zone="dbusmenu-menuitem-get-root"><primary>dbusmenu_menuitem_get_root</primary></indexterm> +<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> dbusmenu_menuitem_get_root (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>);</programlisting> +<para> +This function returns the internal value of whether this is a + root node or not. +</para><variablelist role="params"> +<varlistentry><term><parameter>mi</parameter> :</term> +<listitem><simpara><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to see whether it's root +</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><type>TRUE</type></link> if this is a root node +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="dbusmenu-menuitem-foreach" role="function"> +<title>dbusmenu_menuitem_foreach ()</title> +<indexterm zone="dbusmenu-menuitem-foreach"><primary>dbusmenu_menuitem_foreach</primary></indexterm> +<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> dbusmenu_menuitem_foreach (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, + <parameter><link linkend="void"><type>void</type></link> (funcDbusmenuMenuitem * mi, gpointer data) ()</parameter>, + <parameter><link linkend="gpointer"><type>gpointer</type></link> data</parameter>);</programlisting> +<para> +This calls the function <parameter>func</parameter> 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. +</para><variablelist role="params"> +<varlistentry><term><parameter>mi</parameter> :</term> +<listitem><simpara>The <link linkend="DbusmenItem"><type>DbusmenItem</type></link> to start from +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>data</parameter> :</term> +<listitem><simpara> User data to pass to the function. closure</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="dbusmenu-menuitem-handle-event" role="function"> +<title>dbusmenu_menuitem_handle_event ()</title> +<indexterm zone="dbusmenu-menuitem-handle-event"><primary>dbusmenu_menuitem_handle_event</primary></indexterm> +<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> dbusmenu_menuitem_handle_event (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, + <parameter>const <link linkend="gchar"><type>gchar</type></link> *name</parameter>, + <parameter>const <link linkend="GValue"><type>GValue</type></link> *value</parameter>, + <parameter><link linkend="guint"><type>guint</type></link> timestamp</parameter>);</programlisting> +<para> +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: +</para> +<para> + Emits the <link linkend="DbusmenuMenuitem-item-activate"><type>"item-activate"</type></link> signal on this + menu item. Called by server objects when they get the + appropriate DBus signals from the client. +</para> +<para> + If you subclass this function you should really think + about calling the parent function unless you have a good + reason not to. +</para><variablelist role="params"> +<varlistentry><term><parameter>mi</parameter> :</term> +<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to send the signal on. +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>name</parameter> :</term> +<listitem><simpara>The name of the signal +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>value</parameter> :</term> +<listitem><simpara>A value that could be set for the event +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>timestamp</parameter> :</term> +<listitem><simpara>The timestamp of when the event happened +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="dbusmenu-menuitem-send-about-to-show" role="function"> +<title>dbusmenu_menuitem_send_about_to_show ()</title> +<indexterm zone="dbusmenu-menuitem-send-about-to-show"><primary>dbusmenu_menuitem_send_about_to_show</primary></indexterm> +<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> dbusmenu_menuitem_send_about_to_show + (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *mi</parameter>, + <parameter><link linkend="dbusmenu-menuitem-about-to-show-cb"><type>dbusmenu_menuitem_about_to_show_cb</type></link> cb</parameter>, + <parameter><link linkend="gpointer"><type>gpointer</type></link> cb_data</parameter>);</programlisting> +<para> +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. +</para><variablelist role="params"> +<varlistentry><term><parameter>mi</parameter> :</term> +<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to send the signal on. +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>cb</parameter> :</term> +<listitem><simpara>Callback to call when the call has returned. +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>cb_data</parameter> :</term> +<listitem><simpara> Data to pass to the callback.. closure</simpara></listitem></varlistentry> +</variablelist></refsect2> + +</refsect1> +<refsect1 id="DbusmenuMenuitem.property-details" role="property_details"> +<title role="property_details.title">Property Details</title> +<refsect2 id="DbusmenuMenuitem--id" role="property"><title>The <literal>"id"</literal> property</title> +<indexterm zone="DbusmenuMenuitem--id"><primary>DbusmenuMenuitem:id</primary></indexterm> +<programlisting> "id" <link linkend="gint"><type>gint</type></link> : Read / Write / Construct Only</programlisting> +<para>This is a unique indentifier for the menu item.</para><para>Allowed values: [G_MAXULONG,30000]</para> +<para>Default value: -1</para> +</refsect2> +</refsect1> +<refsect1 id="DbusmenuMenuitem.signal-details" role="signals"> +<title role="signals.title">Signal Details</title> +<refsect2 id="DbusmenuMenuitem-child-added" role="signal"><title>The <literal>"child-added"</literal> signal</title> +<indexterm zone="DbusmenuMenuitem-child-added"><primary>DbusmenuMenuitem::child-added</primary></indexterm> +<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> user_function (<link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *arg0, + <link linkend="GObject"><type>GObject</type></link> *arg1, + <link linkend="guint"><type>guint</type></link> arg2, + <link linkend="gpointer"><type>gpointer</type></link> user_data) : Run Last</programlisting> +<para> +Signaled when the child menuitem has been added to + the parent. +</para><variablelist role="params"> +<varlistentry><term><parameter>arg0</parameter> :</term> +<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> which is the parent. +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>arg1</parameter> :</term> +<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> which is the child. +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>arg2</parameter> :</term> +<listitem><simpara>The position that the child is being added in. +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>user_data</parameter> :</term> +<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry> +</variablelist></refsect2><refsect2 id="DbusmenuMenuitem-child-moved" role="signal"><title>The <literal>"child-moved"</literal> signal</title> +<indexterm zone="DbusmenuMenuitem-child-moved"><primary>DbusmenuMenuitem::child-moved</primary></indexterm> +<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> user_function (<link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *arg0, + <link linkend="GObject"><type>GObject</type></link> *arg1, + <link linkend="guint"><type>guint</type></link> arg2, + <link linkend="guint"><type>guint</type></link> arg3, + <link linkend="gpointer"><type>gpointer</type></link> user_data) : Run Last</programlisting> +<para> +Signaled when the child menuitem has had it's location + in the list change. +</para><variablelist role="params"> +<varlistentry><term><parameter>arg0</parameter> :</term> +<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> which is the parent. +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>arg1</parameter> :</term> +<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> which is the child. +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>arg2</parameter> :</term> +<listitem><simpara>The position that the child is being moved to. +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>arg3</parameter> :</term> +<listitem><simpara>The position that the child is was in. +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>user_data</parameter> :</term> +<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry> +</variablelist></refsect2><refsect2 id="DbusmenuMenuitem-child-removed" role="signal"><title>The <literal>"child-removed"</literal> signal</title> +<indexterm zone="DbusmenuMenuitem-child-removed"><primary>DbusmenuMenuitem::child-removed</primary></indexterm> +<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> user_function (<link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *arg0, + <link linkend="GObject"><type>GObject</type></link> *arg1, + <link linkend="gpointer"><type>gpointer</type></link> user_data) : Run Last</programlisting> +<para> +Signaled when the child menuitem has been requested to + be removed from the parent. This signal is called when + it has been removed from the list but not yet had + <link linkend="g-object-unref"><type>g_object_unref</type></link> called on it. +</para><variablelist role="params"> +<varlistentry><term><parameter>arg0</parameter> :</term> +<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> which was the parent. +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>arg1</parameter> :</term> +<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> which was the child. +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>user_data</parameter> :</term> +<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry> +</variablelist></refsect2><refsect2 id="DbusmenuMenuitem-item-activated" role="signal"><title>The <literal>"item-activated"</literal> signal</title> +<indexterm zone="DbusmenuMenuitem-item-activated"><primary>DbusmenuMenuitem::item-activated</primary></indexterm> +<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> user_function (<link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *arg0, + <link linkend="guint"><type>guint</type></link> arg1, + <link linkend="gpointer"><type>gpointer</type></link> user_data) : Run Last</programlisting> +<para> +Emitted on the objects on the server side when + they are signaled on the client side. +</para><variablelist role="params"> +<varlistentry><term><parameter>arg0</parameter> :</term> +<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> object. +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>arg1</parameter> :</term> +<listitem><simpara>The timestamp of when it was activated +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>user_data</parameter> :</term> +<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry> +</variablelist></refsect2><refsect2 id="DbusmenuMenuitem-property-changed" role="signal"><title>The <literal>"property-changed"</literal> signal</title> +<indexterm zone="DbusmenuMenuitem-property-changed"><primary>DbusmenuMenuitem::property-changed</primary></indexterm> +<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> user_function (<link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *arg0, + <link linkend="gchar"><type>gchar</type></link> *arg1, + <link linkend="gpointer"><type>gpointer</type></link> arg2, + <link linkend="gpointer"><type>gpointer</type></link> user_data) : Run Last</programlisting> +<para> +Emitted everytime a property on a menuitem is either + updated or added. +</para><variablelist role="params"> +<varlistentry><term><parameter>arg0</parameter> :</term> +<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> object. +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>arg1</parameter> :</term> +<listitem><simpara>The name of the property that changed +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>arg2</parameter> :</term> +<listitem><simpara>The new value of the property +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>user_data</parameter> :</term> +<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry> +</variablelist></refsect2><refsect2 id="DbusmenuMenuitem-realized" role="signal"><title>The <literal>"realized"</literal> signal</title> +<indexterm zone="DbusmenuMenuitem-realized"><primary>DbusmenuMenuitem::realized</primary></indexterm> +<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> user_function (<link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *arg0, + <link linkend="gpointer"><type>gpointer</type></link> user_data) : Run Last</programlisting> +<para> +Emitted when the initial request for properties + is complete on the item. If there is a type + handler configured for the "type" parameter + that will be executed before this is signaled. +</para><variablelist role="params"> +<varlistentry><term><parameter>arg0</parameter> :</term> +<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> object. +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>user_data</parameter> :</term> +<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry> +</variablelist></refsect2> +</refsect1> + +</refentry> diff --git a/docs/libdbusmenu-glib/reference/xml/server.xml b/docs/libdbusmenu-glib/reference/xml/server.xml new file mode 100644 index 0000000..1390c03 --- /dev/null +++ b/docs/libdbusmenu-glib/reference/xml/server.xml @@ -0,0 +1,183 @@ +<?xml version="1.0"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" + "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" +[ + <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'"> +]> +<refentry id="libdbusmenu-glib-DbusmenuServer"> +<refmeta> +<refentrytitle role="top_of_page" id="libdbusmenu-glib-DbusmenuServer.top_of_page">DbusmenuServer</refentrytitle> +<manvolnum>3</manvolnum> +<refmiscinfo> + LIBDBUSMENU-GLIB Library +</refmiscinfo> +</refmeta> +<refnamediv> +<refname>DbusmenuServer</refname> +<refpurpose></refpurpose> +</refnamediv> + +<refsynopsisdiv id="libdbusmenu-glib-DbusmenuServer.synopsis" role="synopsis"> +<title role="synopsis.title">Synopsis</title> + +<synopsis>#define <link linkend="DBUSMENU-SERVER-SIGNAL-ID-PROP-UPDATE:CAPS">DBUSMENU_SERVER_SIGNAL_ID_PROP_UPDATE</link> +#define <link linkend="DBUSMENU-SERVER-SIGNAL-ID-UPDATE:CAPS">DBUSMENU_SERVER_SIGNAL_ID_UPDATE</link> +#define <link linkend="DBUSMENU-SERVER-SIGNAL-LAYOUT-UPDATED:CAPS">DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATED</link> +#define <link linkend="DBUSMENU-SERVER-SIGNAL-LAYOUT-UPDATE:CAPS">DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATE</link> +#define <link linkend="DBUSMENU-SERVER-PROP-DBUS-OBJECT:CAPS">DBUSMENU_SERVER_PROP_DBUS_OBJECT</link> +#define <link linkend="DBUSMENU-SERVER-PROP-ROOT-NODE:CAPS">DBUSMENU_SERVER_PROP_ROOT_NODE</link> +#define <link linkend="DBUSMENU-SERVER-PROP-VERSION:CAPS">DBUSMENU_SERVER_PROP_VERSION</link> + <link linkend="DbusmenuServerClass">DbusmenuServerClass</link>; +<link linkend="DbusmenuServer"><returnvalue>DbusmenuServer</returnvalue></link> * <link linkend="dbusmenu-server-new">dbusmenu_server_new</link> (<parameter>const <link linkend="gchar"><type>gchar</type></link> *object</parameter>); +<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="dbusmenu-server-set-root">dbusmenu_server_set_root</link> (<parameter><link linkend="DbusmenuServer"><type>DbusmenuServer</type></link> *server</parameter>, + <parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *root</parameter>); +</synopsis> +</refsynopsisdiv> + +<refsect1 id="libdbusmenu-glib-DbusmenuServer.description" role="desc"> +<title role="desc.title">Description</title> +<para> +</para> +</refsect1> +<refsect1 id="libdbusmenu-glib-DbusmenuServer.details" role="details"> +<title role="details.title">Details</title> +<refsect2 id="DBUSMENU-SERVER-SIGNAL-ID-PROP-UPDATE:CAPS" role="macro"> +<title>DBUSMENU_SERVER_SIGNAL_ID_PROP_UPDATE</title> +<indexterm zone="DBUSMENU-SERVER-SIGNAL-ID-PROP-UPDATE:CAPS"><primary>DBUSMENU_SERVER_SIGNAL_ID_PROP_UPDATE</primary></indexterm> +<programlisting>#define DBUSMENU_SERVER_SIGNAL_ID_PROP_UPDATE "item-property-updated" +</programlisting> +<para> +</para></refsect2> +<refsect2 id="DBUSMENU-SERVER-SIGNAL-ID-UPDATE:CAPS" role="macro"> +<title>DBUSMENU_SERVER_SIGNAL_ID_UPDATE</title> +<indexterm zone="DBUSMENU-SERVER-SIGNAL-ID-UPDATE:CAPS"><primary>DBUSMENU_SERVER_SIGNAL_ID_UPDATE</primary></indexterm> +<programlisting>#define DBUSMENU_SERVER_SIGNAL_ID_UPDATE "item-updated" +</programlisting> +<para> +</para></refsect2> +<refsect2 id="DBUSMENU-SERVER-SIGNAL-LAYOUT-UPDATED:CAPS" role="macro"> +<title>DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATED</title> +<indexterm zone="DBUSMENU-SERVER-SIGNAL-LAYOUT-UPDATED:CAPS"><primary>DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATED</primary></indexterm> +<programlisting>#define DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATED "layout-updated" +</programlisting> +<para> +</para></refsect2> +<refsect2 id="DBUSMENU-SERVER-SIGNAL-LAYOUT-UPDATE:CAPS" role="macro"> +<title>DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATE</title> +<indexterm zone="DBUSMENU-SERVER-SIGNAL-LAYOUT-UPDATE:CAPS"><primary>DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATE</primary></indexterm> +<programlisting>#define DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATE DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATED +</programlisting> +<para> +</para></refsect2> +<refsect2 id="DBUSMENU-SERVER-PROP-DBUS-OBJECT:CAPS" role="macro"> +<title>DBUSMENU_SERVER_PROP_DBUS_OBJECT</title> +<indexterm zone="DBUSMENU-SERVER-PROP-DBUS-OBJECT:CAPS"><primary>DBUSMENU_SERVER_PROP_DBUS_OBJECT</primary></indexterm> +<programlisting>#define DBUSMENU_SERVER_PROP_DBUS_OBJECT "dbus-object" +</programlisting> +<para> +</para></refsect2> +<refsect2 id="DBUSMENU-SERVER-PROP-ROOT-NODE:CAPS" role="macro"> +<title>DBUSMENU_SERVER_PROP_ROOT_NODE</title> +<indexterm zone="DBUSMENU-SERVER-PROP-ROOT-NODE:CAPS"><primary>DBUSMENU_SERVER_PROP_ROOT_NODE</primary></indexterm> +<programlisting>#define DBUSMENU_SERVER_PROP_ROOT_NODE "root-node" +</programlisting> +<para> +</para></refsect2> +<refsect2 id="DBUSMENU-SERVER-PROP-VERSION:CAPS" role="macro"> +<title>DBUSMENU_SERVER_PROP_VERSION</title> +<indexterm zone="DBUSMENU-SERVER-PROP-VERSION:CAPS"><primary>DBUSMENU_SERVER_PROP_VERSION</primary></indexterm> +<programlisting>#define DBUSMENU_SERVER_PROP_VERSION "version" +</programlisting> +<para> +</para></refsect2> +<refsect2 id="DbusmenuServerClass" role="struct"> +<title>DbusmenuServerClass</title> +<indexterm zone="DbusmenuServerClass"><primary>DbusmenuServerClass</primary></indexterm> +<programlisting>typedef struct { + GObjectClass parent_class; + + /* Signals */ + void (*id_prop_update)(gint id, gchar * property, gchar * value); + void (*id_update)(gint id); + void (*layout_updated)(gint revision); + + /* Reserved */ + void (*dbusmenu_server_reserved1)(void); + void (*dbusmenu_server_reserved2)(void); + void (*dbusmenu_server_reserved3)(void); + void (*dbusmenu_server_reserved4)(void); +} DbusmenuServerClass; +</programlisting> +<para> +The class implementing the virtual functions for <link linkend="DbusmenuServer"><type>DbusmenuServer</type></link>. +</para><variablelist role="struct"> +<varlistentry><term><link linkend="GObjectClass"><type>GObjectClass</type></link> <structfield id="DbusmenuServerClass.parent-class">parent_class</structfield>;</term> +<listitem><simpara><link linkend="GObjectClass"><type>GObjectClass</type></link> +</simpara></listitem> +</varlistentry> +<varlistentry><term><structfield id="DbusmenuServerClass.id-prop-update">id_prop_update</structfield> ()</term> +<listitem><simpara>Slot for <link linkend="DbusmenuServer-id-prop-update"><type>"id-prop-update"</type></link>. +</simpara></listitem> +</varlistentry> +<varlistentry><term><structfield id="DbusmenuServerClass.id-update">id_update</structfield> ()</term> +<listitem><simpara>Slot for <link linkend="DbusmenuServer-id-update"><type>"id-update"</type></link>. +</simpara></listitem> +</varlistentry> +<varlistentry><term><structfield id="DbusmenuServerClass.layout-updated">layout_updated</structfield> ()</term> +<listitem><simpara>Slot for <link linkend="DbusmenuServer-layout-update"><type>"layout-update"</type></link>. +</simpara></listitem> +</varlistentry> +<varlistentry><term><structfield id="DbusmenuServerClass.dbusmenu-server-reserved1">dbusmenu_server_reserved1</structfield> ()</term> +<listitem><simpara>Reserved for future use. +</simpara></listitem> +</varlistentry> +<varlistentry><term><structfield id="DbusmenuServerClass.dbusmenu-server-reserved2">dbusmenu_server_reserved2</structfield> ()</term> +<listitem><simpara>Reserved for future use. +</simpara></listitem> +</varlistentry> +<varlistentry><term><structfield id="DbusmenuServerClass.dbusmenu-server-reserved3">dbusmenu_server_reserved3</structfield> ()</term> +<listitem><simpara>Reserved for future use. +</simpara></listitem> +</varlistentry> +<varlistentry><term><structfield id="DbusmenuServerClass.dbusmenu-server-reserved4">dbusmenu_server_reserved4</structfield> ()</term> +<listitem><simpara>Reserved for future use. +</simpara></listitem> +</varlistentry> +</variablelist></refsect2> +<refsect2 id="dbusmenu-server-new" role="function"> +<title>dbusmenu_server_new ()</title> +<indexterm zone="dbusmenu-server-new"><primary>dbusmenu_server_new</primary></indexterm> +<programlisting><link linkend="DbusmenuServer"><returnvalue>DbusmenuServer</returnvalue></link> * dbusmenu_server_new (<parameter>const <link linkend="gchar"><type>gchar</type></link> *object</parameter>);</programlisting> +<para> +Creates a new <link linkend="DbusmenuServer"><type>DbusmenuServer</type></link> object with a specific object + path on DBus. If <parameter>object</parameter> is set to NULL the default object + name of "/org/ayatana/dbusmenu" will be used. +</para><variablelist role="params"> +<varlistentry><term><parameter>object</parameter> :</term> +<listitem><simpara>The object name to show for this menu structure + on DBus. May be NULL. +</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A brand new <link linkend="DbusmenuServer"><type>DbusmenuServer</type></link> +</simpara></listitem></varlistentry> +</variablelist></refsect2> +<refsect2 id="dbusmenu-server-set-root" role="function"> +<title>dbusmenu_server_set_root ()</title> +<indexterm zone="dbusmenu-server-set-root"><primary>dbusmenu_server_set_root</primary></indexterm> +<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> dbusmenu_server_set_root (<parameter><link linkend="DbusmenuServer"><type>DbusmenuServer</type></link> *server</parameter>, + <parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *root</parameter>);</programlisting> +<para> +This function contains all of the <link linkend="GValue"><type>GValue</type></link> wrapping + required to set the property <link linkend="DbusmenuServer--root-node"><type>"root-node"</type></link> + on the server <parameter>self</parameter>. +</para><variablelist role="params"> +<varlistentry><term><parameter>server</parameter> :</term> +<listitem><simpara> +</simpara></listitem></varlistentry> +<varlistentry><term><parameter>root</parameter> :</term> +<listitem><simpara>The new root <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> tree +</simpara></listitem></varlistentry> +</variablelist></refsect2> + +</refsect1> + +</refentry> |