diff options
author | Ken VanDine <ken.vandine@canonical.com> | 2010-08-03 11:31:13 -0400 |
---|---|---|
committer | Ken VanDine <ken.vandine@canonical.com> | 2010-08-03 11:31:13 -0400 |
commit | 850b6b37172364b823e6afe0813d48a1466f6a9c (patch) | |
tree | afb323bbad6655b2a2e989f268412cbf2dee841a /docs/libdbusmenu-gtk/reference/xml/menuitem.xml | |
parent | 8dbd3ed2a39b885de434da32079cd64ef264ba99 (diff) | |
parent | 165de03abfb456cdff28880f6824651cf873e35f (diff) | |
download | libdbusmenu-850b6b37172364b823e6afe0813d48a1466f6a9c.tar.gz libdbusmenu-850b6b37172364b823e6afe0813d48a1466f6a9c.tar.bz2 libdbusmenu-850b6b37172364b823e6afe0813d48a1466f6a9c.zip |
releasing version 0.3.9-0ubuntu1
Diffstat (limited to 'docs/libdbusmenu-gtk/reference/xml/menuitem.xml')
-rw-r--r-- | docs/libdbusmenu-gtk/reference/xml/menuitem.xml | 98 |
1 files changed, 0 insertions, 98 deletions
diff --git a/docs/libdbusmenu-gtk/reference/xml/menuitem.xml b/docs/libdbusmenu-gtk/reference/xml/menuitem.xml index 4b92368..b9bd4b6 100644 --- a/docs/libdbusmenu-gtk/reference/xml/menuitem.xml +++ b/docs/libdbusmenu-gtk/reference/xml/menuitem.xml @@ -27,20 +27,6 @@ <link linkend="GdkPixbuf"><returnvalue>GdkPixbuf</returnvalue></link> * <link linkend="dbusmenu-menuitem-property-get-image">dbusmenu_menuitem_property_get_image</link> (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *menuitem</parameter>, <parameter>const <link linkend="gchar"><type>gchar</type></link> *property</parameter>); -<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="dbusmenu-menuitem-property-set-shortcut">dbusmenu_menuitem_property_set_shortcut</link> - (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *menuitem</parameter>, - <parameter><link linkend="guint"><type>guint</type></link> key</parameter>, - <parameter><link linkend="GdkModifierType"><type>GdkModifierType</type></link> modifier</parameter>); -<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="dbusmenu-menuitem-property-set-shortcut-string">dbusmenu_menuitem_property_set_shortcut_string</link> - (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *menuitem</parameter>, - <parameter>const <link linkend="gchar"><type>gchar</type></link> *shortcut</parameter>); -<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="dbusmenu-menuitem-property-set-shortcut-menuitem">dbusmenu_menuitem_property_set_shortcut_menuitem</link> - (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *menuitem</parameter>, - <parameter>const <link linkend="GtkMenuItem"><type>GtkMenuItem</type></link> *gmi</parameter>); -<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="dbusmenu-menuitem-property-get-shortcut">dbusmenu_menuitem_property_get_shortcut</link> - (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *menuitem</parameter>, - <parameter><link linkend="guint"><type>guint</type></link> *key</parameter>, - <parameter><link linkend="GdkModifierType"><type>GdkModifierType</type></link> *modifiers</parameter>); </synopsis> </refsynopsisdiv> @@ -97,90 +83,6 @@ This function looks on the menu item for a property by the <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> -<indexterm zone="dbusmenu-menuitem-property-set-shortcut"><primary>dbusmenu_menuitem_property_set_shortcut</primary></indexterm> -<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> dbusmenu_menuitem_property_set_shortcut - (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *menuitem</parameter>, - <parameter><link linkend="guint"><type>guint</type></link> key</parameter>, - <parameter><link linkend="GdkModifierType"><type>GdkModifierType</type></link> modifier</parameter>);</programlisting> -<para> -Takes the modifer described by <parameter>key</parameter> and <parameter>modifier</parameter> and places that into - 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> -<varlistentry><term><parameter>key</parameter> :</term> -<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> -</variablelist></refsect2> -<refsect2 id="dbusmenu-menuitem-property-set-shortcut-string" role="function"> -<title>dbusmenu_menuitem_property_set_shortcut_string ()</title> -<indexterm zone="dbusmenu-menuitem-property-set-shortcut-string"><primary>dbusmenu_menuitem_property_set_shortcut_string</primary></indexterm> -<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> dbusmenu_menuitem_property_set_shortcut_string - (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *menuitem</parameter>, - <parameter>const <link linkend="gchar"><type>gchar</type></link> *shortcut</parameter>);</programlisting> -<para> -This function takes a GTK shortcut string as defined in - <link linkend="gtk-accelerator-parse"><type>gtk_accelerator_parse</type></link> and turns that into the information - 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> -<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> -</variablelist></refsect2> -<refsect2 id="dbusmenu-menuitem-property-set-shortcut-menuitem" role="function"> -<title>dbusmenu_menuitem_property_set_shortcut_menuitem ()</title> -<indexterm zone="dbusmenu-menuitem-property-set-shortcut-menuitem"><primary>dbusmenu_menuitem_property_set_shortcut_menuitem</primary></indexterm> -<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> dbusmenu_menuitem_property_set_shortcut_menuitem - (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *menuitem</parameter>, - <parameter>const <link linkend="GtkMenuItem"><type>GtkMenuItem</type></link> *gmi</parameter>);</programlisting> -<para> -Takes the shortcut that is installed on a menu item and calls - <link linkend="dbusmenu-menuitem-property-set-shortcut"><type>dbusmenu_menuitem_property_set_shortcut</type></link> with it. It also sets - 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> -<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> -</variablelist></refsect2> -<refsect2 id="dbusmenu-menuitem-property-get-shortcut" role="function"> -<title>dbusmenu_menuitem_property_get_shortcut ()</title> -<indexterm zone="dbusmenu-menuitem-property-get-shortcut"><primary>dbusmenu_menuitem_property_get_shortcut</primary></indexterm> -<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> dbusmenu_menuitem_property_get_shortcut - (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *menuitem</parameter>, - <parameter><link linkend="guint"><type>guint</type></link> *key</parameter>, - <parameter><link linkend="GdkModifierType"><type>GdkModifierType</type></link> *modifiers</parameter>);</programlisting> -<para> -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> -<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> -</variablelist></refsect2> </refsect1> |