← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/libdbusmenu/oneiric

« back to all changes in this revision

Viewing changes to docs/libdbusmenu-gtk/reference/html/libdbusmenu-gtk-parser.html

  • Committer: Bazaar Package Importer
  • Author(s): Ken VanDine, Ted Gould, Ken VanDine
  • Date: 2011-08-24 20:22:14 UTC
  • mfrom: (1.1.51 upstream)
  • Revision ID: james.westby@ubuntu.com-20110824202214-niqpb3vmy6ljn1xp
Tags: 0.4.92-0ubuntu1
https://launchpad.net/bugs/799878
[ Ted Gould ]
* New upstream release (0.4.92).
  * Add in a property for setting the menuitem disposition
  * Fix GTK 2 build for style properties
  * Fixed proxied menu events not getting returned (LP: #799878)
* Removed debian/patches:
  * All upstream

[ Ken VanDine ]
* debian/libdbusmenu-gtk4.symbols debian/libdbusmenu-gtk3-4.symbols
  - Added new symbols

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/libdbusmenu-gtk/reference/html/libdbusmenu-gtk-parser.html
1
 
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
 
<html>
3
 
<head>
4
 
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
 
<title>parser</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7
 
<link rel="home" href="index.html" title="libdbusmenu-gtk Reference Manual">
8
 
<link rel="up" href="ch01.html" title="API">
9
 
<link rel="prev" href="libdbusmenu-gtk-DbusmenuGtkClient.html" title="DbusmenuGtkClient">
10
 
<link rel="next" href="object-tree.html" title="Object Hierarchy">
11
 
<meta name="generator" content="GTK-Doc V1.17 (XML mode)">
12
 
<link rel="stylesheet" href="style.css" type="text/css">
13
 
</head>
14
 
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15
 
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
16
 
<tr valign="middle">
17
 
<td><a accesskey="p" href="libdbusmenu-gtk-DbusmenuGtkClient.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18
 
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19
 
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20
 
<th width="100%" align="center">libdbusmenu-gtk Reference Manual</th>
21
 
<td><a accesskey="n" href="object-tree.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
22
 
</tr>
23
 
<tr><td colspan="5" class="shortcuts">
24
 
<a href="#libdbusmenu-gtk-parser.synopsis" class="shortcut">Top</a>
25
 
                   | 
26
 
                  <a href="#libdbusmenu-gtk-parser.description" class="shortcut">Description</a>
27
 
</td></tr>
28
 
</table>
29
 
<div class="refentry">
30
 
<a name="libdbusmenu-gtk-parser"></a><div class="titlepage"></div>
31
 
<div class="refnamediv"><table width="100%"><tr>
32
 
<td valign="top">
33
 
<h2><span class="refentrytitle"><a name="libdbusmenu-gtk-parser.top_of_page"></a>parser</span></h2>
34
 
<p>parser — A parser of in-memory GTK menu trees</p>
35
 
</td>
36
 
<td valign="top" align="right"></td>
37
 
</tr></table></div>
38
 
<div class="refsect1">
39
 
<a name="libdbusmenu-gtk-parser.stability-level"></a><h2>Stability Level</h2>
40
 
Unstable, unless otherwise indicated
41
 
</div>
42
 
<div class="refsynopsisdiv">
43
 
<a name="libdbusmenu-gtk-parser.synopsis"></a><h2>Synopsis</h2>
44
 
<pre class="synopsis">
45
 
#include &lt;libdbusmenu-gtk/parser.h&gt;
46
 
 
47
 
<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://library.gnome.org/devel/gtk/GtkWidget.html"><span class="type">GtkWidget</span></a> *widget</code></em>);
48
 
<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://library.gnome.org/devel/gtk/GtkWidget.html"><span class="type">GtkWidget</span></a> *widget</code></em>);
49
 
</pre>
50
 
</div>
51
 
<div class="refsect1">
52
 
<a name="libdbusmenu-gtk-parser.description"></a><h2>Description</h2>
53
 
<p>
54
 
The parser will take a GTK menu tree and attach it to a Dbusmenu menu
55
 
        tree.  Along with setting up all the signals for updates and destruction.
56
 
        The returned item would be the root item of the given tree.
57
 
</p>
58
 
</div>
59
 
<div class="refsect1">
60
 
<a name="libdbusmenu-gtk-parser.details"></a><h2>Details</h2>
61
 
<div class="refsect2">
62
 
<a name="dbusmenu-gtk-parse-menu-structure"></a><h3>dbusmenu_gtk_parse_menu_structure ()</h3>
63
 
<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://library.gnome.org/devel/gtk/GtkWidget.html"><span class="type">GtkWidget</span></a> *widget</code></em>);</pre>
64
 
<p>
65
 
Goes through the GTK structures and turns them into the appropraite
66
 
Dbusmenu structures along with setting up all the relationships
67
 
between the objects.  It also stores the dbusmenu items as a cache
68
 
on the GTK items so that they'll be reused if necissary.
69
 
</p>
70
 
<div class="variablelist"><table border="0">
71
 
<col align="left" valign="top">
72
 
<tbody>
73
 
<tr>
74
 
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
75
 
<td>A <a href="http://library.gnome.org/devel/gtk/GtkMenuItem.html"><span class="type">GtkMenuItem</span></a> or <a href="http://library.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>
76
 
</td>
77
 
</tr>
78
 
<tr>
79
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
80
 
<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>
81
 
</td>
82
 
</tr>
83
 
</tbody>
84
 
</table></div>
85
 
</div>
86
 
<hr>
87
 
<div class="refsect2">
88
 
<a name="dbusmenu-gtk-parse-get-cached-item"></a><h3>dbusmenu_gtk_parse_get_cached_item ()</h3>
89
 
<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://library.gnome.org/devel/gtk/GtkWidget.html"><span class="type">GtkWidget</span></a> *widget</code></em>);</pre>
90
 
<p>
91
 
The Dbusmenu GTK parser adds cached items on the various
92
 
menu items throughout the tree.  Sometimes it can be useful
93
 
to get that cached item to use directly.  This function
94
 
will retrieve it for you.
95
 
</p>
96
 
<div class="variablelist"><table border="0">
97
 
<col align="left" valign="top">
98
 
<tbody>
99
 
<tr>
100
 
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
101
 
<td>A <a href="http://library.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>
102
 
</tr>
103
 
<tr>
104
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
105
 
<td>A pointer to the cached item
106
 
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>
107
 
</td>
108
 
</tr>
109
 
</tbody>
110
 
</table></div>
111
 
</div>
112
 
</div>
113
 
</div>
114
 
<div class="footer">
115
 
<hr>
116
 
          Generated by GTK-Doc V1.17</div>
117
 
</body>
118
 
</html>
 
 
b'\\ No newline at end of file'