/usr/share/gtk-doc/html/garcon/GarconMenu.html is in libgarcon-1-0-dev 0.4.0-2.
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 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GarconMenu</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="garcon Reference Manual">
<link rel="up" href="garcon-menus.html" title="Part II. Menus and Menu Items">
<link rel="prev" href="garcon-menus.html" title="Part II. Menus and Menu Items">
<link rel="next" href="GarconMenuDirectory.html" title="GarconMenuDirectory">
<meta name="generator" content="GTK-Doc V1.21 (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="#GarconMenu.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#GarconMenu.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#GarconMenu.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span>
<a href="#GarconMenu.signals" class="shortcut">Signals</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="garcon-menus.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="garcon-menus.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GarconMenuDirectory.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry" lang="en">
<a name="GarconMenu"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GarconMenu.top_of_page"></a>GarconMenu</span></h2>
<p>GarconMenu — Menu element.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1" lang="en">
<a name="GarconMenu.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a href="GarconMenu.html" title="GarconMenu"><span class="returnvalue">GarconMenu</span></a> *
</td>
<td class="function_name">
<a href="GarconMenu.html#garcon-menu-new" title="garcon_menu_new ()">garcon_menu_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="GarconMenu.html" title="GarconMenu"><span class="returnvalue">GarconMenu</span></a> *
</td>
<td class="function_name">
<a href="GarconMenu.html#garcon-menu-new-for-path" title="garcon_menu_new_for_path ()">garcon_menu_new_for_path</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="GarconMenu.html" title="GarconMenu"><span class="returnvalue">GarconMenu</span></a> *
</td>
<td class="function_name">
<a href="GarconMenu.html#garcon-menu-new-applications" title="garcon_menu_new_applications ()">garcon_menu_new_applications</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a href="GarconMenu.html#garcon-menu-load" title="garcon_menu_load ()">garcon_menu_load</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="https://developer.gnome.org/gio/unstable/GFile.html"><span class="returnvalue">GFile</span></a> *
</td>
<td class="function_name">
<a href="GarconMenu.html#garcon-menu-get-file" title="garcon_menu_get_file ()">garcon_menu_get_file</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="GarconMenuDirectory.html" title="GarconMenuDirectory"><span class="returnvalue">GarconMenuDirectory</span></a> *
</td>
<td class="function_name">
<a href="GarconMenu.html#garcon-menu-get-directory" title="garcon_menu_get_directory ()">garcon_menu_get_directory</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="https://developer.gnome.org/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
</td>
<td class="function_name">
<a href="GarconMenu.html#garcon-menu-get-menus" title="garcon_menu_get_menus ()">garcon_menu_get_menus</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a href="GarconMenu.html#garcon-menu-add-menu" title="garcon_menu_add_menu ()">garcon_menu_add_menu</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="GarconMenu.html" title="GarconMenu"><span class="returnvalue">GarconMenu</span></a> *
</td>
<td class="function_name">
<a href="GarconMenu.html#garcon-menu-get-menu-with-name" title="garcon_menu_get_menu_with_name ()">garcon_menu_get_menu_with_name</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="GarconMenu.html" title="GarconMenu"><span class="returnvalue">GarconMenu</span></a> *
</td>
<td class="function_name">
<a href="GarconMenu.html#garcon-menu-get-parent" title="garcon_menu_get_parent ()">garcon_menu_get_parent</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="garcon-garcon-menu-item-pool.html#GarconMenuItemPool"><span class="returnvalue">GarconMenuItemPool</span></a> *
</td>
<td class="function_name">
<a href="GarconMenu.html#garcon-menu-get-item-pool" title="garcon_menu_get_item_pool ()">garcon_menu_get_item_pool</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="https://developer.gnome.org/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
</td>
<td class="function_name">
<a href="GarconMenu.html#garcon-menu-get-items" title="garcon_menu_get_items ()">garcon_menu_get_items</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="https://developer.gnome.org/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
</td>
<td class="function_name">
<a href="GarconMenu.html#garcon-menu-get-elements" title="garcon_menu_get_elements ()">garcon_menu_get_elements</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1" lang="en">
<a name="GarconMenu.properties"></a><h2>Properties</h2>
<div class="informaltable"><table border="0">
<colgroup>
<col>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="property_type">
<a href="GarconMenuDirectory.html" title="GarconMenuDirectory"><span class="type">GarconMenuDirectory</span></a> *</td>
<td class="property_name"><a href="GarconMenu.html#GarconMenu--directory" title="The “directory” property">directory</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a href="https://developer.gnome.org/gio/unstable/GFile.html"><span class="type">GFile</span></a> *</td>
<td class="property_name"><a href="GarconMenu.html#GarconMenu--file" title="The “file” property">file</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1" lang="en">
<a name="GarconMenu.signals"></a><h2>Signals</h2>
<div class="informaltable"><table border="0">
<colgroup>
<col>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a href="GarconMenu.html#GarconMenu-directory-changed" title="The “directory-changed” signal">directory-changed</a></td>
<td class="signal_flags">No Hooks</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a href="GarconMenu.html#GarconMenu-reload-required" title="The “reload-required” signal">reload-required</a></td>
<td class="signal_flags">No Hooks</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1" lang="en">
<a name="GarconMenu.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
<span class="lineart">╰──</span> GarconMenu
</pre>
</div>
<div class="refsect1" lang="en">
<a name="GarconMenu.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <garcon/garcon.h>
</pre>
</div>
<div class="refsect1" lang="en">
<a name="GarconMenu.description"></a><h2>Description</h2>
<p>Main element the contains the parsed menu.</p>
</div>
<div class="refsect1" lang="en">
<a name="GarconMenu.functions_details"></a><h2>Functions</h2>
<div class="refsect2" lang="en">
<a name="garcon-menu-new"></a><h3>garcon_menu_new ()</h3>
<pre class="programlisting"><a href="GarconMenu.html" title="GarconMenu"><span class="returnvalue">GarconMenu</span></a> *
garcon_menu_new (<em class="parameter"><code><a href="https://developer.gnome.org/gio/unstable/GFile.html"><span class="type">GFile</span></a> *file</code></em>);</pre>
<p>Creates a new <a href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a> for the .menu file referred to by <em class="parameter"><code>file</code></em>
.
This operation only fails <em class="parameter"><code>file</code></em>
is invalid. To load the menu
tree from the file, you need to call <a href="GarconMenu.html#garcon-menu-load" title="garcon_menu_load ()"><code class="function">garcon_menu_load()</code></a> with the
returned <a href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a>.</p>
<p>The caller is responsible to destroy the returned <a href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a>
using <a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>.</p>
<p>For more information about the usage <em class="parameter"><code>see</code></em>
<a href="GarconMenu.html#garcon-menu-new" title="garcon_menu_new ()"><code class="function">garcon_menu_new()</code></a>.</p>
<div class="refsect3" lang="en">
<a name="idp554586224"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col>
<col>
<col>
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>file</p></td>
<td class="parameter_description"><p><a href="https://developer.gnome.org/gio/unstable/GFile.html"><span class="type">GFile</span></a> for the .menu file you want to load.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3" lang="en">
<a name="idp554557936"></a><h4>Returns</h4>
<p> a new <a href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a> for <em class="parameter"><code>file</code></em>
.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="garcon-menu-new-for-path"></a><h3>garcon_menu_new_for_path ()</h3>
<pre class="programlisting"><a href="GarconMenu.html" title="GarconMenu"><span class="returnvalue">GarconMenu</span></a> *
garcon_menu_new_for_path (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>);</pre>
<p>Creates a new <a href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a> for the .menu file referred to by <em class="parameter"><code>filename</code></em>
.
This operation only fails if the filename is NULL. To load the menu
tree from the file, you need to call <a href="GarconMenu.html#garcon-menu-load" title="garcon_menu_load ()"><code class="function">garcon_menu_load()</code></a> with the
returned <a href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a>.</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3
4
5
6
7
8</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="usertype">GarconMenu</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">menu </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="GarconMenu.html#garcon-menu-new">garcon_menu_new</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">filename</span><span class="symbol">);</span>
<span class="keyword">if</span><span class="normal"> </span><span class="symbol">(</span><span class="function"><a href="GarconMenu.html#garcon-menu-load">garcon_menu_load</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">menu</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">&</span><span class="normal">error</span><span class="symbol">))</span>
<span class="normal"> </span><span class="symbol">...</span>
<span class="keyword">else</span>
<span class="normal"> </span><span class="symbol">...</span>
<span class="function"><a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref">g_object_unref</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">menu</span><span class="symbol">);</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p>The caller is responsible to destroy the returned <a href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a>
using <a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>.</p>
<div class="refsect3" lang="en">
<a name="idp554545392"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col>
<col>
<col>
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>filename</p></td>
<td class="parameter_description"><p>Path/URI of the .menu file you want to load.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3" lang="en">
<a name="idp554546032"></a><h4>Returns</h4>
<p> a new <a href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a> for <em class="parameter"><code>filename</code></em>
.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="garcon-menu-new-applications"></a><h3>garcon_menu_new_applications ()</h3>
<pre class="programlisting"><a href="GarconMenu.html" title="GarconMenu"><span class="returnvalue">GarconMenu</span></a> *
garcon_menu_new_applications (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates a new <a href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a> for the applications.menu file
which is being used to display installed applications.</p>
<p>For more information about the usage <em class="parameter"><code>see</code></em>
<a href="GarconMenu.html#garcon-menu-new" title="garcon_menu_new ()"><code class="function">garcon_menu_new()</code></a>.</p>
<div class="refsect3" lang="en">
<a name="idp554537072"></a><h4>Returns</h4>
<p> a new <a href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a> for applications.menu.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="garcon-menu-load"></a><h3>garcon_menu_load ()</h3>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
garcon_menu_load (<em class="parameter"><code><a href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a> *menu</code></em>,
<em class="parameter"><code><a href="https://developer.gnome.org/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>This function loads the entire menu tree from the file referred to
by <em class="parameter"><code>menu</code></em>
. It resolves merges, moves and everything else defined
in the menu specification. The resulting tree information is
stored within <em class="parameter"><code>menu</code></em>
and can be accessed using the public <a href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a>
API afterwards.</p>
<p><em class="parameter"><code>cancellable</code></em>
can be used to handle blocking I/O when reading data
from files during the loading process.</p>
<p><em class="parameter"><code>error</code></em>
should either be NULL or point to a <a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> return location
where errors should be stored in.</p>
<div class="refsect3" lang="en">
<a name="idp554521584"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>menu</p></td>
<td class="parameter_description"><p>a <a href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p>a <a href="https://developer.gnome.org/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p><a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> return location</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3" lang="en">
<a name="idp554493040"></a><h4>Returns</h4>
<p> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the menu was loaded successfully or
<a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if there was an error or the process was
cancelled.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="garcon-menu-get-file"></a><h3>garcon_menu_get_file ()</h3>
<pre class="programlisting"><a href="https://developer.gnome.org/gio/unstable/GFile.html"><span class="returnvalue">GFile</span></a> *
garcon_menu_get_file (<em class="parameter"><code><a href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a> *menu</code></em>);</pre>
<p>Get the file for <em class="parameter"><code>menu</code></em>
. It refers to the .menu file from which
<em class="parameter"><code>menu</code></em>
was or will be loaded.</p>
<div class="refsect3" lang="en">
<a name="idp554490352"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col>
<col>
<col>
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>menu</p></td>
<td class="parameter_description"><p>a <a href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3" lang="en">
<a name="idp554478960"></a><h4>Returns</h4>
<p> a <a href="https://developer.gnome.org/gio/unstable/GFile.html"><span class="type">GFile</span></a>. The returned object
should be unreffed with <a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when no longer needed.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="garcon-menu-get-directory"></a><h3>garcon_menu_get_directory ()</h3>
<pre class="programlisting"><a href="GarconMenuDirectory.html" title="GarconMenuDirectory"><span class="returnvalue">GarconMenuDirectory</span></a> *
garcon_menu_get_directory (<em class="parameter"><code><a href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a> *menu</code></em>);</pre>
<p>Returns the <a href="GarconMenuDirectory.html" title="GarconMenuDirectory"><span class="type">GarconMenuDirectory</span></a> of <em class="parameter"><code>menu</code></em>
or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the <Menu>
element that corresponds to <em class="parameter"><code>menu</code></em>
has no valid <Directory> element.
The menu directory may contain a lot of useful information about
the menu like the display and icon name, desktop environments it
should show up in etc.</p>
<div class="refsect3" lang="en">
<a name="idp554477808"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col>
<col>
<col>
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>menu</p></td>
<td class="parameter_description"><p>a <a href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3" lang="en">
<a name="idp554458224"></a><h4>Returns</h4>
<p> <a href="GarconMenuDirectory.html" title="GarconMenuDirectory"><span class="type">GarconMenuDirectory</span></a> of <em class="parameter"><code>menu</code></em>
or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if
<em class="parameter"><code>menu</code></em>
has no valid directory element. The returned object
should be unreffed with <a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when no longer needed.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="garcon-menu-get-menus"></a><h3>garcon_menu_get_menus ()</h3>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
garcon_menu_get_menus (<em class="parameter"><code><a href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a> *menu</code></em>);</pre>
<p>Returns a sorted list of <a href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a> submenus of <em class="parameter"><code>menu</code></em>
.</p>
<div class="refsect3" lang="en">
<a name="idp554446320"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col>
<col>
<col>
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>menu</p></td>
<td class="parameter_description"><p>a <a href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3" lang="en">
<a name="idp554432368"></a><h4>Returns</h4>
<p> a sorted list of <a href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a> object. The list should
be freed with <a href="https://developer.gnome.org/glib/unstable/glib-Doubly-Linked-Lists.html#g-list-free"><code class="function">g_list_free()</code></a>.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="garcon-menu-add-menu"></a><h3>garcon_menu_add_menu ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
garcon_menu_add_menu (<em class="parameter"><code><a href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a> *menu</code></em>,
<em class="parameter"><code><a href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a> *submenu</code></em>);</pre>
<p>Adds <em class="parameter"><code>submenu</code></em>
as a sub menu to <em class="parameter"><code>menu</code></em>
.</p>
<div class="refsect3" lang="en">
<a name="idp554428528"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>menu</p></td>
<td class="parameter_description"><p>a <a href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>submenu</p></td>
<td class="parameter_description"><p>a <a href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="garcon-menu-get-menu-with-name"></a><h3>garcon_menu_get_menu_with_name ()</h3>
<pre class="programlisting"><a href="GarconMenu.html" title="GarconMenu"><span class="returnvalue">GarconMenu</span></a> *
garcon_menu_get_menu_with_name (<em class="parameter"><code><a href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a> *menu</code></em>,
<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
<p>Looks in <em class="parameter"><code>menu</code></em>
for a submenu with <em class="parameter"><code>name</code></em>
as name.</p>
<div class="refsect3" lang="en">
<a name="idp554414576"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>menu</p></td>
<td class="parameter_description"><p>a <a href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>a sub menu name</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3" lang="en">
<a name="idm2010170128"></a><h4>Returns</h4>
<p> a <a href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a> or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="garcon-menu-get-parent"></a><h3>garcon_menu_get_parent ()</h3>
<pre class="programlisting"><a href="GarconMenu.html" title="GarconMenu"><span class="returnvalue">GarconMenu</span></a> *
garcon_menu_get_parent (<em class="parameter"><code><a href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a> *menu</code></em>);</pre>
<p>Returns the parent <a href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a> or <em class="parameter"><code>menu</code></em>
.</p>
<div class="refsect3" lang="en">
<a name="idm3395983760"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col>
<col>
<col>
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>menu</p></td>
<td class="parameter_description"><p>a <a href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3" lang="en">
<a name="idm2065489296"></a><h4>Returns</h4>
<p> a <a href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a> or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if <em class="parameter"><code>menu</code></em>
is the root menu.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="garcon-menu-get-item-pool"></a><h3>garcon_menu_get_item_pool ()</h3>
<pre class="programlisting"><a href="garcon-garcon-menu-item-pool.html#GarconMenuItemPool"><span class="returnvalue">GarconMenuItemPool</span></a> *
garcon_menu_get_item_pool (<em class="parameter"><code><a href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a> *menu</code></em>);</pre>
<p>Get the item pool of the menu. This pool contains all items in this
menu (for that of its submenus).</p>
<div class="refsect3" lang="en">
<a name="idm1297319952"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col>
<col>
<col>
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>menu</p></td>
<td class="parameter_description"><p>a <a href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3" lang="en">
<a name="idp643786480"></a><h4>Returns</h4>
<p> a <a href="garcon-garcon-menu-item-pool.html#GarconMenuItemPool"><span class="type">GarconMenuItemPool</span></a>.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="garcon-menu-get-items"></a><h3>garcon_menu_get_items ()</h3>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
garcon_menu_get_items (<em class="parameter"><code><a href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a> *menu</code></em>);</pre>
<p>Returns all <a href="GarconMenuItem.html" title="GarconMenuItem"><span class="type">GarconMenuItem</span></a>s included in <em class="parameter"><code>menu</code></em>
. The items are
sorted by their display names in ascending order.</p>
<p>The caller is responsible to free the returned list using</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="function"><a href="https://developer.gnome.org/glib/unstable/glib-Doubly-Linked-Lists.html#g-list-free">g_list_free</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">list</span><span class="symbol">);</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p>when no longer needed.</p>
<div class="refsect3" lang="en">
<a name="idm525417104"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col>
<col>
<col>
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>menu</p></td>
<td class="parameter_description"><p>a <a href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3" lang="en">
<a name="idm1348912400"></a><h4>Returns</h4>
<p> list of <a href="GarconMenuItem.html" title="GarconMenuItem"><span class="type">GarconMenuItem</span></a>s included in <em class="parameter"><code>menu</code></em>
.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="garcon-menu-get-elements"></a><h3>garcon_menu_get_elements ()</h3>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
garcon_menu_get_elements (<em class="parameter"><code><a href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a> *menu</code></em>);</pre>
<p>Get all the menu element in <em class="parameter"><code>menu</code></em>
. This contains sub menus, menu items
and separators.</p>
<div class="refsect3" lang="en">
<a name="idm2307989392"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col>
<col>
<col>
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>menu</p></td>
<td class="parameter_description"><p>a <a href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3" lang="en">
<a name="idm2307988368"></a><h4>Returns</h4>
<p> a list of <a href="GarconMenuItem.html" title="GarconMenuItem"><span class="type">GarconMenuItem</span></a> elements or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. Free the list
with <a href="https://developer.gnome.org/glib/unstable/glib-Doubly-Linked-Lists.html#g-list-free"><code class="function">g_list_free()</code></a>.</p>
<p></p>
</div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="GarconMenu.other_details"></a><h2>Types and Values</h2>
</div>
<div class="refsect1" lang="en">
<a name="GarconMenu.property-details"></a><h2>Property Details</h2>
<div class="refsect2" lang="en">
<a name="GarconMenu--directory"></a><h3>The <code class="literal">“directory”</code> property</h3>
<pre class="programlisting"> “directory” <a href="GarconMenuDirectory.html" title="GarconMenuDirectory"><span class="type">GarconMenuDirectory</span></a> *</pre>
<p>Directory entry associated with this menu.</p>
<p>Flags: Read / Write</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="GarconMenu--file"></a><h3>The <code class="literal">“file”</code> property</h3>
<pre class="programlisting"> “file” <a href="https://developer.gnome.org/gio/unstable/GFile.html"><span class="type">GFile</span></a> *</pre>
<p>file.</p>
<p>Flags: Read / Write / Construct Only</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="GarconMenu.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2" lang="en">
<a name="GarconMenu-directory-changed"></a><h3>The <code class="literal">“directory-changed”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a> *garconmenu,
<a href="GarconMenuDirectory.html" title="GarconMenuDirectory"><span class="type">GarconMenuDirectory</span></a> *arg1,
<a href="GarconMenuDirectory.html" title="GarconMenuDirectory"><span class="type">GarconMenuDirectory</span></a> *arg2,
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>Flags: No Hooks</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="GarconMenu-reload-required"></a><h3>The <code class="literal">“reload-required”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a> *garconmenu,
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>Flags: No Hooks</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.21</div>
</body>
</html>
|