diff options
Diffstat (limited to 'docs/libdbusmenu-gtk/reference/xml/menuitem.xml')
| -rw-r--r-- | docs/libdbusmenu-gtk/reference/xml/menuitem.xml | 62 |
1 files changed, 20 insertions, 42 deletions
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> |