diff options
Diffstat (limited to 'docs/libdbusmenu-glib/reference/xml')
| -rw-r--r-- | docs/libdbusmenu-glib/reference/xml/annotation-glossary.xml | 10 | ||||
| -rw-r--r-- | docs/libdbusmenu-glib/reference/xml/client-menuitem.xml | 28 | ||||
| -rw-r--r-- | docs/libdbusmenu-glib/reference/xml/client.xml | 152 | ||||
| -rw-r--r-- | docs/libdbusmenu-glib/reference/xml/menuitem-proxy.xml | 49 | ||||
| -rw-r--r-- | docs/libdbusmenu-glib/reference/xml/menuitem.xml | 340 | ||||
| -rw-r--r-- | docs/libdbusmenu-glib/reference/xml/server.xml | 73 |
6 files changed, 222 insertions, 430 deletions
diff --git a/docs/libdbusmenu-glib/reference/xml/annotation-glossary.xml b/docs/libdbusmenu-glib/reference/xml/annotation-glossary.xml index 2dfb261..dd61dad 100644 --- a/docs/libdbusmenu-glib/reference/xml/annotation-glossary.xml +++ b/docs/libdbusmenu-glib/reference/xml/annotation-glossary.xml @@ -44,6 +44,16 @@ <para>Free data after the code is done.</para> </glossdef> </glossentry> +</glossdiv> +<glossdiv><title>C</title> + <glossentry> + <glossterm><anchor id="annotation-glossterm-closure"/>closure</glossterm> + <glossdef> + <para>This parameter is a 'user_data', for callbacks; many bindings can pass NULL here.</para> + </glossdef> + </glossentry> +</glossdiv> +<glossdiv><title>T</title> <glossentry> <glossterm><anchor id="annotation-glossterm-transfer none"/>transfer none</glossterm> <glossdef> diff --git a/docs/libdbusmenu-glib/reference/xml/client-menuitem.xml b/docs/libdbusmenu-glib/reference/xml/client-menuitem.xml index 267178d..cbd425f 100644 --- a/docs/libdbusmenu-glib/reference/xml/client-menuitem.xml +++ b/docs/libdbusmenu-glib/reference/xml/client-menuitem.xml @@ -22,8 +22,8 @@ <synopsis>#define <link linkend="DBUSMENU-CLIENT-MENUITEM-TYPE:CAPS">DBUSMENU_CLIENT_MENUITEM_TYPE</link> <link linkend="DbusmenuClientMenuitem">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>, +struct <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> @@ -45,37 +45,25 @@ <refsect2 id="DbusmenuClientMenuitem" role="struct"> <title>DbusmenuClientMenuitem</title> <indexterm zone="DbusmenuClientMenuitem"><primary>DbusmenuClientMenuitem</primary></indexterm> -<programlisting>typedef struct { - DbusmenuMenuitem parent; -} DbusmenuClientMenuitem; -</programlisting> +<programlisting>typedef struct _DbusmenuClientMenuitem DbusmenuClientMenuitem;</programlisting> <para> </para></refsect2> <refsect2 id="DbusmenuClientMenuitemClass" role="struct"> -<title>DbusmenuClientMenuitemClass</title> +<title>struct DbusmenuClientMenuitemClass</title> <indexterm zone="DbusmenuClientMenuitemClass"><primary>DbusmenuClientMenuitemClass</primary></indexterm> -<programlisting>typedef struct { +<programlisting>struct DbusmenuClientMenuitemClass { 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>, +<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> +</para></refsect2> </refsect1> diff --git a/docs/libdbusmenu-glib/reference/xml/client.xml b/docs/libdbusmenu-glib/reference/xml/client.xml index 9e9dc16..754fe90 100644 --- a/docs/libdbusmenu-glib/reference/xml/client.xml +++ b/docs/libdbusmenu-glib/reference/xml/client.xml @@ -36,13 +36,14 @@ Unstable, unless otherwise indicated #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="DbusmenuClient">DbusmenuClient</link>; - <link linkend="DbusmenuClientClass">DbusmenuClientClass</link>; +struct <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><link linkend="DbusmenuClient"><type>DbusmenuClient</type></link> *client</parameter>, + <parameter><link linkend="gpointer"><type>gpointer</type></link> user_data</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="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>); @@ -53,7 +54,7 @@ Unstable, unless otherwise indicated <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="void"><type>void</type></link> (*cb) (gpointer user_data)</parameter>, <parameter><link linkend="gpointer"><type>gpointer</type></link> cb_data</parameter>); </synopsis> </refsynopsisdiv> @@ -138,30 +139,16 @@ The client exists as a mirror to the server. For most folks <refsect2 id="DbusmenuClient" role="struct"> <title>DbusmenuClient</title> <indexterm zone="DbusmenuClient"><primary>DbusmenuClient</primary></indexterm> -<programlisting>typedef struct { - GObject parent; - - /*< Private >*/ - DbusmenuClientPrivate * priv; -} DbusmenuClient; -</programlisting> +<programlisting>typedef struct _DbusmenuClient DbusmenuClient;</programlisting> <para> The client for a <link linkend="DbusmenuServer"><type>DbusmenuServer</type></link> creating a shared object set of <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> objects. </para><variablelist role="struct"> -<varlistentry><term><link linkend="GObject"><type>GObject</type></link> <structfield id="DbusmenuClient.parent">parent</structfield>;</term> -<listitem><simpara><link linkend="GObject"><type>GObject</type></link>. -</simpara></listitem> -</varlistentry> -<varlistentry><term><link linkend="DbusmenuClientPrivate"><type>DbusmenuClientPrivate</type></link> *<structfield id="DbusmenuClient.priv">priv</structfield>;</term> -<listitem><simpara> -</simpara></listitem> -</varlistentry> </variablelist></refsect2> <refsect2 id="DbusmenuClientClass" role="struct"> -<title>DbusmenuClientClass</title> +<title>struct DbusmenuClientClass</title> <indexterm zone="DbusmenuClientClass"><primary>DbusmenuClientClass</primary></indexterm> -<programlisting>typedef struct { +<programlisting>struct DbusmenuClientClass { GObjectClass parent_class; void (*layout_updated)(void); @@ -177,7 +164,7 @@ The client for a <link linkend="DbusmenuServer"><type>DbusmenuServer</type></lin void (*reserved4) (void); void (*reserved5) (void); void (*reserved6) (void); -} DbusmenuClientClass; +}; </programlisting> <para> A simple class that takes all of the information from a @@ -185,52 +172,40 @@ A simple class that takes all of the information from a <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> +<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> +<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> +<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> +<listitem><simpara>Slot for <link linkend="DbusmenuClient-new-menuitem"><type>"new-menuitem"</type></link>.</simpara></listitem> </varlistentry> <varlistentry><term><structfield id="DbusmenuClientClass.item-activate">item_activate</structfield> ()</term> -<listitem><simpara>Slot for <link linkend="DbusmenuClient-item-activate"><type>"item-activate"</type></link>. -</simpara></listitem> +<listitem><simpara>Slot for <link linkend="DbusmenuClient-item-activate"><type>"item-activate"</type></link>.</simpara></listitem> </varlistentry> <varlistentry><term><structfield id="DbusmenuClientClass.event-result">event_result</structfield> ()</term> -<listitem><simpara>Slot for <link linkend="DbusmenuClient-event-error"><type>"event-error"</type></link>. -</simpara></listitem> +<listitem><simpara>Slot for <link linkend="DbusmenuClient-event-error"><type>"event-error"</type></link>.</simpara></listitem> </varlistentry> <varlistentry><term><structfield id="DbusmenuClientClass.reserved1">reserved1</structfield> ()</term> -<listitem><simpara>Reserved for future use. -</simpara></listitem> +<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> +<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> +<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> +<listitem><simpara>Reserved for future use.</simpara></listitem> </varlistentry> <varlistentry><term><structfield id="DbusmenuClientClass.reserved5">reserved5</structfield> ()</term> -<listitem><simpara>Reserved for future use. -</simpara></listitem> +<listitem><simpara>Reserved for future use.</simpara></listitem> </varlistentry> <varlistentry><term><structfield id="DbusmenuClientClass.reserved6">reserved6</structfield> ()</term> -<listitem><simpara>Reserved for future use. -</simpara></listitem> +<listitem><simpara>Reserved for future use.</simpara></listitem> </varlistentry> </variablelist></refsect2> <refsect2 id="DbusmenuClientTypeHandler" role="function"> @@ -238,25 +213,25 @@ A simple class that takes all of the information from a <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> + <parameter><link linkend="DbusmenuClient"><type>DbusmenuClient</type></link> *client</parameter>, + <parameter><link linkend="gpointer"><type>gpointer</type></link> user_data</parameter>);</programlisting> <para> +The type handler is called when a dbusmenu item is created + with a matching type as setup in <link linkend="dbusmenu-client-add-type-handler"><type>dbusmenu_client_add_type_handler</type></link> </para><variablelist role="params"> <varlistentry><term><parameter>newitem</parameter> :</term> -<listitem><simpara> -</simpara></listitem></varlistentry> +<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> that was created</simpara></listitem></varlistentry> <varlistentry><term><parameter>parent</parameter> :</term> -<listitem><simpara> -</simpara></listitem></varlistentry> +<listitem><simpara>The parent of <parameter>newitem</parameter> or <link linkend="NULL:CAPS"><type>NULL</type></link> if none</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> +<listitem><simpara>A pointer to the <link linkend="DbusmenuClient"><type>DbusmenuClient</type></link></simpara></listitem></varlistentry> +<varlistentry><term><parameter>user_data</parameter> :</term> +<listitem><simpara>The data you gave us</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>, +<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 @@ -266,18 +241,15 @@ This function creates a new client that connects to a specific 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> +<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> +<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> +<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 @@ -288,12 +260,10 @@ Grabs the root node for the specified client <parameter>client</parameter>. Thi 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> +<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> @@ -315,18 +285,14 @@ This function connects into the type handling of the <link linkend="DbusmenuClie 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> +<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> +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> +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> @@ -337,42 +303,18 @@ This function connects into the type handling of the <link linkend="DbusmenuClie <parameter><link linkend="GVariant"><type>GVariant</type></link> *variant</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>variant</parameter> :</term> -<listitem><simpara> -</simpara></listitem></varlistentry> -<varlistentry><term><parameter>timestamp</parameter> :</term> -<listitem><simpara> -</simpara></listitem></varlistentry> -</variablelist></refsect2> +</para></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="void"><type>void</type></link> (*cb) (gpointer 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> +<listitem><simpara><parameter>gpointer</parameter> user_data:</simpara></listitem></varlistentry> </variablelist></refsect2> </refsect1> diff --git a/docs/libdbusmenu-glib/reference/xml/menuitem-proxy.xml b/docs/libdbusmenu-glib/reference/xml/menuitem-proxy.xml index e523603..b18a62e 100644 --- a/docs/libdbusmenu-glib/reference/xml/menuitem-proxy.xml +++ b/docs/libdbusmenu-glib/reference/xml/menuitem-proxy.xml @@ -21,8 +21,8 @@ <title role="synopsis.title">Synopsis</title> <synopsis> <link linkend="DbusmenuMenuitemProxy">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>); +struct <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> @@ -37,19 +37,13 @@ <refsect2 id="DbusmenuMenuitemProxy" role="struct"> <title>DbusmenuMenuitemProxy</title> <indexterm zone="DbusmenuMenuitemProxy"><primary>DbusmenuMenuitemProxy</primary></indexterm> -<programlisting>typedef struct { - DbusmenuMenuitem parent; - - /*< Private >*/ - DbusmenuMenuitemProxyPrivate * priv; -} DbusmenuMenuitemProxy; -</programlisting> +<programlisting>typedef struct _DbusmenuMenuitemProxy DbusmenuMenuitemProxy;</programlisting> <para> </para></refsect2> <refsect2 id="DbusmenuMenuitemProxyClass" role="struct"> -<title>DbusmenuMenuitemProxyClass</title> +<title>struct DbusmenuMenuitemProxyClass</title> <indexterm zone="DbusmenuMenuitemProxyClass"><primary>DbusmenuMenuitemProxyClass</primary></indexterm> -<programlisting>typedef struct { +<programlisting>struct DbusmenuMenuitemProxyClass { DbusmenuMenuitemClass parent_class; /*< Private >*/ @@ -57,45 +51,38 @@ void (*reserved2) (void); void (*reserved3) (void); void (*reserved4) (void); -} 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> +<listitem><simpara>The Class of <link linkend="DbusmeneMenuitem"><type>DbusmeneMenuitem</type></link></simpara></listitem> </varlistentry> <varlistentry><term><structfield id="DbusmenuMenuitemProxyClass.reserved1">reserved1</structfield> ()</term> -<listitem><simpara>Reserved for future use. -</simpara></listitem> +<listitem><simpara>Reserved for future use.</simpara></listitem> </varlistentry> <varlistentry><term><structfield id="DbusmenuMenuitemProxyClass.reserved2">reserved2</structfield> ()</term> -<listitem><simpara>Reserved for future use. -</simpara></listitem> +<listitem><simpara>Reserved for future use.</simpara></listitem> </varlistentry> <varlistentry><term><structfield id="DbusmenuMenuitemProxyClass.reserved3">reserved3</structfield> ()</term> -<listitem><simpara>Reserved for future use. -</simpara></listitem> +<listitem><simpara>Reserved for future use.</simpara></listitem> </varlistentry> <varlistentry><term><structfield id="DbusmenuMenuitemProxyClass.reserved4">reserved4</structfield> ()</term> -<listitem><simpara>Reserved for future use. -</simpara></listitem> +<listitem><simpara>Reserved for future use.</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> +<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> +<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> @@ -106,11 +93,9 @@ Accesses the private variable of which <link linkend="DbusmenuMenuitem"><type>Db 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> +<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> diff --git a/docs/libdbusmenu-glib/reference/xml/menuitem.xml b/docs/libdbusmenu-glib/reference/xml/menuitem.xml index 858e829..9e32406 100644 --- a/docs/libdbusmenu-glib/reference/xml/menuitem.xml +++ b/docs/libdbusmenu-glib/reference/xml/menuitem.xml @@ -50,14 +50,14 @@ Unstable, unless otherwise indicated #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> #define <link linkend="DBUSMENU-MENUITEM-CHILD-DISPLAY-SUBMENU:CAPS">DBUSMENU_MENUITEM_CHILD_DISPLAY_SUBMENU</link> - <link linkend="DbusmenuMenuitem">DbusmenuMenuitem</link>; +struct <link linkend="DbusmenuMenuitem">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>; +struct <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>); @@ -110,7 +110,7 @@ const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <lin <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="void"><type>void</type></link> (*func) (DbusmenuMenuitem * 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>, @@ -118,7 +118,7 @@ const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <lin <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="void"><type>void</type></link> (cbDbusmenuMenuitem * mi, gpointer user_data) ()</parameter>, + <parameter><link linkend="void"><type>void</type></link> (*cb) (DbusmenuMenuitem * mi, gpointer user_data)</parameter>, <parameter><link linkend="gpointer"><type>gpointer</type></link> cb_data</parameter>); </synopsis> </refsynopsisdiv> @@ -304,14 +304,14 @@ objects and handled appropriately. <para> </para></refsect2> <refsect2 id="DbusmenuMenuitem" role="struct"> -<title>DbusmenuMenuitem</title> +<title>struct DbusmenuMenuitem</title> <indexterm zone="DbusmenuMenuitem"><primary>DbusmenuMenuitem</primary></indexterm> -<programlisting>typedef struct { +<programlisting>struct DbusmenuMenuitem { GObject parent; /*< Private >*/ DbusmenuMenuitemPrivate * priv; -} DbusmenuMenuitem; +}; </programlisting> <para> This is the <link linkend="GObject"><type>GObject</type></link> based object that represents a menu @@ -332,10 +332,9 @@ 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> +<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. <emphasis role="annotation">[closure]</emphasis></simpara></listitem></varlistentry> +<listitem><simpara>Extra user data sent with the function. <emphasis role="annotation">[<acronym>closure</acronym>]</emphasis></simpara></listitem></varlistentry> </variablelist></refsect2> <refsect2 id="dbusmenu-menuitem-buildxml-slot-t" role="function"> <title>dbusmenu_menuitem_buildxml_slot_t ()</title> @@ -348,14 +347,14 @@ 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. <emphasis role="annotation">[<acronym>in</acronym>]</emphasis></simpara></listitem></varlistentry> +<listitem><simpara>Menu item that should be built from. <emphasis role="annotation">[<acronym>in</acronym>]</emphasis></simpara></listitem></varlistentry> <varlistentry><term><parameter>stringarray</parameter> :</term> -<listitem><simpara> An array of strings that can be combined into an XML file. <emphasis role="annotation">[<acronym>inout</acronym>][<acronym>transfer none</acronym>][<acronym>array</acronym>][<acronym>element-type</acronym> utf8]</emphasis></simpara></listitem></varlistentry> +<listitem><simpara>An array of strings that can be combined into an XML file. <emphasis role="annotation">[<acronym>inout</acronym>][<acronym>transfer none</acronym>][<acronym>array</acronym>][<acronym>element-type</acronym> utf8]</emphasis></simpara></listitem></varlistentry> </variablelist></refsect2> <refsect2 id="DbusmenuMenuitemClass" role="struct"> -<title>DbusmenuMenuitemClass</title> +<title>struct DbusmenuMenuitemClass</title> <indexterm zone="DbusmenuMenuitemClass"><primary>DbusmenuMenuitemClass</primary></indexterm> -<programlisting>typedef struct { +<programlisting>struct DbusmenuMenuitemClass { GObjectClass parent_class; /* Signals */ @@ -381,7 +380,7 @@ as an XML fragment. Should call it's own children. void (*reserved4) (void); void (*reserved5) (void); void (*reserved6) (void); -} DbusmenuMenuitemClass; +}; </programlisting> <para> <parameter>reserved1</parameter>: Reserved for future use. @@ -392,72 +391,55 @@ as an XML fragment. Should call it's own children. <parameter>reserved6</parameter>: Reserved for future use. </para><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> +<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> +<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> +<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> +<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> +<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> +<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> +<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> +<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> +<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.show-to-user">show_to_user</structfield> ()</term> -<listitem><simpara>Slot for <link linkend="DbusmenuMenuitem-show-to-user"><type>"show-to-user"</type></link>. -</simpara></listitem> +<listitem><simpara>Slot for <link linkend="DbusmenuMenuitem-show-to-user"><type>"show-to-user"</type></link>.</simpara></listitem> </varlistentry> <varlistentry><term><structfield id="DbusmenuMenuitemClass.about-to-show">about_to_show</structfield> ()</term> -<listitem><simpara>Slot for <link linkend="DbusmenuMenuitem-about-to-show"><type>"about-to-show"</type></link>. -</simpara></listitem> +<listitem><simpara>Slot for <link linkend="DbusmenuMenuitem-about-to-show"><type>"about-to-show"</type></link>.</simpara></listitem> </varlistentry> <varlistentry><term><structfield id="DbusmenuMenuitemClass.reserved1">reserved1</structfield> ()</term> -<listitem><simpara> -</simpara></listitem> +<listitem><simpara></simpara></listitem> </varlistentry> <varlistentry><term><structfield id="DbusmenuMenuitemClass.reserved2">reserved2</structfield> ()</term> -<listitem><simpara> -</simpara></listitem> +<listitem><simpara></simpara></listitem> </varlistentry> <varlistentry><term><structfield id="DbusmenuMenuitemClass.reserved3">reserved3</structfield> ()</term> -<listitem><simpara> -</simpara></listitem> +<listitem><simpara></simpara></listitem> </varlistentry> <varlistentry><term><structfield id="DbusmenuMenuitemClass.reserved4">reserved4</structfield> ()</term> -<listitem><simpara> -</simpara></listitem> +<listitem><simpara></simpara></listitem> </varlistentry> <varlistentry><term><structfield id="DbusmenuMenuitemClass.reserved5">reserved5</structfield> ()</term> -<listitem><simpara> -</simpara></listitem> +<listitem><simpara></simpara></listitem> </varlistentry> <varlistentry><term><structfield id="DbusmenuMenuitemClass.reserved6">reserved6</structfield> ()</term> -<listitem><simpara> -</simpara></listitem> +<listitem><simpara></simpara></listitem> </varlistentry> </variablelist></refsect2> <refsect2 id="dbusmenu-menuitem-new" role="function"> @@ -467,8 +449,7 @@ as an XML fragment. Should call it's own children. <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> +<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> @@ -478,10 +459,8 @@ Create a new <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></lin 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> +<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> @@ -491,10 +470,8 @@ This creates a blank <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</ty 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> +<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> @@ -506,10 +483,8 @@ Returns simply the list of children that this menu item 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> +<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> @@ -523,10 +498,8 @@ While the name sounds devious that's exactly what this function 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> +<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> @@ -539,13 +512,10 @@ This function returns the position of the menu item <parameter>mi</parameter> 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> +<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> +<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> @@ -558,13 +528,10 @@ This function is very similar to <link linkend="dbusmenu-menuitem-get-position"> 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> +<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> +<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> @@ -576,13 +543,10 @@ This function adds <parameter>child</parameter> to the list of children on <para 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> +<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> +<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> @@ -594,13 +558,10 @@ This function adds <parameter>child</parameter> to the list of children on <para 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> +<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> +<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> @@ -612,14 +573,11 @@ This function removes <parameter>child</parameter> from the children list of <pa 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> +<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> +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> @@ -634,16 +592,12 @@ Puts <parameter>child</parameter> in the list of children for <parameter>mi</par 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> +<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> +<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> +<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> @@ -656,17 +610,11 @@ 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> +<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> +<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> @@ -678,14 +626,11 @@ Search the children of <parameter>mi</parameter> to find one with the ID of <par 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> +<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> +<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> @@ -698,15 +643,12 @@ This function searchs the whole tree of children that 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> +<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> +<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> @@ -723,16 +665,12 @@ Takes the pair of <parameter>property</parameter> and <parameter>value</paramete 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> +<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> +<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> +<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-bool" role="function"> <title>dbusmenu_menuitem_property_set_bool ()</title> @@ -749,16 +687,12 @@ Takes a boolean <parameter>value</parameter> and sets it on <parameter>property< 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> +<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> +<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> +<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> @@ -775,16 +709,12 @@ Takes a boolean <parameter>value</parameter> and sets it on <parameter>property< 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> +<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> +<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> +<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> @@ -797,15 +727,12 @@ Look up a property on <parameter>mi</parameter> and return the value of it if 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> +<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> +<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-bool" role="function"> <title>dbusmenu_menuitem_property_get_bool ()</title> @@ -817,13 +744,10 @@ 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> +<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> +<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> @@ -835,13 +759,10 @@ 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> +<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> +<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> @@ -849,16 +770,7 @@ Look up a property on <parameter>mi</parameter> and return the value of it if <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> +</para></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> @@ -870,10 +782,8 @@ This functiong gets a list of the names of all the properties <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> +<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> @@ -888,11 +798,9 @@ This function takes the properties of a <link linkend="DbusmenuMenuitem"><type>D 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> +<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> @@ -903,11 +811,9 @@ This function takes the properties of a <link linkend="DbusmenuMenuitem"><type>D 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> +<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> +<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> @@ -919,11 +825,9 @@ 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> +<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> +<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> @@ -934,16 +838,14 @@ 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> +<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="void"><type>void</type></link> (*func) (DbusmenuMenuitem * 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 @@ -952,10 +854,11 @@ This calls the function <parameter>func</parameter> on this menu item and all 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> +<listitem><simpara>The <link linkend="DbusmenItem"><type>DbusmenItem</type></link> to start from</simpara></listitem></varlistentry> +<varlistentry><term><parameter>func</parameter> :</term> +<listitem><simpara>Function to call on every node in the tree</simpara></listitem></varlistentry> <varlistentry><term><parameter>data</parameter> :</term> -<listitem><simpara> User data to pass to the function. <emphasis role="annotation">[closure]</emphasis></simpara></listitem></varlistentry> +<listitem><simpara>User data to pass to the function. <emphasis role="annotation">[<acronym>closure</acronym>]</emphasis></simpara></listitem></varlistentry> </variablelist></refsect2> <refsect2 id="dbusmenu-menuitem-handle-event" role="function"> <title>dbusmenu_menuitem_handle_event ()</title> @@ -980,24 +883,18 @@ This function is called to create an event. It is likely 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> +<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> -</simpara></listitem></varlistentry> +<listitem><simpara>The name of the signal</simpara></listitem></varlistentry> <varlistentry><term><parameter>timestamp</parameter> :</term> -<listitem><simpara>The timestamp of when the event happened -</simpara></listitem></varlistentry> +<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="void"><type>void</type></link> (cbDbusmenuMenuitem * mi, gpointer user_data) ()</parameter>, + <parameter><link linkend="void"><type>void</type></link> (*cb) (DbusmenuMenuitem * mi, gpointer user_data)</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 @@ -1006,10 +903,11 @@ This function is used to send the even that the submenu 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> +<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. <emphasis role="annotation">[closure]</emphasis></simpara></listitem></varlistentry> +<listitem><simpara>Data to pass to the callback. <emphasis role="annotation">[<acronym>closure</acronym>]</emphasis></simpara></listitem></varlistentry> </variablelist></refsect2> </refsect1> diff --git a/docs/libdbusmenu-glib/reference/xml/server.xml b/docs/libdbusmenu-glib/reference/xml/server.xml index d80da6d..396a99e 100644 --- a/docs/libdbusmenu-glib/reference/xml/server.xml +++ b/docs/libdbusmenu-glib/reference/xml/server.xml @@ -28,8 +28,8 @@ #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="DbusmenuServer">DbusmenuServer</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>); +struct <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> @@ -94,30 +94,16 @@ <refsect2 id="DbusmenuServer" role="struct"> <title>DbusmenuServer</title> <indexterm zone="DbusmenuServer"><primary>DbusmenuServer</primary></indexterm> -<programlisting>typedef struct { - GObject parent; - - /*< Private >*/ - DbusmenuServerPrivate * priv; -} DbusmenuServer; -</programlisting> +<programlisting>typedef struct _DbusmenuServer DbusmenuServer;</programlisting> <para> A server which represents a sharing of a set of <link linkend="DbusmenuMenuitems"><type>DbusmenuMenuitems</type></link> across DBus to a <link linkend="DbusmenuClient"><type>DbusmenuClient</type></link>. </para><variablelist role="struct"> -<varlistentry><term><link linkend="GObject"><type>GObject</type></link> <structfield id="DbusmenuServer.parent">parent</structfield>;</term> -<listitem><simpara><link linkend="GObject"><type>GObject</type></link> -</simpara></listitem> -</varlistentry> -<varlistentry><term><link linkend="DbusmenuServerPrivate"><type>DbusmenuServerPrivate</type></link> *<structfield id="DbusmenuServer.priv">priv</structfield>;</term> -<listitem><simpara> -</simpara></listitem> -</varlistentry> </variablelist></refsect2> <refsect2 id="DbusmenuServerClass" role="struct"> -<title>DbusmenuServerClass</title> +<title>struct DbusmenuServerClass</title> <indexterm zone="DbusmenuServerClass"><primary>DbusmenuServerClass</primary></indexterm> -<programlisting>typedef struct { +<programlisting>struct DbusmenuServerClass { GObjectClass parent_class; /* Signals */ @@ -133,7 +119,7 @@ A server which represents a sharing of a set of void (*reserved4) (void); void (*reserved5) (void); void (*reserved6) (void); -} DbusmenuServerClass; +}; </programlisting> <para> <parameter>reserved1</parameter>: Reserved for future use. @@ -147,54 +133,43 @@ A server which represents a sharing of a set of 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> +<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> +<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> +<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> +<listitem><simpara>Slot for <link linkend="DbusmenuServer-layout-update"><type>"layout-update"</type></link>.</simpara></listitem> </varlistentry> <varlistentry><term><structfield id="DbusmenuServerClass.item-activation">item_activation</structfield> ()</term> -<listitem><simpara> -</simpara></listitem> +<listitem><simpara></simpara></listitem> </varlistentry> <varlistentry><term><structfield id="DbusmenuServerClass.reserved1">reserved1</structfield> ()</term> -<listitem><simpara> -</simpara></listitem> +<listitem><simpara></simpara></listitem> </varlistentry> <varlistentry><term><structfield id="DbusmenuServerClass.reserved2">reserved2</structfield> ()</term> -<listitem><simpara> -</simpara></listitem> +<listitem><simpara></simpara></listitem> </varlistentry> <varlistentry><term><structfield id="DbusmenuServerClass.reserved3">reserved3</structfield> ()</term> -<listitem><simpara> -</simpara></listitem> +<listitem><simpara></simpara></listitem> </varlistentry> <varlistentry><term><structfield id="DbusmenuServerClass.reserved4">reserved4</structfield> ()</term> -<listitem><simpara> -</simpara></listitem> +<listitem><simpara></simpara></listitem> </varlistentry> <varlistentry><term><structfield id="DbusmenuServerClass.reserved5">reserved5</structfield> ()</term> -<listitem><simpara> -</simpara></listitem> +<listitem><simpara></simpara></listitem> </varlistentry> <varlistentry><term><structfield id="DbusmenuServerClass.reserved6">reserved6</structfield> ()</term> -<listitem><simpara> -</simpara></listitem> +<listitem><simpara></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> +<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 @@ -202,10 +177,8 @@ Creates a new <link linkend="DbusmenuServer"><type>DbusmenuServer</type></link> </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> +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> @@ -217,12 +190,8 @@ This function contains all of the <link linkend="GValue"><type>GValue</type></li 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> +<listitem><simpara>The new root <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> tree</simpara></listitem></varlistentry> </variablelist></refsect2> </refsect1> |