diff options
author | Ted Gould <ted@gould.cx> | 2011-01-27 14:19:46 -0600 |
---|---|---|
committer | Ted Gould <ted@gould.cx> | 2011-01-27 14:19:46 -0600 |
commit | 2a91021522eb038b3aa18f2532ac289b921c9a48 (patch) | |
tree | e196e319299579a539bcdcc439b180dea0d327a2 /docs/libdbusmenu-gtk/reference/xml | |
parent | 3354af7e467e14415756fc3e640b5c027af5ebde (diff) | |
parent | 35265154f7d70dc31837ff8fe4e45a810c393c2b (diff) | |
download | libdbusmenu-2a91021522eb038b3aa18f2532ac289b921c9a48.tar.gz libdbusmenu-2a91021522eb038b3aa18f2532ac289b921c9a48.tar.bz2 libdbusmenu-2a91021522eb038b3aa18f2532ac289b921c9a48.zip |
Import upstream version 0.3.94
Diffstat (limited to 'docs/libdbusmenu-gtk/reference/xml')
-rw-r--r-- | docs/libdbusmenu-gtk/reference/xml/api-index-full.xml | 18 | ||||
-rw-r--r-- | docs/libdbusmenu-gtk/reference/xml/client.xml | 89 | ||||
-rw-r--r-- | docs/libdbusmenu-gtk/reference/xml/genericmenuitem.xml | 222 | ||||
-rw-r--r-- | docs/libdbusmenu-gtk/reference/xml/menu.xml | 48 | ||||
-rw-r--r-- | docs/libdbusmenu-gtk/reference/xml/menuitem.xml | 62 |
5 files changed, 69 insertions, 370 deletions
diff --git a/docs/libdbusmenu-gtk/reference/xml/api-index-full.xml b/docs/libdbusmenu-gtk/reference/xml/api-index-full.xml index 23555fd..0f97ad8 100644 --- a/docs/libdbusmenu-gtk/reference/xml/api-index-full.xml +++ b/docs/libdbusmenu-gtk/reference/xml/api-index-full.xml @@ -6,20 +6,6 @@ ]> <indexdiv> <indexdiv><title>G</title> -<indexentry><primaryie linkends="Genericmenuitem-struct"><link linkend="Genericmenuitem-struct">Genericmenuitem</link>, struct in <link linkend="Genericmenuitem">Genericmenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="GENERICMENUITEM:CAPS"><link linkend="GENERICMENUITEM:CAPS">GENERICMENUITEM</link>, macro in <link linkend="Genericmenuitem">Genericmenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="GenericmenuitemCheckType"><link linkend="GenericmenuitemCheckType">GenericmenuitemCheckType</link>, enum in <link linkend="Genericmenuitem">Genericmenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="GenericmenuitemClass"><link linkend="GenericmenuitemClass">GenericmenuitemClass</link>, struct in <link linkend="Genericmenuitem">Genericmenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="GenericmenuitemPrivate"><link linkend="GenericmenuitemPrivate">GenericmenuitemPrivate</link>, struct in <link linkend="Genericmenuitem">Genericmenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="GenericmenuitemState"><link linkend="GenericmenuitemState">GenericmenuitemState</link>, enum in <link linkend="Genericmenuitem">Genericmenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="GENERICMENUITEM-CLASS:CAPS"><link linkend="GENERICMENUITEM-CLASS:CAPS">GENERICMENUITEM_CLASS</link>, macro in <link linkend="Genericmenuitem">Genericmenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="GENERICMENUITEM-GET-CLASS:CAPS"><link linkend="GENERICMENUITEM-GET-CLASS:CAPS">GENERICMENUITEM_GET_CLASS</link>, macro in <link linkend="Genericmenuitem">Genericmenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="genericmenuitem-get-image"><link linkend="genericmenuitem-get-image">genericmenuitem_get_image</link>, function in <link linkend="Genericmenuitem">Genericmenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="genericmenuitem-get-type"><link linkend="genericmenuitem-get-type">genericmenuitem_get_type</link>, function in <link linkend="Genericmenuitem">Genericmenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="genericmenuitem-set-check-type"><link linkend="genericmenuitem-set-check-type">genericmenuitem_set_check_type</link>, function in <link linkend="Genericmenuitem">Genericmenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="genericmenuitem-set-image"><link linkend="genericmenuitem-set-image">genericmenuitem_set_image</link>, function in <link linkend="Genericmenuitem">Genericmenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="genericmenuitem-set-state"><link linkend="genericmenuitem-set-state">genericmenuitem_set_state</link>, function in <link linkend="Genericmenuitem">Genericmenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="GENERICMENUITEM-TYPE:CAPS"><link linkend="GENERICMENUITEM-TYPE:CAPS">GENERICMENUITEM_TYPE</link>, macro in <link linkend="Genericmenuitem">Genericmenuitem</link></primaryie></indexentry> <indexentry><primaryie linkends="DbusmenuGtkClientClass"><link linkend="DbusmenuGtkClientClass">DbusmenuGtkClientClass</link>, struct in <link linkend="libdbusmenu-gtk-DbusmenuGtkClient">DbusmenuGtkClient</link></primaryie></indexentry> <indexentry><primaryie linkends="DbusmenuGtkClientPrivate"><link linkend="DbusmenuGtkClientPrivate">DbusmenuGtkClientPrivate</link>, struct in <link linkend="libdbusmenu-gtk-DbusmenuGtkClient">DbusmenuGtkClient</link></primaryie></indexentry> <indexentry><primaryie linkends="dbusmenu-gtkclient-get-accel-group"><link linkend="dbusmenu-gtkclient-get-accel-group">dbusmenu_gtkclient_get_accel_group</link>, function in <link linkend="libdbusmenu-gtk-DbusmenuGtkClient">DbusmenuGtkClient</link></primaryie></indexentry> @@ -36,10 +22,6 @@ <indexentry><primaryie linkends="dbusmenu-gtkmenu-new"><link linkend="dbusmenu-gtkmenu-new">dbusmenu_gtkmenu_new</link>, function in <link linkend="libdbusmenu-gtk-DbusmenuGtkMenu">DbusmenuGtkMenu</link></primaryie></indexentry> <indexentry><primaryie linkends="DBUSMENU-GTKMENU-TYPE:CAPS"><link linkend="DBUSMENU-GTKMENU-TYPE:CAPS">DBUSMENU_GTKMENU_TYPE</link>, macro in <link linkend="libdbusmenu-gtk-DbusmenuGtkMenu">DbusmenuGtkMenu</link></primaryie></indexentry> </indexdiv> -<indexdiv><title>I</title> -<indexentry><primaryie linkends="IS-GENERICMENUITEM:CAPS"><link linkend="IS-GENERICMENUITEM:CAPS">IS_GENERICMENUITEM</link>, macro in <link linkend="Genericmenuitem">Genericmenuitem</link></primaryie></indexentry> -<indexentry><primaryie linkends="IS-GENERICMENUITEM-CLASS:CAPS"><link linkend="IS-GENERICMENUITEM-CLASS:CAPS">IS_GENERICMENUITEM_CLASS</link>, macro in <link linkend="Genericmenuitem">Genericmenuitem</link></primaryie></indexentry> -</indexdiv> <indexdiv><title>M</title> <indexentry><primaryie linkends="dbusmenu-menuitem-property-get-image"><link linkend="dbusmenu-menuitem-property-get-image">dbusmenu_menuitem_property_get_image</link>, function in <link linkend="libdbusmenu-gtk-menuitem">menuitem</link></primaryie></indexentry> <indexentry><primaryie linkends="dbusmenu-menuitem-property-get-shortcut"><link linkend="dbusmenu-menuitem-property-get-shortcut">dbusmenu_menuitem_property_get_shortcut</link>, function in <link linkend="libdbusmenu-gtk-menuitem">menuitem</link></primaryie></indexentry> diff --git a/docs/libdbusmenu-gtk/reference/xml/client.xml b/docs/libdbusmenu-gtk/reference/xml/client.xml index dc0e4d2..6efe10a 100644 --- a/docs/libdbusmenu-gtk/reference/xml/client.xml +++ b/docs/libdbusmenu-gtk/reference/xml/client.xml @@ -23,8 +23,8 @@ <synopsis>#define <link linkend="DBUSMENU-GTKCLIENT-TYPE:CAPS">DBUSMENU_GTKCLIENT_TYPE</link> #define <link linkend="DBUSMENU-GTKCLIENT-SIGNAL-ROOT-CHANGED:CAPS">DBUSMENU_GTKCLIENT_SIGNAL_ROOT_CHANGED</link> <link linkend="DbusmenuGtkClientPrivate">DbusmenuGtkClientPrivate</link>; - <link linkend="DbusmenuGtkClientClass">DbusmenuGtkClientClass</link>; -<link linkend="DbusmenuGtkClient"><returnvalue>DbusmenuGtkClient</returnvalue></link> * <link linkend="dbusmenu-gtkclient-new">dbusmenu_gtkclient_new</link> (<parameter><link linkend="gchar"><type>gchar</type></link> *dbus_name</parameter>, +struct <link linkend="DbusmenuGtkClientClass">DbusmenuGtkClientClass</link>; +<link linkend="DbusmenuGtkClient"><returnvalue>DbusmenuGtkClient</returnvalue></link> * <link linkend="dbusmenu-gtkclient-new">dbusmenu_gtkclient_new</link> (<parameter><link linkend="gchar"><type>gchar</type></link> *dbus_name</parameter>, <parameter><link linkend="gchar"><type>gchar</type></link> *dbus_object</parameter>); <link linkend="GtkMenuItem"><returnvalue>GtkMenuItem</returnvalue></link> * <link linkend="dbusmenu-gtkclient-menuitem-get">dbusmenu_gtkclient_menuitem_get</link> (<parameter><link linkend="DbusmenuGtkClient"><type>DbusmenuGtkClient</type></link> *client</parameter>, <parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *item</parameter>); @@ -69,9 +69,9 @@ <para> </para></refsect2> <refsect2 id="DbusmenuGtkClientClass" role="struct"> -<title>DbusmenuGtkClientClass</title> +<title>struct DbusmenuGtkClientClass</title> <indexterm zone="DbusmenuGtkClientClass"><primary>DbusmenuGtkClientClass</primary></indexterm> -<programlisting>typedef struct { +<programlisting>struct DbusmenuGtkClientClass { DbusmenuClientClass parent_class; /* Signals */ @@ -84,59 +84,46 @@ void (*reserved4) (void); void (*reserved5) (void); void (*reserved6) (void); -} DbusmenuGtkClientClass; +}; </programlisting> <variablelist role="struct"> <varlistentry><term><link linkend="DbusmenuClientClass"><type>DbusmenuClientClass</type></link> <structfield id="DbusmenuGtkClientClass.parent-class">parent_class</structfield>;</term> -<listitem><simpara><link linkend="GtkMenuClass"><type>GtkMenuClass</type></link> -</simpara></listitem> +<listitem><simpara><link linkend="GtkMenuClass"><type>GtkMenuClass</type></link></simpara></listitem> </varlistentry> <varlistentry><term><structfield id="DbusmenuGtkClientClass.root-changed">root_changed</structfield> ()</term> -<listitem><simpara> -</simpara></listitem> +<listitem><simpara></simpara></listitem> </varlistentry> <varlistentry><term><structfield id="DbusmenuGtkClientClass.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="DbusmenuGtkClientClass.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="DbusmenuGtkClientClass.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="DbusmenuGtkClientClass.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="DbusmenuGtkClientClass.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="DbusmenuGtkClientClass.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="dbusmenu-gtkclient-new" role="function"> <title>dbusmenu_gtkclient_new ()</title> <indexterm zone="dbusmenu-gtkclient-new"><primary>dbusmenu_gtkclient_new</primary></indexterm> -<programlisting><link linkend="DbusmenuGtkClient"><returnvalue>DbusmenuGtkClient</returnvalue></link> * dbusmenu_gtkclient_new (<parameter><link linkend="gchar"><type>gchar</type></link> *dbus_name</parameter>, +<programlisting><link linkend="DbusmenuGtkClient"><returnvalue>DbusmenuGtkClient</returnvalue></link> * dbusmenu_gtkclient_new (<parameter><link linkend="gchar"><type>gchar</type></link> *dbus_name</parameter>, <parameter><link linkend="gchar"><type>gchar</type></link> *dbus_object</parameter>);</programlisting> <para> Creates a new <link linkend="DbusmenuGtkClient"><type>DbusmenuGtkClient</type></link> object and creates a <link linkend="DbusmenuClient"><type>DbusmenuClient</type></link> that connects across DBus to a <link linkend="DbusmenuServer"><type>DbusmenuServer</type></link>. </para><variablelist role="params"> <varlistentry><term><parameter>dbus_name</parameter> :</term> -<listitem><simpara>Name of the <link linkend="DbusmenuServer"><type>DbusmenuServer</type></link> on DBus -</simpara></listitem></varlistentry> -<varlistentry><term><parameter>dbus_object</parameter> :</term> -<listitem><simpara> -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new <link linkend="DbusmenuGtkClient"><type>DbusmenuGtkClient</type></link> sync'd with a server -</simpara></listitem></varlistentry> +<listitem><simpara>Name of the <link linkend="DbusmenuServer"><type>DbusmenuServer</type></link> on DBus</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>A new <link linkend="DbusmenuGtkClient"><type>DbusmenuGtkClient</type></link> sync'd with a server</simpara></listitem></varlistentry> </variablelist></refsect2> <refsect2 id="dbusmenu-gtkclient-menuitem-get" role="function"> <title>dbusmenu_gtkclient_menuitem_get ()</title> @@ -148,13 +135,10 @@ This grabs the <link linkend="GtkMenuItem"><type>GtkMenuItem</type></link> that <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link>. </para><variablelist role="params"> <varlistentry><term><parameter>client</parameter> :</term> -<listitem><simpara>A <link linkend="DbusmenuGtkClient"><type>DbusmenuGtkClient</type></link> with the item in it. -</simpara></listitem></varlistentry> +<listitem><simpara>A <link linkend="DbusmenuGtkClient"><type>DbusmenuGtkClient</type></link> with the item in it.</simpara></listitem></varlistentry> <varlistentry><term><parameter>item</parameter> :</term> -<listitem><simpara><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to get associated <link linkend="GtkMenuItem"><type>GtkMenuItem</type></link> on. -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The <link linkend="GtkMenuItem"><type>GtkMenuItem</type></link> that can be played with. -</simpara></listitem></varlistentry> +<listitem><simpara><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to get associated <link linkend="GtkMenuItem"><type>GtkMenuItem</type></link> on.</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>The <link linkend="GtkMenuItem"><type>GtkMenuItem</type></link> that can be played with.</simpara></listitem></varlistentry> </variablelist></refsect2> <refsect2 id="dbusmenu-gtkclient-menuitem-get-submenu" role="function"> <title>dbusmenu_gtkclient_menuitem_get_submenu ()</title> @@ -166,13 +150,10 @@ This grabs the <link linkend="GtkMenuItem"><type>GtkMenuItem</type></link> that This grabs the submenu associated with the menuitem. </para><variablelist role="params"> <varlistentry><term><parameter>client</parameter> :</term> -<listitem><simpara>A <link linkend="DbusmenuGtkClient"><type>DbusmenuGtkClient</type></link> with the item in it. -</simpara></listitem></varlistentry> +<listitem><simpara>A <link linkend="DbusmenuGtkClient"><type>DbusmenuGtkClient</type></link> with the item in it.</simpara></listitem></varlistentry> <varlistentry><term><parameter>item</parameter> :</term> -<listitem><simpara><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to get associated <link linkend="GtkMenu"><type>GtkMenu</type></link> on. -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The <link linkend="GtkMenu"><type>GtkMenu</type></link> if there is one. -</simpara></listitem></varlistentry> +<listitem><simpara><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to get associated <link linkend="GtkMenu"><type>GtkMenu</type></link> on.</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>The <link linkend="GtkMenu"><type>GtkMenu</type></link> if there is one.</simpara></listitem></varlistentry> </variablelist></refsect2> <refsect2 id="dbusmenu-gtkclient-set-accel-group" role="function"> <title>dbusmenu_gtkclient_set_accel_group ()</title> @@ -184,11 +165,9 @@ Sets the acceleration group for the menu items with accelerators on this client. </para><variablelist role="params"> <varlistentry><term><parameter>client</parameter> :</term> -<listitem><simpara>To set the group on -</simpara></listitem></varlistentry> +<listitem><simpara>To set the group on</simpara></listitem></varlistentry> <varlistentry><term><parameter>agroup</parameter> :</term> -<listitem><simpara>The new acceleration group -</simpara></listitem></varlistentry> +<listitem><simpara>The new acceleration group</simpara></listitem></varlistentry> </variablelist></refsect2> <refsect2 id="dbusmenu-gtkclient-get-accel-group" role="function"> <title>dbusmenu_gtkclient_get_accel_group ()</title> @@ -198,11 +177,9 @@ Sets the acceleration group for the menu items with accelerators Gets the accel group for this client. </para><variablelist role="params"> <varlistentry><term><parameter>client</parameter> :</term> -<listitem><simpara>Client to query for an accelerator group -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Either a valid group or <link linkend="NULL:CAPS"><type>NULL</type></link> on error or - none set. -</simpara></listitem></varlistentry> +<listitem><simpara>Client to query for an accelerator group</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>Either a valid group or <link linkend="NULL:CAPS"><type>NULL</type></link> on error or +none set.</simpara></listitem></varlistentry> </variablelist></refsect2> <refsect2 id="dbusmenu-gtkclient-newitem-base" role="function"> <title>dbusmenu_gtkclient_newitem_base ()</title> @@ -223,17 +200,13 @@ This function provides some of the basic connectivity for being in <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> side of thing. </para><variablelist role="params"> <varlistentry><term><parameter>client</parameter> :</term> -<listitem><simpara>The client handling everything on this connection -</simpara></listitem></varlistentry> +<listitem><simpara>The client handling everything on this connection</simpara></listitem></varlistentry> <varlistentry><term><parameter>item</parameter> :</term> -<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to attach the GTK-isms to -</simpara></listitem></varlistentry> +<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to attach the GTK-isms to</simpara></listitem></varlistentry> <varlistentry><term><parameter>gmi</parameter> :</term> -<listitem><simpara>A <link linkend="GtkMenuItem"><type>GtkMenuItem</type></link> representing the GTK world's view of this menuitem -</simpara></listitem></varlistentry> +<listitem><simpara>A <link linkend="GtkMenuItem"><type>GtkMenuItem</type></link> representing the GTK world's view of this menuitem</simpara></listitem></varlistentry> <varlistentry><term><parameter>parent</parameter> :</term> -<listitem><simpara>The parent <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> -</simpara></listitem></varlistentry> +<listitem><simpara>The parent <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link></simpara></listitem></varlistentry> </variablelist></refsect2> </refsect1> diff --git a/docs/libdbusmenu-gtk/reference/xml/genericmenuitem.xml b/docs/libdbusmenu-gtk/reference/xml/genericmenuitem.xml index 1ecb04c..0ac5025 100644 --- a/docs/libdbusmenu-gtk/reference/xml/genericmenuitem.xml +++ b/docs/libdbusmenu-gtk/reference/xml/genericmenuitem.xml @@ -20,48 +20,8 @@ <refsynopsisdiv id="Genericmenuitem.synopsis" role="synopsis"> <title role="synopsis.title">Synopsis</title> -<synopsis>#define <link linkend="GENERICMENUITEM-TYPE:CAPS">GENERICMENUITEM_TYPE</link> -#define <link linkend="GENERICMENUITEM:CAPS">GENERICMENUITEM</link> (obj) -#define <link linkend="GENERICMENUITEM-CLASS:CAPS">GENERICMENUITEM_CLASS</link> (klass) -#define <link linkend="IS-GENERICMENUITEM:CAPS">IS_GENERICMENUITEM</link> (obj) -#define <link linkend="IS-GENERICMENUITEM-CLASS:CAPS">IS_GENERICMENUITEM_CLASS</link> (klass) -#define <link linkend="GENERICMENUITEM-GET-CLASS:CAPS">GENERICMENUITEM_GET_CLASS</link> (obj) - <link linkend="Genericmenuitem-struct">Genericmenuitem</link>; - <link linkend="GenericmenuitemClass">GenericmenuitemClass</link>; - <link linkend="GenericmenuitemPrivate">GenericmenuitemPrivate</link>; -enum <link linkend="GenericmenuitemCheckType">GenericmenuitemCheckType</link>; -enum <link linkend="GenericmenuitemState">GenericmenuitemState</link>; -<link linkend="GType"><returnvalue>GType</returnvalue></link> <link linkend="genericmenuitem-get-type">genericmenuitem_get_type</link> (<parameter><type>void</type></parameter>); -<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="genericmenuitem-set-check-type">genericmenuitem_set_check_type</link> (<parameter><link linkend="Genericmenuitem"><type>Genericmenuitem</type></link> *item</parameter>, - <parameter><link linkend="GenericmenuitemCheckType"><type>GenericmenuitemCheckType</type></link> check_type</parameter>); -<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="genericmenuitem-set-state">genericmenuitem_set_state</link> (<parameter><link linkend="Genericmenuitem"><type>Genericmenuitem</type></link> *item</parameter>, - <parameter><link linkend="GenericmenuitemState"><type>GenericmenuitemState</type></link> state</parameter>); -<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="genericmenuitem-set-image">genericmenuitem_set_image</link> (<parameter><link linkend="Genericmenuitem"><type>Genericmenuitem</type></link> *item</parameter>, - <parameter><link linkend="GtkWidget"><type>GtkWidget</type></link> *image</parameter>); -<link linkend="GtkWidget"><returnvalue>GtkWidget</returnvalue></link> * <link linkend="genericmenuitem-get-image">genericmenuitem_get_image</link> (<parameter><link linkend="Genericmenuitem"><type>Genericmenuitem</type></link> *item</parameter>); -</synopsis> +<synopsis></synopsis> </refsynopsisdiv> -<refsect1 id="Genericmenuitem.object-hierarchy" role="object_hierarchy"> -<title role="object_hierarchy.title">Object Hierarchy</title> -<synopsis> - <link linkend="GObject">GObject</link> - +----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link> - +----<link linkend="GtkObject">GtkObject</link> - +----<link linkend="GtkWidget">GtkWidget</link> - +----<link linkend="GtkContainer">GtkContainer</link> - +----<link linkend="GtkBin">GtkBin</link> - +----<link linkend="GtkItem">GtkItem</link> - +----<link linkend="GtkMenuItem">GtkMenuItem</link> - +----<link linkend="GtkCheckMenuItem">GtkCheckMenuItem</link> - +----Genericmenuitem -</synopsis> -</refsect1> -<refsect1 id="Genericmenuitem.implemented-interfaces" role="impl_interfaces"> -<title role="impl_interfaces.title">Implemented Interfaces</title> -<para> -Genericmenuitem implements - <link linkend="AtkImplementorIface">AtkImplementorIface</link>, <link linkend="GtkBuildable">GtkBuildable</link> and <link linkend="GtkActivatable">GtkActivatable</link>.</para> -</refsect1> <refsect1 id="Genericmenuitem.description" role="desc"> <title role="desc.title">Description</title> @@ -70,186 +30,6 @@ Genericmenuitem implements </refsect1> <refsect1 id="Genericmenuitem.details" role="details"> <title role="details.title">Details</title> -<refsect2 id="GENERICMENUITEM-TYPE:CAPS" role="macro"> -<title>GENERICMENUITEM_TYPE</title> -<indexterm zone="GENERICMENUITEM-TYPE:CAPS"><primary>GENERICMENUITEM_TYPE</primary></indexterm> -<programlisting>#define GENERICMENUITEM_TYPE (genericmenuitem_get_type ()) -</programlisting> -<para> -</para></refsect2> -<refsect2 id="GENERICMENUITEM:CAPS" role="macro"> -<title>GENERICMENUITEM()</title> -<indexterm zone="GENERICMENUITEM:CAPS"><primary>GENERICMENUITEM</primary></indexterm> -<programlisting>#define GENERICMENUITEM(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GENERICMENUITEM_TYPE, Genericmenuitem)) -</programlisting> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>obj</parameter> :</term> -<listitem><simpara> -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="GENERICMENUITEM-CLASS:CAPS" role="macro"> -<title>GENERICMENUITEM_CLASS()</title> -<indexterm zone="GENERICMENUITEM-CLASS:CAPS"><primary>GENERICMENUITEM_CLASS</primary></indexterm> -<programlisting>#define GENERICMENUITEM_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GENERICMENUITEM_TYPE, GenericmenuitemClass)) -</programlisting> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>klass</parameter> :</term> -<listitem><simpara> -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="IS-GENERICMENUITEM:CAPS" role="macro"> -<title>IS_GENERICMENUITEM()</title> -<indexterm zone="IS-GENERICMENUITEM:CAPS"><primary>IS_GENERICMENUITEM</primary></indexterm> -<programlisting>#define IS_GENERICMENUITEM(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GENERICMENUITEM_TYPE)) -</programlisting> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>obj</parameter> :</term> -<listitem><simpara> -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="IS-GENERICMENUITEM-CLASS:CAPS" role="macro"> -<title>IS_GENERICMENUITEM_CLASS()</title> -<indexterm zone="IS-GENERICMENUITEM-CLASS:CAPS"><primary>IS_GENERICMENUITEM_CLASS</primary></indexterm> -<programlisting>#define IS_GENERICMENUITEM_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GENERICMENUITEM_TYPE)) -</programlisting> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>klass</parameter> :</term> -<listitem><simpara> -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="GENERICMENUITEM-GET-CLASS:CAPS" role="macro"> -<title>GENERICMENUITEM_GET_CLASS()</title> -<indexterm zone="GENERICMENUITEM-GET-CLASS:CAPS"><primary>GENERICMENUITEM_GET_CLASS</primary></indexterm> -<programlisting>#define GENERICMENUITEM_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GENERICMENUITEM_TYPE, GenericmenuitemClass)) -</programlisting> -<para> -</para><variablelist role="params"> -<varlistentry><term><parameter>obj</parameter> :</term> -<listitem><simpara> -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="Genericmenuitem-struct" role="struct"> -<title>Genericmenuitem</title> -<indexterm zone="Genericmenuitem-struct"><primary>Genericmenuitem</primary></indexterm> -<programlisting>typedef struct _Genericmenuitem Genericmenuitem;</programlisting> -<variablelist role="struct"> -</variablelist></refsect2> -<refsect2 id="GenericmenuitemClass" role="struct"> -<title>GenericmenuitemClass</title> -<indexterm zone="GenericmenuitemClass"><primary>GenericmenuitemClass</primary></indexterm> -<programlisting>typedef struct { - GtkCheckMenuItemClass parent_class; -} GenericmenuitemClass; -</programlisting> -<variablelist role="struct"> -<varlistentry><term><link linkend="GtkCheckMenuItemClass"><type>GtkCheckMenuItemClass</type></link> <structfield id="GenericmenuitemClass.parent-class">parent_class</structfield>;</term> -<listitem><simpara>Our parent <link linkend="GtkCheckMenuItemClass"><type>GtkCheckMenuItemClass</type></link> -</simpara></listitem> -</varlistentry> -</variablelist></refsect2> -<refsect2 id="GenericmenuitemPrivate" role="struct"> -<title>GenericmenuitemPrivate</title> -<indexterm zone="GenericmenuitemPrivate"><primary>GenericmenuitemPrivate</primary></indexterm> -<programlisting>typedef struct _GenericmenuitemPrivate GenericmenuitemPrivate;</programlisting> -<variablelist role="struct"> -</variablelist></refsect2> -<refsect2 id="GenericmenuitemCheckType" role="enum"> -<title>enum GenericmenuitemCheckType</title> -<indexterm zone="GenericmenuitemCheckType"><primary>GenericmenuitemCheckType</primary></indexterm> -<programlisting>enum GenericmenuitemCheckType { - GENERICMENUITEM_CHECK_TYPE_NONE, - GENERICMENUITEM_CHECK_TYPE_CHECKBOX, - GENERICMENUITEM_CHECK_TYPE_RADIO -}; -</programlisting> -<para> -</para></refsect2> -<refsect2 id="GenericmenuitemState" role="enum"> -<title>enum GenericmenuitemState</title> -<indexterm zone="GenericmenuitemState"><primary>GenericmenuitemState</primary></indexterm> -<programlisting>enum GenericmenuitemState { - GENERICMENUITEM_STATE_UNCHECKED, - GENERICMENUITEM_STATE_CHECKED, - GENERICMENUITEM_STATE_INDETERMINATE -}; -</programlisting> -<para> -</para></refsect2> -<refsect2 id="genericmenuitem-get-type" role="function"> -<title>genericmenuitem_get_type ()</title> -<indexterm zone="genericmenuitem-get-type"><primary>genericmenuitem_get_type</primary></indexterm> -<programlisting><link linkend="GType"><returnvalue>GType</returnvalue></link> genericmenuitem_get_type (<parameter><type>void</type></parameter>);</programlisting> -<para> -</para><variablelist role="params"> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="genericmenuitem-set-check-type" role="function"> -<title>genericmenuitem_set_check_type ()</title> -<indexterm zone="genericmenuitem-set-check-type"><primary>genericmenuitem_set_check_type</primary></indexterm> -<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> genericmenuitem_set_check_type (<parameter><link linkend="Genericmenuitem"><type>Genericmenuitem</type></link> *item</parameter>, - <parameter><link linkend="GenericmenuitemCheckType"><type>GenericmenuitemCheckType</type></link> check_type</parameter>);</programlisting> -<para> -This function changes the type of the checkmark that - appears in the left hand gutter for the menuitem. -</para><variablelist role="params"> -<varlistentry><term><parameter>item</parameter> :</term> -<listitem><simpara><link linkend="Genericmenuitem"><type>Genericmenuitem</type></link> to set the type on -</simpara></listitem></varlistentry> -<varlistentry><term><parameter>check_type</parameter> :</term> -<listitem><simpara>Which type of check should be displayed -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="genericmenuitem-set-state" role="function"> -<title>genericmenuitem_set_state ()</title> -<indexterm zone="genericmenuitem-set-state"><primary>genericmenuitem_set_state</primary></indexterm> -<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> genericmenuitem_set_state (<parameter><link linkend="Genericmenuitem"><type>Genericmenuitem</type></link> *item</parameter>, - <parameter><link linkend="GenericmenuitemState"><type>GenericmenuitemState</type></link> state</parameter>);</programlisting> -<para> -Sets the state of the check in the menu item. It does - not require, but isn't really useful if the type of - check that the menuitem is set to <link linkend="GENERICMENUITEM-CHECK-TYPE-NONE:CAPS"><type>GENERICMENUITEM_CHECK_TYPE_NONE</type></link>. -</para><variablelist role="params"> -<varlistentry><term><parameter>item</parameter> :</term> -<listitem><simpara><link linkend="Genericmenuitem"><type>Genericmenuitem</type></link> to set the type on -</simpara></listitem></varlistentry> -<varlistentry><term><parameter>state</parameter> :</term> -<listitem><simpara> -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="genericmenuitem-set-image" role="function"> -<title>genericmenuitem_set_image ()</title> -<indexterm zone="genericmenuitem-set-image"><primary>genericmenuitem_set_image</primary></indexterm> -<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> genericmenuitem_set_image (<parameter><link linkend="Genericmenuitem"><type>Genericmenuitem</type></link> *item</parameter>, - <parameter><link linkend="GtkWidget"><type>GtkWidget</type></link> *image</parameter>);</programlisting> -<para> -Sets the image of the menu item. -</para><variablelist role="params"> -<varlistentry><term><parameter>item</parameter> :</term> -<listitem><simpara>A <link linkend="Genericmenuitem"><type>Genericmenuitem</type></link> -</simpara></listitem></varlistentry> -<varlistentry><term><parameter>image</parameter> :</term> -<listitem><simpara>The image to set as the image of <parameter>item</parameter> -</simpara></listitem></varlistentry> -</variablelist></refsect2> -<refsect2 id="genericmenuitem-get-image" role="function"> -<title>genericmenuitem_get_image ()</title> -<indexterm zone="genericmenuitem-get-image"><primary>genericmenuitem_get_image</primary></indexterm> -<programlisting><link linkend="GtkWidget"><returnvalue>GtkWidget</returnvalue></link> * genericmenuitem_get_image (<parameter><link linkend="Genericmenuitem"><type>Genericmenuitem</type></link> *item</parameter>);</programlisting> -<para> -Returns the image if there is one. -</para><variablelist role="params"> -<varlistentry><term><parameter>item</parameter> :</term> -<listitem><simpara>A <link linkend="Genericmenuitem"><type>Genericmenuitem</type></link> -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A pointer to the image of the item or <link linkend="NULL:CAPS"><type>NULL</type></link> - if there isn't one. -</simpara></listitem></varlistentry> -</variablelist></refsect2> </refsect1> diff --git a/docs/libdbusmenu-gtk/reference/xml/menu.xml b/docs/libdbusmenu-gtk/reference/xml/menu.xml index 26e578e..4513e23 100644 --- a/docs/libdbusmenu-gtk/reference/xml/menu.xml +++ b/docs/libdbusmenu-gtk/reference/xml/menu.xml @@ -22,10 +22,10 @@ <synopsis>#define <link linkend="DBUSMENU-GTKMENU-TYPE:CAPS">DBUSMENU_GTKMENU_TYPE</link> <link linkend="DbusmenuGtkMenuPrivate">DbusmenuGtkMenuPrivate</link>; - <link linkend="DbusmenuGtkMenuClass">DbusmenuGtkMenuClass</link>; +struct <link linkend="DbusmenuGtkMenuClass">DbusmenuGtkMenuClass</link>; <link linkend="DbusmenuGtkMenu"><returnvalue>DbusmenuGtkMenu</returnvalue></link> * <link linkend="dbusmenu-gtkmenu-new">dbusmenu_gtkmenu_new</link> (<parameter><link linkend="gchar"><type>gchar</type></link> *dbus_name</parameter>, <parameter><link linkend="gchar"><type>gchar</type></link> *dbus_object</parameter>); -<link linkend="DbusmenuGtkClient"><returnvalue>DbusmenuGtkClient</returnvalue></link> * <link linkend="dbusmenu-gtkmenu-get-client">dbusmenu_gtkmenu_get_client</link> (<parameter><link linkend="DbusmenuGtkMenu"><type>DbusmenuGtkMenu</type></link> *menu</parameter>); +<link linkend="DbusmenuGtkClient"><returnvalue>DbusmenuGtkClient</returnvalue></link> * <link linkend="dbusmenu-gtkmenu-get-client">dbusmenu_gtkmenu_get_client</link> (<parameter><link linkend="DbusmenuGtkMenu"><type>DbusmenuGtkMenu</type></link> *menu</parameter>); </synopsis> </refsynopsisdiv> @@ -50,9 +50,9 @@ <para> </para></refsect2> <refsect2 id="DbusmenuGtkMenuClass" role="struct"> -<title>DbusmenuGtkMenuClass</title> +<title>struct DbusmenuGtkMenuClass</title> <indexterm zone="DbusmenuGtkMenuClass"><primary>DbusmenuGtkMenuClass</primary></indexterm> -<programlisting>typedef struct { +<programlisting>struct DbusmenuGtkMenuClass { GtkMenuClass parent_class; /*< Private >*/ @@ -62,36 +62,29 @@ void (*reserved4) (void); void (*reserved5) (void); void (*reserved6) (void); -} DbusmenuGtkMenuClass; +}; </programlisting> <variablelist role="struct"> <varlistentry><term><link linkend="GtkMenuClass"><type>GtkMenuClass</type></link> <structfield id="DbusmenuGtkMenuClass.parent-class">parent_class</structfield>;</term> -<listitem><simpara><link linkend="GtkMenuClass"><type>GtkMenuClass</type></link> -</simpara></listitem> +<listitem><simpara><link linkend="GtkMenuClass"><type>GtkMenuClass</type></link></simpara></listitem> </varlistentry> <varlistentry><term><structfield id="DbusmenuGtkMenuClass.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="DbusmenuGtkMenuClass.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="DbusmenuGtkMenuClass.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="DbusmenuGtkMenuClass.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="DbusmenuGtkMenuClass.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="DbusmenuGtkMenuClass.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="dbusmenu-gtkmenu-new" role="function"> @@ -104,27 +97,20 @@ Creates a new <link linkend="DbusmenuGtkMenu"><type>DbusmenuGtkMenu</type></link that connects across DBus to a <link linkend="DbusmenuServer"><type>DbusmenuServer</type></link>. </para><variablelist role="params"> <varlistentry><term><parameter>dbus_name</parameter> :</term> -<listitem><simpara>Name of the <link linkend="DbusmenuServer"><type>DbusmenuServer</type></link> on DBus -</simpara></listitem></varlistentry> -<varlistentry><term><parameter>dbus_object</parameter> :</term> -<listitem><simpara> -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new <link linkend="DbusmenuGtkMenu"><type>DbusmenuGtkMenu</type></link> sync'd with a server -</simpara></listitem></varlistentry> +<listitem><simpara>Name of the <link linkend="DbusmenuServer"><type>DbusmenuServer</type></link> on DBus</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>A new <link linkend="DbusmenuGtkMenu"><type>DbusmenuGtkMenu</type></link> sync'd with a server</simpara></listitem></varlistentry> </variablelist></refsect2> <refsect2 id="dbusmenu-gtkmenu-get-client" role="function"> <title>dbusmenu_gtkmenu_get_client ()</title> <indexterm zone="dbusmenu-gtkmenu-get-client"><primary>dbusmenu_gtkmenu_get_client</primary></indexterm> -<programlisting><link linkend="DbusmenuGtkClient"><returnvalue>DbusmenuGtkClient</returnvalue></link> * dbusmenu_gtkmenu_get_client (<parameter><link linkend="DbusmenuGtkMenu"><type>DbusmenuGtkMenu</type></link> *menu</parameter>);</programlisting> +<programlisting><link linkend="DbusmenuGtkClient"><returnvalue>DbusmenuGtkClient</returnvalue></link> * dbusmenu_gtkmenu_get_client (<parameter><link linkend="DbusmenuGtkMenu"><type>DbusmenuGtkMenu</type></link> *menu</parameter>);</programlisting> <para> An accessor for the client that this menu is using to communicate with the server. </para><variablelist role="params"> <varlistentry><term><parameter>menu</parameter> :</term> -<listitem><simpara>The <link linkend="DbusmenuGtkMenu"><type>DbusmenuGtkMenu</type></link> to get the client from -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A valid <link linkend="DbusmenuGtkClient"><type>DbusmenuGtkClient</type></link> or NULL on error. -</simpara></listitem></varlistentry> +<listitem><simpara>The <link linkend="DbusmenuGtkMenu"><type>DbusmenuGtkMenu</type></link> to get the client from</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>A valid <link linkend="DbusmenuGtkClient"><type>DbusmenuGtkClient</type></link> or NULL on error.</simpara></listitem></varlistentry> </variablelist></refsect2> </refsect1> diff --git a/docs/libdbusmenu-gtk/reference/xml/menuitem.xml b/docs/libdbusmenu-gtk/reference/xml/menuitem.xml index 4b92368..6af8086 100644 --- a/docs/libdbusmenu-gtk/reference/xml/menuitem.xml +++ b/docs/libdbusmenu-gtk/reference/xml/menuitem.xml @@ -64,17 +64,13 @@ This function takes the pixbuf that is stored in <parameter>data</parameter> and onto a standard <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> property. </para><variablelist role="params"> <varlistentry><term><parameter>menuitem</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>data</parameter> :</term> -<listitem><simpara>The image to place on the property. -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Whether the function was able to set the property - or not. -</simpara></listitem></varlistentry> +<listitem><simpara>The image to place on the property.</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>Whether the function was able to set the property +or not.</simpara></listitem></varlistentry> </variablelist></refsect2> <refsect2 id="dbusmenu-menuitem-property-get-image" role="function"> <title>dbusmenu_menuitem_property_get_image ()</title> @@ -89,13 +85,10 @@ This function looks on the menu item for a property by the PNG file like the one created by <link linkend="dbusmenu-menuite-property-set-image"><type>dbusmenu_menuite_property_set_image</type></link>. </para><variablelist role="params"> <varlistentry><term><parameter>menuitem</parameter> :</term> -<listitem><simpara>The <link linkend="DbusmenuMenuite"><type>DbusmenuMenuite</type></link> to look for the property on -</simpara></listitem></varlistentry> +<listitem><simpara>The <link linkend="DbusmenuMenuite"><type>DbusmenuMenuite</type></link> to look for the property on</simpara></listitem></varlistentry> <varlistentry><term><parameter>property</parameter> :</term> -<listitem><simpara>The name of the property to look for. -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A pixbuf or <link linkend="NULL:CAPS"><type>NULL</type></link> to signal error. -</simpara></listitem></varlistentry> +<listitem><simpara>The name of the property to look for.</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>A pixbuf or <link linkend="NULL:CAPS"><type>NULL</type></link> to signal error.</simpara></listitem></varlistentry> </variablelist></refsect2> <refsect2 id="dbusmenu-menuitem-property-set-shortcut" role="function"> <title>dbusmenu_menuitem_property_set_shortcut ()</title> @@ -109,16 +102,12 @@ Takes the modifer described by <parameter>key</parameter> and <parameter>modifie the format sending across Dbus for shortcuts. </para><variablelist role="params"> <varlistentry><term><parameter>menuitem</parameter> :</term> -<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to set the shortcut on -</simpara></listitem></varlistentry> +<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to set the shortcut on</simpara></listitem></varlistentry> <varlistentry><term><parameter>key</parameter> :</term> -<listitem><simpara>The keycode of the key to send -</simpara></listitem></varlistentry> +<listitem><simpara>The keycode of the key to send</simpara></listitem></varlistentry> <varlistentry><term><parameter>modifier</parameter> :</term> -<listitem><simpara>A bitmask of modifiers used to activate the item -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Whether it was successful at setting the property. -</simpara></listitem></varlistentry> +<listitem><simpara>A bitmask of modifiers used to activate the item</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>Whether it was successful at setting the property.</simpara></listitem></varlistentry> </variablelist></refsect2> <refsect2 id="dbusmenu-menuitem-property-set-shortcut-string" role="function"> <title>dbusmenu_menuitem_property_set_shortcut_string ()</title> @@ -132,13 +121,10 @@ This function takes a GTK shortcut string as defined in required to send it over DBusmenu. </para><variablelist role="params"> <varlistentry><term><parameter>menuitem</parameter> :</term> -<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to set the shortcut on -</simpara></listitem></varlistentry> +<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to set the shortcut on</simpara></listitem></varlistentry> <varlistentry><term><parameter>shortcut</parameter> :</term> -<listitem><simpara>String describing the shortcut -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Whether it was successful at setting the property. -</simpara></listitem></varlistentry> +<listitem><simpara>String describing the shortcut</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>Whether it was successful at setting the property.</simpara></listitem></varlistentry> </variablelist></refsect2> <refsect2 id="dbusmenu-menuitem-property-set-shortcut-menuitem" role="function"> <title>dbusmenu_menuitem_property_set_shortcut_menuitem ()</title> @@ -152,13 +138,10 @@ Takes the shortcut that is installed on a menu item and calls up listeners to watch it change. </para><variablelist role="params"> <varlistentry><term><parameter>menuitem</parameter> :</term> -<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to set the shortcut on -</simpara></listitem></varlistentry> +<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to set the shortcut on</simpara></listitem></varlistentry> <varlistentry><term><parameter>gmi</parameter> :</term> -<listitem><simpara>A menu item to steal the shortcut off of -</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Whether it was successful at setting the property. -</simpara></listitem></varlistentry> +<listitem><simpara>A menu item to steal the shortcut off of</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>Whether it was successful at setting the property.</simpara></listitem></varlistentry> </variablelist></refsect2> <refsect2 id="dbusmenu-menuitem-property-get-shortcut" role="function"> <title>dbusmenu_menuitem_property_get_shortcut ()</title> @@ -172,14 +155,9 @@ This function gets a GTK shortcut as a key and a mask for use to set the accelerators. </para><variablelist role="params"> <varlistentry><term><parameter>menuitem</parameter> :</term> -<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to get the shortcut off -</simpara></listitem></varlistentry> +<listitem><simpara>The <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> to get the shortcut off</simpara></listitem></varlistentry> <varlistentry><term><parameter>key</parameter> :</term> -<listitem><simpara>Location to put the key value -</simpara></listitem></varlistentry> -<varlistentry><term><parameter>modifiers</parameter> :</term> -<listitem><simpara> -</simpara></listitem></varlistentry> +<listitem><simpara>Location to put the key value</simpara></listitem></varlistentry> </variablelist></refsect2> </refsect1> |