diff options
author | Ted Gould <ted@gould.cx> | 2011-01-14 10:36:48 -0600 |
---|---|---|
committer | Ted Gould <ted@gould.cx> | 2011-01-14 10:36:48 -0600 |
commit | 2461e539704dc3b306c24b5b841be342111a76b9 (patch) | |
tree | 36293d9dbbf964f7f1fe54765140c19564c861b1 /docs/libdbusmenu-gtk/reference/html/Genericmenuitem.html | |
parent | b76ed9c7f918123610e5e56bb9cdd1025d34caa1 (diff) | |
parent | ece305e4b1b4eee4e3fb54faf8f9c291ef915e8c (diff) | |
download | libdbusmenu-2461e539704dc3b306c24b5b841be342111a76b9.tar.gz libdbusmenu-2461e539704dc3b306c24b5b841be342111a76b9.tar.bz2 libdbusmenu-2461e539704dc3b306c24b5b841be342111a76b9.zip |
Import upstream version 0.3.92
Diffstat (limited to 'docs/libdbusmenu-gtk/reference/html/Genericmenuitem.html')
-rw-r--r-- | docs/libdbusmenu-gtk/reference/html/Genericmenuitem.html | 360 |
1 files changed, 360 insertions, 0 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 |