diff options
Diffstat (limited to 'docs/libdbusmenu-gtk')
30 files changed, 3288 insertions, 1 deletions
diff --git a/docs/libdbusmenu-gtk/reference/html/Genericmenuitem.html b/docs/libdbusmenu-gtk/reference/html/Genericmenuitem.html new file mode 100644 index 0000000..f9ec761 --- /dev/null +++ b/docs/libdbusmenu-gtk/reference/html/Genericmenuitem.html @@ -0,0 +1,360 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Genericmenuitem</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="index.html" title="libdbusmenu-gtk Reference Manual"> +<link rel="up" href="ch01.html" title="API"> +<link rel="prev" href="libdbusmenu-gtk-DbusmenuGtkClient.html" title="DbusmenuGtkClient"> +<link rel="next" href="libdbusmenu-gtk-menuitem.html" title="menuitem"> +<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="libdbusmenu-gtk-DbusmenuGtkClient.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-gtk Reference Manual</th> +<td><a accesskey="n" href="libdbusmenu-gtk-menuitem.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#Genericmenuitem.synopsis" class="shortcut">Top</a> + | + <a href="#Genericmenuitem.description" class="shortcut">Description</a> + | + <a href="#Genericmenuitem.object-hierarchy" class="shortcut">Object Hierarchy</a> + | + <a href="#Genericmenuitem.implemented-interfaces" class="shortcut">Implemented Interfaces</a> +</td></tr> +</table> +<div class="refentry" title="Genericmenuitem"> +<a name="Genericmenuitem"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="Genericmenuitem.top_of_page"></a>Genericmenuitem</span></h2> +<p>Genericmenuitem</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv" title="Synopsis"> +<a name="Genericmenuitem.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis">#define <a class="link" href="Genericmenuitem.html#GENERICMENUITEM-TYPE:CAPS" title="GENERICMENUITEM_TYPE">GENERICMENUITEM_TYPE</a> +#define <a class="link" href="Genericmenuitem.html#GENERICMENUITEM:CAPS" title="GENERICMENUITEM()">GENERICMENUITEM</a> (obj) +#define <a class="link" href="Genericmenuitem.html#GENERICMENUITEM-CLASS:CAPS" title="GENERICMENUITEM_CLASS()">GENERICMENUITEM_CLASS</a> (klass) +#define <a class="link" href="Genericmenuitem.html#IS-GENERICMENUITEM:CAPS" title="IS_GENERICMENUITEM()">IS_GENERICMENUITEM</a> (obj) +#define <a class="link" href="Genericmenuitem.html#IS-GENERICMENUITEM-CLASS:CAPS" title="IS_GENERICMENUITEM_CLASS()">IS_GENERICMENUITEM_CLASS</a> (klass) +#define <a class="link" href="Genericmenuitem.html#GENERICMENUITEM-GET-CLASS:CAPS" title="GENERICMENUITEM_GET_CLASS()">GENERICMENUITEM_GET_CLASS</a> (obj) + <a class="link" href="Genericmenuitem.html#Genericmenuitem-struct" title="Genericmenuitem">Genericmenuitem</a>; + <a class="link" href="Genericmenuitem.html#GenericmenuitemClass" title="GenericmenuitemClass">GenericmenuitemClass</a>; + <a class="link" href="Genericmenuitem.html#GenericmenuitemPrivate" title="GenericmenuitemPrivate">GenericmenuitemPrivate</a>; +enum <a class="link" href="Genericmenuitem.html#GenericmenuitemCheckType" title="enum GenericmenuitemCheckType">GenericmenuitemCheckType</a>; +enum <a class="link" href="Genericmenuitem.html#GenericmenuitemState" title="enum GenericmenuitemState">GenericmenuitemState</a>; +<a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a> <a class="link" href="Genericmenuitem.html#genericmenuitem-get-type" title="genericmenuitem_get_type ()">genericmenuitem_get_type</a> (<em class="parameter"><code><span class="type">void</span></code></em>); +<span class="returnvalue">void</span> <a class="link" href="Genericmenuitem.html#genericmenuitem-set-check-type" title="genericmenuitem_set_check_type ()">genericmenuitem_set_check_type</a> (<em class="parameter"><code><a class="link" href="Genericmenuitem.html" title="Genericmenuitem"><span class="type">Genericmenuitem</span></a> *item</code></em>, + <em class="parameter"><code><a class="link" href="Genericmenuitem.html#GenericmenuitemCheckType" title="enum GenericmenuitemCheckType"><span class="type">GenericmenuitemCheckType</span></a> check_type</code></em>); +<span class="returnvalue">void</span> <a class="link" href="Genericmenuitem.html#genericmenuitem-set-state" title="genericmenuitem_set_state ()">genericmenuitem_set_state</a> (<em class="parameter"><code><a class="link" href="Genericmenuitem.html" title="Genericmenuitem"><span class="type">Genericmenuitem</span></a> *item</code></em>, + <em class="parameter"><code><a class="link" href="Genericmenuitem.html#GenericmenuitemState" title="enum GenericmenuitemState"><span class="type">GenericmenuitemState</span></a> state</code></em>); +<span class="returnvalue">void</span> <a class="link" href="Genericmenuitem.html#genericmenuitem-set-image" title="genericmenuitem_set_image ()">genericmenuitem_set_image</a> (<em class="parameter"><code><a class="link" href="Genericmenuitem.html" title="Genericmenuitem"><span class="type">Genericmenuitem</span></a> *item</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"><span class="type">GtkWidget</span></a> *image</code></em>); +<a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> * <a class="link" href="Genericmenuitem.html#genericmenuitem-get-image" title="genericmenuitem_get_image ()">genericmenuitem_get_image</a> (<em class="parameter"><code><a class="link" href="Genericmenuitem.html" title="Genericmenuitem"><span class="type">Genericmenuitem</span></a> *item</code></em>); +</pre> +</div> +<div class="refsect1" title="Object Hierarchy"> +<a name="Genericmenuitem.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> + +----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> + +----<a href="http://library.gnome.org/devel/gtk/unstable/GtkObject.html">GtkObject</a> + +----<a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html">GtkWidget</a> + +----<a href="http://library.gnome.org/devel/gtk/unstable/GtkContainer.html">GtkContainer</a> + +----<a href="http://library.gnome.org/devel/gtk/unstable/GtkBin.html">GtkBin</a> + +----<a href="http://library.gnome.org/devel/gtk/unstable/GtkItem.html">GtkItem</a> + +----<a href="http://library.gnome.org/devel/gtk/unstable/GtkMenuItem.html">GtkMenuItem</a> + +----<a href="http://library.gnome.org/devel/gtk/unstable/gtk3-gtkcheckmenuitem.html#GtkCheckMenuItem">GtkCheckMenuItem</a> + +----Genericmenuitem +</pre> +</div> +<div class="refsect1" title="Implemented Interfaces"> +<a name="Genericmenuitem.implemented-interfaces"></a><h2>Implemented Interfaces</h2> +<p> +Genericmenuitem implements + AtkImplementorIface, <a href="http://library.gnome.org/devel/gtk/unstable/GtkBuildable.html">GtkBuildable</a> and <a href="http://library.gnome.org/devel/gtk/unstable/GtkActivatable.html">GtkActivatable</a>.</p> +</div> +<div class="refsect1" title="Description"> +<a name="Genericmenuitem.description"></a><h2>Description</h2> +<p> +</p> +</div> +<div class="refsect1" title="Details"> +<a name="Genericmenuitem.details"></a><h2>Details</h2> +<div class="refsect2" title="GENERICMENUITEM_TYPE"> +<a name="GENERICMENUITEM-TYPE:CAPS"></a><h3>GENERICMENUITEM_TYPE</h3> +<pre class="programlisting">#define GENERICMENUITEM_TYPE (genericmenuitem_get_type ()) +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="GENERICMENUITEM()"> +<a name="GENERICMENUITEM:CAPS"></a><h3>GENERICMENUITEM()</h3> +<pre class="programlisting">#define GENERICMENUITEM(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GENERICMENUITEM_TYPE, Genericmenuitem)) +</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>obj</code></em> :</span></p></td> +<td> +</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="GENERICMENUITEM_CLASS()"> +<a name="GENERICMENUITEM-CLASS:CAPS"></a><h3>GENERICMENUITEM_CLASS()</h3> +<pre class="programlisting">#define GENERICMENUITEM_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GENERICMENUITEM_TYPE, GenericmenuitemClass)) +</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>klass</code></em> :</span></p></td> +<td> +</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="IS_GENERICMENUITEM()"> +<a name="IS-GENERICMENUITEM:CAPS"></a><h3>IS_GENERICMENUITEM()</h3> +<pre class="programlisting">#define IS_GENERICMENUITEM(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GENERICMENUITEM_TYPE)) +</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>obj</code></em> :</span></p></td> +<td> +</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="IS_GENERICMENUITEM_CLASS()"> +<a name="IS-GENERICMENUITEM-CLASS:CAPS"></a><h3>IS_GENERICMENUITEM_CLASS()</h3> +<pre class="programlisting">#define IS_GENERICMENUITEM_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GENERICMENUITEM_TYPE)) +</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>klass</code></em> :</span></p></td> +<td> +</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="GENERICMENUITEM_GET_CLASS()"> +<a name="GENERICMENUITEM-GET-CLASS:CAPS"></a><h3>GENERICMENUITEM_GET_CLASS()</h3> +<pre class="programlisting">#define GENERICMENUITEM_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GENERICMENUITEM_TYPE, GenericmenuitemClass)) +</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>obj</code></em> :</span></p></td> +<td> +</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="Genericmenuitem"> +<a name="Genericmenuitem-struct"></a><h3>Genericmenuitem</h3> +<pre class="programlisting">typedef struct _Genericmenuitem Genericmenuitem;</pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody></tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="GenericmenuitemClass"> +<a name="GenericmenuitemClass"></a><h3>GenericmenuitemClass</h3> +<pre class="programlisting">typedef struct { + GtkCheckMenuItemClass parent_class; +} GenericmenuitemClass; +</pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><span class="type">GtkCheckMenuItemClass</span> <em class="structfield"><code><a name="GenericmenuitemClass.parent-class"></a>parent_class</code></em>;</span></p></td> +<td>Our parent <span class="type">GtkCheckMenuItemClass</span> +</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="GenericmenuitemPrivate"> +<a name="GenericmenuitemPrivate"></a><h3>GenericmenuitemPrivate</h3> +<pre class="programlisting">typedef struct _GenericmenuitemPrivate GenericmenuitemPrivate;</pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody></tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="enum GenericmenuitemCheckType"> +<a name="GenericmenuitemCheckType"></a><h3>enum GenericmenuitemCheckType</h3> +<pre class="programlisting">enum GenericmenuitemCheckType { + GENERICMENUITEM_CHECK_TYPE_NONE, + GENERICMENUITEM_CHECK_TYPE_CHECKBOX, + GENERICMENUITEM_CHECK_TYPE_RADIO +}; +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="enum GenericmenuitemState"> +<a name="GenericmenuitemState"></a><h3>enum GenericmenuitemState</h3> +<pre class="programlisting">enum GenericmenuitemState { + GENERICMENUITEM_STATE_UNCHECKED, + GENERICMENUITEM_STATE_CHECKED, + GENERICMENUITEM_STATE_INDETERMINATE +}; +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="genericmenuitem_get_type ()"> +<a name="genericmenuitem-get-type"></a><h3>genericmenuitem_get_type ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a> genericmenuitem_get_type (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="genericmenuitem_set_check_type ()"> +<a name="genericmenuitem-set-check-type"></a><h3>genericmenuitem_set_check_type ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> genericmenuitem_set_check_type (<em class="parameter"><code><a class="link" href="Genericmenuitem.html" title="Genericmenuitem"><span class="type">Genericmenuitem</span></a> *item</code></em>, + <em class="parameter"><code><a class="link" href="Genericmenuitem.html#GenericmenuitemCheckType" title="enum GenericmenuitemCheckType"><span class="type">GenericmenuitemCheckType</span></a> check_type</code></em>);</pre> +<p> +This function changes the type of the checkmark that + appears in the left hand gutter for the menuitem. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td> +<td> +<a class="link" href="Genericmenuitem.html" title="Genericmenuitem"><span class="type">Genericmenuitem</span></a> to set the type on +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>check_type</code></em> :</span></p></td> +<td>Which type of check should be displayed +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="genericmenuitem_set_state ()"> +<a name="genericmenuitem-set-state"></a><h3>genericmenuitem_set_state ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> genericmenuitem_set_state (<em class="parameter"><code><a class="link" href="Genericmenuitem.html" title="Genericmenuitem"><span class="type">Genericmenuitem</span></a> *item</code></em>, + <em class="parameter"><code><a class="link" href="Genericmenuitem.html#GenericmenuitemState" title="enum GenericmenuitemState"><span class="type">GenericmenuitemState</span></a> state</code></em>);</pre> +<p> +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 <span class="type">GENERICMENUITEM_CHECK_TYPE_NONE</span>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td> +<td> +<a class="link" href="Genericmenuitem.html" title="Genericmenuitem"><span class="type">Genericmenuitem</span></a> to set the type on +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td> +<td> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="genericmenuitem_set_image ()"> +<a name="genericmenuitem-set-image"></a><h3>genericmenuitem_set_image ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> genericmenuitem_set_image (<em class="parameter"><code><a class="link" href="Genericmenuitem.html" title="Genericmenuitem"><span class="type">Genericmenuitem</span></a> *item</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"><span class="type">GtkWidget</span></a> *image</code></em>);</pre> +<p> +Sets the image of the menu item. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td> +<td>A <a class="link" href="Genericmenuitem.html" title="Genericmenuitem"><span class="type">Genericmenuitem</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>image</code></em> :</span></p></td> +<td>The image to set as the image of <em class="parameter"><code>item</code></em> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="genericmenuitem_get_image ()"> +<a name="genericmenuitem-get-image"></a><h3>genericmenuitem_get_image ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> * genericmenuitem_get_image (<em class="parameter"><code><a class="link" href="Genericmenuitem.html" title="Genericmenuitem"><span class="type">Genericmenuitem</span></a> *item</code></em>);</pre> +<p> +Returns the image if there is one. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td> +<td>A <a class="link" href="Genericmenuitem.html" title="Genericmenuitem"><span class="type">Genericmenuitem</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> A pointer to the image of the item or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><span class="type">NULL</span></a> + if there isn't one. +</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 diff --git a/docs/libdbusmenu-gtk/reference/html/api-index-full.html b/docs/libdbusmenu-gtk/reference/html/api-index-full.html new file mode 100644 index 0000000..1b11c39 --- /dev/null +++ b/docs/libdbusmenu-gtk/reference/html/api-index-full.html @@ -0,0 +1,189 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>API Index</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="index.html" title="libdbusmenu-gtk Reference Manual"> +<link rel="up" href="index.html" title="libdbusmenu-gtk Reference Manual"> +<link rel="prev" href="object-tree.html" title="Object Hierarchy"> +<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="object-tree.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td> </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-gtk Reference Manual</th> +<td> </td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a class="shortcut" href="#idxG">G</a> + | + <a class="shortcut" href="#idxI">I</a> + | + <a class="shortcut" href="#idxM">M</a> +</td></tr> +</table> +<div class="index" title="API Index"> +<div class="titlepage"><div><div><h2 class="title"> +<a name="api-index-full"></a>API Index</h2></div></div></div> +<a name="idx"></a><a name="idxG"></a><h3 class="title">G</h3> +<dt> +<a class="link" href="Genericmenuitem.html#Genericmenuitem-struct" title="Genericmenuitem">Genericmenuitem</a>, struct in <a class="link" href="Genericmenuitem.html" title="Genericmenuitem">Genericmenuitem</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="Genericmenuitem.html#GENERICMENUITEM:CAPS" title="GENERICMENUITEM()">GENERICMENUITEM</a>, macro in <a class="link" href="Genericmenuitem.html" title="Genericmenuitem">Genericmenuitem</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="Genericmenuitem.html#GenericmenuitemCheckType" title="enum GenericmenuitemCheckType">GenericmenuitemCheckType</a>, enum in <a class="link" href="Genericmenuitem.html" title="Genericmenuitem">Genericmenuitem</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="Genericmenuitem.html#GenericmenuitemClass" title="GenericmenuitemClass">GenericmenuitemClass</a>, struct in <a class="link" href="Genericmenuitem.html" title="Genericmenuitem">Genericmenuitem</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="Genericmenuitem.html#GenericmenuitemPrivate" title="GenericmenuitemPrivate">GenericmenuitemPrivate</a>, struct in <a class="link" href="Genericmenuitem.html" title="Genericmenuitem">Genericmenuitem</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="Genericmenuitem.html#GenericmenuitemState" title="enum GenericmenuitemState">GenericmenuitemState</a>, enum in <a class="link" href="Genericmenuitem.html" title="Genericmenuitem">Genericmenuitem</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="Genericmenuitem.html#GENERICMENUITEM-CLASS:CAPS" title="GENERICMENUITEM_CLASS()">GENERICMENUITEM_CLASS</a>, macro in <a class="link" href="Genericmenuitem.html" title="Genericmenuitem">Genericmenuitem</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="Genericmenuitem.html#GENERICMENUITEM-GET-CLASS:CAPS" title="GENERICMENUITEM_GET_CLASS()">GENERICMENUITEM_GET_CLASS</a>, macro in <a class="link" href="Genericmenuitem.html" title="Genericmenuitem">Genericmenuitem</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="Genericmenuitem.html#genericmenuitem-get-image" title="genericmenuitem_get_image ()">genericmenuitem_get_image</a>, function in <a class="link" href="Genericmenuitem.html" title="Genericmenuitem">Genericmenuitem</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="Genericmenuitem.html#genericmenuitem-get-type" title="genericmenuitem_get_type ()">genericmenuitem_get_type</a>, function in <a class="link" href="Genericmenuitem.html" title="Genericmenuitem">Genericmenuitem</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="Genericmenuitem.html#genericmenuitem-set-check-type" title="genericmenuitem_set_check_type ()">genericmenuitem_set_check_type</a>, function in <a class="link" href="Genericmenuitem.html" title="Genericmenuitem">Genericmenuitem</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="Genericmenuitem.html#genericmenuitem-set-image" title="genericmenuitem_set_image ()">genericmenuitem_set_image</a>, function in <a class="link" href="Genericmenuitem.html" title="Genericmenuitem">Genericmenuitem</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="Genericmenuitem.html#genericmenuitem-set-state" title="genericmenuitem_set_state ()">genericmenuitem_set_state</a>, function in <a class="link" href="Genericmenuitem.html" title="Genericmenuitem">Genericmenuitem</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="Genericmenuitem.html#GENERICMENUITEM-TYPE:CAPS" title="GENERICMENUITEM_TYPE">GENERICMENUITEM_TYPE</a>, macro in <a class="link" href="Genericmenuitem.html" title="Genericmenuitem">Genericmenuitem</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libdbusmenu-gtk-DbusmenuGtkClient.html#DbusmenuGtkClientClass" title="DbusmenuGtkClientClass">DbusmenuGtkClientClass</a>, struct in <a class="link" href="libdbusmenu-gtk-DbusmenuGtkClient.html" title="DbusmenuGtkClient">DbusmenuGtkClient</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libdbusmenu-gtk-DbusmenuGtkClient.html#DbusmenuGtkClientPrivate" title="DbusmenuGtkClientPrivate">DbusmenuGtkClientPrivate</a>, struct in <a class="link" href="libdbusmenu-gtk-DbusmenuGtkClient.html" title="DbusmenuGtkClient">DbusmenuGtkClient</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libdbusmenu-gtk-DbusmenuGtkClient.html#dbusmenu-gtkclient-get-accel-group" title="dbusmenu_gtkclient_get_accel_group ()">dbusmenu_gtkclient_get_accel_group</a>, function in <a class="link" href="libdbusmenu-gtk-DbusmenuGtkClient.html" title="DbusmenuGtkClient">DbusmenuGtkClient</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libdbusmenu-gtk-DbusmenuGtkClient.html#dbusmenu-gtkclient-menuitem-get" title="dbusmenu_gtkclient_menuitem_get ()">dbusmenu_gtkclient_menuitem_get</a>, function in <a class="link" href="libdbusmenu-gtk-DbusmenuGtkClient.html" title="DbusmenuGtkClient">DbusmenuGtkClient</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libdbusmenu-gtk-DbusmenuGtkClient.html#dbusmenu-gtkclient-menuitem-get-submenu" title="dbusmenu_gtkclient_menuitem_get_submenu ()">dbusmenu_gtkclient_menuitem_get_submenu</a>, function in <a class="link" href="libdbusmenu-gtk-DbusmenuGtkClient.html" title="DbusmenuGtkClient">DbusmenuGtkClient</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libdbusmenu-gtk-DbusmenuGtkClient.html#dbusmenu-gtkclient-new" title="dbusmenu_gtkclient_new ()">dbusmenu_gtkclient_new</a>, function in <a class="link" href="libdbusmenu-gtk-DbusmenuGtkClient.html" title="DbusmenuGtkClient">DbusmenuGtkClient</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libdbusmenu-gtk-DbusmenuGtkClient.html#dbusmenu-gtkclient-newitem-base" title="dbusmenu_gtkclient_newitem_base ()">dbusmenu_gtkclient_newitem_base</a>, function in <a class="link" href="libdbusmenu-gtk-DbusmenuGtkClient.html" title="DbusmenuGtkClient">DbusmenuGtkClient</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libdbusmenu-gtk-DbusmenuGtkClient.html#dbusmenu-gtkclient-set-accel-group" title="dbusmenu_gtkclient_set_accel_group ()">dbusmenu_gtkclient_set_accel_group</a>, function in <a class="link" href="libdbusmenu-gtk-DbusmenuGtkClient.html" title="DbusmenuGtkClient">DbusmenuGtkClient</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libdbusmenu-gtk-DbusmenuGtkClient.html#DBUSMENU-GTKCLIENT-SIGNAL-ROOT-CHANGED:CAPS" title="DBUSMENU_GTKCLIENT_SIGNAL_ROOT_CHANGED">DBUSMENU_GTKCLIENT_SIGNAL_ROOT_CHANGED</a>, macro in <a class="link" href="libdbusmenu-gtk-DbusmenuGtkClient.html" title="DbusmenuGtkClient">DbusmenuGtkClient</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libdbusmenu-gtk-DbusmenuGtkClient.html#DBUSMENU-GTKCLIENT-TYPE:CAPS" title="DBUSMENU_GTKCLIENT_TYPE">DBUSMENU_GTKCLIENT_TYPE</a>, macro in <a class="link" href="libdbusmenu-gtk-DbusmenuGtkClient.html" title="DbusmenuGtkClient">DbusmenuGtkClient</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libdbusmenu-gtk-DbusmenuGtkMenu.html#DbusmenuGtkMenuClass" title="DbusmenuGtkMenuClass">DbusmenuGtkMenuClass</a>, struct in <a class="link" href="libdbusmenu-gtk-DbusmenuGtkMenu.html" title="DbusmenuGtkMenu">DbusmenuGtkMenu</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libdbusmenu-gtk-DbusmenuGtkMenu.html#DbusmenuGtkMenuPrivate" title="DbusmenuGtkMenuPrivate">DbusmenuGtkMenuPrivate</a>, struct in <a class="link" href="libdbusmenu-gtk-DbusmenuGtkMenu.html" title="DbusmenuGtkMenu">DbusmenuGtkMenu</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libdbusmenu-gtk-DbusmenuGtkMenu.html#dbusmenu-gtkmenu-get-client" title="dbusmenu_gtkmenu_get_client ()">dbusmenu_gtkmenu_get_client</a>, function in <a class="link" href="libdbusmenu-gtk-DbusmenuGtkMenu.html" title="DbusmenuGtkMenu">DbusmenuGtkMenu</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libdbusmenu-gtk-DbusmenuGtkMenu.html#dbusmenu-gtkmenu-new" title="dbusmenu_gtkmenu_new ()">dbusmenu_gtkmenu_new</a>, function in <a class="link" href="libdbusmenu-gtk-DbusmenuGtkMenu.html" title="DbusmenuGtkMenu">DbusmenuGtkMenu</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libdbusmenu-gtk-DbusmenuGtkMenu.html#DBUSMENU-GTKMENU-TYPE:CAPS" title="DBUSMENU_GTKMENU_TYPE">DBUSMENU_GTKMENU_TYPE</a>, macro in <a class="link" href="libdbusmenu-gtk-DbusmenuGtkMenu.html" title="DbusmenuGtkMenu">DbusmenuGtkMenu</a> +</dt> +<dd></dd> +<a name="idxI"></a><h3 class="title">I</h3> +<dt> +<a class="link" href="Genericmenuitem.html#IS-GENERICMENUITEM:CAPS" title="IS_GENERICMENUITEM()">IS_GENERICMENUITEM</a>, macro in <a class="link" href="Genericmenuitem.html" title="Genericmenuitem">Genericmenuitem</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="Genericmenuitem.html#IS-GENERICMENUITEM-CLASS:CAPS" title="IS_GENERICMENUITEM_CLASS()">IS_GENERICMENUITEM_CLASS</a>, macro in <a class="link" href="Genericmenuitem.html" title="Genericmenuitem">Genericmenuitem</a> +</dt> +<dd></dd> +<a name="idxM"></a><h3 class="title">M</h3> +<dt> +<a class="link" href="libdbusmenu-gtk-menuitem.html#dbusmenu-menuitem-property-get-image" title="dbusmenu_menuitem_property_get_image ()">dbusmenu_menuitem_property_get_image</a>, function in <a class="link" href="libdbusmenu-gtk-menuitem.html" title="menuitem">menuitem</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libdbusmenu-gtk-menuitem.html#dbusmenu-menuitem-property-get-shortcut" title="dbusmenu_menuitem_property_get_shortcut ()">dbusmenu_menuitem_property_get_shortcut</a>, function in <a class="link" href="libdbusmenu-gtk-menuitem.html" title="menuitem">menuitem</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libdbusmenu-gtk-menuitem.html#dbusmenu-menuitem-property-set-image" title="dbusmenu_menuitem_property_set_image ()">dbusmenu_menuitem_property_set_image</a>, function in <a class="link" href="libdbusmenu-gtk-menuitem.html" title="menuitem">menuitem</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libdbusmenu-gtk-menuitem.html#dbusmenu-menuitem-property-set-shortcut" title="dbusmenu_menuitem_property_set_shortcut ()">dbusmenu_menuitem_property_set_shortcut</a>, function in <a class="link" href="libdbusmenu-gtk-menuitem.html" title="menuitem">menuitem</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libdbusmenu-gtk-menuitem.html#dbusmenu-menuitem-property-set-shortcut-menuitem" title="dbusmenu_menuitem_property_set_shortcut_menuitem ()">dbusmenu_menuitem_property_set_shortcut_menuitem</a>, function in <a class="link" href="libdbusmenu-gtk-menuitem.html" title="menuitem">menuitem</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libdbusmenu-gtk-menuitem.html#dbusmenu-menuitem-property-set-shortcut-string" title="dbusmenu_menuitem_property_set_shortcut_string ()">dbusmenu_menuitem_property_set_shortcut_string</a>, function in <a class="link" href="libdbusmenu-gtk-menuitem.html" title="menuitem">menuitem</a> +</dt> +<dd></dd> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.15</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/libdbusmenu-gtk/reference/html/ch01.html b/docs/libdbusmenu-gtk/reference/html/ch01.html new file mode 100644 index 0000000..2275b9c --- /dev/null +++ b/docs/libdbusmenu-gtk/reference/html/ch01.html @@ -0,0 +1,44 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>API</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="index.html" title="libdbusmenu-gtk Reference Manual"> +<link rel="up" href="index.html" title="libdbusmenu-gtk Reference Manual"> +<link rel="prev" href="index.html" title="libdbusmenu-gtk Reference Manual"> +<link rel="next" href="libdbusmenu-gtk-DbusmenuGtkMenu.html" title="DbusmenuGtkMenu"> +<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="index.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td> </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-gtk Reference Manual</th> +<td><a accesskey="n" href="libdbusmenu-gtk-DbusmenuGtkMenu.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr></table> +<div class="chapter" title="API"> +<div class="titlepage"><div><div><h2 class="title"> +<a name="id569264"></a>API</h2></div></div></div> +<div class="toc"><dl> +<dt> +<span class="refentrytitle"><a href="libdbusmenu-gtk-DbusmenuGtkMenu.html">DbusmenuGtkMenu</a></span><span class="refpurpose"></span> +</dt> +<dt> +<span class="refentrytitle"><a href="libdbusmenu-gtk-DbusmenuGtkClient.html">DbusmenuGtkClient</a></span><span class="refpurpose"></span> +</dt> +<dt> +<span class="refentrytitle"><a href="Genericmenuitem.html">Genericmenuitem</a></span><span class="refpurpose"></span> +</dt> +<dt> +<span class="refentrytitle"><a href="libdbusmenu-gtk-menuitem.html">menuitem</a></span><span class="refpurpose"></span> +</dt> +</dl></div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.15</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/libdbusmenu-gtk/reference/html/home.png b/docs/libdbusmenu-gtk/reference/html/home.png Binary files differnew file mode 100644 index 0000000..eed7ad1 --- /dev/null +++ b/docs/libdbusmenu-gtk/reference/html/home.png diff --git a/docs/libdbusmenu-gtk/reference/html/index.html b/docs/libdbusmenu-gtk/reference/html/index.html new file mode 100644 index 0000000..1e6f6ae --- /dev/null +++ b/docs/libdbusmenu-gtk/reference/html/index.html @@ -0,0 +1,42 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>libdbusmenu-gtk Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="index.html" title="libdbusmenu-gtk Reference Manual"> +<link rel="next" href="ch01.html" title="API"> +<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"> +<div class="book" title="libdbusmenu-gtk Reference Manual"> +<div class="titlepage"> +<div><div><table class="navigation" id="top" width="100%" cellpadding="2" cellspacing="0"><tr><th valign="middle"><p class="title">libdbusmenu-gtk Reference Manual</p></th></tr></table></div></div> +<hr> +</div> +<div class="toc"><dl> +<dt><span class="chapter"><a href="ch01.html">API</a></span></dt> +<dd><dl> +<dt> +<span class="refentrytitle"><a href="libdbusmenu-gtk-DbusmenuGtkMenu.html">DbusmenuGtkMenu</a></span><span class="refpurpose"></span> +</dt> +<dt> +<span class="refentrytitle"><a href="libdbusmenu-gtk-DbusmenuGtkClient.html">DbusmenuGtkClient</a></span><span class="refpurpose"></span> +</dt> +<dt> +<span class="refentrytitle"><a href="Genericmenuitem.html">Genericmenuitem</a></span><span class="refpurpose"></span> +</dt> +<dt> +<span class="refentrytitle"><a href="libdbusmenu-gtk-menuitem.html">menuitem</a></span><span class="refpurpose"></span> +</dt> +</dl></dd> +<dt><span class="chapter"><a href="object-tree.html">Object Hierarchy</a></span></dt> +<dt><span class="index"><a href="api-index-full.html">API Index</a></span></dt> +</dl></div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.15</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/libdbusmenu-gtk/reference/html/index.sgml b/docs/libdbusmenu-gtk/reference/html/index.sgml new file mode 100644 index 0000000..0b7f8af --- /dev/null +++ b/docs/libdbusmenu-gtk/reference/html/index.sgml @@ -0,0 +1,55 @@ +<ANCHOR id="libdbusmenu-gtk-DbusmenuGtkMenu" href="libdbusmenu-gtk/libdbusmenu-gtk-DbusmenuGtkMenu.html"> +<ANCHOR id="libdbusmenu-gtk-DbusmenuGtkMenu.synopsis" href="libdbusmenu-gtk/libdbusmenu-gtk-DbusmenuGtkMenu.html#libdbusmenu-gtk-DbusmenuGtkMenu.synopsis"> +<ANCHOR id="libdbusmenu-gtk-DbusmenuGtkMenu.description" href="libdbusmenu-gtk/libdbusmenu-gtk-DbusmenuGtkMenu.html#libdbusmenu-gtk-DbusmenuGtkMenu.description"> +<ANCHOR id="libdbusmenu-gtk-DbusmenuGtkMenu.details" href="libdbusmenu-gtk/libdbusmenu-gtk-DbusmenuGtkMenu.html#libdbusmenu-gtk-DbusmenuGtkMenu.details"> +<ANCHOR id="DBUSMENU-GTKMENU-TYPE:CAPS" href="libdbusmenu-gtk/libdbusmenu-gtk-DbusmenuGtkMenu.html#DBUSMENU-GTKMENU-TYPE:CAPS"> +<ANCHOR id="DbusmenuGtkMenuPrivate" href="libdbusmenu-gtk/libdbusmenu-gtk-DbusmenuGtkMenu.html#DbusmenuGtkMenuPrivate"> +<ANCHOR id="DbusmenuGtkMenuClass" href="libdbusmenu-gtk/libdbusmenu-gtk-DbusmenuGtkMenu.html#DbusmenuGtkMenuClass"> +<ANCHOR id="dbusmenu-gtkmenu-new" href="libdbusmenu-gtk/libdbusmenu-gtk-DbusmenuGtkMenu.html#dbusmenu-gtkmenu-new"> +<ANCHOR id="dbusmenu-gtkmenu-get-client" href="libdbusmenu-gtk/libdbusmenu-gtk-DbusmenuGtkMenu.html#dbusmenu-gtkmenu-get-client"> +<ANCHOR id="libdbusmenu-gtk-DbusmenuGtkClient" href="libdbusmenu-gtk/libdbusmenu-gtk-DbusmenuGtkClient.html"> +<ANCHOR id="libdbusmenu-gtk-DbusmenuGtkClient.synopsis" href="libdbusmenu-gtk/libdbusmenu-gtk-DbusmenuGtkClient.html#libdbusmenu-gtk-DbusmenuGtkClient.synopsis"> +<ANCHOR id="libdbusmenu-gtk-DbusmenuGtkClient.description" href="libdbusmenu-gtk/libdbusmenu-gtk-DbusmenuGtkClient.html#libdbusmenu-gtk-DbusmenuGtkClient.description"> +<ANCHOR id="libdbusmenu-gtk-DbusmenuGtkClient.details" href="libdbusmenu-gtk/libdbusmenu-gtk-DbusmenuGtkClient.html#libdbusmenu-gtk-DbusmenuGtkClient.details"> +<ANCHOR id="DBUSMENU-GTKCLIENT-TYPE:CAPS" href="libdbusmenu-gtk/libdbusmenu-gtk-DbusmenuGtkClient.html#DBUSMENU-GTKCLIENT-TYPE:CAPS"> +<ANCHOR id="DBUSMENU-GTKCLIENT-SIGNAL-ROOT-CHANGED:CAPS" href="libdbusmenu-gtk/libdbusmenu-gtk-DbusmenuGtkClient.html#DBUSMENU-GTKCLIENT-SIGNAL-ROOT-CHANGED:CAPS"> +<ANCHOR id="DbusmenuGtkClientPrivate" href="libdbusmenu-gtk/libdbusmenu-gtk-DbusmenuGtkClient.html#DbusmenuGtkClientPrivate"> +<ANCHOR id="DbusmenuGtkClientClass" href="libdbusmenu-gtk/libdbusmenu-gtk-DbusmenuGtkClient.html#DbusmenuGtkClientClass"> +<ANCHOR id="dbusmenu-gtkclient-new" href="libdbusmenu-gtk/libdbusmenu-gtk-DbusmenuGtkClient.html#dbusmenu-gtkclient-new"> +<ANCHOR id="dbusmenu-gtkclient-menuitem-get" href="libdbusmenu-gtk/libdbusmenu-gtk-DbusmenuGtkClient.html#dbusmenu-gtkclient-menuitem-get"> +<ANCHOR id="dbusmenu-gtkclient-menuitem-get-submenu" href="libdbusmenu-gtk/libdbusmenu-gtk-DbusmenuGtkClient.html#dbusmenu-gtkclient-menuitem-get-submenu"> +<ANCHOR id="dbusmenu-gtkclient-set-accel-group" href="libdbusmenu-gtk/libdbusmenu-gtk-DbusmenuGtkClient.html#dbusmenu-gtkclient-set-accel-group"> +<ANCHOR id="dbusmenu-gtkclient-get-accel-group" href="libdbusmenu-gtk/libdbusmenu-gtk-DbusmenuGtkClient.html#dbusmenu-gtkclient-get-accel-group"> +<ANCHOR id="dbusmenu-gtkclient-newitem-base" href="libdbusmenu-gtk/libdbusmenu-gtk-DbusmenuGtkClient.html#dbusmenu-gtkclient-newitem-base"> +<ANCHOR id="Genericmenuitem" href="libdbusmenu-gtk/Genericmenuitem.html"> +<ANCHOR id="Genericmenuitem.synopsis" href="libdbusmenu-gtk/Genericmenuitem.html#Genericmenuitem.synopsis"> +<ANCHOR id="Genericmenuitem.object-hierarchy" href="libdbusmenu-gtk/Genericmenuitem.html#Genericmenuitem.object-hierarchy"> +<ANCHOR id="Genericmenuitem.implemented-interfaces" href="libdbusmenu-gtk/Genericmenuitem.html#Genericmenuitem.implemented-interfaces"> +<ANCHOR id="Genericmenuitem.description" href="libdbusmenu-gtk/Genericmenuitem.html#Genericmenuitem.description"> +<ANCHOR id="Genericmenuitem.details" href="libdbusmenu-gtk/Genericmenuitem.html#Genericmenuitem.details"> +<ANCHOR id="GENERICMENUITEM-TYPE:CAPS" href="libdbusmenu-gtk/Genericmenuitem.html#GENERICMENUITEM-TYPE:CAPS"> +<ANCHOR id="GENERICMENUITEM:CAPS" href="libdbusmenu-gtk/Genericmenuitem.html#GENERICMENUITEM:CAPS"> +<ANCHOR id="GENERICMENUITEM-CLASS:CAPS" href="libdbusmenu-gtk/Genericmenuitem.html#GENERICMENUITEM-CLASS:CAPS"> +<ANCHOR id="IS-GENERICMENUITEM:CAPS" href="libdbusmenu-gtk/Genericmenuitem.html#IS-GENERICMENUITEM:CAPS"> +<ANCHOR id="IS-GENERICMENUITEM-CLASS:CAPS" href="libdbusmenu-gtk/Genericmenuitem.html#IS-GENERICMENUITEM-CLASS:CAPS"> +<ANCHOR id="GENERICMENUITEM-GET-CLASS:CAPS" href="libdbusmenu-gtk/Genericmenuitem.html#GENERICMENUITEM-GET-CLASS:CAPS"> +<ANCHOR id="Genericmenuitem-struct" href="libdbusmenu-gtk/Genericmenuitem.html#Genericmenuitem-struct"> +<ANCHOR id="GenericmenuitemClass" href="libdbusmenu-gtk/Genericmenuitem.html#GenericmenuitemClass"> +<ANCHOR id="GenericmenuitemPrivate" href="libdbusmenu-gtk/Genericmenuitem.html#GenericmenuitemPrivate"> +<ANCHOR id="GenericmenuitemCheckType" href="libdbusmenu-gtk/Genericmenuitem.html#GenericmenuitemCheckType"> +<ANCHOR id="GenericmenuitemState" href="libdbusmenu-gtk/Genericmenuitem.html#GenericmenuitemState"> +<ANCHOR id="genericmenuitem-get-type" href="libdbusmenu-gtk/Genericmenuitem.html#genericmenuitem-get-type"> +<ANCHOR id="genericmenuitem-set-check-type" href="libdbusmenu-gtk/Genericmenuitem.html#genericmenuitem-set-check-type"> +<ANCHOR id="genericmenuitem-set-state" href="libdbusmenu-gtk/Genericmenuitem.html#genericmenuitem-set-state"> +<ANCHOR id="genericmenuitem-set-image" href="libdbusmenu-gtk/Genericmenuitem.html#genericmenuitem-set-image"> +<ANCHOR id="genericmenuitem-get-image" href="libdbusmenu-gtk/Genericmenuitem.html#genericmenuitem-get-image"> +<ANCHOR id="libdbusmenu-gtk-menuitem" href="libdbusmenu-gtk/libdbusmenu-gtk-menuitem.html"> +<ANCHOR id="libdbusmenu-gtk-menuitem.synopsis" href="libdbusmenu-gtk/libdbusmenu-gtk-menuitem.html#libdbusmenu-gtk-menuitem.synopsis"> +<ANCHOR id="libdbusmenu-gtk-menuitem.description" href="libdbusmenu-gtk/libdbusmenu-gtk-menuitem.html#libdbusmenu-gtk-menuitem.description"> +<ANCHOR id="libdbusmenu-gtk-menuitem.details" href="libdbusmenu-gtk/libdbusmenu-gtk-menuitem.html#libdbusmenu-gtk-menuitem.details"> +<ANCHOR id="dbusmenu-menuitem-property-set-image" href="libdbusmenu-gtk/libdbusmenu-gtk-menuitem.html#dbusmenu-menuitem-property-set-image"> +<ANCHOR id="dbusmenu-menuitem-property-get-image" href="libdbusmenu-gtk/libdbusmenu-gtk-menuitem.html#dbusmenu-menuitem-property-get-image"> +<ANCHOR id="dbusmenu-menuitem-property-set-shortcut" href="libdbusmenu-gtk/libdbusmenu-gtk-menuitem.html#dbusmenu-menuitem-property-set-shortcut"> +<ANCHOR id="dbusmenu-menuitem-property-set-shortcut-string" href="libdbusmenu-gtk/libdbusmenu-gtk-menuitem.html#dbusmenu-menuitem-property-set-shortcut-string"> +<ANCHOR id="dbusmenu-menuitem-property-set-shortcut-menuitem" href="libdbusmenu-gtk/libdbusmenu-gtk-menuitem.html#dbusmenu-menuitem-property-set-shortcut-menuitem"> +<ANCHOR id="dbusmenu-menuitem-property-get-shortcut" href="libdbusmenu-gtk/libdbusmenu-gtk-menuitem.html#dbusmenu-menuitem-property-get-shortcut"> diff --git a/docs/libdbusmenu-gtk/reference/html/left.png b/docs/libdbusmenu-gtk/reference/html/left.png Binary files differnew file mode 100644 index 0000000..1d0e5d6 --- /dev/null +++ b/docs/libdbusmenu-gtk/reference/html/left.png diff --git a/docs/libdbusmenu-gtk/reference/html/libdbusmenu-gtk-DbusmenuGtkClient.html b/docs/libdbusmenu-gtk/reference/html/libdbusmenu-gtk-DbusmenuGtkClient.html new file mode 100644 index 0000000..4cbe3a6 --- /dev/null +++ b/docs/libdbusmenu-gtk/reference/html/libdbusmenu-gtk-DbusmenuGtkClient.html @@ -0,0 +1,345 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>DbusmenuGtkClient</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="index.html" title="libdbusmenu-gtk Reference Manual"> +<link rel="up" href="ch01.html" title="API"> +<link rel="prev" href="libdbusmenu-gtk-DbusmenuGtkMenu.html" title="DbusmenuGtkMenu"> +<link rel="next" href="Genericmenuitem.html" title="Genericmenuitem"> +<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="libdbusmenu-gtk-DbusmenuGtkMenu.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-gtk Reference Manual</th> +<td><a accesskey="n" href="Genericmenuitem.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-gtk-DbusmenuGtkClient.synopsis" class="shortcut">Top</a> + | + <a href="#libdbusmenu-gtk-DbusmenuGtkClient.description" class="shortcut">Description</a> +</td></tr> +</table> +<div class="refentry" title="DbusmenuGtkClient"> +<a name="libdbusmenu-gtk-DbusmenuGtkClient"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="libdbusmenu-gtk-DbusmenuGtkClient.top_of_page"></a>DbusmenuGtkClient</span></h2> +<p>DbusmenuGtkClient</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv" title="Synopsis"> +<a name="libdbusmenu-gtk-DbusmenuGtkClient.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis">#define <a class="link" href="libdbusmenu-gtk-DbusmenuGtkClient.html#DBUSMENU-GTKCLIENT-TYPE:CAPS" title="DBUSMENU_GTKCLIENT_TYPE">DBUSMENU_GTKCLIENT_TYPE</a> +#define <a class="link" href="libdbusmenu-gtk-DbusmenuGtkClient.html#DBUSMENU-GTKCLIENT-SIGNAL-ROOT-CHANGED:CAPS" title="DBUSMENU_GTKCLIENT_SIGNAL_ROOT_CHANGED">DBUSMENU_GTKCLIENT_SIGNAL_ROOT_CHANGED</a> + <a class="link" href="libdbusmenu-gtk-DbusmenuGtkClient.html#DbusmenuGtkClientPrivate" title="DbusmenuGtkClientPrivate">DbusmenuGtkClientPrivate</a>; + <a class="link" href="libdbusmenu-gtk-DbusmenuGtkClient.html#DbusmenuGtkClientClass" title="DbusmenuGtkClientClass">DbusmenuGtkClientClass</a>; +<span class="returnvalue">DbusmenuGtkClient</span> * <a class="link" href="libdbusmenu-gtk-DbusmenuGtkClient.html#dbusmenu-gtkclient-new" title="dbusmenu_gtkclient_new ()">dbusmenu_gtkclient_new</a> (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *dbus_name</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *dbus_object</code></em>); +<a href="http://library.gnome.org/devel/gtk/unstable/GtkMenuItem.html"><span class="returnvalue">GtkMenuItem</span></a> * <a class="link" href="libdbusmenu-gtk-DbusmenuGtkClient.html#dbusmenu-gtkclient-menuitem-get" title="dbusmenu_gtkclient_menuitem_get ()">dbusmenu_gtkclient_menuitem_get</a> (<em class="parameter"><code><span class="type">DbusmenuGtkClient</span> *client</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> *item</code></em>); +<a href="http://library.gnome.org/devel/gtk/unstable/GtkMenu.html"><span class="returnvalue">GtkMenu</span></a> * <a class="link" href="libdbusmenu-gtk-DbusmenuGtkClient.html#dbusmenu-gtkclient-menuitem-get-submenu" title="dbusmenu_gtkclient_menuitem_get_submenu ()">dbusmenu_gtkclient_menuitem_get_submenu</a> + (<em class="parameter"><code><span class="type">DbusmenuGtkClient</span> *client</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> *item</code></em>); +<span class="returnvalue">void</span> <a class="link" href="libdbusmenu-gtk-DbusmenuGtkClient.html#dbusmenu-gtkclient-set-accel-group" title="dbusmenu_gtkclient_set_accel_group ()">dbusmenu_gtkclient_set_accel_group</a> (<em class="parameter"><code><span class="type">DbusmenuGtkClient</span> *client</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/unstable/gtk3-Keyboard-Accelerators.html#GtkAccelGroup"><span class="type">GtkAccelGroup</span></a> *agroup</code></em>); +<a href="http://library.gnome.org/devel/gtk/unstable/gtk3-Keyboard-Accelerators.html#GtkAccelGroup"><span class="returnvalue">GtkAccelGroup</span></a> * <a class="link" href="libdbusmenu-gtk-DbusmenuGtkClient.html#dbusmenu-gtkclient-get-accel-group" title="dbusmenu_gtkclient_get_accel_group ()">dbusmenu_gtkclient_get_accel_group</a> (<em class="parameter"><code><span class="type">DbusmenuGtkClient</span> *client</code></em>); +<span class="returnvalue">void</span> <a class="link" href="libdbusmenu-gtk-DbusmenuGtkClient.html#dbusmenu-gtkclient-newitem-base" title="dbusmenu_gtkclient_newitem_base ()">dbusmenu_gtkclient_newitem_base</a> (<em class="parameter"><code><span class="type">DbusmenuGtkClient</span> *client</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> *item</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/unstable/GtkMenuItem.html"><span class="type">GtkMenuItem</span></a> *gmi</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> *parent</code></em>); +</pre> +</div> +<div class="refsect1" title="Description"> +<a name="libdbusmenu-gtk-DbusmenuGtkClient.description"></a><h2>Description</h2> +<p> +</p> +</div> +<div class="refsect1" title="Details"> +<a name="libdbusmenu-gtk-DbusmenuGtkClient.details"></a><h2>Details</h2> +<div class="refsect2" title="DBUSMENU_GTKCLIENT_TYPE"> +<a name="DBUSMENU-GTKCLIENT-TYPE:CAPS"></a><h3>DBUSMENU_GTKCLIENT_TYPE</h3> +<pre class="programlisting">#define DBUSMENU_GTKCLIENT_TYPE (dbusmenu_gtkclient_get_type ()) +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="DBUSMENU_GTKCLIENT_SIGNAL_ROOT_CHANGED"> +<a name="DBUSMENU-GTKCLIENT-SIGNAL-ROOT-CHANGED:CAPS"></a><h3>DBUSMENU_GTKCLIENT_SIGNAL_ROOT_CHANGED</h3> +<pre class="programlisting">#define DBUSMENU_GTKCLIENT_SIGNAL_ROOT_CHANGED DBUSMENU_CLIENT_SIGNAL_ROOT_CHANGED +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="DbusmenuGtkClientPrivate"> +<a name="DbusmenuGtkClientPrivate"></a><h3>DbusmenuGtkClientPrivate</h3> +<pre class="programlisting">typedef struct _DbusmenuGtkClientPrivate DbusmenuGtkClientPrivate;</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="DbusmenuGtkClientClass"> +<a name="DbusmenuGtkClientClass"></a><h3>DbusmenuGtkClientClass</h3> +<pre class="programlisting">typedef struct { + DbusmenuClientClass parent_class; + + /* Signals */ + void (*root_changed) (DbusmenuMenuitem * newroot); + + /*< Private >*/ + void (*reserved1) (void); + void (*reserved2) (void); + void (*reserved3) (void); + void (*reserved4) (void); + void (*reserved5) (void); + void (*reserved6) (void); +} DbusmenuGtkClientClass; +</pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuClient.html#DbusmenuClientClass"><span class="type">DbusmenuClientClass</span></a> <em class="structfield"><code><a name="DbusmenuGtkClientClass.parent-class"></a>parent_class</code></em>;</span></p></td> +<td> +<span class="type">GtkMenuClass</span> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="DbusmenuGtkClientClass.root-changed"></a>root_changed</code></em> ()</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="DbusmenuGtkClientClass.reserved1"></a>reserved1</code></em> ()</span></p></td> +<td>Reserved for future use. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="DbusmenuGtkClientClass.reserved2"></a>reserved2</code></em> ()</span></p></td> +<td>Reserved for future use. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="DbusmenuGtkClientClass.reserved3"></a>reserved3</code></em> ()</span></p></td> +<td>Reserved for future use. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="DbusmenuGtkClientClass.reserved4"></a>reserved4</code></em> ()</span></p></td> +<td>Reserved for future use. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="DbusmenuGtkClientClass.reserved5"></a>reserved5</code></em> ()</span></p></td> +<td>Reserved for future use. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="DbusmenuGtkClientClass.reserved6"></a>reserved6</code></em> ()</span></p></td> +<td>Reserved for future use. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="dbusmenu_gtkclient_new ()"> +<a name="dbusmenu-gtkclient-new"></a><h3>dbusmenu_gtkclient_new ()</h3> +<pre class="programlisting"><span class="returnvalue">DbusmenuGtkClient</span> * dbusmenu_gtkclient_new (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *dbus_name</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *dbus_object</code></em>);</pre> +<p> +Creates a new <span class="type">DbusmenuGtkClient</span> object and creates a <a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuClient.html#DbusmenuClient"><span class="type">DbusmenuClient</span></a> + that connects across DBus to a <a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuServer.html#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"><em class="parameter"><code>dbus_name</code></em> :</span></p></td> +<td>Name of the <a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuServer.html#DbusmenuServer"><span class="type">DbusmenuServer</span></a> on DBus +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>dbus_object</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> A new <span class="type">DbusmenuGtkClient</span> sync'd with a server +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="dbusmenu_gtkclient_menuitem_get ()"> +<a name="dbusmenu-gtkclient-menuitem-get"></a><h3>dbusmenu_gtkclient_menuitem_get ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/gtk/unstable/GtkMenuItem.html"><span class="returnvalue">GtkMenuItem</span></a> * dbusmenu_gtkclient_menuitem_get (<em class="parameter"><code><span class="type">DbusmenuGtkClient</span> *client</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> *item</code></em>);</pre> +<p> +This grabs the <a href="http://library.gnome.org/devel/gtk/unstable/GtkMenuItem.html"><span class="type">GtkMenuItem</span></a> that is associated with the + <a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</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>client</code></em> :</span></p></td> +<td>A <span class="type">DbusmenuGtkClient</span> with the item in it. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td> +<td> +<a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> to get associated <a href="http://library.gnome.org/devel/gtk/unstable/GtkMenuItem.html"><span class="type">GtkMenuItem</span></a> on. +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> The <a href="http://library.gnome.org/devel/gtk/unstable/GtkMenuItem.html"><span class="type">GtkMenuItem</span></a> that can be played with. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="dbusmenu_gtkclient_menuitem_get_submenu ()"> +<a name="dbusmenu-gtkclient-menuitem-get-submenu"></a><h3>dbusmenu_gtkclient_menuitem_get_submenu ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/gtk/unstable/GtkMenu.html"><span class="returnvalue">GtkMenu</span></a> * dbusmenu_gtkclient_menuitem_get_submenu + (<em class="parameter"><code><span class="type">DbusmenuGtkClient</span> *client</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> *item</code></em>);</pre> +<p> +This grabs the submenu associated with the menuitem. +</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>A <span class="type">DbusmenuGtkClient</span> with the item in it. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td> +<td> +<a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> to get associated <a href="http://library.gnome.org/devel/gtk/unstable/GtkMenu.html"><span class="type">GtkMenu</span></a> on. +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> The <a href="http://library.gnome.org/devel/gtk/unstable/GtkMenu.html"><span class="type">GtkMenu</span></a> if there is one. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="dbusmenu_gtkclient_set_accel_group ()"> +<a name="dbusmenu-gtkclient-set-accel-group"></a><h3>dbusmenu_gtkclient_set_accel_group ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> dbusmenu_gtkclient_set_accel_group (<em class="parameter"><code><span class="type">DbusmenuGtkClient</span> *client</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/unstable/gtk3-Keyboard-Accelerators.html#GtkAccelGroup"><span class="type">GtkAccelGroup</span></a> *agroup</code></em>);</pre> +<p> +Sets the acceleration group for the menu items with accelerators + on this client. +</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>To set the group on +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>agroup</code></em> :</span></p></td> +<td>The new acceleration group +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="dbusmenu_gtkclient_get_accel_group ()"> +<a name="dbusmenu-gtkclient-get-accel-group"></a><h3>dbusmenu_gtkclient_get_accel_group ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/gtk/unstable/gtk3-Keyboard-Accelerators.html#GtkAccelGroup"><span class="returnvalue">GtkAccelGroup</span></a> * dbusmenu_gtkclient_get_accel_group (<em class="parameter"><code><span class="type">DbusmenuGtkClient</span> *client</code></em>);</pre> +<p> +Gets the accel group for this client. +</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>Client to query for an accelerator group +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> Either a valid group or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><span class="type">NULL</span></a> on error or + none set. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="dbusmenu_gtkclient_newitem_base ()"> +<a name="dbusmenu-gtkclient-newitem-base"></a><h3>dbusmenu_gtkclient_newitem_base ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> dbusmenu_gtkclient_newitem_base (<em class="parameter"><code><span class="type">DbusmenuGtkClient</span> *client</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> *item</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/unstable/GtkMenuItem.html"><span class="type">GtkMenuItem</span></a> *gmi</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> *parent</code></em>);</pre> +<p> +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. +</p> +<p> + This also handles passing the "activate" signal back to the + <a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> side of thing. +</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>The client handling everything on this connection +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td> +<td>The <a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> to attach the GTK-isms to +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>gmi</code></em> :</span></p></td> +<td>A <a href="http://library.gnome.org/devel/gtk/unstable/GtkMenuItem.html"><span class="type">GtkMenuItem</span></a> representing the GTK world's view of this menuitem +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>parent</code></em> :</span></p></td> +<td>The parent <a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> +</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 diff --git a/docs/libdbusmenu-gtk/reference/html/libdbusmenu-gtk-DbusmenuGtkMenu.html b/docs/libdbusmenu-gtk/reference/html/libdbusmenu-gtk-DbusmenuGtkMenu.html new file mode 100644 index 0000000..8cd5f1a --- /dev/null +++ b/docs/libdbusmenu-gtk/reference/html/libdbusmenu-gtk-DbusmenuGtkMenu.html @@ -0,0 +1,186 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>DbusmenuGtkMenu</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="index.html" title="libdbusmenu-gtk Reference Manual"> +<link rel="up" href="ch01.html" title="API"> +<link rel="prev" href="ch01.html" title="API"> +<link rel="next" href="libdbusmenu-gtk-DbusmenuGtkClient.html" title="DbusmenuGtkClient"> +<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-gtk Reference Manual</th> +<td><a accesskey="n" href="libdbusmenu-gtk-DbusmenuGtkClient.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-gtk-DbusmenuGtkMenu.synopsis" class="shortcut">Top</a> + | + <a href="#libdbusmenu-gtk-DbusmenuGtkMenu.description" class="shortcut">Description</a> +</td></tr> +</table> +<div class="refentry" title="DbusmenuGtkMenu"> +<a name="libdbusmenu-gtk-DbusmenuGtkMenu"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="libdbusmenu-gtk-DbusmenuGtkMenu.top_of_page"></a>DbusmenuGtkMenu</span></h2> +<p>DbusmenuGtkMenu</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv" title="Synopsis"> +<a name="libdbusmenu-gtk-DbusmenuGtkMenu.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis">#define <a class="link" href="libdbusmenu-gtk-DbusmenuGtkMenu.html#DBUSMENU-GTKMENU-TYPE:CAPS" title="DBUSMENU_GTKMENU_TYPE">DBUSMENU_GTKMENU_TYPE</a> + <a class="link" href="libdbusmenu-gtk-DbusmenuGtkMenu.html#DbusmenuGtkMenuPrivate" title="DbusmenuGtkMenuPrivate">DbusmenuGtkMenuPrivate</a>; + <a class="link" href="libdbusmenu-gtk-DbusmenuGtkMenu.html#DbusmenuGtkMenuClass" title="DbusmenuGtkMenuClass">DbusmenuGtkMenuClass</a>; +<span class="returnvalue">DbusmenuGtkMenu</span> * <a class="link" href="libdbusmenu-gtk-DbusmenuGtkMenu.html#dbusmenu-gtkmenu-new" title="dbusmenu_gtkmenu_new ()">dbusmenu_gtkmenu_new</a> (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *dbus_name</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *dbus_object</code></em>); +<span class="returnvalue">DbusmenuGtkClient</span> * <a class="link" href="libdbusmenu-gtk-DbusmenuGtkMenu.html#dbusmenu-gtkmenu-get-client" title="dbusmenu_gtkmenu_get_client ()">dbusmenu_gtkmenu_get_client</a> (<em class="parameter"><code><span class="type">DbusmenuGtkMenu</span> *menu</code></em>); +</pre> +</div> +<div class="refsect1" title="Description"> +<a name="libdbusmenu-gtk-DbusmenuGtkMenu.description"></a><h2>Description</h2> +<p> +</p> +</div> +<div class="refsect1" title="Details"> +<a name="libdbusmenu-gtk-DbusmenuGtkMenu.details"></a><h2>Details</h2> +<div class="refsect2" title="DBUSMENU_GTKMENU_TYPE"> +<a name="DBUSMENU-GTKMENU-TYPE:CAPS"></a><h3>DBUSMENU_GTKMENU_TYPE</h3> +<pre class="programlisting">#define DBUSMENU_GTKMENU_TYPE (dbusmenu_gtkmenu_get_type ()) +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="DbusmenuGtkMenuPrivate"> +<a name="DbusmenuGtkMenuPrivate"></a><h3>DbusmenuGtkMenuPrivate</h3> +<pre class="programlisting">typedef struct _DbusmenuGtkMenuPrivate DbusmenuGtkMenuPrivate;</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="DbusmenuGtkMenuClass"> +<a name="DbusmenuGtkMenuClass"></a><h3>DbusmenuGtkMenuClass</h3> +<pre class="programlisting">typedef struct { + GtkMenuClass parent_class; + + /*< Private >*/ + void (*reserved1) (void); + void (*reserved2) (void); + void (*reserved3) (void); + void (*reserved4) (void); + void (*reserved5) (void); + void (*reserved6) (void); +} DbusmenuGtkMenuClass; +</pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><span class="type">GtkMenuClass</span> <em class="structfield"><code><a name="DbusmenuGtkMenuClass.parent-class"></a>parent_class</code></em>;</span></p></td> +<td> +<span class="type">GtkMenuClass</span> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="DbusmenuGtkMenuClass.reserved1"></a>reserved1</code></em> ()</span></p></td> +<td>Reserved for future use. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="DbusmenuGtkMenuClass.reserved2"></a>reserved2</code></em> ()</span></p></td> +<td>Reserved for future use. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="DbusmenuGtkMenuClass.reserved3"></a>reserved3</code></em> ()</span></p></td> +<td>Reserved for future use. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="DbusmenuGtkMenuClass.reserved4"></a>reserved4</code></em> ()</span></p></td> +<td>Reserved for future use. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="DbusmenuGtkMenuClass.reserved5"></a>reserved5</code></em> ()</span></p></td> +<td>Reserved for future use. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="structfield"><code><a name="DbusmenuGtkMenuClass.reserved6"></a>reserved6</code></em> ()</span></p></td> +<td>Reserved for future use. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="dbusmenu_gtkmenu_new ()"> +<a name="dbusmenu-gtkmenu-new"></a><h3>dbusmenu_gtkmenu_new ()</h3> +<pre class="programlisting"><span class="returnvalue">DbusmenuGtkMenu</span> * dbusmenu_gtkmenu_new (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *dbus_name</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *dbus_object</code></em>);</pre> +<p> +Creates a new <span class="type">DbusmenuGtkMenu</span> object and creates a <a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuClient.html#DbusmenuClient"><span class="type">DbusmenuClient</span></a> + that connects across DBus to a <a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuServer.html#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"><em class="parameter"><code>dbus_name</code></em> :</span></p></td> +<td>Name of the <a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuServer.html#DbusmenuServer"><span class="type">DbusmenuServer</span></a> on DBus +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>dbus_object</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> A new <span class="type">DbusmenuGtkMenu</span> sync'd with a server +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="dbusmenu_gtkmenu_get_client ()"> +<a name="dbusmenu-gtkmenu-get-client"></a><h3>dbusmenu_gtkmenu_get_client ()</h3> +<pre class="programlisting"><span class="returnvalue">DbusmenuGtkClient</span> * dbusmenu_gtkmenu_get_client (<em class="parameter"><code><span class="type">DbusmenuGtkMenu</span> *menu</code></em>);</pre> +<p> +An accessor for the client that this menu is using to + communicate with the server. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>menu</code></em> :</span></p></td> +<td>The <span class="type">DbusmenuGtkMenu</span> to get the client from +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> A valid <span class="type">DbusmenuGtkClient</span> or NULL on error. +</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 diff --git a/docs/libdbusmenu-gtk/reference/html/libdbusmenu-gtk-menuitem.html b/docs/libdbusmenu-gtk/reference/html/libdbusmenu-gtk-menuitem.html new file mode 100644 index 0000000..fcbe37b --- /dev/null +++ b/docs/libdbusmenu-gtk/reference/html/libdbusmenu-gtk-menuitem.html @@ -0,0 +1,280 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>menuitem</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="index.html" title="libdbusmenu-gtk Reference Manual"> +<link rel="up" href="ch01.html" title="API"> +<link rel="prev" href="Genericmenuitem.html" title="Genericmenuitem"> +<link rel="next" href="object-tree.html" title="Object Hierarchy"> +<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="Genericmenuitem.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-gtk Reference Manual</th> +<td><a accesskey="n" href="object-tree.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-gtk-menuitem.synopsis" class="shortcut">Top</a> + | + <a href="#libdbusmenu-gtk-menuitem.description" class="shortcut">Description</a> +</td></tr> +</table> +<div class="refentry" title="menuitem"> +<a name="libdbusmenu-gtk-menuitem"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="libdbusmenu-gtk-menuitem.top_of_page"></a>menuitem</span></h2> +<p>menuitem</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv" title="Synopsis"> +<a name="libdbusmenu-gtk-menuitem.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis"><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-gtk-menuitem.html#dbusmenu-menuitem-property-set-image" title="dbusmenu_menuitem_property_set_image ()">dbusmenu_menuitem_property_set_image</a> + (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> *menuitem</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> *property</code></em>, + <em class="parameter"><code>const <span class="type">GdkPixbuf</span> *data</code></em>); +<span class="returnvalue">GdkPixbuf</span> * <a class="link" href="libdbusmenu-gtk-menuitem.html#dbusmenu-menuitem-property-get-image" title="dbusmenu_menuitem_property_get_image ()">dbusmenu_menuitem_property_get_image</a> + (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> *menuitem</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> *property</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-gtk-menuitem.html#dbusmenu-menuitem-property-set-shortcut" title="dbusmenu_menuitem_property_set_shortcut ()">dbusmenu_menuitem_property_set_shortcut</a> + (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> *menuitem</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> key</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/gdk/unstable/gdk-Windows.html#GdkModifierType"><span class="type">GdkModifierType</span></a> modifier</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-gtk-menuitem.html#dbusmenu-menuitem-property-set-shortcut-string" title="dbusmenu_menuitem_property_set_shortcut_string ()">dbusmenu_menuitem_property_set_shortcut_string</a> + (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> *menuitem</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> *shortcut</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-gtk-menuitem.html#dbusmenu-menuitem-property-set-shortcut-menuitem" title="dbusmenu_menuitem_property_set_shortcut_menuitem ()">dbusmenu_menuitem_property_set_shortcut_menuitem</a> + (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> *menuitem</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/gtk/unstable/GtkMenuItem.html"><span class="type">GtkMenuItem</span></a> *gmi</code></em>); +<span class="returnvalue">void</span> <a class="link" href="libdbusmenu-gtk-menuitem.html#dbusmenu-menuitem-property-get-shortcut" title="dbusmenu_menuitem_property_get_shortcut ()">dbusmenu_menuitem_property_get_shortcut</a> + (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> *menuitem</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *key</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/gdk/unstable/gdk-Windows.html#GdkModifierType"><span class="type">GdkModifierType</span></a> *modifiers</code></em>); +</pre> +</div> +<div class="refsect1" title="Description"> +<a name="libdbusmenu-gtk-menuitem.description"></a><h2>Description</h2> +<p> +</p> +</div> +<div class="refsect1" title="Details"> +<a name="libdbusmenu-gtk-menuitem.details"></a><h2>Details</h2> +<div class="refsect2" title="dbusmenu_menuitem_property_set_image ()"> +<a name="dbusmenu-menuitem-property-set-image"></a><h3>dbusmenu_menuitem_property_set_image ()</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_menuitem_property_set_image + (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> *menuitem</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> *property</code></em>, + <em class="parameter"><code>const <span class="type">GdkPixbuf</span> *data</code></em>);</pre> +<p> +This function takes the pixbuf that is stored in <em class="parameter"><code>data</code></em> and + turns it into a base64 encoded PNG so that it can be placed + onto a standard <a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> property. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>menuitem</code></em> :</span></p></td> +<td>The <a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> to set the property on. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>property</code></em> :</span></p></td> +<td>Name of the property to set. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td> +<td>The image to place on the property. +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> Whether the function was able to set the property + or not. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="dbusmenu_menuitem_property_get_image ()"> +<a name="dbusmenu-menuitem-property-get-image"></a><h3>dbusmenu_menuitem_property_get_image ()</h3> +<pre class="programlisting"><span class="returnvalue">GdkPixbuf</span> * dbusmenu_menuitem_property_get_image + (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> *menuitem</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> *property</code></em>);</pre> +<p> +This function looks on the menu item for a property by the + name of <em class="parameter"><code>property</code></em>. If one exists it tries to turn it into + a <span class="type">GdkPixbuf</span>. It assumes that the property is a base64 encoded + PNG file like the one created by <span class="type">dbusmenu_menuite_property_set_image</span>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>menuitem</code></em> :</span></p></td> +<td>The <span class="type">DbusmenuMenuite</span> to look for the property on +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>property</code></em> :</span></p></td> +<td>The name of the property to look for. +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> A pixbuf or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><span class="type">NULL</span></a> to signal error. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="dbusmenu_menuitem_property_set_shortcut ()"> +<a name="dbusmenu-menuitem-property-set-shortcut"></a><h3>dbusmenu_menuitem_property_set_shortcut ()</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_menuitem_property_set_shortcut + (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> *menuitem</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> key</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/gdk/unstable/gdk-Windows.html#GdkModifierType"><span class="type">GdkModifierType</span></a> modifier</code></em>);</pre> +<p> +Takes the modifer described by <em class="parameter"><code>key</code></em> and <em class="parameter"><code>modifier</code></em> and places that into + the format sending across Dbus for shortcuts. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>menuitem</code></em> :</span></p></td> +<td>The <a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> to set the shortcut on +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td> +<td>The keycode of the key to send +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>modifier</code></em> :</span></p></td> +<td>A bitmask of modifiers used to activate the item +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> Whether it was successful at setting the property. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="dbusmenu_menuitem_property_set_shortcut_string ()"> +<a name="dbusmenu-menuitem-property-set-shortcut-string"></a><h3>dbusmenu_menuitem_property_set_shortcut_string ()</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_menuitem_property_set_shortcut_string + (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> *menuitem</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> *shortcut</code></em>);</pre> +<p> +This function takes a GTK shortcut string as defined in + <a href="http://library.gnome.org/devel/gtk/unstable/gtk3-Keyboard-Accelerators.html#gtk-accelerator-parse"><span class="type">gtk_accelerator_parse</span></a> and turns that into the information + required to send it over DBusmenu. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>menuitem</code></em> :</span></p></td> +<td>The <a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> to set the shortcut on +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>shortcut</code></em> :</span></p></td> +<td>String describing the shortcut +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> Whether it was successful at setting the property. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="dbusmenu_menuitem_property_set_shortcut_menuitem ()"> +<a name="dbusmenu-menuitem-property-set-shortcut-menuitem"></a><h3>dbusmenu_menuitem_property_set_shortcut_menuitem ()</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_menuitem_property_set_shortcut_menuitem + (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> *menuitem</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/gtk/unstable/GtkMenuItem.html"><span class="type">GtkMenuItem</span></a> *gmi</code></em>);</pre> +<p> +Takes the shortcut that is installed on a menu item and calls + <a class="link" href="libdbusmenu-gtk-menuitem.html#dbusmenu-menuitem-property-set-shortcut" title="dbusmenu_menuitem_property_set_shortcut ()"><span class="type">dbusmenu_menuitem_property_set_shortcut</span></a> with it. It also sets + up listeners to watch it change. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>menuitem</code></em> :</span></p></td> +<td>The <a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> to set the shortcut on +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>gmi</code></em> :</span></p></td> +<td>A menu item to steal the shortcut off of +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> Whether it was successful at setting the property. +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="dbusmenu_menuitem_property_get_shortcut ()"> +<a name="dbusmenu-menuitem-property-get-shortcut"></a><h3>dbusmenu_menuitem_property_get_shortcut ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> dbusmenu_menuitem_property_get_shortcut + (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> *menuitem</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *key</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/gdk/unstable/gdk-Windows.html#GdkModifierType"><span class="type">GdkModifierType</span></a> *modifiers</code></em>);</pre> +<p> +This function gets a GTK shortcut as a key and a mask + for use to set the accelerators. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>menuitem</code></em> :</span></p></td> +<td>The <a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> to get the shortcut off +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td> +<td>Location to put the key value +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>modifiers</code></em> :</span></p></td> +<td> +</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 diff --git a/docs/libdbusmenu-gtk/reference/html/libdbusmenu-gtk.devhelp b/docs/libdbusmenu-gtk/reference/html/libdbusmenu-gtk.devhelp new file mode 100644 index 0000000..4d0bf3e --- /dev/null +++ b/docs/libdbusmenu-gtk/reference/html/libdbusmenu-gtk.devhelp @@ -0,0 +1,53 @@ +<?xml version="1.0" encoding="utf-8" standalone="no"?> +<!DOCTYPE book PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" ""> +<book xmlns="http://www.devhelp.net/book" title="libdbusmenu-gtk Reference Manual" link="index.html" author="" name="libdbusmenu-gtk"> + <chapters> + <sub name="API" link="ch01.html"> + <sub name="DbusmenuGtkMenu" link="libdbusmenu-gtk-DbusmenuGtkMenu.html"/> + <sub name="DbusmenuGtkClient" link="libdbusmenu-gtk-DbusmenuGtkClient.html"/> + <sub name="Genericmenuitem" link="Genericmenuitem.html"/> + <sub name="menuitem" link="libdbusmenu-gtk-menuitem.html"/> + </sub> + <sub name="Object Hierarchy" link="object-tree.html"/> + <sub name="API Index" link="api-index-full.html"/> + </chapters> + <functions> + <function name="DBUSMENU_GTKMENU_TYPE" link="libdbusmenu-gtk-DbusmenuGtkMenu.html#DBUSMENU-GTKMENU-TYPE:CAPS"/> + <function name="DbusmenuGtkMenuPrivate" link="libdbusmenu-gtk-DbusmenuGtkMenu.html#DbusmenuGtkMenuPrivate"/> + <function name="DbusmenuGtkMenuClass" link="libdbusmenu-gtk-DbusmenuGtkMenu.html#DbusmenuGtkMenuClass"/> + <function name="dbusmenu_gtkmenu_new ()" link="libdbusmenu-gtk-DbusmenuGtkMenu.html#dbusmenu-gtkmenu-new"/> + <function name="dbusmenu_gtkmenu_get_client ()" link="libdbusmenu-gtk-DbusmenuGtkMenu.html#dbusmenu-gtkmenu-get-client"/> + <function name="DBUSMENU_GTKCLIENT_TYPE" link="libdbusmenu-gtk-DbusmenuGtkClient.html#DBUSMENU-GTKCLIENT-TYPE:CAPS"/> + <function name="DBUSMENU_GTKCLIENT_SIGNAL_ROOT_CHANGED" link="libdbusmenu-gtk-DbusmenuGtkClient.html#DBUSMENU-GTKCLIENT-SIGNAL-ROOT-CHANGED:CAPS"/> + <function name="DbusmenuGtkClientPrivate" link="libdbusmenu-gtk-DbusmenuGtkClient.html#DbusmenuGtkClientPrivate"/> + <function name="DbusmenuGtkClientClass" link="libdbusmenu-gtk-DbusmenuGtkClient.html#DbusmenuGtkClientClass"/> + <function name="dbusmenu_gtkclient_new ()" link="libdbusmenu-gtk-DbusmenuGtkClient.html#dbusmenu-gtkclient-new"/> + <function name="dbusmenu_gtkclient_menuitem_get ()" link="libdbusmenu-gtk-DbusmenuGtkClient.html#dbusmenu-gtkclient-menuitem-get"/> + <function name="dbusmenu_gtkclient_menuitem_get_submenu ()" link="libdbusmenu-gtk-DbusmenuGtkClient.html#dbusmenu-gtkclient-menuitem-get-submenu"/> + <function name="dbusmenu_gtkclient_set_accel_group ()" link="libdbusmenu-gtk-DbusmenuGtkClient.html#dbusmenu-gtkclient-set-accel-group"/> + <function name="dbusmenu_gtkclient_get_accel_group ()" link="libdbusmenu-gtk-DbusmenuGtkClient.html#dbusmenu-gtkclient-get-accel-group"/> + <function name="dbusmenu_gtkclient_newitem_base ()" link="libdbusmenu-gtk-DbusmenuGtkClient.html#dbusmenu-gtkclient-newitem-base"/> + <function name="GENERICMENUITEM_TYPE" link="Genericmenuitem.html#GENERICMENUITEM-TYPE:CAPS"/> + <function name="GENERICMENUITEM()" link="Genericmenuitem.html#GENERICMENUITEM:CAPS"/> + <function name="GENERICMENUITEM_CLASS()" link="Genericmenuitem.html#GENERICMENUITEM-CLASS:CAPS"/> + <function name="IS_GENERICMENUITEM()" link="Genericmenuitem.html#IS-GENERICMENUITEM:CAPS"/> + <function name="IS_GENERICMENUITEM_CLASS()" link="Genericmenuitem.html#IS-GENERICMENUITEM-CLASS:CAPS"/> + <function name="GENERICMENUITEM_GET_CLASS()" link="Genericmenuitem.html#GENERICMENUITEM-GET-CLASS:CAPS"/> + <function name="Genericmenuitem" link="Genericmenuitem.html#Genericmenuitem-struct"/> + <function name="GenericmenuitemClass" link="Genericmenuitem.html#GenericmenuitemClass"/> + <function name="GenericmenuitemPrivate" link="Genericmenuitem.html#GenericmenuitemPrivate"/> + <function name="enum GenericmenuitemCheckType" link="Genericmenuitem.html#GenericmenuitemCheckType"/> + <function name="enum GenericmenuitemState" link="Genericmenuitem.html#GenericmenuitemState"/> + <function name="genericmenuitem_get_type ()" link="Genericmenuitem.html#genericmenuitem-get-type"/> + <function name="genericmenuitem_set_check_type ()" link="Genericmenuitem.html#genericmenuitem-set-check-type"/> + <function name="genericmenuitem_set_state ()" link="Genericmenuitem.html#genericmenuitem-set-state"/> + <function name="genericmenuitem_set_image ()" link="Genericmenuitem.html#genericmenuitem-set-image"/> + <function name="genericmenuitem_get_image ()" link="Genericmenuitem.html#genericmenuitem-get-image"/> + <function name="dbusmenu_menuitem_property_set_image ()" link="libdbusmenu-gtk-menuitem.html#dbusmenu-menuitem-property-set-image"/> + <function name="dbusmenu_menuitem_property_get_image ()" link="libdbusmenu-gtk-menuitem.html#dbusmenu-menuitem-property-get-image"/> + <function name="dbusmenu_menuitem_property_set_shortcut ()" link="libdbusmenu-gtk-menuitem.html#dbusmenu-menuitem-property-set-shortcut"/> + <function name="dbusmenu_menuitem_property_set_shortcut_string ()" link="libdbusmenu-gtk-menuitem.html#dbusmenu-menuitem-property-set-shortcut-string"/> + <function name="dbusmenu_menuitem_property_set_shortcut_menuitem ()" link="libdbusmenu-gtk-menuitem.html#dbusmenu-menuitem-property-set-shortcut-menuitem"/> + <function name="dbusmenu_menuitem_property_get_shortcut ()" link="libdbusmenu-gtk-menuitem.html#dbusmenu-menuitem-property-get-shortcut"/> + </functions> +</book> diff --git a/docs/libdbusmenu-gtk/reference/html/libdbusmenu-gtk.devhelp2 b/docs/libdbusmenu-gtk/reference/html/libdbusmenu-gtk.devhelp2 new file mode 100644 index 0000000..88dfbfc --- /dev/null +++ b/docs/libdbusmenu-gtk/reference/html/libdbusmenu-gtk.devhelp2 @@ -0,0 +1,53 @@ +<?xml version="1.0" encoding="utf-8" standalone="no"?> +<!DOCTYPE book PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" ""> +<book xmlns="http://www.devhelp.net/book" title="libdbusmenu-gtk Reference Manual" link="index.html" author="" name="libdbusmenu-gtk" version="2" language="c"> + <chapters> + <sub name="API" link="ch01.html"> + <sub name="DbusmenuGtkMenu" link="libdbusmenu-gtk-DbusmenuGtkMenu.html"/> + <sub name="DbusmenuGtkClient" link="libdbusmenu-gtk-DbusmenuGtkClient.html"/> + <sub name="Genericmenuitem" link="Genericmenuitem.html"/> + <sub name="menuitem" link="libdbusmenu-gtk-menuitem.html"/> + </sub> + <sub name="Object Hierarchy" link="object-tree.html"/> + <sub name="API Index" link="api-index-full.html"/> + </chapters> + <functions> + <keyword type="macro" name="DBUSMENU_GTKMENU_TYPE" link="libdbusmenu-gtk-DbusmenuGtkMenu.html#DBUSMENU-GTKMENU-TYPE:CAPS"/> + <keyword type="struct" name="DbusmenuGtkMenuPrivate" link="libdbusmenu-gtk-DbusmenuGtkMenu.html#DbusmenuGtkMenuPrivate"/> + <keyword type="struct" name="DbusmenuGtkMenuClass" link="libdbusmenu-gtk-DbusmenuGtkMenu.html#DbusmenuGtkMenuClass"/> + <keyword type="function" name="dbusmenu_gtkmenu_new ()" link="libdbusmenu-gtk-DbusmenuGtkMenu.html#dbusmenu-gtkmenu-new"/> + <keyword type="function" name="dbusmenu_gtkmenu_get_client ()" link="libdbusmenu-gtk-DbusmenuGtkMenu.html#dbusmenu-gtkmenu-get-client"/> + <keyword type="macro" name="DBUSMENU_GTKCLIENT_TYPE" link="libdbusmenu-gtk-DbusmenuGtkClient.html#DBUSMENU-GTKCLIENT-TYPE:CAPS"/> + <keyword type="macro" name="DBUSMENU_GTKCLIENT_SIGNAL_ROOT_CHANGED" link="libdbusmenu-gtk-DbusmenuGtkClient.html#DBUSMENU-GTKCLIENT-SIGNAL-ROOT-CHANGED:CAPS"/> + <keyword type="struct" name="DbusmenuGtkClientPrivate" link="libdbusmenu-gtk-DbusmenuGtkClient.html#DbusmenuGtkClientPrivate"/> + <keyword type="struct" name="DbusmenuGtkClientClass" link="libdbusmenu-gtk-DbusmenuGtkClient.html#DbusmenuGtkClientClass"/> + <keyword type="function" name="dbusmenu_gtkclient_new ()" link="libdbusmenu-gtk-DbusmenuGtkClient.html#dbusmenu-gtkclient-new"/> + <keyword type="function" name="dbusmenu_gtkclient_menuitem_get ()" link="libdbusmenu-gtk-DbusmenuGtkClient.html#dbusmenu-gtkclient-menuitem-get"/> + <keyword type="function" name="dbusmenu_gtkclient_menuitem_get_submenu ()" link="libdbusmenu-gtk-DbusmenuGtkClient.html#dbusmenu-gtkclient-menuitem-get-submenu"/> + <keyword type="function" name="dbusmenu_gtkclient_set_accel_group ()" link="libdbusmenu-gtk-DbusmenuGtkClient.html#dbusmenu-gtkclient-set-accel-group"/> + <keyword type="function" name="dbusmenu_gtkclient_get_accel_group ()" link="libdbusmenu-gtk-DbusmenuGtkClient.html#dbusmenu-gtkclient-get-accel-group"/> + <keyword type="function" name="dbusmenu_gtkclient_newitem_base ()" link="libdbusmenu-gtk-DbusmenuGtkClient.html#dbusmenu-gtkclient-newitem-base"/> + <keyword type="macro" name="GENERICMENUITEM_TYPE" link="Genericmenuitem.html#GENERICMENUITEM-TYPE:CAPS"/> + <keyword type="macro" name="GENERICMENUITEM()" link="Genericmenuitem.html#GENERICMENUITEM:CAPS"/> + <keyword type="macro" name="GENERICMENUITEM_CLASS()" link="Genericmenuitem.html#GENERICMENUITEM-CLASS:CAPS"/> + <keyword type="macro" name="IS_GENERICMENUITEM()" link="Genericmenuitem.html#IS-GENERICMENUITEM:CAPS"/> + <keyword type="macro" name="IS_GENERICMENUITEM_CLASS()" link="Genericmenuitem.html#IS-GENERICMENUITEM-CLASS:CAPS"/> + <keyword type="macro" name="GENERICMENUITEM_GET_CLASS()" link="Genericmenuitem.html#GENERICMENUITEM-GET-CLASS:CAPS"/> + <keyword type="struct" name="Genericmenuitem" link="Genericmenuitem.html#Genericmenuitem-struct"/> + <keyword type="struct" name="GenericmenuitemClass" link="Genericmenuitem.html#GenericmenuitemClass"/> + <keyword type="struct" name="GenericmenuitemPrivate" link="Genericmenuitem.html#GenericmenuitemPrivate"/> + <keyword type="enum" name="enum GenericmenuitemCheckType" link="Genericmenuitem.html#GenericmenuitemCheckType"/> + <keyword type="enum" name="enum GenericmenuitemState" link="Genericmenuitem.html#GenericmenuitemState"/> + <keyword type="function" name="genericmenuitem_get_type ()" link="Genericmenuitem.html#genericmenuitem-get-type"/> + <keyword type="function" name="genericmenuitem_set_check_type ()" link="Genericmenuitem.html#genericmenuitem-set-check-type"/> + <keyword type="function" name="genericmenuitem_set_state ()" link="Genericmenuitem.html#genericmenuitem-set-state"/> + <keyword type="function" name="genericmenuitem_set_image ()" link="Genericmenuitem.html#genericmenuitem-set-image"/> + <keyword type="function" name="genericmenuitem_get_image ()" link="Genericmenuitem.html#genericmenuitem-get-image"/> + <keyword type="function" name="dbusmenu_menuitem_property_set_image ()" link="libdbusmenu-gtk-menuitem.html#dbusmenu-menuitem-property-set-image"/> + <keyword type="function" name="dbusmenu_menuitem_property_get_image ()" link="libdbusmenu-gtk-menuitem.html#dbusmenu-menuitem-property-get-image"/> + <keyword type="function" name="dbusmenu_menuitem_property_set_shortcut ()" link="libdbusmenu-gtk-menuitem.html#dbusmenu-menuitem-property-set-shortcut"/> + <keyword type="function" name="dbusmenu_menuitem_property_set_shortcut_string ()" link="libdbusmenu-gtk-menuitem.html#dbusmenu-menuitem-property-set-shortcut-string"/> + <keyword type="function" name="dbusmenu_menuitem_property_set_shortcut_menuitem ()" link="libdbusmenu-gtk-menuitem.html#dbusmenu-menuitem-property-set-shortcut-menuitem"/> + <keyword type="function" name="dbusmenu_menuitem_property_get_shortcut ()" link="libdbusmenu-gtk-menuitem.html#dbusmenu-menuitem-property-get-shortcut"/> + </functions> +</book> diff --git a/docs/libdbusmenu-gtk/reference/html/object-tree.html b/docs/libdbusmenu-gtk/reference/html/object-tree.html new file mode 100644 index 0000000..baf2c12 --- /dev/null +++ b/docs/libdbusmenu-gtk/reference/html/object-tree.html @@ -0,0 +1,42 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Object Hierarchy</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="index.html" title="libdbusmenu-gtk Reference Manual"> +<link rel="up" href="index.html" title="libdbusmenu-gtk Reference Manual"> +<link rel="prev" href="libdbusmenu-gtk-menuitem.html" title="menuitem"> +<link rel="next" href="api-index-full.html" title="API Index"> +<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="libdbusmenu-gtk-menuitem.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td> </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-gtk Reference Manual</th> +<td><a accesskey="n" href="api-index-full.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr></table> +<div class="chapter" title="Object Hierarchy"> +<div class="titlepage"><div><div><h2 class="title"> +<a name="object-tree"></a>Object Hierarchy</h2></div></div></div> +<pre class="screen"> + <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> + <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> + <a href="http://library.gnome.org/devel/gtk/unstable/GtkObject.html">GtkObject</a> + <a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html">GtkWidget</a> + <a href="http://library.gnome.org/devel/gtk/unstable/GtkContainer.html">GtkContainer</a> + <a href="http://library.gnome.org/devel/gtk/unstable/GtkBin.html">GtkBin</a> + <a href="http://library.gnome.org/devel/gtk/unstable/GtkItem.html">GtkItem</a> + <a href="http://library.gnome.org/devel/gtk/unstable/GtkMenuItem.html">GtkMenuItem</a> + <a href="http://library.gnome.org/devel/gtk/unstable/gtk3-gtkcheckmenuitem.html#GtkCheckMenuItem">GtkCheckMenuItem</a> + <a class="link" href="Genericmenuitem.html" title="Genericmenuitem">Genericmenuitem</a> +</pre> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.15</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/libdbusmenu-gtk/reference/html/right.png b/docs/libdbusmenu-gtk/reference/html/right.png Binary files differnew file mode 100644 index 0000000..6fecd43 --- /dev/null +++ b/docs/libdbusmenu-gtk/reference/html/right.png diff --git a/docs/libdbusmenu-gtk/reference/html/style.css b/docs/libdbusmenu-gtk/reference/html/style.css new file mode 100644 index 0000000..d544a2c --- /dev/null +++ b/docs/libdbusmenu-gtk/reference/html/style.css @@ -0,0 +1,265 @@ +.synopsis, .classsynopsis +{ + /* tango:aluminium 1/2 */ + background: #eeeeec; + border: solid 1px #d3d7cf; + padding: 0.5em; +} +.programlisting +{ + /* tango:sky blue 0/1 */ + background: #e6f3ff; + border: solid 1px #729fcf; + padding: 0.5em; +} +.variablelist +{ + padding: 4px; + margin-left: 3em; +} +.variablelist td:first-child +{ + vertical-align: top; +} + +@media screen { + sup a.footnote + { + position: relative; + top: 0em ! important; + + } + /* this is needed so that the local anchors are displayed below the naviagtion */ + div.footnote a[name], div.refnamediv a[name], div.refsect1 a[name], div.refsect2 a[name], div.index a[name], div.glossary a[name], div.sect1 a[name] + { + position: relative; + padding-top:4.5em; + } + /* this seems to be a bug in the xsl style sheets when generating indexes */ + div.index div.index + { + top: 0em; + } + /* make space for the fixed navigation bar and add space at the bottom so that + * link targets appear somewhat close to top + */ + body + { + padding-top: 3.2em; + padding-bottom: 20em; + } + /* style and size the navigation bar */ + table.navigation#top + { + position: fixed; + /* tango:scarlet red 0/1 */ + background: #ffe6e6; + border: solid 1px #ef2929; + margin-top: 0; + margin-bottom: 0; + top: 0; + left: 0; + height: 3em; + z-index: 10; + } + .navigation a, .navigation a:visited + { + /* tango:scarlet red 3 */ + color: #a40000; + } + .navigation a:hover + { + /* tango:scarlet red 1 */ + color: #ef2929; + } + td.shortcuts + { + /* tango:scarlet red 1 */ + color: #ef2929; + font-size: 80%; + white-space: nowrap; + } +} +@media print { + table.navigation { + visibility: collapse; + display: none; + } + div.titlepage table.navigation { + visibility: visible; + display: table; + /* tango:scarlet red 0/1 */ + background: #ffe6e6; + border: solid 1px #ef2929; + margin-top: 0; + margin-bottom: 0; + top: 0; + left: 0; + height: 3em; + } +} + +.navigation .title +{ + font-size: 200%; +} + +div.gallery-float +{ + float: left; + padding: 10px; +} +div.gallery-float img +{ + border-style: none; +} +div.gallery-spacer +{ + clear: both; +} + +a, a:visited +{ + text-decoration: none; + /* tango:sky blue 2 */ + color: #3465a4; +} +a:hover +{ + text-decoration: underline; + /* tango:sky blue 1 */ + color: #729fcf; +} + +div.table table +{ + border-collapse: collapse; + border-spacing: 0px; + /* tango:aluminium 3 */ + border: solid 1px #babdb6; +} + +div.table table td, div.table table th +{ + /* tango:aluminium 3 */ + border: solid 1px #babdb6; + padding: 3px; + vertical-align: top; +} + +div.table table th +{ + /* tango:aluminium 2 */ + background-color: #d3d7cf; +} + +hr +{ + /* tango:aluminium 3 */ + color: #babdb6; + background: #babdb6; + border: none 0px; + height: 1px; + clear: both; +} + +.footer +{ + padding-top: 3.5em; + /* tango:aluminium 3 */ + color: #babdb6; + text-align: center; + font-size: 80%; +} + +.warning +{ + /* tango:orange 0/1 */ + background: #ffeed9; + border-color: #ffb04f; +} +.note +{ + /* tango:chameleon 0/0.5 */ + background: #d8ffb2; + border-color: #abf562; +} +.note, .warning +{ + padding: 0.5em; + border-width: 1px; + border-style: solid; +} +.note h3, .warning h3 +{ + margin-top: 0.0em +} +.note p, .warning p +{ + margin-bottom: 0.0em +} + +/* blob links */ +h2 .extralinks, h3 .extralinks +{ + float: right; + /* tango:aluminium 3 */ + color: #babdb6; + font-size: 80%; + font-weight: normal; +} + +.annotation +{ + /* tango:aluminium 5 */ + color: #555753; + font-size: 80%; + font-weight: normal; +} + +/* code listings */ + +.listing_code .programlisting .cbracket { color: #a40000; } /* tango: scarlet red 3 */ +.listing_code .programlisting .comment { color: #a1a39d; } /* tango: aluminium 4 */ +.listing_code .programlisting .function { color: #000000; font-weight: bold; } +.listing_code .programlisting .function a { color: #11326b; font-weight: bold; } /* tango: sky blue 4 */ +.listing_code .programlisting .keyword { color: #4e9a06; } /* tango: chameleon 3 */ +.listing_code .programlisting .linenum { color: #babdb6; } /* tango: aluminium 3 */ +.listing_code .programlisting .normal { color: #000000; } +.listing_code .programlisting .number { color: #75507b; } /* tango: plum 2 */ +.listing_code .programlisting .preproc { color: #204a87; } /* tango: sky blue 3 */ +.listing_code .programlisting .string { color: #c17d11; } /* tango: chocolate 2 */ +.listing_code .programlisting .type { color: #000000; } +.listing_code .programlisting .type a { color: #11326b; } /* tango: sky blue 4 */ +.listing_code .programlisting .symbol { color: #ce5c00; } /* tango: orange 3 */ + +.listing_frame { + /* tango:sky blue 1 */ + border: solid 1px #729fcf; + padding: 0px; +} + +.listing_lines, .listing_code { + margin-top: 0px; + margin-bottom: 0px; + padding: 0.5em; +} +.listing_lines { + /* tango:sky blue 0.5 */ + background: #a6c5e3; + /* tango:aluminium 6 */ + color: #2e3436; +} +.listing_code { + /* tango:sky blue 0 */ + background: #e6f3ff; +} +.listing_code .programlisting { + /* override from previous */ + border: none 0px; + padding: 0px; +} +.listing_lines pre, .listing_code pre { + margin: 0px; +} + diff --git a/docs/libdbusmenu-gtk/reference/html/up.png b/docs/libdbusmenu-gtk/reference/html/up.png Binary files differnew file mode 100644 index 0000000..85b3e2a --- /dev/null +++ b/docs/libdbusmenu-gtk/reference/html/up.png diff --git a/docs/libdbusmenu-gtk/reference/libdbusmenu-gtk-sections.txt b/docs/libdbusmenu-gtk/reference/libdbusmenu-gtk-sections.txt new file mode 100644 index 0000000..eca240c --- /dev/null +++ b/docs/libdbusmenu-gtk/reference/libdbusmenu-gtk-sections.txt @@ -0,0 +1,70 @@ +<SECTION> +<FILE>client</FILE> +<TITLE>DbusmenuGtkClient</TITLE> +DBUSMENU_GTKCLIENT_TYPE +DBUSMENU_GTKCLIENT_SIGNAL_ROOT_CHANGED +DbusmenuGtkClientPrivate +DbusmenuGtkClientClass +dbusmenu_gtkclient_new +dbusmenu_gtkclient_menuitem_get +dbusmenu_gtkclient_menuitem_get_submenu +dbusmenu_gtkclient_set_accel_group +dbusmenu_gtkclient_get_accel_group +dbusmenu_gtkclient_newitem_base +<SUBSECTION Standard> +DBUSMENU_GTKCLIENT +DBUSMENU_IS_GTKCLIENT +dbusmenu_gtkclient_get_type +DBUSMENU_GTKCLIENT_CLASS +DBUSMENU_IS_GTKCLIENT_CLASS +DBUSMENU_GTKCLIENT_GET_CLASS +</SECTION> + +<SECTION> +<FILE>menu</FILE> +<TITLE>DbusmenuGtkMenu</TITLE> +DBUSMENU_GTKMENU_TYPE +DbusmenuGtkMenuPrivate +DbusmenuGtkMenuClass +dbusmenu_gtkmenu_new +dbusmenu_gtkmenu_get_client +<SUBSECTION Standard> +DBUSMENU_GTKMENU +DBUSMENU_IS_GTKMENU +dbusmenu_gtkmenu_get_type +DBUSMENU_GTKMENU_CLASS +DBUSMENU_IS_GTKMENU_CLASS +DBUSMENU_GTKMENU_GET_CLASS +</SECTION> + +<SECTION> +<FILE>menuitem</FILE> +dbusmenu_menuitem_property_set_image +dbusmenu_menuitem_property_get_image +dbusmenu_menuitem_property_set_shortcut +dbusmenu_menuitem_property_set_shortcut_string +dbusmenu_menuitem_property_set_shortcut_menuitem +dbusmenu_menuitem_property_get_shortcut +</SECTION> + +<SECTION> +<FILE>genericmenuitem</FILE> +<TITLE>Genericmenuitem</TITLE> +GENERICMENUITEM_TYPE +GENERICMENUITEM +GENERICMENUITEM_CLASS +IS_GENERICMENUITEM +IS_GENERICMENUITEM_CLASS +GENERICMENUITEM_GET_CLASS +Genericmenuitem +GenericmenuitemClass +GenericmenuitemPrivate +GenericmenuitemCheckType +GenericmenuitemState +genericmenuitem_get_type +genericmenuitem_set_check_type +genericmenuitem_set_state +genericmenuitem_set_image +genericmenuitem_get_image +</SECTION> + diff --git a/docs/libdbusmenu-gtk/reference/libdbusmenu-gtk.types b/docs/libdbusmenu-gtk/reference/libdbusmenu-gtk.types new file mode 100644 index 0000000..092dccd --- /dev/null +++ b/docs/libdbusmenu-gtk/reference/libdbusmenu-gtk.types @@ -0,0 +1,3 @@ +dbusmenu_gtkclient_get_type +dbusmenu_gtkmenu_get_type +genericmenuitem_get_type diff --git a/docs/libdbusmenu-gtk/reference/tmpl/client.sgml b/docs/libdbusmenu-gtk/reference/tmpl/client.sgml new file mode 100644 index 0000000..9f4881d --- /dev/null +++ b/docs/libdbusmenu-gtk/reference/tmpl/client.sgml @@ -0,0 +1,117 @@ +<!-- ##### SECTION Title ##### --> +DbusmenuGtkClient + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO DBUSMENU_GTKCLIENT_TYPE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO DBUSMENU_GTKCLIENT_SIGNAL_ROOT_CHANGED ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT DbusmenuGtkClientPrivate ##### --> +<para> + +</para> + + +<!-- ##### STRUCT DbusmenuGtkClientClass ##### --> +<para> + +</para> + +@parent_class: +@root_changed: +@reserved1: +@reserved2: +@reserved3: +@reserved4: +@reserved5: +@reserved6: + +<!-- ##### FUNCTION dbusmenu_gtkclient_new ##### --> +<para> + +</para> + +@dbus_name: +@dbus_object: +@Returns: + + +<!-- ##### FUNCTION dbusmenu_gtkclient_menuitem_get ##### --> +<para> + +</para> + +@client: +@item: +@Returns: + + +<!-- ##### FUNCTION dbusmenu_gtkclient_menuitem_get_submenu ##### --> +<para> + +</para> + +@client: +@item: +@Returns: + + +<!-- ##### FUNCTION dbusmenu_gtkclient_set_accel_group ##### --> +<para> + +</para> + +@client: +@agroup: + + +<!-- ##### FUNCTION dbusmenu_gtkclient_get_accel_group ##### --> +<para> + +</para> + +@client: +@Returns: + + +<!-- ##### FUNCTION dbusmenu_gtkclient_newitem_base ##### --> +<para> + +</para> + +@client: +@item: +@gmi: +@parent: + + diff --git a/docs/libdbusmenu-gtk/reference/tmpl/genericmenuitem.sgml b/docs/libdbusmenu-gtk/reference/tmpl/genericmenuitem.sgml new file mode 100644 index 0000000..91b4673 --- /dev/null +++ b/docs/libdbusmenu-gtk/reference/tmpl/genericmenuitem.sgml @@ -0,0 +1,153 @@ +<!-- ##### SECTION Title ##### --> +Genericmenuitem + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO GENERICMENUITEM_TYPE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO GENERICMENUITEM ##### --> +<para> + +</para> + +@obj: + + +<!-- ##### MACRO GENERICMENUITEM_CLASS ##### --> +<para> + +</para> + +@klass: + + +<!-- ##### MACRO IS_GENERICMENUITEM ##### --> +<para> + +</para> + +@obj: + + +<!-- ##### MACRO IS_GENERICMENUITEM_CLASS ##### --> +<para> + +</para> + +@klass: + + +<!-- ##### MACRO GENERICMENUITEM_GET_CLASS ##### --> +<para> + +</para> + +@obj: + + +<!-- ##### STRUCT Genericmenuitem ##### --> +<para> + +</para> + + +<!-- ##### STRUCT GenericmenuitemClass ##### --> +<para> + +</para> + +@parent_class: + +<!-- ##### STRUCT GenericmenuitemPrivate ##### --> +<para> + +</para> + + +<!-- ##### ENUM GenericmenuitemCheckType ##### --> +<para> + +</para> + +@GENERICMENUITEM_CHECK_TYPE_NONE: +@GENERICMENUITEM_CHECK_TYPE_CHECKBOX: +@GENERICMENUITEM_CHECK_TYPE_RADIO: + +<!-- ##### ENUM GenericmenuitemState ##### --> +<para> + +</para> + +@GENERICMENUITEM_STATE_UNCHECKED: +@GENERICMENUITEM_STATE_CHECKED: +@GENERICMENUITEM_STATE_INDETERMINATE: + +<!-- ##### FUNCTION genericmenuitem_get_type ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION genericmenuitem_set_check_type ##### --> +<para> + +</para> + +@item: +@check_type: + + +<!-- ##### FUNCTION genericmenuitem_set_state ##### --> +<para> + +</para> + +@item: +@state: + + +<!-- ##### FUNCTION genericmenuitem_set_image ##### --> +<para> + +</para> + +@item: +@image: + + +<!-- ##### FUNCTION genericmenuitem_get_image ##### --> +<para> + +</para> + +@item: +@Returns: + + diff --git a/docs/libdbusmenu-gtk/reference/tmpl/libdbusmenu-gtk-unused.sgml b/docs/libdbusmenu-gtk/reference/tmpl/libdbusmenu-gtk-unused.sgml new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/docs/libdbusmenu-gtk/reference/tmpl/libdbusmenu-gtk-unused.sgml diff --git a/docs/libdbusmenu-gtk/reference/tmpl/menu.sgml b/docs/libdbusmenu-gtk/reference/tmpl/menu.sgml new file mode 100644 index 0000000..b1ed631 --- /dev/null +++ b/docs/libdbusmenu-gtk/reference/tmpl/menu.sgml @@ -0,0 +1,69 @@ +<!-- ##### SECTION Title ##### --> +DbusmenuGtkMenu + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO DBUSMENU_GTKMENU_TYPE ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT DbusmenuGtkMenuPrivate ##### --> +<para> + +</para> + + +<!-- ##### STRUCT DbusmenuGtkMenuClass ##### --> +<para> + +</para> + +@parent_class: +@reserved1: +@reserved2: +@reserved3: +@reserved4: +@reserved5: +@reserved6: + +<!-- ##### FUNCTION dbusmenu_gtkmenu_new ##### --> +<para> + +</para> + +@dbus_name: +@dbus_object: +@Returns: + + +<!-- ##### FUNCTION dbusmenu_gtkmenu_get_client ##### --> +<para> + +</para> + +@menu: +@Returns: + + diff --git a/docs/libdbusmenu-gtk/reference/tmpl/menuitem.sgml b/docs/libdbusmenu-gtk/reference/tmpl/menuitem.sgml new file mode 100644 index 0000000..55347ff --- /dev/null +++ b/docs/libdbusmenu-gtk/reference/tmpl/menuitem.sgml @@ -0,0 +1,86 @@ +<!-- ##### SECTION Title ##### --> +menuitem + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### FUNCTION dbusmenu_menuitem_property_set_image ##### --> +<para> + +</para> + +@menuitem: +@property: +@data: +@Returns: + + +<!-- ##### FUNCTION dbusmenu_menuitem_property_get_image ##### --> +<para> + +</para> + +@menuitem: +@property: +@Returns: + + +<!-- ##### FUNCTION dbusmenu_menuitem_property_set_shortcut ##### --> +<para> + +</para> + +@menuitem: +@key: +@modifier: +@Returns: + + +<!-- ##### FUNCTION dbusmenu_menuitem_property_set_shortcut_string ##### --> +<para> + +</para> + +@menuitem: +@shortcut: +@Returns: + + +<!-- ##### FUNCTION dbusmenu_menuitem_property_set_shortcut_menuitem ##### --> +<para> + +</para> + +@menuitem: +@gmi: +@Returns: + + +<!-- ##### FUNCTION dbusmenu_menuitem_property_get_shortcut ##### --> +<para> + +</para> + +@menuitem: +@key: +@modifiers: + + diff --git a/docs/libdbusmenu-gtk/reference/version.xml b/docs/libdbusmenu-gtk/reference/version.xml index 15edd7c..bdbb067 100644 --- a/docs/libdbusmenu-gtk/reference/version.xml +++ b/docs/libdbusmenu-gtk/reference/version.xml @@ -1 +1 @@ -0.3.91 +0.3.92 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..23555fd --- /dev/null +++ b/docs/libdbusmenu-gtk/reference/xml/api-index-full.xml @@ -0,0 +1,51 @@ +<?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="DbusmenuGtkClientPrivate"><link linkend="DbusmenuGtkClientPrivate">DbusmenuGtkClientPrivate</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="DbusmenuGtkMenuPrivate"><link linkend="DbusmenuGtkMenuPrivate">DbusmenuGtkMenuPrivate</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..dc0e4d2 --- /dev/null +++ b/docs/libdbusmenu-gtk/reference/xml/client.xml @@ -0,0 +1,241 @@ +<?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="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>, + <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="DbusmenuGtkClientPrivate" role="struct"> +<title>DbusmenuGtkClientPrivate</title> +<indexterm zone="DbusmenuGtkClientPrivate"><primary>DbusmenuGtkClientPrivate</primary></indexterm> +<programlisting>typedef struct _DbusmenuGtkClientPrivate DbusmenuGtkClientPrivate;</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); + + /*< Private >*/ + void (*reserved1) (void); + void (*reserved2) (void); + void (*reserved3) (void); + void (*reserved4) (void); + void (*reserved5) (void); + void (*reserved6) (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> +<varlistentry><term><structfield id="DbusmenuGtkClientClass.reserved5">reserved5</structfield> ()</term> +<listitem><simpara>Reserved for future use. +</simpara></listitem> +</varlistentry> +<varlistentry><term><structfield id="DbusmenuGtkClientClass.reserved6">reserved6</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..26e578e --- /dev/null +++ b/docs/libdbusmenu-gtk/reference/xml/menu.xml @@ -0,0 +1,132 @@ +<?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="DbusmenuGtkMenuPrivate">DbusmenuGtkMenuPrivate</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="DbusmenuGtkMenuPrivate" role="struct"> +<title>DbusmenuGtkMenuPrivate</title> +<indexterm zone="DbusmenuGtkMenuPrivate"><primary>DbusmenuGtkMenuPrivate</primary></indexterm> +<programlisting>typedef struct _DbusmenuGtkMenuPrivate DbusmenuGtkMenuPrivate;</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; + + /*< Private >*/ + void (*reserved1) (void); + void (*reserved2) (void); + void (*reserved3) (void); + void (*reserved4) (void); + void (*reserved5) (void); + void (*reserved6) (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> +<varlistentry><term><structfield id="DbusmenuGtkMenuClass.reserved5">reserved5</structfield> ()</term> +<listitem><simpara>Reserved for future use. +</simpara></listitem> +</varlistentry> +<varlistentry><term><structfield id="DbusmenuGtkMenuClass.reserved6">reserved6</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> |
