aboutsummaryrefslogtreecommitdiff
path: root/docs/libdbusmenu-gtk/reference/xml/client.xml
diff options
context:
space:
mode:
authorTed Gould <ted@gould.cx>2011-01-27 14:20:28 -0600
committerTed Gould <ted@gould.cx>2011-01-27 14:20:28 -0600
commit8ebd984c6a2b81e1bf109786a9bc69dba5f69308 (patch)
tree73669fd5d4f23f61b56537c9f444ccd5c1833e7c /docs/libdbusmenu-gtk/reference/xml/client.xml
parent788e7913d8e948876c70b7a7003a75caf8d5627a (diff)
parent2a91021522eb038b3aa18f2532ac289b921c9a48 (diff)
downloadlibdbusmenu-8ebd984c6a2b81e1bf109786a9bc69dba5f69308.tar.gz
libdbusmenu-8ebd984c6a2b81e1bf109786a9bc69dba5f69308.tar.bz2
libdbusmenu-8ebd984c6a2b81e1bf109786a9bc69dba5f69308.zip
New upstream release.
Diffstat (limited to 'docs/libdbusmenu-gtk/reference/xml/client.xml')
-rw-r--r--docs/libdbusmenu-gtk/reference/xml/client.xml89
1 files changed, 31 insertions, 58 deletions
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>&#160;<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>&#160;()</term>
-<listitem><simpara>
-</simpara></listitem>
+<listitem><simpara></simpara></listitem>
</varlistentry>
<varlistentry><term><structfield id="DbusmenuGtkClientClass.reserved1">reserved1</structfield>&#160;()</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>&#160;()</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>&#160;()</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>&#160;()</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>&#160;()</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>&#160;()</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>&#160;:</term>
-<listitem><simpara>Name of the <link linkend="DbusmenuServer"><type>DbusmenuServer</type></link> on DBus
-</simpara></listitem></varlistentry>
-<varlistentry><term><parameter>dbus_object</parameter>&#160;:</term>
-<listitem><simpara>
-</simpara></listitem></varlistentry>
-<varlistentry><term><emphasis>Returns</emphasis>&#160;:</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>&#160;:</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>&#160;:</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>&#160;:</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>&#160;:</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>&#160;:</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>&#160;:</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>&#160;:</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>&#160;:</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>&#160;:</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>&#160;:</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>&#160;:</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>&#160;:</term>
-<listitem><simpara>Client to query for an accelerator group
-</simpara></listitem></varlistentry>
-<varlistentry><term><emphasis>Returns</emphasis>&#160;:</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>&#160;:</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>&#160;:</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>&#160;:</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>&#160;:</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>&#160;:</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>