diff options
| author | Ken VanDine <ken.vandine@canonical.com> | 2011-01-27 16:40:56 -0500 |
|---|---|---|
| committer | Ken VanDine <ken.vandine@canonical.com> | 2011-01-27 16:40:56 -0500 |
| commit | e08b0e33060a39b3c95e43531825a95f5d415af8 (patch) | |
| tree | cb3deecc01d16e57265afe76ce1074df10a79baa /docs/libdbusmenu-glib/reference/html/libdbusmenu-glib-DbusmenuClient.html | |
| parent | 4ef0a2886c4d4865a453ee32656937eb37669421 (diff) | |
| parent | ea3e23cd918f2b8c7b6f9a94b3d80499bc0ce550 (diff) | |
| download | libdbusmenu-e08b0e33060a39b3c95e43531825a95f5d415af8.tar.gz libdbusmenu-e08b0e33060a39b3c95e43531825a95f5d415af8.tar.bz2 libdbusmenu-e08b0e33060a39b3c95e43531825a95f5d415af8.zip | |
releasing version 0.3.94-0ubuntu1
Diffstat (limited to 'docs/libdbusmenu-glib/reference/html/libdbusmenu-glib-DbusmenuClient.html')
| -rw-r--r-- | docs/libdbusmenu-glib/reference/html/libdbusmenu-glib-DbusmenuClient.html | 239 |
1 files changed, 79 insertions, 160 deletions
diff --git a/docs/libdbusmenu-glib/reference/html/libdbusmenu-glib-DbusmenuClient.html b/docs/libdbusmenu-glib/reference/html/libdbusmenu-glib-DbusmenuClient.html index d811d86..935b872 100644 --- a/docs/libdbusmenu-glib/reference/html/libdbusmenu-glib-DbusmenuClient.html +++ b/docs/libdbusmenu-glib/reference/html/libdbusmenu-glib-DbusmenuClient.html @@ -8,7 +8,7 @@ <link rel="up" href="ch01.html" title="API"> <link rel="prev" href="libdbusmenu-glib-DbusmenuMenuitem.html" title="DbusmenuMenuitem"> <link rel="next" href="libdbusmenu-glib-DbusmenuClientMenuitem.html" title="DbusmenuClientMenuitem"> -<meta name="generator" content="GTK-Doc V1.15 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.16 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -26,7 +26,7 @@ <a href="#libdbusmenu-glib-DbusmenuClient.description" class="shortcut">Description</a> </td></tr> </table> -<div class="refentry" title="DbusmenuClient"> +<div class="refentry"> <a name="libdbusmenu-glib-DbusmenuClient"></a><div class="titlepage"></div> <div class="refnamediv"><table width="100%"><tr> <td valign="top"> @@ -35,11 +35,11 @@ </td> <td valign="top" align="right"></td> </tr></table></div> -<div class="refsect1" title="Stability Level"> +<div class="refsect1"> <a name="libdbusmenu-glib-DbusmenuClient.stability-level"></a><h2>Stability Level</h2> Unstable, unless otherwise indicated </div> -<div class="refsynopsisdiv" title="Synopsis"> +<div class="refsynopsisdiv"> <a name="libdbusmenu-glib-DbusmenuClient.synopsis"></a><h2>Synopsis</h2> <pre class="synopsis"> #include <libdbusmenu-glib/client.h> @@ -53,13 +53,14 @@ Unstable, unless otherwise indicated #define <a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DBUSMENU-CLIENT-TYPES-SEPARATOR:CAPS" title="DBUSMENU_CLIENT_TYPES_SEPARATOR">DBUSMENU_CLIENT_TYPES_SEPARATOR</a> #define <a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DBUSMENU-CLIENT-TYPES-IMAGE:CAPS" title="DBUSMENU_CLIENT_TYPES_IMAGE">DBUSMENU_CLIENT_TYPES_IMAGE</a> <a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DbusmenuClient" title="DbusmenuClient">DbusmenuClient</a>; - <a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DbusmenuClientClass" title="DbusmenuClientClass">DbusmenuClientClass</a>; -<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> (<a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DbusmenuClientTypeHandler" title="DbusmenuClientTypeHandler ()">*DbusmenuClientTypeHandler</a>) (<em class="parameter"><code><a class="link" href="libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem" title="DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> *newitem</code></em>, - <em class="parameter"><code><a class="link" href="libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem" title="DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> *parent</code></em>, - <em class="parameter"><code><a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DbusmenuClient" title="DbusmenuClient"><span class="type">DbusmenuClient</span></a> *client</code></em>); -<a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DbusmenuClient" title="DbusmenuClient"><span class="returnvalue">DbusmenuClient</span></a> * <a class="link" href="libdbusmenu-glib-DbusmenuClient.html#dbusmenu-client-new" title="dbusmenu_client_new ()">dbusmenu_client_new</a> (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>, +struct <a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DbusmenuClientClass" title="struct DbusmenuClientClass">DbusmenuClientClass</a>; +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> (<a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DbusmenuClientTypeHandler" title="DbusmenuClientTypeHandler ()">*DbusmenuClientTypeHandler</a>) (<em class="parameter"><code><a class="link" href="libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem" title="struct DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> *newitem</code></em>, + <em class="parameter"><code><a class="link" href="libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem" title="struct DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> *parent</code></em>, + <em class="parameter"><code><a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DbusmenuClient" title="DbusmenuClient"><span class="type">DbusmenuClient</span></a> *client</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>); +<a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DbusmenuClient" title="DbusmenuClient"><span class="returnvalue">DbusmenuClient</span></a> * <a class="link" href="libdbusmenu-glib-DbusmenuClient.html#dbusmenu-client-new" title="dbusmenu_client_new ()">dbusmenu_client_new</a> (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>, <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *object</code></em>); -<a class="link" href="libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem" title="DbusmenuMenuitem"><span class="returnvalue">DbusmenuMenuitem</span></a> * <a class="link" href="libdbusmenu-glib-DbusmenuClient.html#dbusmenu-client-get-root" title="dbusmenu_client_get_root ()">dbusmenu_client_get_root</a> (<em class="parameter"><code><a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DbusmenuClient" title="DbusmenuClient"><span class="type">DbusmenuClient</span></a> *client</code></em>); +<a class="link" href="libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem" title="struct DbusmenuMenuitem"><span class="returnvalue">DbusmenuMenuitem</span></a> * <a class="link" href="libdbusmenu-glib-DbusmenuClient.html#dbusmenu-client-get-root" title="dbusmenu_client_get_root ()">dbusmenu_client_get_root</a> (<em class="parameter"><code><a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DbusmenuClient" title="DbusmenuClient"><span class="type">DbusmenuClient</span></a> *client</code></em>); <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="libdbusmenu-glib-DbusmenuClient.html#dbusmenu-client-add-type-handler" title="dbusmenu_client_add_type_handler ()">dbusmenu_client_add_type_handler</a> (<em class="parameter"><code><a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DbusmenuClient" title="DbusmenuClient"><span class="type">DbusmenuClient</span></a> *client</code></em>, <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *type</code></em>, <em class="parameter"><code><a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DbusmenuClientTypeHandler" title="DbusmenuClientTypeHandler ()"><span class="type">DbusmenuClientTypeHandler</span></a> newfunc</code></em>); @@ -70,11 +71,11 @@ Unstable, unless otherwise indicated <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> timestamp</code></em>); <span class="returnvalue">void</span> <a class="link" href="libdbusmenu-glib-DbusmenuClient.html#dbusmenu-client-send-about-to-show" title="dbusmenu_client_send_about_to_show ()">dbusmenu_client_send_about_to_show</a> (<em class="parameter"><code><a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DbusmenuClient" title="DbusmenuClient"><span class="type">DbusmenuClient</span></a> *client</code></em>, <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> id</code></em>, - <em class="parameter"><code><span class="type">void</span> (cbgpointer user_data) ()</code></em>, + <em class="parameter"><code><span class="type">void</span> (*cb) (gpointer user_data)</code></em>, <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> cb_data</code></em>); </pre> </div> -<div class="refsect1" title="Description"> +<div class="refsect1"> <a name="libdbusmenu-glib-DbusmenuClient.description"></a><h2>Description</h2> <p> The client exists as a mirror to the server. For most folks @@ -93,9 +94,9 @@ The client exists as a mirror to the server. For most folks nodes should be enough for most users. </p> </div> -<div class="refsect1" title="Details"> +<div class="refsect1"> <a name="libdbusmenu-glib-DbusmenuClient.details"></a><h2>Details</h2> -<div class="refsect2" title="DBUSMENU_CLIENT_SIGNAL_LAYOUT_UPDATED"> +<div class="refsect2"> <a name="DBUSMENU-CLIENT-SIGNAL-LAYOUT-UPDATED:CAPS"></a><h3>DBUSMENU_CLIENT_SIGNAL_LAYOUT_UPDATED</h3> <pre class="programlisting">#define DBUSMENU_CLIENT_SIGNAL_LAYOUT_UPDATED "layout-updated" </pre> @@ -103,7 +104,7 @@ The client exists as a mirror to the server. For most folks </p> </div> <hr> -<div class="refsect2" title="DBUSMENU_CLIENT_SIGNAL_ROOT_CHANGED"> +<div class="refsect2"> <a name="DBUSMENU-CLIENT-SIGNAL-ROOT-CHANGED:CAPS"></a><h3>DBUSMENU_CLIENT_SIGNAL_ROOT_CHANGED</h3> <pre class="programlisting">#define DBUSMENU_CLIENT_SIGNAL_ROOT_CHANGED "root-changed" </pre> @@ -111,7 +112,7 @@ The client exists as a mirror to the server. For most folks </p> </div> <hr> -<div class="refsect2" title="DBUSMENU_CLIENT_SIGNAL_NEW_MENUITEM"> +<div class="refsect2"> <a name="DBUSMENU-CLIENT-SIGNAL-NEW-MENUITEM:CAPS"></a><h3>DBUSMENU_CLIENT_SIGNAL_NEW_MENUITEM</h3> <pre class="programlisting">#define DBUSMENU_CLIENT_SIGNAL_NEW_MENUITEM "new-menuitem" </pre> @@ -119,7 +120,7 @@ The client exists as a mirror to the server. For most folks </p> </div> <hr> -<div class="refsect2" title="DBUSMENU_CLIENT_PROP_DBUS_NAME"> +<div class="refsect2"> <a name="DBUSMENU-CLIENT-PROP-DBUS-NAME:CAPS"></a><h3>DBUSMENU_CLIENT_PROP_DBUS_NAME</h3> <pre class="programlisting">#define DBUSMENU_CLIENT_PROP_DBUS_NAME "dbus-name" </pre> @@ -127,7 +128,7 @@ The client exists as a mirror to the server. For most folks </p> </div> <hr> -<div class="refsect2" title="DBUSMENU_CLIENT_PROP_DBUS_OBJECT"> +<div class="refsect2"> <a name="DBUSMENU-CLIENT-PROP-DBUS-OBJECT:CAPS"></a><h3>DBUSMENU_CLIENT_PROP_DBUS_OBJECT</h3> <pre class="programlisting">#define DBUSMENU_CLIENT_PROP_DBUS_OBJECT "dbus-object" </pre> @@ -135,7 +136,7 @@ The client exists as a mirror to the server. For most folks </p> </div> <hr> -<div class="refsect2" title="DBUSMENU_CLIENT_TYPES_DEFAULT"> +<div class="refsect2"> <a name="DBUSMENU-CLIENT-TYPES-DEFAULT:CAPS"></a><h3>DBUSMENU_CLIENT_TYPES_DEFAULT</h3> <pre class="programlisting">#define DBUSMENU_CLIENT_TYPES_DEFAULT "standard" </pre> @@ -143,7 +144,7 @@ The client exists as a mirror to the server. For most folks </p> </div> <hr> -<div class="refsect2" title="DBUSMENU_CLIENT_TYPES_SEPARATOR"> +<div class="refsect2"> <a name="DBUSMENU-CLIENT-TYPES-SEPARATOR:CAPS"></a><h3>DBUSMENU_CLIENT_TYPES_SEPARATOR</h3> <pre class="programlisting">#define DBUSMENU_CLIENT_TYPES_SEPARATOR "separator" </pre> @@ -151,7 +152,7 @@ The client exists as a mirror to the server. For most folks </p> </div> <hr> -<div class="refsect2" title="DBUSMENU_CLIENT_TYPES_IMAGE"> +<div class="refsect2"> <a name="DBUSMENU-CLIENT-TYPES-IMAGE:CAPS"></a><h3>DBUSMENU_CLIENT_TYPES_IMAGE</h3> <pre class="programlisting">#define DBUSMENU_CLIENT_TYPES_IMAGE "standard" </pre> @@ -159,40 +160,22 @@ The client exists as a mirror to the server. For most folks </p> </div> <hr> -<div class="refsect2" title="DbusmenuClient"> +<div class="refsect2"> <a name="DbusmenuClient"></a><h3>DbusmenuClient</h3> -<pre class="programlisting">typedef struct { - GObject parent; - - /*< Private >*/ - DbusmenuClientPrivate * priv; -} DbusmenuClient; -</pre> +<pre class="programlisting">typedef struct _DbusmenuClient DbusmenuClient;</pre> <p> The client for a <a class="link" href="libdbusmenu-glib-DbusmenuServer.html#DbusmenuServer" title="DbusmenuServer"><span class="type">DbusmenuServer</span></a> creating a shared - object set of <a class="link" href="libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem" title="DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> objects. + object set of <a class="link" href="libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem" title="struct DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> objects. </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> <em class="structfield"><code><a name="DbusmenuClient.parent"></a>parent</code></em>;</span></p></td> -<td> -<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a>. -</td> -</tr> -<tr> -<td><p><span class="term"><span class="type">DbusmenuClientPrivate</span> *<em class="structfield"><code><a name="DbusmenuClient.priv"></a>priv</code></em>;</span></p></td> -<td> -</td> -</tr> -</tbody> +<tbody></tbody> </table></div> </div> <hr> -<div class="refsect2" title="DbusmenuClientClass"> -<a name="DbusmenuClientClass"></a><h3>DbusmenuClientClass</h3> -<pre class="programlisting">typedef struct { +<div class="refsect2"> +<a name="DbusmenuClientClass"></a><h3>struct DbusmenuClientClass</h3> +<pre class="programlisting">struct DbusmenuClientClass { GObjectClass parent_class; void (*layout_updated)(void); @@ -208,118 +191,105 @@ The client for a <a class="link" href="libdbusmenu-glib-DbusmenuServer.html#Dbus void (*reserved4) (void); void (*reserved5) (void); void (*reserved6) (void); -} DbusmenuClientClass; +}; </pre> <p> A simple class that takes all of the information from a <a class="link" href="libdbusmenu-glib-DbusmenuServer.html#DbusmenuServer" title="DbusmenuServer"><span class="type">DbusmenuServer</span></a> over DBus and makes the same set of - <a class="link" href="libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem" title="DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> objects appear on the other side. + <a class="link" href="libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem" title="struct DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> objects appear on the other side. </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObjectClass"><span class="type">GObjectClass</span></a> <em class="structfield"><code><a name="DbusmenuClientClass.parent-class"></a>parent_class</code></em>;</span></p></td> -<td> -<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObjectClass"><span class="type">GObjectClass</span></a> -</td> +<td><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObjectClass"><span class="type">GObjectClass</span></a></td> </tr> <tr> <td><p><span class="term"><em class="structfield"><code><a name="DbusmenuClientClass.layout-updated"></a>layout_updated</code></em> ()</span></p></td> -<td>Slot for <span class="type">"layout-updated"</span>. -</td> +<td>Slot for <span class="type">"layout-updated"</span>.</td> </tr> <tr> <td><p><span class="term"><em class="structfield"><code><a name="DbusmenuClientClass.root-changed"></a>root_changed</code></em> ()</span></p></td> -<td> -</td> +<td></td> </tr> <tr> <td><p><span class="term"><em class="structfield"><code><a name="DbusmenuClientClass.new-menuitem"></a>new_menuitem</code></em> ()</span></p></td> -<td>Slot for <span class="type">"new-menuitem"</span>. -</td> +<td>Slot for <span class="type">"new-menuitem"</span>.</td> </tr> <tr> <td><p><span class="term"><em class="structfield"><code><a name="DbusmenuClientClass.item-activate"></a>item_activate</code></em> ()</span></p></td> -<td>Slot for <span class="type">"item-activate"</span>. -</td> +<td>Slot for <span class="type">"item-activate"</span>.</td> </tr> <tr> <td><p><span class="term"><em class="structfield"><code><a name="DbusmenuClientClass.event-result"></a>event_result</code></em> ()</span></p></td> -<td>Slot for <span class="type">"event-error"</span>. -</td> +<td>Slot for <span class="type">"event-error"</span>.</td> </tr> <tr> <td><p><span class="term"><em class="structfield"><code><a name="DbusmenuClientClass.reserved1"></a>reserved1</code></em> ()</span></p></td> -<td>Reserved for future use. -</td> +<td>Reserved for future use.</td> </tr> <tr> <td><p><span class="term"><em class="structfield"><code><a name="DbusmenuClientClass.reserved2"></a>reserved2</code></em> ()</span></p></td> -<td>Reserved for future use. -</td> +<td>Reserved for future use.</td> </tr> <tr> <td><p><span class="term"><em class="structfield"><code><a name="DbusmenuClientClass.reserved3"></a>reserved3</code></em> ()</span></p></td> -<td>Reserved for future use. -</td> +<td>Reserved for future use.</td> </tr> <tr> <td><p><span class="term"><em class="structfield"><code><a name="DbusmenuClientClass.reserved4"></a>reserved4</code></em> ()</span></p></td> -<td>Reserved for future use. -</td> +<td>Reserved for future use.</td> </tr> <tr> <td><p><span class="term"><em class="structfield"><code><a name="DbusmenuClientClass.reserved5"></a>reserved5</code></em> ()</span></p></td> -<td>Reserved for future use. -</td> +<td>Reserved for future use.</td> </tr> <tr> <td><p><span class="term"><em class="structfield"><code><a name="DbusmenuClientClass.reserved6"></a>reserved6</code></em> ()</span></p></td> -<td>Reserved for future use. -</td> +<td>Reserved for future use.</td> </tr> </tbody> </table></div> </div> <hr> -<div class="refsect2" title="DbusmenuClientTypeHandler ()"> +<div class="refsect2"> <a name="DbusmenuClientTypeHandler"></a><h3>DbusmenuClientTypeHandler ()</h3> -<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> (*DbusmenuClientTypeHandler) (<em class="parameter"><code><a class="link" href="libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem" title="DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> *newitem</code></em>, - <em class="parameter"><code><a class="link" href="libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem" title="DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> *parent</code></em>, - <em class="parameter"><code><a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DbusmenuClient" title="DbusmenuClient"><span class="type">DbusmenuClient</span></a> *client</code></em>);</pre> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> (*DbusmenuClientTypeHandler) (<em class="parameter"><code><a class="link" href="libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem" title="struct DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> *newitem</code></em>, + <em class="parameter"><code><a class="link" href="libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem" title="struct DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> *parent</code></em>, + <em class="parameter"><code><a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DbusmenuClient" title="DbusmenuClient"><span class="type">DbusmenuClient</span></a> *client</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre> <p> +The type handler is called when a dbusmenu item is created + with a matching type as setup in <a class="link" href="libdbusmenu-glib-DbusmenuClient.html#dbusmenu-client-add-type-handler" title="dbusmenu_client_add_type_handler ()"><span class="type">dbusmenu_client_add_type_handler</span></a> </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>newitem</code></em> :</span></p></td> -<td> -</td> +<td>The <a class="link" href="libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem" title="struct DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> that was created</td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>parent</code></em> :</span></p></td> -<td> -</td> +<td>The parent of <em class="parameter"><code>newitem</code></em> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><span class="type">NULL</span></a> if none</td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td> -<td> +<td>A pointer to the <a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DbusmenuClient" title="DbusmenuClient"><span class="type">DbusmenuClient</span></a> </td> </tr> <tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> -</td> +<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td> +<td>The data you gave us</td> </tr> </tbody> </table></div> </div> <hr> -<div class="refsect2" title="dbusmenu_client_new ()"> +<div class="refsect2"> <a name="dbusmenu-client-new"></a><h3>dbusmenu_client_new ()</h3> -<pre class="programlisting"><a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DbusmenuClient" title="DbusmenuClient"><span class="returnvalue">DbusmenuClient</span></a> * dbusmenu_client_new (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>, +<pre class="programlisting"><a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DbusmenuClient" title="DbusmenuClient"><span class="returnvalue">DbusmenuClient</span></a> * dbusmenu_client_new (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>, <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *object</code></em>);</pre> <p> This function creates a new client that connects to a specific @@ -333,26 +303,24 @@ This function creates a new client that connects to a specific <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td> -<td>The DBus name for the server to connect to -</td> +<td>The DBus name for the server to connect to</td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td> -<td>The object on the server to monitor -</td> +<td>The object on the server to monitor</td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> A brand new <a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DbusmenuClient" title="DbusmenuClient"><span class="type">DbusmenuClient</span></a> +<td>A brand new <a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DbusmenuClient" title="DbusmenuClient"><span class="type">DbusmenuClient</span></a> </td> </tr> </tbody> </table></div> </div> <hr> -<div class="refsect2" title="dbusmenu_client_get_root ()"> +<div class="refsect2"> <a name="dbusmenu-client-get-root"></a><h3>dbusmenu_client_get_root ()</h3> -<pre class="programlisting"><a class="link" href="libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem" title="DbusmenuMenuitem"><span class="returnvalue">DbusmenuMenuitem</span></a> * dbusmenu_client_get_root (<em class="parameter"><code><a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DbusmenuClient" title="DbusmenuClient"><span class="type">DbusmenuClient</span></a> *client</code></em>);</pre> +<pre class="programlisting"><a class="link" href="libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem" title="struct DbusmenuMenuitem"><span class="returnvalue">DbusmenuMenuitem</span></a> * dbusmenu_client_get_root (<em class="parameter"><code><a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DbusmenuClient" title="DbusmenuClient"><span class="type">DbusmenuClient</span></a> *client</code></em>);</pre> <p> Grabs the root node for the specified client <em class="parameter"><code>client</code></em>. This function may block. It will block if there is currently a @@ -367,21 +335,19 @@ Grabs the root node for the specified client <em class="parameter"><code>client< <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td> -<td>The <a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DbusmenuClient" title="DbusmenuClient"><span class="type">DbusmenuClient</span></a> to get the root node from -</td> +<td>The <a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DbusmenuClient" title="DbusmenuClient"><span class="type">DbusmenuClient</span></a> to get the root node from</td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> A <a class="link" href="libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem" title="DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> representing the root of - menu on the server. If there is no server or there is - an error receiving its layout it'll return <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><span class="type">NULL</span></a>. -</td> +<td>A <a class="link" href="libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem" title="struct DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> representing the root of +menu on the server. If there is no server or there is +an error receiving its layout it'll return <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><span class="type">NULL</span></a>.</td> </tr> </tbody> </table></div> </div> <hr> -<div class="refsect2" title="dbusmenu_client_add_type_handler ()"> +<div class="refsect2"> <a name="dbusmenu-client-add-type-handler"></a><h3>dbusmenu_client_add_type_handler ()</h3> <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> dbusmenu_client_add_type_handler (<em class="parameter"><code><a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DbusmenuClient" title="DbusmenuClient"><span class="type">DbusmenuClient</span></a> *client</code></em>, <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *type</code></em>, @@ -392,7 +358,7 @@ This function connects into the type handling of the <a class="link" href="libdb properties. When we get those properties we check the 'type' property and look to see if it matches a handler that is known by the client. If so, the <em class="parameter"><code>newfunc</code></em> function is executed on that - <a class="link" href="libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem" title="DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a>. If not, then the DbusmenuClient::new-menuitem + <a class="link" href="libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem" title="struct DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a>. If not, then the DbusmenuClient::new-menuitem signal is sent. </p> <p> @@ -404,31 +370,27 @@ This function connects into the type handling of the <a class="link" href="libdb <tbody> <tr> <td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td> -<td>Client where we're getting types coming in -</td> +<td>Client where we're getting types coming in</td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td> <td>A text string that will be matched with the 'type' - property on incoming menu items -</td> +property on incoming menu items</td> </tr> <tr> <td><p><span class="term"><em class="parameter"><code>newfunc</code></em> :</span></p></td> <td>The function that will be executed with those new - items when they come in. -</td> +items when they come in.</td> </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> If registering the new type was successful. -</td> +<td>If registering the new type was successful.</td> </tr> </tbody> </table></div> </div> <hr> -<div class="refsect2" title="dbusmenu_client_send_event ()"> +<div class="refsect2"> <a name="dbusmenu-client-send-event"></a><h3>dbusmenu_client_send_event ()</h3> <pre class="programlisting"><span class="returnvalue">void</span> dbusmenu_client_send_event (<em class="parameter"><code><a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DbusmenuClient" title="DbusmenuClient"><span class="type">DbusmenuClient</span></a> *client</code></em>, <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> id</code></em>, @@ -437,72 +399,29 @@ This function connects into the type handling of the <a class="link" href="libdb <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> timestamp</code></em>);</pre> <p> </p> -<div class="variablelist"><table border="0"> -<col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td> -<td> -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td> -<td> -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td> -<td> -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>variant</code></em> :</span></p></td> -<td> -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>timestamp</code></em> :</span></p></td> -<td> -</td> -</tr> -</tbody> -</table></div> </div> <hr> -<div class="refsect2" title="dbusmenu_client_send_about_to_show ()"> +<div class="refsect2"> <a name="dbusmenu-client-send-about-to-show"></a><h3>dbusmenu_client_send_about_to_show ()</h3> <pre class="programlisting"><span class="returnvalue">void</span> dbusmenu_client_send_about_to_show (<em class="parameter"><code><a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DbusmenuClient" title="DbusmenuClient"><span class="type">DbusmenuClient</span></a> *client</code></em>, <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> id</code></em>, - <em class="parameter"><code><span class="type">void</span> (cbgpointer user_data) ()</code></em>, + <em class="parameter"><code><span class="type">void</span> (*cb) (gpointer user_data)</code></em>, <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> cb_data</code></em>);</pre> <p> </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> -<tbody> -<tr> -<td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td> -<td> -</td> -</tr> -<tr> +<tbody><tr> <td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td> <td> -<em class="parameter"><code>gpointer</code></em> user_data: -</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>cb_data</code></em> :</span></p></td> -<td> -</td> -</tr> -</tbody> +<em class="parameter"><code>gpointer</code></em> user_data:</td> +</tr></tbody> </table></div> </div> </div> </div> <div class="footer"> <hr> - Generated by GTK-Doc V1.15</div> + Generated by GTK-Doc V1.16</div> </body> </html>
\ No newline at end of file |