/usr/share/gtk-doc/html/libdbusmenu-gtk/libdbusmenu-gtk-menuitem.html is in libdbusmenu-gtk-doc 12.10.3+16.04.20160223.1-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 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 | <!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: 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="libdbusmenu-gtk-DbusmenuGtkMenu.html" title="DbusmenuGtkMenu">
<link rel="next" href="libdbusmenu-gtk-DbusmenuGtkClient.html" title="DbusmenuGtkClient">
<meta name="generator" content="GTK-Doc V1.24 (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-menuitem.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="libdbusmenu-gtk-DbusmenuGtkMenu.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libdbusmenu-gtk-DbusmenuGtkClient.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<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 — Helpers for <span class="type">DbusmenuMenuitem</span> properties that require a GTK dependency</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libdbusmenu-gtk-menuitem.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-menuitem.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">gboolean</span>
</td>
<td class="function_name">
<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> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GdkPixbuf</span> *
</td>
<td class="function_name">
<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> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<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> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<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> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<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> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<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> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libdbusmenu-gtk-menuitem.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libdbusmenu-gtk/menuitem.h>
</pre>
</div>
<div class="refsect1">
<a name="libdbusmenu-gtk-menuitem.description"></a><h2>Description</h2>
<p>Some property helpers can't be done without picking up a GTK+
dependency. So those sit in libdbusmenu-gtk but have very similar
prototypes to the code in libdbusmenu-glib so your code will
look consistent, just with the extra depedency.</p>
</div>
<div class="refsect1">
<a name="libdbusmenu-gtk-menuitem.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="dbusmenu-menuitem-property-set-image"></a><h3>dbusmenu_menuitem_property_set_image ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
dbusmenu_menuitem_property_set_image (<em class="parameter"><code><span class="type">DbusmenuMenuitem</span> *menuitem</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *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 <span class="type">DbusmenuMenuitem</span> property.</p>
<div class="refsect3">
<a name="id-1.2.3.7.2.5"></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>menuitem</p></td>
<td class="parameter_description"><p>The <span class="type">DbusmenuMenuitem</span> to set the property on.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>property</p></td>
<td class="parameter_description"><p>Name of the property to set.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p>The image to place on the property.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.3.7.2.6"></a><h4>Returns</h4>
<p> Whether the function was able to set the property
or not.</p>
</div>
</div>
<hr>
<div class="refsect2">
<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><span class="type">DbusmenuMenuitem</span> *menuitem</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *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="refsect3">
<a name="id-1.2.3.7.3.5"></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>menuitem</p></td>
<td class="parameter_description"><p>The <span class="type">DbusmenuMenuitem</span> to look for the property on</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>property</p></td>
<td class="parameter_description"><p>The name of the property to look for.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.3.7.3.6"></a><h4>Returns</h4>
<p> A pixbuf or <span class="type">NULL</span> to signal error. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dbusmenu-menuitem-property-set-shortcut"></a><h3>dbusmenu_menuitem_property_set_shortcut ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
dbusmenu_menuitem_property_set_shortcut
(<em class="parameter"><code><span class="type">DbusmenuMenuitem</span> *menuitem</code></em>,
<em class="parameter"><code><span class="type">guint</span> key</code></em>,
<em class="parameter"><code><span class="type">GdkModifierType</span> 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="refsect3">
<a name="id-1.2.3.7.4.5"></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>menuitem</p></td>
<td class="parameter_description"><p>The <span class="type">DbusmenuMenuitem</span> to set the shortcut on</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>key</p></td>
<td class="parameter_description"><p>The keycode of the key to send</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>modifier</p></td>
<td class="parameter_description"><p>A bitmask of modifiers used to activate the item</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.3.7.4.6"></a><h4>Returns</h4>
<p> Whether it was successful at setting the property.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dbusmenu-menuitem-property-set-shortcut-string"></a><h3>dbusmenu_menuitem_property_set_shortcut_string ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
dbusmenu_menuitem_property_set_shortcut_string
(<em class="parameter"><code><span class="type">DbusmenuMenuitem</span> *menuitem</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *shortcut</code></em>);</pre>
<p>This function takes a GTK shortcut string as defined in
<span class="type">gtk_accelerator_parse</span> and turns that into the information
required to send it over DBusmenu.</p>
<div class="refsect3">
<a name="id-1.2.3.7.5.5"></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>menuitem</p></td>
<td class="parameter_description"><p>The <span class="type">DbusmenuMenuitem</span> to set the shortcut on</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>shortcut</p></td>
<td class="parameter_description"><p>String describing the shortcut</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.3.7.5.6"></a><h4>Returns</h4>
<p> Whether it was successful at setting the property.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dbusmenu-menuitem-property-set-shortcut-menuitem"></a><h3>dbusmenu_menuitem_property_set_shortcut_menuitem ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
dbusmenu_menuitem_property_set_shortcut_menuitem
(<em class="parameter"><code><span class="type">DbusmenuMenuitem</span> *menuitem</code></em>,
<em class="parameter"><code>const <span class="type">GtkMenuItem</span> *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="refsect3">
<a name="id-1.2.3.7.6.5"></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>menuitem</p></td>
<td class="parameter_description"><p>The <span class="type">DbusmenuMenuitem</span> to set the shortcut on</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>gmi</p></td>
<td class="parameter_description"><p>A menu item to steal the shortcut off of</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.3.7.6.6"></a><h4>Returns</h4>
<p> Whether it was successful at setting the property.</p>
</div>
</div>
<hr>
<div class="refsect2">
<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><span class="type">DbusmenuMenuitem</span> *menuitem</code></em>,
<em class="parameter"><code><span class="type">guint</span> *key</code></em>,
<em class="parameter"><code><span class="type">GdkModifierType</span> *modifier</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="refsect3">
<a name="id-1.2.3.7.7.5"></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>menuitem</p></td>
<td class="parameter_description"><p>The <span class="type">DbusmenuMenuitem</span> to get the shortcut off</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>key</p></td>
<td class="parameter_description"><p> Location to put the key value. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>modifier</p></td>
<td class="parameter_description"><p> Location to put the modifier mask. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="libdbusmenu-gtk-menuitem.other_details"></a><h2>Types and Values</h2>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>
|