Import upstream version 0.6.2

author: Ted Gould <ted@gould.cx> 2012-06-13 14:28:19 -0500
committer: Ted Gould <ted@gould.cx> 2012-06-13 14:28:19 -0500
commit: d1a1d09ea3487669f8622eb4106414eb01d41cfd (patch)
tree: b3ad1b8a1a68ff0c57a7be7c763e5377b93eb0e2 /docs/libdbusmenu-gtk/reference/html/libdbusmenu-gtk-parser.html
parent: 4940701cf76bc33c40cb908211b3293ab65d26c5 (diff)
parent: 6552cd19a5472c47e2cb89a2d597bcc90e36d3bf (diff)
download: libdbusmenu-d1a1d09ea3487669f8622eb4106414eb01d41cfd.tar.gz
libdbusmenu-d1a1d09ea3487669f8622eb4106414eb01d41cfd.tar.bz2
libdbusmenu-d1a1d09ea3487669f8622eb4106414eb01d41cfd.zip
1 files changed, 118 insertions, 0 deletions
diff --git a/docs/libdbusmenu-gtk/reference/html/libdbusmenu-gtk-parser.html b/docs/libdbusmenu-gtk/reference/html/libdbusmenu-gtk-parser.html
new file mode 100644
index 0000000..10b7a3a
--- /dev/null
+++ b/docs/libdbusmenu-gtk/reference/html/libdbusmenu-gtk-parser.html
@@ -0,0 +1,118 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>parser</title>
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
+<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="object-tree.html" title="Object Hierarchy">
+<meta name="generator" content="GTK-Doc V1.18 (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="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-parser.synopsis" class="shortcut">Top</a>
+                   | 
+                  <a href="#libdbusmenu-gtk-parser.description" class="shortcut">Description</a>
+</td></tr>
+</table>
+<div class="refentry">
+<a name="libdbusmenu-gtk-parser"></a><div class="titlepage"></div>
+<div class="refnamediv"><table width="100%"><tr>
+<td valign="top">
+<h2><span class="refentrytitle"><a name="libdbusmenu-gtk-parser.top_of_page"></a>parser</span></h2>
+<p>parser — A parser of in-memory GTK menu trees</p>
+</td>
+<td valign="top" align="right"></td>
+</tr></table></div>
+<div class="refsect1">
+<a name="libdbusmenu-gtk-parser.stability-level"></a><h2>Stability Level</h2>
+Unstable, unless otherwise indicated
+</div>
+<div class="refsynopsisdiv">
+<a name="libdbusmenu-gtk-parser.synopsis"></a><h2>Synopsis</h2>
+<pre class="synopsis">
+#include &lt;libdbusmenu-gtk/parser.h&gt;
+
+<a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem"><span class="returnvalue">DbusmenuMenuitem</span></a> *  <a class="link" href="libdbusmenu-gtk-parser.html#dbusmenu-gtk-parse-menu-structure" title="dbusmenu_gtk_parse_menu_structure ()">dbusmenu_gtk_parse_menu_structure</a>   (<em class="parameter"><code><a href="http://developer.gnome.org/devel/gtk/GtkWidget.html"><span class="type">GtkWidget</span></a> *widget</code></em>);
+<a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem"><span class="returnvalue">DbusmenuMenuitem</span></a> *  <a class="link" href="libdbusmenu-gtk-parser.html#dbusmenu-gtk-parse-get-cached-item" title="dbusmenu_gtk_parse_get_cached_item ()">dbusmenu_gtk_parse_get_cached_item</a>  (<em class="parameter"><code><a href="http://developer.gnome.org/devel/gtk/GtkWidget.html"><span class="type">GtkWidget</span></a> *widget</code></em>);
+</pre>
+</div>
+<div class="refsect1">
+<a name="libdbusmenu-gtk-parser.description"></a><h2>Description</h2>
+<p>
+The parser will take a GTK menu tree and attach it to a Dbusmenu menu
+	tree.  Along with setting up all the signals for updates and destruction.
+	The returned item would be the root item of the given tree.
+</p>
+</div>
+<div class="refsect1">
+<a name="libdbusmenu-gtk-parser.details"></a><h2>Details</h2>
+<div class="refsect2">
+<a name="dbusmenu-gtk-parse-menu-structure"></a><h3>dbusmenu_gtk_parse_menu_structure ()</h3>
+<pre class="programlisting"><a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem"><span class="returnvalue">DbusmenuMenuitem</span></a> *  dbusmenu_gtk_parse_menu_structure   (<em class="parameter"><code><a href="http://developer.gnome.org/devel/gtk/GtkWidget.html"><span class="type">GtkWidget</span></a> *widget</code></em>);</pre>
+<p>
+Goes through the GTK structures and turns them into the appropraite
+Dbusmenu structures along with setting up all the relationships
+between the objects.  It also stores the dbusmenu items as a cache
+on the GTK items so that they'll be reused if necissary.
+</p>
+<div class="variablelist"><table border="0">
+<col align="left" valign="top">
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
+<td>A <a href="http://developer.gnome.org/devel/gtk/GtkMenuItem.html"><span class="type">GtkMenuItem</span></a> or <a href="http://developer.gnome.org/devel/gtk/GtkMenuShell.html"><span class="type">GtkMenuShell</span></a> to turn into a <a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a>
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
+<td>A dbusmenu item representing the menu structure. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
+</td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="dbusmenu-gtk-parse-get-cached-item"></a><h3>dbusmenu_gtk_parse_get_cached_item ()</h3>
+<pre class="programlisting"><a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem"><span class="returnvalue">DbusmenuMenuitem</span></a> *  dbusmenu_gtk_parse_get_cached_item  (<em class="parameter"><code><a href="http://developer.gnome.org/devel/gtk/GtkWidget.html"><span class="type">GtkWidget</span></a> *widget</code></em>);</pre>
+<p>
+The Dbusmenu GTK parser adds cached items on the various
+menu items throughout the tree.  Sometimes it can be useful
+to get that cached item to use directly.  This function
+will retrieve it for you.
+</p>
+<div class="variablelist"><table border="0">
+<col align="left" valign="top">
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
+<td>A <a href="http://developer.gnome.org/devel/gtk/GtkMenuItem.html"><span class="type">GtkMenuItem</span></a> that may have a cached <a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuMenuitem.html#DbusmenuMenuitem"><span class="type">DbusmenuMenuitem</span></a> from the parser</td>
+</tr>
+<tr>
+<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
+<td>A pointer to the cached item
+or NULL if it isn't there. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
+</td>
+</tr>
+</tbody>
+</table></div>
+</div>
+</div>
+</div>
+<div class="footer">
+<hr>
+          Generated by GTK-Doc V1.18</div>
+</body>
+</html>
+\ No newline at end of file
author	Ted Gould <ted@gould.cx>	2012-06-13 14:28:19 -0500
committer	Ted Gould <ted@gould.cx>	2012-06-13 14:28:19 -0500
commit	d1a1d09ea3487669f8622eb4106414eb01d41cfd (patch)
tree	b3ad1b8a1a68ff0c57a7be7c763e5377b93eb0e2 /docs/libdbusmenu-gtk/reference/html/libdbusmenu-gtk-parser.html
parent	4940701cf76bc33c40cb908211b3293ab65d26c5 (diff)
parent	6552cd19a5472c47e2cb89a2d597bcc90e36d3bf (diff)
download	libdbusmenu-d1a1d09ea3487669f8622eb4106414eb01d41cfd.tar.gz libdbusmenu-d1a1d09ea3487669f8622eb4106414eb01d41cfd.tar.bz2 libdbusmenu-d1a1d09ea3487669f8622eb4106414eb01d41cfd.zip