Debian Codegraph @

docs/reference/html/GarconMenu.html

raw
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>GarconMenu: garcon Reference Manual</title>
6 <meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
7 <link rel="home" href="index.html" title="garcon Reference Manual">
8 <link rel="up" href="garcon-menus.html" title="Part II. Menus and Menu Items">
9 <link rel="prev" href="garcon-menus.html" title="Part II. Menus and Menu Items">
10 <link rel="next" href="GarconMenuDirectory.html" title="GarconMenuDirectory">
11 <meta name="generator" content="GTK-Doc V1.34.0 (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="5"><tr valign="middle">
16 <td width="100%" align="left" class="shortcuts">
17 <a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
18 <a href="#GarconMenu.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
19 <a href="#GarconMenu.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span> 
20 <a href="#GarconMenu.properties" class="shortcut">Properties</a></span><span id="nav_signals">  <span class="dim">|</span> 
21 <a href="#GarconMenu.signals" class="shortcut">Signals</a></span>
22 </td>
23 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
24 <td><a accesskey="u" href="garcon-menus.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
25 <td><a accesskey="p" href="garcon-menus.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
26 <td><a accesskey="n" href="GarconMenuDirectory.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
27 </tr></table>
28 <div class="refentry">
29 <a name="GarconMenu"></a><div class="titlepage"></div>
30 <div class="refnamediv"><table width="100%"><tr>
31 <td valign="top">
32 <h2><span class="refentrytitle"><a name="GarconMenu.top_of_page"></a>GarconMenu</span></h2>
33 <p>GarconMenu — Menu element.</p>
34 </td>
35 <td class="gallery_image" valign="top" align="right"></td>
36 </tr></table></div>
37 <div class="refsect1">
38 <a name="GarconMenu.functions"></a><h2>Functions</h2>
39 <div class="informaltable"><table class="informaltable" width="100%" border="0">
40 <colgroup>
41 <col width="150px" class="functions_proto_type">
42 <col class="functions_proto_name">
43 </colgroup>
44 <tbody>
45 <tr>
46 <td class="function_type">
47 <a class="link" href="GarconMenu.html" title="GarconMenu"><span class="returnvalue">GarconMenu</span></a> *
48 </td>
49 <td class="function_name">
50 <a class="link" href="GarconMenu.html#garcon-menu-new" title="garcon_menu_new ()">garcon_menu_new</a> <span class="c_punctuation">()</span>
51 </td>
52 </tr>
53 <tr>
54 <td class="function_type">
55 <a class="link" href="GarconMenu.html" title="GarconMenu"><span class="returnvalue">GarconMenu</span></a> *
56 </td>
57 <td class="function_name">
58 <a class="link" 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>
59 </td>
60 </tr>
61 <tr>
62 <td class="function_type">
63 <a class="link" href="GarconMenu.html" title="GarconMenu"><span class="returnvalue">GarconMenu</span></a> *
64 </td>
65 <td class="function_name">
66 <a class="link" href="GarconMenu.html#garcon-menu-new-applications" title="garcon_menu_new_applications ()">garcon_menu_new_applications</a> <span class="c_punctuation">()</span>
67 </td>
68 </tr>
69 <tr>
70 <td class="function_type">
71 <span class="returnvalue">gboolean</span>
72 </td>
73 <td class="function_name">
74 <a class="link" href="GarconMenu.html#garcon-menu-load" title="garcon_menu_load ()">garcon_menu_load</a> <span class="c_punctuation">()</span>
75 </td>
76 </tr>
77 <tr>
78 <td class="function_type">
79 <span class="returnvalue">GFile</span> *
80 </td>
81 <td class="function_name">
82 <a class="link" href="GarconMenu.html#garcon-menu-get-file" title="garcon_menu_get_file ()">garcon_menu_get_file</a> <span class="c_punctuation">()</span>
83 </td>
84 </tr>
85 <tr>
86 <td class="function_type">
87 <a class="link" href="GarconMenuDirectory.html" title="GarconMenuDirectory"><span class="returnvalue">GarconMenuDirectory</span></a> *
88 </td>
89 <td class="function_name">
90 <a class="link" href="GarconMenu.html#garcon-menu-get-directory" title="garcon_menu_get_directory ()">garcon_menu_get_directory</a> <span class="c_punctuation">()</span>
91 </td>
92 </tr>
93 <tr>
94 <td class="function_type">
95 <span class="returnvalue">GList</span> *
96 </td>
97 <td class="function_name">
98 <a class="link" href="GarconMenu.html#garcon-menu-get-menus" title="garcon_menu_get_menus ()">garcon_menu_get_menus</a> <span class="c_punctuation">()</span>
99 </td>
100 </tr>
101 <tr>
102 <td class="function_type">
103 <span class="returnvalue">void</span>
104 </td>
105 <td class="function_name">
106 <a class="link" href="GarconMenu.html#garcon-menu-add-menu" title="garcon_menu_add_menu ()">garcon_menu_add_menu</a> <span class="c_punctuation">()</span>
107 </td>
108 </tr>
109 <tr>
110 <td class="function_type">
111 <a class="link" href="GarconMenu.html" title="GarconMenu"><span class="returnvalue">GarconMenu</span></a> *
112 </td>
113 <td class="function_name">
114 <a class="link" 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>
115 </td>
116 </tr>
117 <tr>
118 <td class="function_type">
119 <a class="link" href="GarconMenu.html" title="GarconMenu"><span class="returnvalue">GarconMenu</span></a> *
120 </td>
121 <td class="function_name">
122 <a class="link" href="GarconMenu.html#garcon-menu-get-parent" title="garcon_menu_get_parent ()">garcon_menu_get_parent</a> <span class="c_punctuation">()</span>
123 </td>
124 </tr>
125 <tr>
126 <td class="function_type">
127 <a class="link" href="garcon-garcon-menu-item-pool.html#GarconMenuItemPool"><span class="returnvalue">GarconMenuItemPool</span></a> *
128 </td>
129 <td class="function_name">
130 <a class="link" 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>
131 </td>
132 </tr>
133 <tr>
134 <td class="function_type">
135 <span class="returnvalue">GList</span> *
136 </td>
137 <td class="function_name">
138 <a class="link" href="GarconMenu.html#garcon-menu-get-items" title="garcon_menu_get_items ()">garcon_menu_get_items</a> <span class="c_punctuation">()</span>
139 </td>
140 </tr>
141 <tr>
142 <td class="function_type">
143 <span class="returnvalue">GList</span> *
144 </td>
145 <td class="function_name">
146 <a class="link" href="GarconMenu.html#garcon-menu-get-elements" title="garcon_menu_get_elements ()">garcon_menu_get_elements</a> <span class="c_punctuation">()</span>
147 </td>
148 </tr>
149 </tbody>
150 </table></div>
151 </div>
152 <div class="refsect1">
153 <a name="GarconMenu.properties"></a><h2>Properties</h2>
154 <div class="informaltable"><table class="informaltable" border="0">
155 <colgroup>
156 <col width="150px" class="properties_type">
157 <col width="300px" class="properties_name">
158 <col width="200px" class="properties_flags">
159 </colgroup>
160 <tbody>
161 <tr>
162 <td class="property_type">
163 <a class="link" href="GarconMenuDirectory.html" title="GarconMenuDirectory"><span class="type">GarconMenuDirectory</span></a> *</td>
164 <td class="property_name"><a class="link" href="GarconMenu.html#GarconMenu--directory" title="The “directory” property">directory</a></td>
165 <td class="property_flags">Read / Write</td>
166 </tr>
167 <tr>
168 <td class="property_type">
169 <span class="type">GFile</span> *</td>
170 <td class="property_name"><a class="link" href="GarconMenu.html#GarconMenu--file" title="The “file” property">file</a></td>
171 <td class="property_flags">Read / Write / Construct Only</td>
172 </tr>
173 </tbody>
174 </table></div>
175 </div>
176 <div class="refsect1">
177 <a name="GarconMenu.signals"></a><h2>Signals</h2>
178 <div class="informaltable"><table class="informaltable" border="0">
179 <colgroup>
180 <col width="150px" class="signal_proto_type">
181 <col width="300px" class="signal_proto_name">
182 <col width="200px" class="signal_proto_flags">
183 </colgroup>
184 <tbody>
185 <tr>
186 <td class="signal_type"><span class="returnvalue">void</span></td>
187 <td class="signal_name"><a class="link" href="GarconMenu.html#GarconMenu-directory-changed" title="The “directory-changed” signal">directory-changed</a></td>
188 <td class="signal_flags">No Hooks</td>
189 </tr>
190 <tr>
191 <td class="signal_type"><span class="returnvalue">void</span></td>
192 <td class="signal_name"><a class="link" href="GarconMenu.html#GarconMenu-reload-required" title="The “reload-required” signal">reload-required</a></td>
193 <td class="signal_flags">No Hooks</td>
194 </tr>
195 </tbody>
196 </table></div>
197 </div>
198 <div class="refsect1">
199 <a name="GarconMenu.object-hierarchy"></a><h2>Object Hierarchy</h2>
200 <pre class="screen"> GObject
201 <span class="lineart">╰──</span> GarconMenu
202 </pre>
203 </div>
204 <div class="refsect1">
205 <a name="GarconMenu.includes"></a><h2>Includes</h2>
206 <pre class="synopsis">#include &lt;garcon/garcon.h&gt;
207 </pre>
208 </div>
209 <div class="refsect1">
210 <a name="GarconMenu.description"></a><h2>Description</h2>
211 <p>Main element the contains the parsed menu.</p>
212 </div>
213 <div class="refsect1">
214 <a name="GarconMenu.functions_details"></a><h2>Functions</h2>
215 <div class="refsect2">
216 <a name="garcon-menu-new"></a><h3>garcon_menu_new ()</h3>
217 <pre class="programlisting"><a class="link" href="GarconMenu.html" title="GarconMenu"><span class="returnvalue">GarconMenu</span></a> *
218 garcon_menu_new (<em class="parameter"><code><span class="type">GFile</span> *file</code></em>);</pre>
219 <p>Creates a new <a class="link" 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>
220 .
221 This operation only fails if <em class="parameter"><code>file</code></em>
222 is invalid. To load the menu
223 tree from the file, you need to call <a class="link" href="GarconMenu.html#garcon-menu-load" title="garcon_menu_load ()"><code class="function">garcon_menu_load()</code></a> with the
224 returned <a class="link" href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a>.</p>
225 <div class="informalexample">
226 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
227 <tbody>
228 <tr>
229 <td class="listing_lines" align="right"><pre>1
230 2
231 3
232 4
233 5
234 6
235 7
236 8</pre></td>
237 <td class="listing_code"><pre class="programlisting"><span class="n">GarconMenu</span><span class="w"> </span><span class="o">*</span><span class="n">menu</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">garcon_menu_new</span><span class="w"> </span><span class="p">(</span><span class="n">filename</span><span class="p">);</span>
238
239 <span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">garcon_menu_load</span><span class="w"> </span><span class="p">(</span><span class="n">menu</span><span class="p">,</span><span class="w"> </span><span class="o">&amp;</span><span class="n">error</span><span class="p">))</span>
240 <span class="w"> </span><span class="p">...</span>
241 <span class="k">else</span>
242 <span class="w"> </span><span class="p">...</span>
243
244 <span class="n">g_object_unref</span><span class="w"> </span><span class="p">(</span><span class="n">menu</span><span class="p">);</span></pre></td>
245 </tr>
246 </tbody>
247 </table>
248 </div>
249
250 <p>The caller is responsible to destroy the returned <a class="link" href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a>
251 using <code class="function">g_object_unref()</code>.</p>
252 <p>For more information about the usage <em class="parameter"><code>see</code></em>
253 <a class="link" href="GarconMenu.html#garcon-menu-new" title="garcon_menu_new ()"><code class="function">garcon_menu_new()</code></a>.</p>
254 <p><span class="annotation">[<acronym title="This symbol is a constructor, not a static method."><span class="acronym">constructor</span></acronym>]</span></p>
255 <div class="refsect3">
256 <a name="garcon-menu-new.parameters"></a><h4>Parameters</h4>
257 <div class="informaltable"><table class="informaltable" width="100%" border="0">
258 <colgroup>
259 <col width="150px" class="parameters_name">
260 <col class="parameters_description">
261 <col width="200px" class="parameters_annotations">
262 </colgroup>
263 <tbody><tr>
264 <td class="parameter_name"><p>file</p></td>
265 <td class="parameter_description"><p><span class="type">GFile</span> for the .menu file you want to load.</p></td>
266 <td class="parameter_annotations"> </td>
267 </tr></tbody>
268 </table></div>
269 </div>
270 <div class="refsect3">
271 <a name="garcon-menu-new.returns"></a><h4>Returns</h4>
272 <p>a new <a class="link" href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a>. </p>
273 <p><span class="annotation">[<acronym title="The caller owns the data, and is responsible for free it."><span class="acronym">transfer full</span></acronym>]</span></p>
274 </div>
275 </div>
276 <hr>
277 <div class="refsect2">
278 <a name="garcon-menu-new-for-path"></a><h3>garcon_menu_new_for_path ()</h3>
279 <pre class="programlisting"><a class="link" href="GarconMenu.html" title="GarconMenu"><span class="returnvalue">GarconMenu</span></a> *
280 garcon_menu_new_for_path (<em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>);</pre>
281 <p>Creates a new <a class="link" 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>
282 .
283 This operation only fails if the filename is <code class="literal">NULL</code>. To load the menu
284 tree from the file, you need to call <a class="link" href="GarconMenu.html#garcon-menu-load" title="garcon_menu_load ()"><code class="function">garcon_menu_load()</code></a> with the
285 returned <a class="link" href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a>.</p>
286 <p>The caller is responsible to destroy the returned <a class="link" href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a>
287 using <code class="function">g_object_unref()</code>.</p>
288 <p><span class="annotation">[<acronym title="This symbol is a constructor, not a static method."><span class="acronym">constructor</span></acronym>]</span></p>
289 <div class="refsect3">
290 <a name="garcon-menu-new-for-path.parameters"></a><h4>Parameters</h4>
291 <div class="informaltable"><table class="informaltable" width="100%" border="0">
292 <colgroup>
293 <col width="150px" class="parameters_name">
294 <col class="parameters_description">
295 <col width="200px" class="parameters_annotations">
296 </colgroup>
297 <tbody><tr>
298 <td class="parameter_name"><p>filename</p></td>
299 <td class="parameter_description"><p>Path/URI of the .menu file you want to load.</p></td>
300 <td class="parameter_annotations"> </td>
301 </tr></tbody>
302 </table></div>
303 </div>
304 <div class="refsect3">
305 <a name="garcon-menu-new-for-path.returns"></a><h4>Returns</h4>
306 <p>a new <a class="link" href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a>
307 for <em class="parameter"><code>filename</code></em>
308 . </p>
309 <p><span class="annotation">[<acronym title="The caller owns the data, and is responsible for free it."><span class="acronym">transfer full</span></acronym>]</span></p>
310 </div>
311 </div>
312 <hr>
313 <div class="refsect2">
314 <a name="garcon-menu-new-applications"></a><h3>garcon_menu_new_applications ()</h3>
315 <pre class="programlisting"><a class="link" href="GarconMenu.html" title="GarconMenu"><span class="returnvalue">GarconMenu</span></a> *
316 garcon_menu_new_applications (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
317 <p>Creates a new <a class="link" href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a> for the applications.menu file
318 which is being used to display installed applications.</p>
319 <p>For more information about the usage <em class="parameter"><code>see</code></em>
320 <a class="link" href="GarconMenu.html#garcon-menu-new" title="garcon_menu_new ()"><code class="function">garcon_menu_new()</code></a>.</p>
321 <div class="refsect3">
322 <a name="garcon-menu-new-applications.returns"></a><h4>Returns</h4>
323 <p>a new <a class="link" href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a>
324 for applications.menu. </p>
325 <p><span class="annotation">[<acronym title="The caller owns the data, and is responsible for free it."><span class="acronym">transfer full</span></acronym>]</span></p>
326 </div>
327 </div>
328 <hr>
329 <div class="refsect2">
330 <a name="garcon-menu-load"></a><h3>garcon_menu_load ()</h3>
331 <pre class="programlisting"><span class="returnvalue">gboolean</span>
332 garcon_menu_load (<em class="parameter"><code><a class="link" href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a> *menu</code></em>,
333 <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
334 <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
335 <p>This function loads the entire menu tree from the file referred to
336 by <em class="parameter"><code>menu</code></em>
337 . It resolves merges, moves and everything else defined
338 in the menu specification. The resulting tree information is
339 stored within <em class="parameter"><code>menu</code></em>
340 and can be accessed using the public <a class="link" href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a>
341 API afterwards.</p>
342 <p><em class="parameter"><code>cancellable</code></em>
343 can be used to handle blocking I/O when reading data
344 from files during the loading process.</p>
345 <p><em class="parameter"><code>error</code></em>
346 should either be NULL or point to a <span class="type">GError</span> return location
347 where errors should be stored in.</p>
348 <div class="refsect3">
349 <a name="garcon-menu-load.parameters"></a><h4>Parameters</h4>
350 <div class="informaltable"><table class="informaltable" width="100%" border="0">
351 <colgroup>
352 <col width="150px" class="parameters_name">
353 <col class="parameters_description">
354 <col width="200px" class="parameters_annotations">
355 </colgroup>
356 <tbody>
357 <tr>
358 <td class="parameter_name"><p>menu</p></td>
359 <td class="parameter_description"><p>a <a class="link" href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a></p></td>
360 <td class="parameter_annotations"> </td>
361 </tr>
362 <tr>
363 <td class="parameter_name"><p>cancellable</p></td>
364 <td class="parameter_description"><p>a <span class="type">GCancellable</span></p></td>
365 <td class="parameter_annotations"> </td>
366 </tr>
367 <tr>
368 <td class="parameter_name"><p>error</p></td>
369 <td class="parameter_description"><p><span class="type">GError</span> return location</p></td>
370 <td class="parameter_annotations"> </td>
371 </tr>
372 </tbody>
373 </table></div>
374 </div>
375 <div class="refsect3">
376 <a name="garcon-menu-load.returns"></a><h4>Returns</h4>
377 <p> <code class="literal">TRUE</code> if the menu was loaded successfully or
378 <code class="literal">FALSE</code> if there was an error or the process was
379 cancelled.</p>
380 </div>
381 </div>
382 <hr>
383 <div class="refsect2">
384 <a name="garcon-menu-get-file"></a><h3>garcon_menu_get_file ()</h3>
385 <pre class="programlisting"><span class="returnvalue">GFile</span> *
386 garcon_menu_get_file (<em class="parameter"><code><a class="link" href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a> *menu</code></em>);</pre>
387 <p>Get the file for <em class="parameter"><code>menu</code></em>
388 . It refers to the .menu file from which
389 <em class="parameter"><code>menu</code></em>
390 was or will be loaded.</p>
391 <p>The returned object should be unreffed with <code class="function">g_object_unref()</code>
392 when no longer needed.</p>
393 <div class="refsect3">
394 <a name="garcon-menu-get-file.parameters"></a><h4>Parameters</h4>
395 <div class="informaltable"><table class="informaltable" width="100%" border="0">
396 <colgroup>
397 <col width="150px" class="parameters_name">
398 <col class="parameters_description">
399 <col width="200px" class="parameters_annotations">
400 </colgroup>
401 <tbody><tr>
402 <td class="parameter_name"><p>menu</p></td>
403 <td class="parameter_description"><p>a <a class="link" href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a>.</p></td>
404 <td class="parameter_annotations"> </td>
405 </tr></tbody>
406 </table></div>
407 </div>
408 <div class="refsect3">
409 <a name="garcon-menu-get-file.returns"></a><h4>Returns</h4>
410 <p>a <span class="type">GFile</span>. </p>
411 <p><span class="annotation">[<acronym title="The caller owns the data, and is responsible for free it."><span class="acronym">transfer full</span></acronym>]</span></p>
412 </div>
413 </div>
414 <hr>
415 <div class="refsect2">
416 <a name="garcon-menu-get-directory"></a><h3>garcon_menu_get_directory ()</h3>
417 <pre class="programlisting"><a class="link" href="GarconMenuDirectory.html" title="GarconMenuDirectory"><span class="returnvalue">GarconMenuDirectory</span></a> *
418 garcon_menu_get_directory (<em class="parameter"><code><a class="link" href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a> *menu</code></em>);</pre>
419 <p>Returns the <a class="link" href="GarconMenuDirectory.html" title="GarconMenuDirectory"><span class="type">GarconMenuDirectory</span></a> of <em class="parameter"><code>menu</code></em>
420 or <code class="literal">NULL</code> if <em class="parameter"><code>menu</code></em>
421 has
422 no valid directory element.</p>
423 <p>The menu directory may contain a lot of useful information about
424 the menu like the display and icon name, desktop environments it
425 should show up in etc.</p>
426 <div class="refsect3">
427 <a name="garcon-menu-get-directory.parameters"></a><h4>Parameters</h4>
428 <div class="informaltable"><table class="informaltable" width="100%" border="0">
429 <colgroup>
430 <col width="150px" class="parameters_name">
431 <col class="parameters_description">
432 <col width="200px" class="parameters_annotations">
433 </colgroup>
434 <tbody><tr>
435 <td class="parameter_name"><p>menu</p></td>
436 <td class="parameter_description"><p>a <a class="link" href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a>.</p></td>
437 <td class="parameter_annotations"> </td>
438 </tr></tbody>
439 </table></div>
440 </div>
441 <div class="refsect3">
442 <a name="garcon-menu-get-directory.returns"></a><h4>Returns</h4>
443 <p>a <a class="link" href="GarconMenuDirectory.html" title="GarconMenuDirectory"><span class="type">GarconMenuDirectory</span></a>. </p>
444 <p><span class="annotation">[<acronym title="The data is owned by the callee, which is responsible of freeing it."><span class="acronym">transfer none</span></acronym>][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p>
445 </div>
446 </div>
447 <hr>
448 <div class="refsect2">
449 <a name="garcon-menu-get-menus"></a><h3>garcon_menu_get_menus ()</h3>
450 <pre class="programlisting"><span class="returnvalue">GList</span> *
451 garcon_menu_get_menus (<em class="parameter"><code><a class="link" href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a> *menu</code></em>);</pre>
452 <p>Returns a sorted list of <a class="link" href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a> submenus of <em class="parameter"><code>menu</code></em>
453 . The list
454 should be freed with <code class="function">g_list_free()</code>.</p>
455 <div class="refsect3">
456 <a name="garcon-menu-get-menus.parameters"></a><h4>Parameters</h4>
457 <div class="informaltable"><table class="informaltable" width="100%" border="0">
458 <colgroup>
459 <col width="150px" class="parameters_name">
460 <col class="parameters_description">
461 <col width="200px" class="parameters_annotations">
462 </colgroup>
463 <tbody><tr>
464 <td class="parameter_name"><p>menu</p></td>
465 <td class="parameter_description"><p>a <a class="link" href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a></p></td>
466 <td class="parameter_annotations"> </td>
467 </tr></tbody>
468 </table></div>
469 </div>
470 <div class="refsect3">
471 <a name="garcon-menu-get-menus.returns"></a><h4>Returns</h4>
472 <p>a sorted list
473 of <a class="link" href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a>. </p>
474 <p><span class="annotation">[<acronym title="The caller owns the data container, but not the data inside it."><span class="acronym">transfer container</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GarconMenu]</span></p>
475 </div>
476 </div>
477 <hr>
478 <div class="refsect2">
479 <a name="garcon-menu-add-menu"></a><h3>garcon_menu_add_menu ()</h3>
480 <pre class="programlisting"><span class="returnvalue">void</span>
481 garcon_menu_add_menu (<em class="parameter"><code><a class="link" href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a> *menu</code></em>,
482 <em class="parameter"><code><a class="link" href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a> *submenu</code></em>);</pre>
483 <p>Adds <em class="parameter"><code>submenu</code></em>
484 as a sub menu to <em class="parameter"><code>menu</code></em>
485 .</p>
486 <div class="refsect3">
487 <a name="garcon-menu-add-menu.parameters"></a><h4>Parameters</h4>
488 <div class="informaltable"><table class="informaltable" width="100%" border="0">
489 <colgroup>
490 <col width="150px" class="parameters_name">
491 <col class="parameters_description">
492 <col width="200px" class="parameters_annotations">
493 </colgroup>
494 <tbody>
495 <tr>
496 <td class="parameter_name"><p>menu</p></td>
497 <td class="parameter_description"><p>a <a class="link" href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a></p></td>
498 <td class="parameter_annotations"> </td>
499 </tr>
500 <tr>
501 <td class="parameter_name"><p>submenu</p></td>
502 <td class="parameter_description"><p>a <a class="link" href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a></p></td>
503 <td class="parameter_annotations"> </td>
504 </tr>
505 </tbody>
506 </table></div>
507 </div>
508 </div>
509 <hr>
510 <div class="refsect2">
511 <a name="garcon-menu-get-menu-with-name"></a><h3>garcon_menu_get_menu_with_name ()</h3>
512 <pre class="programlisting"><a class="link" href="GarconMenu.html" title="GarconMenu"><span class="returnvalue">GarconMenu</span></a> *
513 garcon_menu_get_menu_with_name (<em class="parameter"><code><a class="link" href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a> *menu</code></em>,
514 <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
515 <p>Looks in <em class="parameter"><code>menu</code></em>
516 for a submenu with <em class="parameter"><code>name</code></em>
517 as name.</p>
518 <div class="refsect3">
519 <a name="garcon-menu-get-menu-with-name.parameters"></a><h4>Parameters</h4>
520 <div class="informaltable"><table class="informaltable" width="100%" border="0">
521 <colgroup>
522 <col width="150px" class="parameters_name">
523 <col class="parameters_description">
524 <col width="200px" class="parameters_annotations">
525 </colgroup>
526 <tbody>
527 <tr>
528 <td class="parameter_name"><p>menu</p></td>
529 <td class="parameter_description"><p>a <a class="link" href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a></p></td>
530 <td class="parameter_annotations"> </td>
531 </tr>
532 <tr>
533 <td class="parameter_name"><p>name</p></td>
534 <td class="parameter_description"><p>a sub menu name</p></td>
535 <td class="parameter_annotations"> </td>
536 </tr>
537 </tbody>
538 </table></div>
539 </div>
540 <div class="refsect3">
541 <a name="garcon-menu-get-menu-with-name.returns"></a><h4>Returns</h4>
542 <p>a <a class="link" href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a> or <code class="literal">NULL</code>. </p>
543 <p><span class="annotation">[<acronym title="The data is owned by the callee, which is responsible of freeing it."><span class="acronym">transfer none</span></acronym>][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p>
544 </div>
545 </div>
546 <hr>
547 <div class="refsect2">
548 <a name="garcon-menu-get-parent"></a><h3>garcon_menu_get_parent ()</h3>
549 <pre class="programlisting"><a class="link" href="GarconMenu.html" title="GarconMenu"><span class="returnvalue">GarconMenu</span></a> *
550 garcon_menu_get_parent (<em class="parameter"><code><a class="link" href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a> *menu</code></em>);</pre>
551 <p>Returns the parent <a class="link" href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a> or <em class="parameter"><code>menu</code></em>
552 .</p>
553 <div class="refsect3">
554 <a name="garcon-menu-get-parent.parameters"></a><h4>Parameters</h4>
555 <div class="informaltable"><table class="informaltable" width="100%" border="0">
556 <colgroup>
557 <col width="150px" class="parameters_name">
558 <col class="parameters_description">
559 <col width="200px" class="parameters_annotations">
560 </colgroup>
561 <tbody><tr>
562 <td class="parameter_name"><p>menu</p></td>
563 <td class="parameter_description"><p>a <a class="link" href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a></p></td>
564 <td class="parameter_annotations"> </td>
565 </tr></tbody>
566 </table></div>
567 </div>
568 <div class="refsect3">
569 <a name="garcon-menu-get-parent.returns"></a><h4>Returns</h4>
570 <p>a <a class="link" href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a> or <code class="literal">NULL</code>
571 if <em class="parameter"><code>menu</code></em>
572 is the root menu. </p>
573 <p><span class="annotation">[<acronym title="The data is owned by the callee, which is responsible of freeing it."><span class="acronym">transfer none</span></acronym>][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p>
574 </div>
575 </div>
576 <hr>
577 <div class="refsect2">
578 <a name="garcon-menu-get-item-pool"></a><h3>garcon_menu_get_item_pool ()</h3>
579 <pre class="programlisting"><a class="link" href="garcon-garcon-menu-item-pool.html#GarconMenuItemPool"><span class="returnvalue">GarconMenuItemPool</span></a> *
580 garcon_menu_get_item_pool (<em class="parameter"><code><a class="link" href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a> *menu</code></em>);</pre>
581 <p>Get the item pool of the menu. This pool contains all items in this
582 menu (for that of its submenus).</p>
583 <div class="refsect3">
584 <a name="garcon-menu-get-item-pool.parameters"></a><h4>Parameters</h4>
585 <div class="informaltable"><table class="informaltable" width="100%" border="0">
586 <colgroup>
587 <col width="150px" class="parameters_name">
588 <col class="parameters_description">
589 <col width="200px" class="parameters_annotations">
590 </colgroup>
591 <tbody><tr>
592 <td class="parameter_name"><p>menu</p></td>
593 <td class="parameter_description"><p>a <a class="link" href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a>.</p></td>
594 <td class="parameter_annotations"> </td>
595 </tr></tbody>
596 </table></div>
597 </div>
598 <div class="refsect3">
599 <a name="garcon-menu-get-item-pool.returns"></a><h4>Returns</h4>
600 <p>a <a class="link" href="garcon-garcon-menu-item-pool.html#GarconMenuItemPool"><span class="type">GarconMenuItemPool</span></a>. </p>
601 <p><span class="annotation">[<acronym title="The data is owned by the callee, which is responsible of freeing it."><span class="acronym">transfer none</span></acronym>]</span></p>
602 </div>
603 </div>
604 <hr>
605 <div class="refsect2">
606 <a name="garcon-menu-get-items"></a><h3>garcon_menu_get_items ()</h3>
607 <pre class="programlisting"><span class="returnvalue">GList</span> *
608 garcon_menu_get_items (<em class="parameter"><code><a class="link" href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a> *menu</code></em>);</pre>
609 <p>Returns all <a class="link" href="GarconMenuItem.html" title="GarconMenuItem"><span class="type">GarconMenuItem</span></a> included in <em class="parameter"><code>menu</code></em>
610 . The items are
611 sorted by their display names in ascending order.</p>
612 <p>The caller is responsible to free the returned list using
613 <code class="function">g_list_free()</code> when no longer needed.</p>
614 <div class="refsect3">
615 <a name="garcon-menu-get-items.parameters"></a><h4>Parameters</h4>
616 <div class="informaltable"><table class="informaltable" width="100%" border="0">
617 <colgroup>
618 <col width="150px" class="parameters_name">
619 <col class="parameters_description">
620 <col width="200px" class="parameters_annotations">
621 </colgroup>
622 <tbody><tr>
623 <td class="parameter_name"><p>menu</p></td>
624 <td class="parameter_description"><p>a <a class="link" href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a>.</p></td>
625 <td class="parameter_annotations"> </td>
626 </tr></tbody>
627 </table></div>
628 </div>
629 <div class="refsect3">
630 <a name="garcon-menu-get-items.returns"></a><h4>Returns</h4>
631 <p>list
632 of <a class="link" href="GarconMenuItem.html" title="GarconMenuItem"><span class="type">GarconMenuItem</span></a> included in <em class="parameter"><code>menu</code></em>
633 . </p>
634 <p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GarconMenuItem][<acronym title="The caller owns the data container, but not the data inside it."><span class="acronym">transfer container</span></acronym>]</span></p>
635 </div>
636 </div>
637 <hr>
638 <div class="refsect2">
639 <a name="garcon-menu-get-elements"></a><h3>garcon_menu_get_elements ()</h3>
640 <pre class="programlisting"><span class="returnvalue">GList</span> *
641 garcon_menu_get_elements (<em class="parameter"><code><a class="link" href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a> *menu</code></em>);</pre>
642 <p>Get all the menu element in <em class="parameter"><code>menu</code></em>
643 . This contains sub menus, menu items
644 and separators.</p>
645 <p>Returns a list of <a class="link" href="GarconMenuItem.html" title="GarconMenuItem"><span class="type">GarconMenuItem</span></a> or <code class="literal">NULL</code>. Free the list with
646 <code class="function">g_list_free()</code>.</p>
647 <div class="refsect3">
648 <a name="garcon-menu-get-elements.parameters"></a><h4>Parameters</h4>
649 <div class="informaltable"><table class="informaltable" width="100%" border="0">
650 <colgroup>
651 <col width="150px" class="parameters_name">
652 <col class="parameters_description">
653 <col width="200px" class="parameters_annotations">
654 </colgroup>
655 <tbody><tr>
656 <td class="parameter_name"><p>menu</p></td>
657 <td class="parameter_description"><p>a <a class="link" href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a>.</p></td>
658 <td class="parameter_annotations"> </td>
659 </tr></tbody>
660 </table></div>
661 </div>
662 <div class="refsect3">
663 <a name="garcon-menu-get-elements.returns"></a><h4>Returns</h4>
664 <p>. </p>
665 <p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GarconMenuItem][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<acronym title="The caller owns the data container, but not the data inside it."><span class="acronym">transfer container</span></acronym>]</span></p>
666 </div>
667 </div>
668 </div>
669 <div class="refsect1">
670 <a name="GarconMenu.property-details"></a><h2>Property Details</h2>
671 <div class="refsect2">
672 <a name="GarconMenu--directory"></a><h3>The <code class="literal">“directory”</code> property</h3>
673 <pre class="programlisting"> “directory” <a class="link" href="GarconMenuDirectory.html" title="GarconMenuDirectory"><span class="type">GarconMenuDirectory</span></a> *</pre>
674 <p>The directory entry associated with this menu.</p>
675 <p>Owner: GarconMenu</p>
676 <p>Flags: Read / Write</p>
677 </div>
678 <hr>
679 <div class="refsect2">
680 <a name="GarconMenu--file"></a><h3>The <code class="literal">“file”</code> property</h3>
681 <pre class="programlisting"> “file” <span class="type">GFile</span> *</pre>
682 <p>The <span class="type">GFile</span> from which the <a class="link" href="GarconMenu.html" title="GarconMenu"><code class="literal">GarconMenu</code></a> was loaded.</p>
683 <p>Owner: GarconMenu</p>
684 <p>Flags: Read / Write / Construct Only</p>
685 </div>
686 </div>
687 <div class="refsect1">
688 <a name="GarconMenu.signal-details"></a><h2>Signal Details</h2>
689 <div class="refsect2">
690 <a name="GarconMenu-directory-changed"></a><h3>The <code class="literal">“directory-changed”</code> signal</h3>
691 <pre class="programlisting"><span class="returnvalue">void</span>
692 user_function (<a class="link" href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a> *garconmenu,
693 <a class="link" href="GarconMenuDirectory.html" title="GarconMenuDirectory"><span class="type">GarconMenuDirectory</span></a> *arg1,
694 <a class="link" href="GarconMenuDirectory.html" title="GarconMenuDirectory"><span class="type">GarconMenuDirectory</span></a> *arg2,
695 <span class="type">gpointer</span> user_data)</pre>
696 <p>Flags: No Hooks</p>
697 </div>
698 <hr>
699 <div class="refsect2">
700 <a name="GarconMenu-reload-required"></a><h3>The <code class="literal">“reload-required”</code> signal</h3>
701 <pre class="programlisting"><span class="returnvalue">void</span>
702 user_function (<a class="link" href="GarconMenu.html" title="GarconMenu"><span class="type">GarconMenu</span></a> *garconmenu,
703 <span class="type">gpointer</span> user_data)</pre>
704 <p>Flags: No Hooks</p>
705 </div>
706 </div>
707 </div>
708 <div class="footer">
709 <hr>Generated by GTK-Doc V1.34.0</div>
710 </body>
711 </html>