diff options
Diffstat (limited to 'docs/libdbusmenu-gtk/reference/xml')
| -rw-r--r-- | docs/libdbusmenu-gtk/reference/xml/api-index-deprecated.xml | 8 | ||||
| -rw-r--r-- | docs/libdbusmenu-gtk/reference/xml/api-index-full.xml | 49 | ||||
| -rw-r--r-- | docs/libdbusmenu-gtk/reference/xml/client.xml | 224 | ||||
| -rw-r--r-- | docs/libdbusmenu-gtk/reference/xml/genericmenuitem.xml | 256 | ||||
| -rw-r--r-- | docs/libdbusmenu-gtk/reference/xml/menu.xml | 115 | ||||
| -rw-r--r-- | docs/libdbusmenu-gtk/reference/xml/menuitem.xml | 187 |
6 files changed, 839 insertions, 0 deletions
diff --git a/docs/libdbusmenu-gtk/reference/xml/api-index-deprecated.xml b/docs/libdbusmenu-gtk/reference/xml/api-index-deprecated.xml new file mode 100644 index 0000000..8ec0fe4 --- /dev/null +++ b/docs/libdbusmenu-gtk/reference/xml/api-index-deprecated.xml @@ -0,0 +1,8 @@ +<?xml version="1.0"?> +<!DOCTYPE indexdiv PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" + "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" +[ + <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'"> +]> +<indexdiv> +</indexdiv> diff --git a/docs/libdbusmenu-gtk/reference/xml/api-index-full.xml b/docs/libdbusmenu-gtk/reference/xml/api-index-full.xml new file mode 100644 index 0000000..8d13dd9 --- /dev/null +++ b/docs/libdbusmenu-gtk/reference/xml/api-index-full.xml @@ -0,0 +1,49 @@ +<?xml version="1.0"?> +<!DOCTYPE indexdiv PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" + "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" +[ + <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'"> +]> +<indexdiv> +<indexdiv><title>G</title> +<indexentry><primaryie linkends="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="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> +<indexentry><primaryie linkends="dbusmenu-gtkclient-menuitem-get"><link linkend="dbusmenu-gtkclient-menuitem-get">dbusmenu_gtkclient_menuitem_get</link>, function in <link linkend="libdbusmenu-gtk-DbusmenuGtkClient">DbusmenuGtkClient</link></primaryie></indexentry> +<indexentry><primaryie linkends="dbusmenu-gtkclient-menuitem-get-submenu"><link linkend="dbusmenu-gtkclient-menuitem-get-submenu">dbusmenu_gtkclient_menuitem_get_submenu</link>, function in <link linkend="libdbusmenu-gtk-DbusmenuGtkClient">DbusmenuGtkClient</link></primaryie></indexentry> +<indexentry><primaryie linkends="dbusmenu-gtkclient-new"><link linkend="dbusmenu-gtkclient-new">dbusmenu_gtkclient_new</link>, function in <link linkend="libdbusmenu-gtk-DbusmenuGtkClient">DbusmenuGtkClient</link></primaryie></indexentry> +<indexentry><primaryie linkends="dbusmenu-gtkclient-newitem-base"><link linkend="dbusmenu-gtkclient-newitem-base">dbusmenu_gtkclient_newitem_base</link>, function in <link linkend="libdbusmenu-gtk-DbusmenuGtkClient">DbusmenuGtkClient</link></primaryie></indexentry> +<indexentry><primaryie linkends="dbusmenu-gtkclient-set-accel-group"><link linkend="dbusmenu-gtkclient-set-accel-group">dbusmenu_gtkclient_set_accel_group</link>, function in <link linkend="libdbusmenu-gtk-DbusmenuGtkClient">DbusmenuGtkClient</link></primaryie></indexentry> +<indexentry><primaryie linkends="DBUSMENU-GTKCLIENT-SIGNAL-ROOT-CHANGED:CAPS"><link linkend="DBUSMENU-GTKCLIENT-SIGNAL-ROOT-CHANGED:CAPS">DBUSMENU_GTKCLIENT_SIGNAL_ROOT_CHANGED</link>, macro in <link linkend="libdbusmenu-gtk-DbusmenuGtkClient">DbusmenuGtkClient</link></primaryie></indexentry> +<indexentry><primaryie linkends="DBUSMENU-GTKCLIENT-TYPE:CAPS"><link linkend="DBUSMENU-GTKCLIENT-TYPE:CAPS">DBUSMENU_GTKCLIENT_TYPE</link>, macro in <link linkend="libdbusmenu-gtk-DbusmenuGtkClient">DbusmenuGtkClient</link></primaryie></indexentry> +<indexentry><primaryie linkends="DbusmenuGtkMenuClass"><link linkend="DbusmenuGtkMenuClass">DbusmenuGtkMenuClass</link>, struct in <link linkend="libdbusmenu-gtk-DbusmenuGtkMenu">DbusmenuGtkMenu</link></primaryie></indexentry> +<indexentry><primaryie linkends="dbusmenu-gtkmenu-get-client"><link linkend="dbusmenu-gtkmenu-get-client">dbusmenu_gtkmenu_get_client</link>, function in <link linkend="libdbusmenu-gtk-DbusmenuGtkMenu">DbusmenuGtkMenu</link></primaryie></indexentry> +<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> +<indexentry><primaryie linkends="dbusmenu-menuitem-property-set-image"><link linkend="dbusmenu-menuitem-property-set-image">dbusmenu_menuitem_property_set_image</link>, function in <link linkend="libdbusmenu-gtk-menuitem">menuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="dbusmenu-menuitem-property-set-shortcut"><link linkend="dbusmenu-menuitem-property-set-shortcut">dbusmenu_menuitem_property_set_shortcut</link>, function in <link linkend="libdbusmenu-gtk-menuitem">menuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="dbusmenu-menuitem-property-set-shortcut-menuitem"><link linkend="dbusmenu-menuitem-property-set-shortcut-menuitem">dbusmenu_menuitem_property_set_shortcut_menuitem</link>, function in <link linkend="libdbusmenu-gtk-menuitem">menuitem</link></primaryie></indexentry> +<indexentry><primaryie linkends="dbusmenu-menuitem-property-set-shortcut-string"><link linkend="dbusmenu-menuitem-property-set-shortcut-string">dbusmenu_menuitem_property_set_shortcut_string</link>, function in <link linkend="libdbusmenu-gtk-menuitem">menuitem</link></primaryie></indexentry> +</indexdiv> +</indexdiv> diff --git a/docs/libdbusmenu-gtk/reference/xml/client.xml b/docs/libdbusmenu-gtk/reference/xml/client.xml new file mode 100644 index 0000000..cd7910e --- /dev/null +++ b/docs/libdbusmenu-gtk/reference/xml/client.xml @@ -0,0 +1,224 @@ +<?xml version="1.0"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" + "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" +[ + <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'"> +]> +<refentry id="libdbusmenu-gtk-DbusmenuGtkClient"> +<refmeta> +<refentrytitle role="top_of_page" id="libdbusmenu-gtk-DbusmenuGtkClient.top_of_page">DbusmenuGtkClient</refentrytitle> +<manvolnum>3</manvolnum> +<refmiscinfo> + LIBDBUSMENU-GTK Library +</refmiscinfo> +</refmeta> +<refnamediv> +<refname>DbusmenuGtkClient</refname> +<refpurpose></refpurpose> +</refnamediv> + +<refsynopsisdiv id="libdbusmenu-gtk-DbusmenuGtkClient.synopsis" role="synopsis"> +<title role="synopsis.title">Synopsis</title> + +<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="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>); +<link linkend="GtkMenu"><returnvalue>GtkMenu</returnvalue></link> * <link linkend="dbusmenu-gtkclient-menuitem-get-submenu">dbusmenu_gtkclient_menuitem_get_submenu</link> + (<parameter><link linkend="DbusmenuGtkClient"><type>DbusmenuGtkClient</type></link> *client</parameter>, + <parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *item</parameter>); +<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="dbusmenu-gtkclient-set-accel-group">dbusmenu_gtkclient_set_accel_group</link> (<parameter><link linkend="DbusmenuGtkClient"><type>DbusmenuGtkClient</type></link> *client</parameter>, + <parameter><link linkend="GtkAccelGroup"><type>GtkAccelGroup</type></link> *agroup</parameter>); +<link linkend="GtkAccelGroup"><returnvalue>GtkAccelGroup</returnvalue></link> * <link linkend="dbusmenu-gtkclient-get-accel-group">dbusmenu_gtkclient_get_accel_group</link> (<parameter><link linkend="DbusmenuGtkClient"><type>DbusmenuGtkClient</type></link> *client</parameter>); +<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="dbusmenu-gtkclient-newitem-base">dbusmenu_gtkclient_newitem_base</link> (<parameter><link linkend="DbusmenuGtkClient"><type>DbusmenuGtkClient</type></link> *client</parameter>, + <parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *item</parameter>, + <parameter><link linkend="GtkMenuItem"><type>GtkMenuItem</type></link> *gmi</parameter>, + <parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *parent</parameter>); +</synopsis> +</refsynopsisdiv> + +<refsect1 id="libdbusmenu-gtk-DbusmenuGtkClient.description" role="desc"> +<title role="desc.title">Description</title> +<para> +</para> +</refsect1> +<refsect1 id="libdbusmenu-gtk-DbusmenuGtkClient.details" role="details"> +<title role="details.title">Details</title> +<refsect2 id="DBUSMENU-GTKCLIENT-TYPE:CAPS" role="macro"> +<title>DBUSMENU_GTKCLIENT_TYPE</title> +<indexterm zone="DBUSMENU-GTKCLIENT-TYPE:CAPS"><primary>DBUSMENU_GTKCLIENT_TYPE</primary></indexterm> +<programlisting>#define DBUSMENU_GTKCLIENT_TYPE (dbusmenu_gtkclient_get_type ()) +</programlisting> +<para> +</para></refsect2> +<refsect2 id="DBUSMENU-GTKCLIENT-SIGNAL-ROOT-CHANGED:CAPS" role="macro"> +<title>DBUSMENU_GTKCLIENT_SIGNAL_ROOT_CHANGED</title> +<indexterm zone="DBUSMENU-GTKCLIENT-SIGNAL-ROOT-CHANGED:CAPS"><primary>DBUSMENU_GTKCLIENT_SIGNAL_ROOT_CHANGED</primary></indexterm> +<programlisting>#define DBUSMENU_GTKCLIENT_SIGNAL_ROOT_CHANGED DBUSMENU_CLIENT_SIGNAL_ROOT_CHANGED +</programlisting> +<para> +</para></refsect2> +<refsect2 id="DbusmenuGtkClientClass" role="struct"> +<title>DbusmenuGtkClientClass</title> +<indexterm zone="DbusmenuGtkClientClass"><primary>DbusmenuGtkClientClass</primary></indexterm> +<programlisting>typedef struct { + DbusmenuClientClass parent_class; + + /* Signals */ + void (*root_changed) (DbusmenuMenuitem * newroot); + + /* Reserved */ + void (*reserved1) (void); + void (*reserved2) (void); + void (*reserved3) (void); + void (*reserved4) (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> +</varlistentry> +<varlistentry><term><structfield id="DbusmenuGtkClientClass.root-changed">root_changed</structfield> ()</term> +<listitem><simpara> +</simpara></listitem> +</varlistentry> +<varlistentry><term><structfield id="DbusmenuGtkClientClass.reserved1">reserved1</structfield> ()</term> +<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> +</varlistentry> +<varlistentry><term><structfield id="DbusmenuGtkClientClass.reserved3">reserved3</structfield> ()</term> +<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> +</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>, + <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> +</variablelist></refsect2> +<refsect2 id="dbusmenu-gtkclient-menuitem-get" role="function"> +<title>dbusmenu_gtkclient_menuitem_get ()</title> +<indexterm zone="dbusmenu-gtkclient-menuitem-get"><primary>dbusmenu_gtkclient_menuitem_get</primary></indexterm> +<programlisting><link linkend="GtkMenuItem"><returnvalue>GtkMenuItem</returnvalue></link> * dbusmenu_gtkclient_menuitem_get (<parameter><link linkend="DbusmenuGtkClient"><type>DbusmenuGtkClient</type></link> *client</parameter>, + <parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *item</parameter>);</programlisting> +<para> +This grabs the <link linkend="GtkMenuItem"><type>GtkMenuItem</type></link> that is associated with the + <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> +<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> +</variablelist></refsect2> +<refsect2 id="dbusmenu-gtkclient-menuitem-get-submenu" role="function"> +<title>dbusmenu_gtkclient_menuitem_get_submenu ()</title> +<indexterm zone="dbusmenu-gtkclient-menuitem-get-submenu"><primary>dbusmenu_gtkclient_menuitem_get_submenu</primary></indexterm> +<programlisting><link linkend="GtkMenu"><returnvalue>GtkMenu</returnvalue></link> * dbusmenu_gtkclient_menuitem_get_submenu + (<parameter><link linkend="DbusmenuGtkClient"><type>DbusmenuGtkClient</type></link> *client</parameter>, + <parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *item</parameter>);</programlisting> +<para> +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> +<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> +</variablelist></refsect2> +<refsect2 id="dbusmenu-gtkclient-set-accel-group" role="function"> +<title>dbusmenu_gtkclient_set_accel_group ()</title> +<indexterm zone="dbusmenu-gtkclient-set-accel-group"><primary>dbusmenu_gtkclient_set_accel_group</primary></indexterm> +<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> dbusmenu_gtkclient_set_accel_group (<parameter><link linkend="DbusmenuGtkClient"><type>DbusmenuGtkClient</type></link> *client</parameter>, + <parameter><link linkend="GtkAccelGroup"><type>GtkAccelGroup</type></link> *agroup</parameter>);</programlisting> +<para> +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> +<varlistentry><term><parameter>agroup</parameter> :</term> +<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> +<indexterm zone="dbusmenu-gtkclient-get-accel-group"><primary>dbusmenu_gtkclient_get_accel_group</primary></indexterm> +<programlisting><link linkend="GtkAccelGroup"><returnvalue>GtkAccelGroup</returnvalue></link> * dbusmenu_gtkclient_get_accel_group (<parameter><link linkend="DbusmenuGtkClient"><type>DbusmenuGtkClient</type></link> *client</parameter>);</programlisting> +<para> +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> +</variablelist></refsect2> +<refsect2 id="dbusmenu-gtkclient-newitem-base" role="function"> +<title>dbusmenu_gtkclient_newitem_base ()</title> +<indexterm zone="dbusmenu-gtkclient-newitem-base"><primary>dbusmenu_gtkclient_newitem_base</primary></indexterm> +<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> dbusmenu_gtkclient_newitem_base (<parameter><link linkend="DbusmenuGtkClient"><type>DbusmenuGtkClient</type></link> *client</parameter>, + <parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *item</parameter>, + <parameter><link linkend="GtkMenuItem"><type>GtkMenuItem</type></link> *gmi</parameter>, + <parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *parent</parameter>);</programlisting> +<para> +This function provides some of the basic connectivity for being in + the GTK world. Things like visibility and sensitivity of the item are + handled here so that the subclasses don't have to. If you're building + your on GTK menu item you can use this function to apply those basic + attributes so that you don't have to deal with them either. +</para> +<para> + This also handles passing the "activate" signal back to the + <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> +<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> +<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> +<varlistentry><term><parameter>parent</parameter> :</term> +<listitem><simpara>The parent <link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> +</simpara></listitem></varlistentry> +</variablelist></refsect2> + +</refsect1> + +</refentry> diff --git a/docs/libdbusmenu-gtk/reference/xml/genericmenuitem.xml b/docs/libdbusmenu-gtk/reference/xml/genericmenuitem.xml new file mode 100644 index 0000000..1ecb04c --- /dev/null +++ b/docs/libdbusmenu-gtk/reference/xml/genericmenuitem.xml @@ -0,0 +1,256 @@ +<?xml version="1.0"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" + "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" +[ + <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'"> +]> +<refentry id="Genericmenuitem"> +<refmeta> +<refentrytitle role="top_of_page" id="Genericmenuitem.top_of_page">Genericmenuitem</refentrytitle> +<manvolnum>3</manvolnum> +<refmiscinfo> + LIBDBUSMENU-GTK Library +</refmiscinfo> +</refmeta> +<refnamediv> +<refname>Genericmenuitem</refname> +<refpurpose></refpurpose> +</refnamediv> + +<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> +</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> +<para> +</para> +</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> + +</refentry> diff --git a/docs/libdbusmenu-gtk/reference/xml/menu.xml b/docs/libdbusmenu-gtk/reference/xml/menu.xml new file mode 100644 index 0000000..5074b52 --- /dev/null +++ b/docs/libdbusmenu-gtk/reference/xml/menu.xml @@ -0,0 +1,115 @@ +<?xml version="1.0"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" + "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" +[ + <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'"> +]> +<refentry id="libdbusmenu-gtk-DbusmenuGtkMenu"> +<refmeta> +<refentrytitle role="top_of_page" id="libdbusmenu-gtk-DbusmenuGtkMenu.top_of_page">DbusmenuGtkMenu</refentrytitle> +<manvolnum>3</manvolnum> +<refmiscinfo> + LIBDBUSMENU-GTK Library +</refmiscinfo> +</refmeta> +<refnamediv> +<refname>DbusmenuGtkMenu</refname> +<refpurpose></refpurpose> +</refnamediv> + +<refsynopsisdiv id="libdbusmenu-gtk-DbusmenuGtkMenu.synopsis" role="synopsis"> +<title role="synopsis.title">Synopsis</title> + +<synopsis>#define <link linkend="DBUSMENU-GTKMENU-TYPE:CAPS">DBUSMENU_GTKMENU_TYPE</link> + <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>); +</synopsis> +</refsynopsisdiv> + +<refsect1 id="libdbusmenu-gtk-DbusmenuGtkMenu.description" role="desc"> +<title role="desc.title">Description</title> +<para> +</para> +</refsect1> +<refsect1 id="libdbusmenu-gtk-DbusmenuGtkMenu.details" role="details"> +<title role="details.title">Details</title> +<refsect2 id="DBUSMENU-GTKMENU-TYPE:CAPS" role="macro"> +<title>DBUSMENU_GTKMENU_TYPE</title> +<indexterm zone="DBUSMENU-GTKMENU-TYPE:CAPS"><primary>DBUSMENU_GTKMENU_TYPE</primary></indexterm> +<programlisting>#define DBUSMENU_GTKMENU_TYPE (dbusmenu_gtkmenu_get_type ()) +</programlisting> +<para> +</para></refsect2> +<refsect2 id="DbusmenuGtkMenuClass" role="struct"> +<title>DbusmenuGtkMenuClass</title> +<indexterm zone="DbusmenuGtkMenuClass"><primary>DbusmenuGtkMenuClass</primary></indexterm> +<programlisting>typedef struct { + GtkMenuClass parent_class; + + /* Reserved */ + void (*reserved1) (void); + void (*reserved2) (void); + void (*reserved3) (void); + void (*reserved4) (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> +</varlistentry> +<varlistentry><term><structfield id="DbusmenuGtkMenuClass.reserved1">reserved1</structfield> ()</term> +<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> +</varlistentry> +<varlistentry><term><structfield id="DbusmenuGtkMenuClass.reserved3">reserved3</structfield> ()</term> +<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> +</varlistentry> +</variablelist></refsect2> +<refsect2 id="dbusmenu-gtkmenu-new" role="function"> +<title>dbusmenu_gtkmenu_new ()</title> +<indexterm zone="dbusmenu-gtkmenu-new"><primary>dbusmenu_gtkmenu_new</primary></indexterm> +<programlisting><link linkend="DbusmenuGtkMenu"><returnvalue>DbusmenuGtkMenu</returnvalue></link> * dbusmenu_gtkmenu_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="DbusmenuGtkMenu"><type>DbusmenuGtkMenu</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="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> +<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> +</variablelist></refsect2> + +</refsect1> + +</refentry> diff --git a/docs/libdbusmenu-gtk/reference/xml/menuitem.xml b/docs/libdbusmenu-gtk/reference/xml/menuitem.xml new file mode 100644 index 0000000..4b92368 --- /dev/null +++ b/docs/libdbusmenu-gtk/reference/xml/menuitem.xml @@ -0,0 +1,187 @@ +<?xml version="1.0"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" + "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" +[ + <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'"> +]> +<refentry id="libdbusmenu-gtk-menuitem"> +<refmeta> +<refentrytitle role="top_of_page" id="libdbusmenu-gtk-menuitem.top_of_page">menuitem</refentrytitle> +<manvolnum>3</manvolnum> +<refmiscinfo> + LIBDBUSMENU-GTK Library +</refmiscinfo> +</refmeta> +<refnamediv> +<refname>menuitem</refname> +<refpurpose></refpurpose> +</refnamediv> + +<refsynopsisdiv id="libdbusmenu-gtk-menuitem.synopsis" role="synopsis"> +<title role="synopsis.title">Synopsis</title> + +<synopsis><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="dbusmenu-menuitem-property-set-image">dbusmenu_menuitem_property_set_image</link> + (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *menuitem</parameter>, + <parameter>const <link linkend="gchar"><type>gchar</type></link> *property</parameter>, + <parameter>const <link linkend="GdkPixbuf"><type>GdkPixbuf</type></link> *data</parameter>); +<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> + +<refsect1 id="libdbusmenu-gtk-menuitem.description" role="desc"> +<title role="desc.title">Description</title> +<para> +</para> +</refsect1> +<refsect1 id="libdbusmenu-gtk-menuitem.details" role="details"> +<title role="details.title">Details</title> +<refsect2 id="dbusmenu-menuitem-property-set-image" role="function"> +<title>dbusmenu_menuitem_property_set_image ()</title> +<indexterm zone="dbusmenu-menuitem-property-set-image"><primary>dbusmenu_menuitem_property_set_image</primary></indexterm> +<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> dbusmenu_menuitem_property_set_image + (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *menuitem</parameter>, + <parameter>const <link linkend="gchar"><type>gchar</type></link> *property</parameter>, + <parameter>const <link linkend="GdkPixbuf"><type>GdkPixbuf</type></link> *data</parameter>);</programlisting> +<para> +This function takes the pixbuf that is stored in <parameter>data</parameter> and + turns it into a base64 encoded PNG so that it can be placed + 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> +<varlistentry><term><parameter>property</parameter> :</term> +<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> +</variablelist></refsect2> +<refsect2 id="dbusmenu-menuitem-property-get-image" role="function"> +<title>dbusmenu_menuitem_property_get_image ()</title> +<indexterm zone="dbusmenu-menuitem-property-get-image"><primary>dbusmenu_menuitem_property_get_image</primary></indexterm> +<programlisting><link linkend="GdkPixbuf"><returnvalue>GdkPixbuf</returnvalue></link> * dbusmenu_menuitem_property_get_image + (<parameter><link linkend="DbusmenuMenuitem"><type>DbusmenuMenuitem</type></link> *menuitem</parameter>, + <parameter>const <link linkend="gchar"><type>gchar</type></link> *property</parameter>);</programlisting> +<para> +This function looks on the menu item for a property by the + name of <parameter>property</parameter>. If one exists it tries to turn it into + a <link linkend="GdkPixbuf"><type>GdkPixbuf</type></link>. It assumes that the property is a base64 encoded + 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> +<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> +</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> + +</refentry> |