diff options
author | Ted Gould <ted@gould.cx> | 2011-01-14 10:36:48 -0600 |
---|---|---|
committer | Ted Gould <ted@gould.cx> | 2011-01-14 10:36:48 -0600 |
commit | 2461e539704dc3b306c24b5b841be342111a76b9 (patch) | |
tree | 36293d9dbbf964f7f1fe54765140c19564c861b1 /docs/libdbusmenu-glib/reference/html/libdbusmenu-glib-DbusmenuServer.html | |
parent | b76ed9c7f918123610e5e56bb9cdd1025d34caa1 (diff) | |
parent | ece305e4b1b4eee4e3fb54faf8f9c291ef915e8c (diff) | |
download | libdbusmenu-2461e539704dc3b306c24b5b841be342111a76b9.tar.gz libdbusmenu-2461e539704dc3b306c24b5b841be342111a76b9.tar.bz2 libdbusmenu-2461e539704dc3b306c24b5b841be342111a76b9.zip |
Import upstream version 0.3.92
Diffstat (limited to 'docs/libdbusmenu-glib/reference/html/libdbusmenu-glib-DbusmenuServer.html')
-rw-r--r-- | docs/libdbusmenu-glib/reference/html/libdbusmenu-glib-DbusmenuServer.html | 299 |
1 files changed, 299 insertions, 0 deletions
diff --git a/docs/libdbusmenu-glib/reference/html/libdbusmenu-glib-DbusmenuServer.html b/docs/libdbusmenu-glib/reference/html/libdbusmenu-glib-DbusmenuServer.html new file mode 100644 index 0000000..d58acff --- /dev/null +++ b/docs/libdbusmenu-glib/reference/html/libdbusmenu-glib-DbusmenuServer.html @@ -0,0 +1,299 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>DbusmenuServer</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="index.html" title="libdbusmenu-glib Reference Manual"> +<link rel="up" href="ch01.html" title="API"> +<link rel="prev" href="ch01.html" title="API"> +<link rel="next" href="libdbusmenu-glib-DbusmenuMenuitemProxy.html" title="DbusmenuMenuitemProxy"> +<meta name="generator" content="GTK-Doc V1.15 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="ch01.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">libdbusmenu-glib Reference Manual</th> +<td><a accesskey="n" href="libdbusmenu-glib-DbusmenuMenuitemProxy.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#libdbusmenu-glib-DbusmenuServer.synopsis" class="shortcut">Top</a> + | + <a href="#libdbusmenu-glib-DbusmenuServer.description" class="shortcut">Description</a> +</td></tr> +</table> +<div class="refentry" title="DbusmenuServer"> +<a name="libdbusmenu-glib-DbusmenuServer"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="libdbusmenu-glib-DbusmenuServer.top_of_page"></a>DbusmenuServer</span></h2> +<p>DbusmenuServer</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv" title="Synopsis"> +<a name="libdbusmenu-glib-DbusmenuServer.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis">#define <a class="link" href="libdbusmenu-glib-DbusmenuServer.html#DBUSMENU-SERVER-SIGNAL-ID-PROP-UPDATE:CAPS" title="DBUSMENU_SERVER_SIGNAL_ID_PROP_UPDATE">DBUSMENU_SERVER_SIGNAL_ID_PROP_UPDATE</a> +#define <a class="link" href="libdbusmenu-glib-DbusmenuServer.html#DBUSMENU-SERVER-SIGNAL-ID-UPDATE:CAPS" title="DBUSMENU_SERVER_SIGNAL_ID_UPDATE">DBUSMENU_SERVER_SIGNAL_ID_UPDATE</a> +#define <a class="link" href="libdbusmenu-glib-DbusmenuServer.html#DBUSMENU-SERVER-SIGNAL-LAYOUT-UPDATED:CAPS" title="DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATED">DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATED</a> +#define <a class="link" href="libdbusmenu-glib-DbusmenuServer.html#DBUSMENU-SERVER-SIGNAL-LAYOUT-UPDATE:CAPS" title="DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATE">DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATE</a> +#define <a class="link" href="libdbusmenu-glib-DbusmenuServer.html#DBUSMENU-SERVER-PROP-DBUS-OBJECT:CAPS" title="DBUSMENU_SERVER_PROP_DBUS_OBJECT">DBUSMENU_SERVER_PROP_DBUS_OBJECT</a> +#define <a class="link" href="libdbusmenu-glib-DbusmenuServer.html#DBUSMENU-SERVER-PROP-ROOT-NODE:CAPS" title="DBUSMENU_SERVER_PROP_ROOT_NODE">DBUSMENU_SERVER_PROP_ROOT_NODE</a> +#define <a class="link" href="libdbusmenu-glib-DbusmenuServer.html#DBUSMENU-SERVER-PROP-VERSION:CAPS" title="DBUSMENU_SERVER_PROP_VERSION">DBUSMENU_SERVER_PROP_VERSION</a> + <a class="link" href="libdbusmenu-glib-DbusmenuServer.html#DbusmenuServer" title="DbusmenuServer">DbusmenuServer</a>; + <a class="link" href="libdbusmenu-glib-DbusmenuServer.html#DbusmenuServerClass" title="DbusmenuServerClass">DbusmenuServerClass</a>; +<a class="link" href="libdbusmenu-glib-DbusmenuServer.html#DbusmenuServer" title="DbusmenuServer"><span class="returnvalue">DbusmenuServer</span></a> * <a class="link" href="libdbusmenu-glib-DbusmenuServer.html#dbusmenu-server-new" title="dbusmenu_server_new ()">dbusmenu_server_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> *object</code></em>); +<span class="returnvalue">void</span> <a class="link" href="libdbusmenu-glib-DbusmenuServer.html#dbusmenu-server-set-root" title="dbusmenu_server_set_root ()">dbusmenu_server_set_root</a> (<em class="parameter"><code><a class="link" href="libdbusmenu-glib-DbusmenuServer.html#DbusmenuServer" title="DbusmenuServer"><span class="type">DbusmenuServer</span></a> *server</code></em>, + <em class="parameter"><code><a class="link" href="libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem" title="DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> *root</code></em>); +</pre> +</div> +<div class="refsect1" title="Description"> +<a name="libdbusmenu-glib-DbusmenuServer.description"></a><h2>Description</h2> +<p> +</p> +</div> +<div class="refsect1" title="Details"> +<a name="libdbusmenu-glib-DbusmenuServer.details"></a><h2>Details</h2> +<div class="refsect2" title="DBUSMENU_SERVER_SIGNAL_ID_PROP_UPDATE"> +<a name="DBUSMENU-SERVER-SIGNAL-ID-PROP-UPDATE:CAPS"></a><h3>DBUSMENU_SERVER_SIGNAL_ID_PROP_UPDATE</h3> +<pre class="programlisting">#define DBUSMENU_SERVER_SIGNAL_ID_PROP_UPDATE "item-property-updated" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="DBUSMENU_SERVER_SIGNAL_ID_UPDATE"> +<a name="DBUSMENU-SERVER-SIGNAL-ID-UPDATE:CAPS"></a><h3>DBUSMENU_SERVER_SIGNAL_ID_UPDATE</h3> +<pre class="programlisting">#define DBUSMENU_SERVER_SIGNAL_ID_UPDATE "item-updated" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATED"> +<a name="DBUSMENU-SERVER-SIGNAL-LAYOUT-UPDATED:CAPS"></a><h3>DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATED</h3> +<pre class="programlisting">#define DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATED "layout-updated" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATE"> +<a name="DBUSMENU-SERVER-SIGNAL-LAYOUT-UPDATE:CAPS"></a><h3>DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATE</h3> +<pre class="programlisting">#define DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATE DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATED +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="DBUSMENU_SERVER_PROP_DBUS_OBJECT"> +<a name="DBUSMENU-SERVER-PROP-DBUS-OBJECT:CAPS"></a><h3>DBUSMENU_SERVER_PROP_DBUS_OBJECT</h3> +<pre class="programlisting">#define DBUSMENU_SERVER_PROP_DBUS_OBJECT "dbus-object" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="DBUSMENU_SERVER_PROP_ROOT_NODE"> +<a name="DBUSMENU-SERVER-PROP-ROOT-NODE:CAPS"></a><h3>DBUSMENU_SERVER_PROP_ROOT_NODE</h3> +<pre class="programlisting">#define DBUSMENU_SERVER_PROP_ROOT_NODE "root-node" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="DBUSMENU_SERVER_PROP_VERSION"> +<a name="DBUSMENU-SERVER-PROP-VERSION:CAPS"></a><h3>DBUSMENU_SERVER_PROP_VERSION</h3> +<pre class="programlisting">#define DBUSMENU_SERVER_PROP_VERSION "version" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="DbusmenuServer"> +<a name="DbusmenuServer"></a><h3>DbusmenuServer</h3> +<pre class="programlisting">typedef struct { + GObject parent; + + /*< Private >*/ + DbusmenuServerPrivate * priv; +} DbusmenuServer; +</pre> +<p> +A server which represents a sharing of a set of + <a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem"><span class="type">DbusmenuMenuitems</span></a> across DBus to a <a class="link" href="libdbusmenu-glib-DbusmenuClient.html#DbusmenuClient" title="DbusmenuClient"><span class="type">DbusmenuClient</span></a>. +</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="DbusmenuServer.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">DbusmenuServerPrivate</span> *<em class="structfield"><code><a name="DbusmenuServer.priv"></a>priv</code></em>;</span></p></td> +<td> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="DbusmenuServerClass"> +<a name="DbusmenuServerClass"></a><h3>DbusmenuServerClass</h3> +<pre class="programlisting">typedef struct { + GObjectClass parent_class; + + /* Signals */ + void (*id_prop_update)(gint id, gchar * property, gchar * value); + void (*id_update)(gint id); + void (*layout_updated)(gint revision); + void (*item_activation)(gint id, guint timestamp); + + /*< Private >*/ + void (*reserved1) (void); + void (*reserved2) (void); + void (*reserved3) (void); + void (*reserved4) (void); + void (*reserved5) (void); + void (*reserved6) (void); +} DbusmenuServerClass; +</pre> +<p> +<em class="parameter"><code>reserved1</code></em>: Reserved for future use. + <em class="parameter"><code>reserved2</code></em>: Reserved for future use. + <em class="parameter"><code>reserved3</code></em>: Reserved for future use. + <em class="parameter"><code>reserved4</code></em>: Reserved for future use. + <em class="parameter"><code>reserved5</code></em>: Reserved for future use. + <em class="parameter"><code>reserved6</code></em>: Reserved for future use. +</p> +<p> + The class implementing the virtual functions for <a class="link" href="libdbusmenu-glib-DbusmenuServer.html#DbusmenuServer" title="DbusmenuServer"><span class="type">DbusmenuServer</span></a>. +</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="DbusmenuServerClass.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> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="DbusmenuServerClass.id-prop-update"></a>id_prop_update</code></em> ()</span></p></td> +<td>Slot for <span class="type">"id-prop-update"</span>. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="DbusmenuServerClass.id-update"></a>id_update</code></em> ()</span></p></td> +<td>Slot for <span class="type">"id-update"</span>. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="DbusmenuServerClass.layout-updated"></a>layout_updated</code></em> ()</span></p></td> +<td>Slot for <span class="type">"layout-update"</span>. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="DbusmenuServerClass.item-activation"></a>item_activation</code></em> ()</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="DbusmenuServerClass.reserved1"></a>reserved1</code></em> ()</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="DbusmenuServerClass.reserved2"></a>reserved2</code></em> ()</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="DbusmenuServerClass.reserved3"></a>reserved3</code></em> ()</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="DbusmenuServerClass.reserved4"></a>reserved4</code></em> ()</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="DbusmenuServerClass.reserved5"></a>reserved5</code></em> ()</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="DbusmenuServerClass.reserved6"></a>reserved6</code></em> ()</span></p></td> +<td> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="dbusmenu_server_new ()"> +<a name="dbusmenu-server-new"></a><h3>dbusmenu_server_new ()</h3> +<pre class="programlisting"><a class="link" href="libdbusmenu-glib-DbusmenuServer.html#DbusmenuServer" title="DbusmenuServer"><span class="returnvalue">DbusmenuServer</span></a> * dbusmenu_server_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> *object</code></em>);</pre> +<p> +Creates a new <a class="link" href="libdbusmenu-glib-DbusmenuServer.html#DbusmenuServer" title="DbusmenuServer"><span class="type">DbusmenuServer</span></a> object with a specific object + path on DBus. If <em class="parameter"><code>object</code></em> is set to NULL the default object + name of "/com/canonical/dbusmenu" will be used. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td> +<td>The object name to show for this menu structure + on DBus. May be NULL. +</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-DbusmenuServer.html#DbusmenuServer" title="DbusmenuServer"><span class="type">DbusmenuServer</span></a> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="dbusmenu_server_set_root ()"> +<a name="dbusmenu-server-set-root"></a><h3>dbusmenu_server_set_root ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> dbusmenu_server_set_root (<em class="parameter"><code><a class="link" href="libdbusmenu-glib-DbusmenuServer.html#DbusmenuServer" title="DbusmenuServer"><span class="type">DbusmenuServer</span></a> *server</code></em>, + <em class="parameter"><code><a class="link" href="libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem" title="DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> *root</code></em>);</pre> +<p> +This function contains all of the <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> wrapping + required to set the property <span class="type">"root-node"</span> + on the server <em class="parameter"><code>self</code></em>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>server</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>root</code></em> :</span></p></td> +<td>The new root <a class="link" href="libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem" title="DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> tree +</td> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.15</div> +</body> +</html>
\ No newline at end of file |