/usr/share/gtk-doc/html/libdbusmenu-gtk/libdbusmenu-gtk-DbusmenuGtkMenu.html is in libdbusmenu-gtk-doc 16.04.1+18.04.20171206-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 | <!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: libdbusmenu-gtk Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<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-menuitem.html" title="menuitem">
<meta name="generator" content="GTK-Doc V1.25 (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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#libdbusmenu-gtk-DbusmenuGtkMenu.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ch01.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libdbusmenu-gtk-menuitem.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<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 — A GTK Menu Object that syncronizes over DBus</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libdbusmenu-gtk-DbusmenuGtkMenu.stability-level"></a><h2>Stability Level</h2>
<acronym title="Unstable interfaces are experimental or transitional. They are typically used to
give outside developers early access to new or rapidly changing technology, or
to provide an interim solution to a problem where a more general solution is
anticipated. No claims are made about either source or binary compatibility from
one minor release to the next.
The Unstable interface level is a warning that these interfaces are subject to
change without warning and should not be used in unbundled products.
Given such caveats, customer impact need not be a factor when considering
incompatible changes to an Unstable interface in a major or minor release.
Nonetheless, when such changes are introduced, the changes should still be
mentioned in the release notes for the affected release.
"><span class="acronym">Unstable</span></acronym>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="libdbusmenu-gtk-DbusmenuGtkMenu.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">DbusmenuGtkMenu</span> *
</td>
<td class="function_name">
<a class="link" href="libdbusmenu-gtk-DbusmenuGtkMenu.html#dbusmenu-gtkmenu-new" title="dbusmenu_gtkmenu_new ()">dbusmenu_gtkmenu_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="libdbusmenu-gtk-DbusmenuGtkClient.html#DbusmenuGtkClient" title="struct DbusmenuGtkClient"><span class="returnvalue">DbusmenuGtkClient</span></a> *
</td>
<td class="function_name">
<a class="link" href="libdbusmenu-gtk-DbusmenuGtkMenu.html#dbusmenu-gtkmenu-get-client" title="dbusmenu_gtkmenu_get_client ()">dbusmenu_gtkmenu_get_client</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libdbusmenu-gtk-DbusmenuGtkMenu.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="libdbusmenu-gtk-DbusmenuGtkMenu.html#DbusmenuGtkMenuClass" title="struct DbusmenuGtkMenuClass">DbusmenuGtkMenuClass</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libdbusmenu-gtk-DbusmenuGtkMenu.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libdbusmenu-gtk/menu.h>
</pre>
</div>
<div class="refsect1">
<a name="libdbusmenu-gtk-DbusmenuGtkMenu.description"></a><h2>Description</h2>
<p>In general, this is just a <span class="type">GtkMenu</span>, why else would you care? Oh,
because this menu is created by someone else on a server that exists
on the other side of DBus. You need a <span class="type">DbusmenuServer</span> to be able
push the data into this menu.</p>
<p> The first thing you need to know is how to find that <span class="type">DbusmenuServer</span>
on DBus. This involves both the DBus name and the DBus object that
the menu interface can be found on. Those two value should be set
when creating the object using <a class="link" href="libdbusmenu-gtk-DbusmenuGtkMenu.html#dbusmenu-gtkmenu-new" title="dbusmenu_gtkmenu_new ()"><code class="function">dbusmenu_gtkmenu_new()</code></a>. They are then
stored on two properties <span class="type">“dbus-name”</span> and <span class="type">“dbus-object”</span>.</p>
<p> After creation the <span class="type">DbusmenuGtkMenu</span> it will continue to keep in
synchronization with the <span class="type">DbusmenuServer</span> object across Dbus. If the
number of entries change, the menus change, if they change thier
properties change, they update in the items. All of this should
be handled transparently to the user of this object.</p>
</div>
<div class="refsect1">
<a name="libdbusmenu-gtk-DbusmenuGtkMenu.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<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><span class="type">gchar</span> *dbus_name</code></em>,
<em class="parameter"><code><span class="type">gchar</span> *dbus_object</code></em>);</pre>
<p>Creates a new <span class="type">DbusmenuGtkMenu</span> object and creates a <span class="type">DbusmenuClient</span>
that connects across DBus to a <span class="type">DbusmenuServer</span>.</p>
<div class="refsect3">
<a name="dbusmenu-gtkmenu-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>dbus_name</p></td>
<td class="parameter_description"><p>Name of the <span class="type">DbusmenuServer</span> on DBus</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>dbus_object</p></td>
<td class="parameter_description"><p>Name of the object on the <span class="type">DbusmenuServer</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="dbusmenu-gtkmenu-new.returns"></a><h4>Returns</h4>
<p> A new <span class="type">DbusmenuGtkMenu</span> sync'd with a server</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dbusmenu-gtkmenu-get-client"></a><h3>dbusmenu_gtkmenu_get_client ()</h3>
<pre class="programlisting"><a class="link" href="libdbusmenu-gtk-DbusmenuGtkClient.html#DbusmenuGtkClient" title="struct DbusmenuGtkClient"><span class="returnvalue">DbusmenuGtkClient</span></a> *
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="refsect3">
<a name="dbusmenu-gtkmenu-get-client.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>menu</p></td>
<td class="parameter_description"><p>The <span class="type">DbusmenuGtkMenu</span> to get the client from</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="dbusmenu-gtkmenu-get-client.returns"></a><h4>Returns</h4>
<p> A valid <a class="link" href="libdbusmenu-gtk-DbusmenuGtkClient.html#DbusmenuGtkClient" title="struct DbusmenuGtkClient"><span class="type">DbusmenuGtkClient</span></a> or NULL on error. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="libdbusmenu-gtk-DbusmenuGtkMenu.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="DbusmenuGtkMenuClass"></a><h3>struct DbusmenuGtkMenuClass</h3>
<pre class="programlisting">struct DbusmenuGtkMenuClass {
GtkMenuClass parent_class;
/*< Private >*/
void (*reserved1) (void);
void (*reserved2) (void);
void (*reserved3) (void);
void (*reserved4) (void);
void (*reserved5) (void);
void (*reserved6) (void);
};
</pre>
<p>All of the subclassable functions and signal slots for a
<span class="type">DbusmenuGtkMenu</span>.</p>
<div class="refsect3">
<a name="DbusmenuGtkMenuClass.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="DbusmenuGtkMenuClass.reserved1"></a>reserved1</code></em> ()</p></td>
<td class="struct_member_description"><p>Reserved for future use.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="DbusmenuGtkMenuClass.reserved2"></a>reserved2</code></em> ()</p></td>
<td class="struct_member_description"><p>Reserved for future use.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="DbusmenuGtkMenuClass.reserved3"></a>reserved3</code></em> ()</p></td>
<td class="struct_member_description"><p>Reserved for future use.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="DbusmenuGtkMenuClass.reserved4"></a>reserved4</code></em> ()</p></td>
<td class="struct_member_description"><p>Reserved for future use.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="DbusmenuGtkMenuClass.reserved5"></a>reserved5</code></em> ()</p></td>
<td class="struct_member_description"><p>Reserved for future use.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="DbusmenuGtkMenuClass.reserved6"></a>reserved6</code></em> ()</p></td>
<td class="struct_member_description"><p>Reserved for future use.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>
|