| 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>GarconMenuDirectory: 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="GarconMenu.html" title="GarconMenu"> |
| 10 |
<link rel="next" href="GarconMenuElement.html" title="GarconMenuElement"> |
| 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="#GarconMenuDirectory.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> |
| 19 |
<a href="#GarconMenuDirectory.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> |
| 20 |
<a href="#GarconMenuDirectory.properties" class="shortcut">Properties</a></span> |
| 21 |
</td> |
| 22 |
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> |
| 23 |
<td><a accesskey="u" href="garcon-menus.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> |
| 24 |
<td><a accesskey="p" href="GarconMenu.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> |
| 25 |
<td><a accesskey="n" href="GarconMenuElement.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> |
| 26 |
</tr></table> |
| 27 |
<div class="refentry"> |
| 28 |
<a name="GarconMenuDirectory"></a><div class="titlepage"></div> |
| 29 |
<div class="refnamediv"><table width="100%"><tr> |
| 30 |
<td valign="top"> |
| 31 |
<h2><span class="refentrytitle"><a name="GarconMenuDirectory.top_of_page"></a>GarconMenuDirectory</span></h2> |
| 32 |
<p>GarconMenuDirectory — Garcon element for .directory files.</p> |
| 33 |
</td> |
| 34 |
<td class="gallery_image" valign="top" align="right"></td> |
| 35 |
</tr></table></div> |
| 36 |
<div class="refsect1"> |
| 37 |
<a name="GarconMenuDirectory.functions"></a><h2>Functions</h2> |
| 38 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 39 |
<colgroup> |
| 40 |
<col width="150px" class="functions_proto_type"> |
| 41 |
<col class="functions_proto_name"> |
| 42 |
</colgroup> |
| 43 |
<tbody> |
| 44 |
<tr> |
| 45 |
<td class="function_type"> |
| 46 |
<a class="link" href="GarconMenuDirectory.html" title="GarconMenuDirectory"><span class="returnvalue">GarconMenuDirectory</span></a> * |
| 47 |
</td> |
| 48 |
<td class="function_name"> |
| 49 |
<a class="link" href="GarconMenuDirectory.html#garcon-menu-directory-new" title="garcon_menu_directory_new ()">garcon_menu_directory_new</a> <span class="c_punctuation">()</span> |
| 50 |
</td> |
| 51 |
</tr> |
| 52 |
<tr> |
| 53 |
<td class="function_type"> |
| 54 |
<span class="returnvalue">GFile</span> * |
| 55 |
</td> |
| 56 |
<td class="function_name"> |
| 57 |
<a class="link" href="GarconMenuDirectory.html#garcon-menu-directory-get-file" title="garcon_menu_directory_get_file ()">garcon_menu_directory_get_file</a> <span class="c_punctuation">()</span> |
| 58 |
</td> |
| 59 |
</tr> |
| 60 |
<tr> |
| 61 |
<td class="function_type">const <span class="returnvalue">gchar</span> * |
| 62 |
</td> |
| 63 |
<td class="function_name"> |
| 64 |
<a class="link" href="GarconMenuDirectory.html#garcon-menu-directory-get-name" title="garcon_menu_directory_get_name ()">garcon_menu_directory_get_name</a> <span class="c_punctuation">()</span> |
| 65 |
</td> |
| 66 |
</tr> |
| 67 |
<tr> |
| 68 |
<td class="function_type"> |
| 69 |
<span class="returnvalue">void</span> |
| 70 |
</td> |
| 71 |
<td class="function_name"> |
| 72 |
<a class="link" href="GarconMenuDirectory.html#garcon-menu-directory-set-name" title="garcon_menu_directory_set_name ()">garcon_menu_directory_set_name</a> <span class="c_punctuation">()</span> |
| 73 |
</td> |
| 74 |
</tr> |
| 75 |
<tr> |
| 76 |
<td class="function_type">const <span class="returnvalue">gchar</span> * |
| 77 |
</td> |
| 78 |
<td class="function_name"> |
| 79 |
<a class="link" href="GarconMenuDirectory.html#garcon-menu-directory-get-comment" title="garcon_menu_directory_get_comment ()">garcon_menu_directory_get_comment</a> <span class="c_punctuation">()</span> |
| 80 |
</td> |
| 81 |
</tr> |
| 82 |
<tr> |
| 83 |
<td class="function_type"> |
| 84 |
<span class="returnvalue">void</span> |
| 85 |
</td> |
| 86 |
<td class="function_name"> |
| 87 |
<a class="link" href="GarconMenuDirectory.html#garcon-menu-directory-set-comment" title="garcon_menu_directory_set_comment ()">garcon_menu_directory_set_comment</a> <span class="c_punctuation">()</span> |
| 88 |
</td> |
| 89 |
</tr> |
| 90 |
<tr> |
| 91 |
<td class="function_type">const <span class="returnvalue">gchar</span> * |
| 92 |
</td> |
| 93 |
<td class="function_name"> |
| 94 |
<a class="link" href="GarconMenuDirectory.html#garcon-menu-directory-get-icon-name" title="garcon_menu_directory_get_icon_name ()">garcon_menu_directory_get_icon_name</a> <span class="c_punctuation">()</span> |
| 95 |
</td> |
| 96 |
</tr> |
| 97 |
<tr> |
| 98 |
<td class="function_type"> |
| 99 |
<span class="returnvalue">void</span> |
| 100 |
</td> |
| 101 |
<td class="function_name"> |
| 102 |
<a class="link" href="GarconMenuDirectory.html#garcon-menu-directory-set-icon-name" title="garcon_menu_directory_set_icon_name ()">garcon_menu_directory_set_icon_name</a> <span class="c_punctuation">()</span> |
| 103 |
</td> |
| 104 |
</tr> |
| 105 |
<tr> |
| 106 |
<td class="function_type"> |
| 107 |
<span class="returnvalue">gboolean</span> |
| 108 |
</td> |
| 109 |
<td class="function_name"> |
| 110 |
<a class="link" href="GarconMenuDirectory.html#garcon-menu-directory-get-no-display" title="garcon_menu_directory_get_no_display ()">garcon_menu_directory_get_no_display</a> <span class="c_punctuation">()</span> |
| 111 |
</td> |
| 112 |
</tr> |
| 113 |
<tr> |
| 114 |
<td class="function_type"> |
| 115 |
<span class="returnvalue">void</span> |
| 116 |
</td> |
| 117 |
<td class="function_name"> |
| 118 |
<a class="link" href="GarconMenuDirectory.html#garcon-menu-directory-set-no-display" title="garcon_menu_directory_set_no_display ()">garcon_menu_directory_set_no_display</a> <span class="c_punctuation">()</span> |
| 119 |
</td> |
| 120 |
</tr> |
| 121 |
<tr> |
| 122 |
<td class="function_type"> |
| 123 |
<span class="returnvalue">gboolean</span> |
| 124 |
</td> |
| 125 |
<td class="function_name"> |
| 126 |
<a class="link" href="GarconMenuDirectory.html#garcon-menu-directory-get-hidden" title="garcon_menu_directory_get_hidden ()">garcon_menu_directory_get_hidden</a> <span class="c_punctuation">()</span> |
| 127 |
</td> |
| 128 |
</tr> |
| 129 |
<tr> |
| 130 |
<td class="function_type"> |
| 131 |
<span class="returnvalue">gboolean</span> |
| 132 |
</td> |
| 133 |
<td class="function_name"> |
| 134 |
<a class="link" href="GarconMenuDirectory.html#garcon-menu-directory-get-show-in-environment" title="garcon_menu_directory_get_show_in_environment ()">garcon_menu_directory_get_show_in_environment</a> <span class="c_punctuation">()</span> |
| 135 |
</td> |
| 136 |
</tr> |
| 137 |
<tr> |
| 138 |
<td class="function_type"> |
| 139 |
<span class="returnvalue">gboolean</span> |
| 140 |
</td> |
| 141 |
<td class="function_name"> |
| 142 |
<a class="link" href="GarconMenuDirectory.html#garcon-menu-directory-get-visible" title="garcon_menu_directory_get_visible ()">garcon_menu_directory_get_visible</a> <span class="c_punctuation">()</span> |
| 143 |
</td> |
| 144 |
</tr> |
| 145 |
<tr> |
| 146 |
<td class="function_type"> |
| 147 |
<span class="returnvalue">gboolean</span> |
| 148 |
</td> |
| 149 |
<td class="function_name"> |
| 150 |
<a class="link" href="GarconMenuDirectory.html#garcon-menu-directory-equal" title="garcon_menu_directory_equal ()">garcon_menu_directory_equal</a> <span class="c_punctuation">()</span> |
| 151 |
</td> |
| 152 |
</tr> |
| 153 |
</tbody> |
| 154 |
</table></div> |
| 155 |
</div> |
| 156 |
<div class="refsect1"> |
| 157 |
<a name="GarconMenuDirectory.properties"></a><h2>Properties</h2> |
| 158 |
<div class="informaltable"><table class="informaltable" border="0"> |
| 159 |
<colgroup> |
| 160 |
<col width="150px" class="properties_type"> |
| 161 |
<col width="300px" class="properties_name"> |
| 162 |
<col width="200px" class="properties_flags"> |
| 163 |
</colgroup> |
| 164 |
<tbody> |
| 165 |
<tr> |
| 166 |
<td class="property_type"> |
| 167 |
<span class="type">char</span> *</td> |
| 168 |
<td class="property_name"><a class="link" href="GarconMenuDirectory.html#GarconMenuDirectory--comment" title="The “comment” property">comment</a></td> |
| 169 |
<td class="property_flags">Read / Write</td> |
| 170 |
</tr> |
| 171 |
<tr> |
| 172 |
<td class="property_type"> |
| 173 |
<span class="type">GFile</span> *</td> |
| 174 |
<td class="property_name"><a class="link" href="GarconMenuDirectory.html#GarconMenuDirectory--file" title="The “file” property">file</a></td> |
| 175 |
<td class="property_flags">Read / Write / Construct Only</td> |
| 176 |
</tr> |
| 177 |
<tr> |
| 178 |
<td class="property_type"> |
| 179 |
<span class="type">char</span> *</td> |
| 180 |
<td class="property_name"><a class="link" href="GarconMenuDirectory.html#GarconMenuDirectory--icon-name" title="The “icon-name” property">icon-name</a></td> |
| 181 |
<td class="property_flags">Read / Write</td> |
| 182 |
</tr> |
| 183 |
<tr> |
| 184 |
<td class="property_type"> |
| 185 |
<span class="type">char</span> *</td> |
| 186 |
<td class="property_name"><a class="link" href="GarconMenuDirectory.html#GarconMenuDirectory--name" title="The “name” property">name</a></td> |
| 187 |
<td class="property_flags">Read / Write</td> |
| 188 |
</tr> |
| 189 |
<tr> |
| 190 |
<td class="property_type"><span class="type">gboolean</span></td> |
| 191 |
<td class="property_name"><a class="link" href="GarconMenuDirectory.html#GarconMenuDirectory--no-display" title="The “no-display” property">no-display</a></td> |
| 192 |
<td class="property_flags">Read / Write</td> |
| 193 |
</tr> |
| 194 |
</tbody> |
| 195 |
</table></div> |
| 196 |
</div> |
| 197 |
<div class="refsect1"> |
| 198 |
<a name="GarconMenuDirectory.object-hierarchy"></a><h2>Object Hierarchy</h2> |
| 199 |
<pre class="screen"> GObject |
| 200 |
<span class="lineart">╰──</span> GarconMenuDirectory |
| 201 |
</pre> |
| 202 |
</div> |
| 203 |
<div class="refsect1"> |
| 204 |
<a name="GarconMenuDirectory.includes"></a><h2>Includes</h2> |
| 205 |
<pre class="synopsis">#include <garcon/garcon.h> |
| 206 |
</pre> |
| 207 |
</div> |
| 208 |
<div class="refsect1"> |
| 209 |
<a name="GarconMenuDirectory.description"></a><h2>Description</h2> |
| 210 |
<p>Element that represents a .directory file in the menu configurations. |
| 211 |
Each menu (except for the root menu) has a <a class="link" href="GarconMenuDirectory.html" title="GarconMenuDirectory"><span class="type">GarconMenuDirectory</span></a>, |
| 212 |
see <a class="link" href="GarconMenu.html#garcon-menu-get-directory" title="garcon_menu_get_directory ()"><code class="function">garcon_menu_get_directory()</code></a>.</p> |
| 213 |
</div> |
| 214 |
<div class="refsect1"> |
| 215 |
<a name="GarconMenuDirectory.functions_details"></a><h2>Functions</h2> |
| 216 |
<div class="refsect2"> |
| 217 |
<a name="garcon-menu-directory-new"></a><h3>garcon_menu_directory_new ()</h3> |
| 218 |
<pre class="programlisting"><a class="link" href="GarconMenuDirectory.html" title="GarconMenuDirectory"><span class="returnvalue">GarconMenuDirectory</span></a> * |
| 219 |
garcon_menu_directory_new (<em class="parameter"><code><span class="type">GFile</span> *file</code></em>);</pre> |
| 220 |
<p>Create a new <a class="link" href="GarconMenuDirectory.html" title="GarconMenuDirectory"><span class="type">GarconMenuDirectory</span></a> for <em class="parameter"><code>file</code></em> |
| 221 |
. You most likely never |
| 222 |
use this, but retrieve the info from <a class="link" href="GarconMenu.html#garcon-menu-get-directory" title="garcon_menu_get_directory ()"><code class="function">garcon_menu_get_directory()</code></a>.</p> |
| 223 |
<p><span class="annotation">[<acronym title="This is a method"><span class="acronym">method</span></acronym>]</span></p> |
| 224 |
<div class="refsect3"> |
| 225 |
<a name="garcon-menu-directory-new.parameters"></a><h4>Parameters</h4> |
| 226 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 227 |
<colgroup> |
| 228 |
<col width="150px" class="parameters_name"> |
| 229 |
<col class="parameters_description"> |
| 230 |
<col width="200px" class="parameters_annotations"> |
| 231 |
</colgroup> |
| 232 |
<tbody><tr> |
| 233 |
<td class="parameter_name"><p>file</p></td> |
| 234 |
<td class="parameter_description"><p>a <span class="type">GFile</span></p></td> |
| 235 |
<td class="parameter_annotations"> </td> |
| 236 |
</tr></tbody> |
| 237 |
</table></div> |
| 238 |
</div> |
| 239 |
<div class="refsect3"> |
| 240 |
<a name="garcon-menu-directory-new.returns"></a><h4>Returns</h4> |
| 241 |
<p> a <a class="link" href="GarconMenuDirectory.html" title="GarconMenuDirectory"><span class="type">GarconMenuDirectory</span></a>.</p> |
| 242 |
</div> |
| 243 |
</div> |
| 244 |
<hr> |
| 245 |
<div class="refsect2"> |
| 246 |
<a name="garcon-menu-directory-get-file"></a><h3>garcon_menu_directory_get_file ()</h3> |
| 247 |
<pre class="programlisting"><span class="returnvalue">GFile</span> * |
| 248 |
garcon_menu_directory_get_file (<em class="parameter"><code><a class="link" href="GarconMenuDirectory.html" title="GarconMenuDirectory"><span class="type">GarconMenuDirectory</span></a> *directory</code></em>);</pre> |
| 249 |
<p>Get the <span class="type">GFile</span> for <em class="parameter"><code>directory</code></em> |
| 250 |
. The returned object should be |
| 251 |
unreffed with <code class="function">g_object_unref()</code> when no longer needed.</p> |
| 252 |
<div class="refsect3"> |
| 253 |
<a name="garcon-menu-directory-get-file.parameters"></a><h4>Parameters</h4> |
| 254 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 255 |
<colgroup> |
| 256 |
<col width="150px" class="parameters_name"> |
| 257 |
<col class="parameters_description"> |
| 258 |
<col width="200px" class="parameters_annotations"> |
| 259 |
</colgroup> |
| 260 |
<tbody><tr> |
| 261 |
<td class="parameter_name"><p>directory</p></td> |
| 262 |
<td class="parameter_description"><p>a <a class="link" href="GarconMenuDirectory.html" title="GarconMenuDirectory"><span class="type">GarconMenuDirectory</span></a></p></td> |
| 263 |
<td class="parameter_annotations"> </td> |
| 264 |
</tr></tbody> |
| 265 |
</table></div> |
| 266 |
</div> |
| 267 |
<div class="refsect3"> |
| 268 |
<a name="garcon-menu-directory-get-file.returns"></a><h4>Returns</h4> |
| 269 |
<p>a <span class="type">GFile</span>. </p> |
| 270 |
<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> |
| 271 |
</div> |
| 272 |
</div> |
| 273 |
<hr> |
| 274 |
<div class="refsect2"> |
| 275 |
<a name="garcon-menu-directory-get-name"></a><h3>garcon_menu_directory_get_name ()</h3> |
| 276 |
<pre class="programlisting">const <span class="returnvalue">gchar</span> * |
| 277 |
garcon_menu_directory_get_name (<em class="parameter"><code><a class="link" href="GarconMenuDirectory.html" title="GarconMenuDirectory"><span class="type">GarconMenuDirectory</span></a> *directory</code></em>);</pre> |
| 278 |
<p>Get the name of <em class="parameter"><code>directory</code></em> |
| 279 |
.</p> |
| 280 |
<div class="refsect3"> |
| 281 |
<a name="garcon-menu-directory-get-name.parameters"></a><h4>Parameters</h4> |
| 282 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 283 |
<colgroup> |
| 284 |
<col width="150px" class="parameters_name"> |
| 285 |
<col class="parameters_description"> |
| 286 |
<col width="200px" class="parameters_annotations"> |
| 287 |
</colgroup> |
| 288 |
<tbody><tr> |
| 289 |
<td class="parameter_name"><p>directory</p></td> |
| 290 |
<td class="parameter_description"><p>a <a class="link" href="GarconMenuDirectory.html" title="GarconMenuDirectory"><span class="type">GarconMenuDirectory</span></a></p></td> |
| 291 |
<td class="parameter_annotations"> </td> |
| 292 |
</tr></tbody> |
| 293 |
</table></div> |
| 294 |
</div> |
| 295 |
<div class="refsect3"> |
| 296 |
<a name="garcon-menu-directory-get-name.returns"></a><h4>Returns</h4> |
| 297 |
<p> a the name for <em class="parameter"><code>directory</code></em> |
| 298 |
.</p> |
| 299 |
</div> |
| 300 |
</div> |
| 301 |
<hr> |
| 302 |
<div class="refsect2"> |
| 303 |
<a name="garcon-menu-directory-set-name"></a><h3>garcon_menu_directory_set_name ()</h3> |
| 304 |
<pre class="programlisting"><span class="returnvalue">void</span> |
| 305 |
garcon_menu_directory_set_name (<em class="parameter"><code><a class="link" href="GarconMenuDirectory.html" title="GarconMenuDirectory"><span class="type">GarconMenuDirectory</span></a> *directory</code></em>, |
| 306 |
<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre> |
| 307 |
<p>Set the name of <em class="parameter"><code>directory</code></em> |
| 308 |
.</p> |
| 309 |
<div class="refsect3"> |
| 310 |
<a name="garcon-menu-directory-set-name.parameters"></a><h4>Parameters</h4> |
| 311 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 312 |
<colgroup> |
| 313 |
<col width="150px" class="parameters_name"> |
| 314 |
<col class="parameters_description"> |
| 315 |
<col width="200px" class="parameters_annotations"> |
| 316 |
</colgroup> |
| 317 |
<tbody> |
| 318 |
<tr> |
| 319 |
<td class="parameter_name"><p>directory</p></td> |
| 320 |
<td class="parameter_description"><p>a <a class="link" href="GarconMenuDirectory.html" title="GarconMenuDirectory"><span class="type">GarconMenuDirectory</span></a></p></td> |
| 321 |
<td class="parameter_annotations"> </td> |
| 322 |
</tr> |
| 323 |
<tr> |
| 324 |
<td class="parameter_name"><p>name</p></td> |
| 325 |
<td class="parameter_description"><p>the new name for <em class="parameter"><code>directory</code></em> |
| 326 |
.</p></td> |
| 327 |
<td class="parameter_annotations"> </td> |
| 328 |
</tr> |
| 329 |
</tbody> |
| 330 |
</table></div> |
| 331 |
</div> |
| 332 |
</div> |
| 333 |
<hr> |
| 334 |
<div class="refsect2"> |
| 335 |
<a name="garcon-menu-directory-get-comment"></a><h3>garcon_menu_directory_get_comment ()</h3> |
| 336 |
<pre class="programlisting">const <span class="returnvalue">gchar</span> * |
| 337 |
garcon_menu_directory_get_comment (<em class="parameter"><code><a class="link" href="GarconMenuDirectory.html" title="GarconMenuDirectory"><span class="type">GarconMenuDirectory</span></a> *directory</code></em>);</pre> |
| 338 |
<p>Get the comment of <em class="parameter"><code>directory</code></em> |
| 339 |
.</p> |
| 340 |
<div class="refsect3"> |
| 341 |
<a name="garcon-menu-directory-get-comment.parameters"></a><h4>Parameters</h4> |
| 342 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 343 |
<colgroup> |
| 344 |
<col width="150px" class="parameters_name"> |
| 345 |
<col class="parameters_description"> |
| 346 |
<col width="200px" class="parameters_annotations"> |
| 347 |
</colgroup> |
| 348 |
<tbody><tr> |
| 349 |
<td class="parameter_name"><p>directory</p></td> |
| 350 |
<td class="parameter_description"><p>a <a class="link" href="GarconMenuDirectory.html" title="GarconMenuDirectory"><span class="type">GarconMenuDirectory</span></a></p></td> |
| 351 |
<td class="parameter_annotations"> </td> |
| 352 |
</tr></tbody> |
| 353 |
</table></div> |
| 354 |
</div> |
| 355 |
<div class="refsect3"> |
| 356 |
<a name="garcon-menu-directory-get-comment.returns"></a><h4>Returns</h4> |
| 357 |
<p> a the description for <em class="parameter"><code>directory</code></em> |
| 358 |
.</p> |
| 359 |
</div> |
| 360 |
</div> |
| 361 |
<hr> |
| 362 |
<div class="refsect2"> |
| 363 |
<a name="garcon-menu-directory-set-comment"></a><h3>garcon_menu_directory_set_comment ()</h3> |
| 364 |
<pre class="programlisting"><span class="returnvalue">void</span> |
| 365 |
garcon_menu_directory_set_comment (<em class="parameter"><code><a class="link" href="GarconMenuDirectory.html" title="GarconMenuDirectory"><span class="type">GarconMenuDirectory</span></a> *directory</code></em>, |
| 366 |
<em class="parameter"><code>const <span class="type">gchar</span> *comment</code></em>);</pre> |
| 367 |
<p>Set the comment of <em class="parameter"><code>directory</code></em> |
| 368 |
.</p> |
| 369 |
<div class="refsect3"> |
| 370 |
<a name="garcon-menu-directory-set-comment.parameters"></a><h4>Parameters</h4> |
| 371 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 372 |
<colgroup> |
| 373 |
<col width="150px" class="parameters_name"> |
| 374 |
<col class="parameters_description"> |
| 375 |
<col width="200px" class="parameters_annotations"> |
| 376 |
</colgroup> |
| 377 |
<tbody> |
| 378 |
<tr> |
| 379 |
<td class="parameter_name"><p>directory</p></td> |
| 380 |
<td class="parameter_description"><p>a <a class="link" href="GarconMenuDirectory.html" title="GarconMenuDirectory"><span class="type">GarconMenuDirectory</span></a></p></td> |
| 381 |
<td class="parameter_annotations"> </td> |
| 382 |
</tr> |
| 383 |
<tr> |
| 384 |
<td class="parameter_name"><p>comment</p></td> |
| 385 |
<td class="parameter_description"><p>the new description for <em class="parameter"><code>directory</code></em> |
| 386 |
.</p></td> |
| 387 |
<td class="parameter_annotations"> </td> |
| 388 |
</tr> |
| 389 |
</tbody> |
| 390 |
</table></div> |
| 391 |
</div> |
| 392 |
</div> |
| 393 |
<hr> |
| 394 |
<div class="refsect2"> |
| 395 |
<a name="garcon-menu-directory-get-icon-name"></a><h3>garcon_menu_directory_get_icon_name ()</h3> |
| 396 |
<pre class="programlisting">const <span class="returnvalue">gchar</span> * |
| 397 |
garcon_menu_directory_get_icon_name (<em class="parameter"><code><a class="link" href="GarconMenuDirectory.html" title="GarconMenuDirectory"><span class="type">GarconMenuDirectory</span></a> *directory</code></em>);</pre> |
| 398 |
<p>Get the icon name of <em class="parameter"><code>directory</code></em> |
| 399 |
.</p> |
| 400 |
<div class="refsect3"> |
| 401 |
<a name="garcon-menu-directory-get-icon-name.parameters"></a><h4>Parameters</h4> |
| 402 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 403 |
<colgroup> |
| 404 |
<col width="150px" class="parameters_name"> |
| 405 |
<col class="parameters_description"> |
| 406 |
<col width="200px" class="parameters_annotations"> |
| 407 |
</colgroup> |
| 408 |
<tbody><tr> |
| 409 |
<td class="parameter_name"><p>directory</p></td> |
| 410 |
<td class="parameter_description"><p>a <a class="link" href="GarconMenuDirectory.html" title="GarconMenuDirectory"><span class="type">GarconMenuDirectory</span></a></p></td> |
| 411 |
<td class="parameter_annotations"> </td> |
| 412 |
</tr></tbody> |
| 413 |
</table></div> |
| 414 |
</div> |
| 415 |
<div class="refsect3"> |
| 416 |
<a name="garcon-menu-directory-get-icon-name.returns"></a><h4>Returns</h4> |
| 417 |
<p> a the icon-name key for <em class="parameter"><code>directory</code></em> |
| 418 |
.</p> |
| 419 |
</div> |
| 420 |
</div> |
| 421 |
<hr> |
| 422 |
<div class="refsect2"> |
| 423 |
<a name="garcon-menu-directory-set-icon-name"></a><h3>garcon_menu_directory_set_icon_name ()</h3> |
| 424 |
<pre class="programlisting"><span class="returnvalue">void</span> |
| 425 |
garcon_menu_directory_set_icon_name (<em class="parameter"><code><a class="link" href="GarconMenuDirectory.html" title="GarconMenuDirectory"><span class="type">GarconMenuDirectory</span></a> *directory</code></em>, |
| 426 |
<em class="parameter"><code>const <span class="type">gchar</span> *icon_name</code></em>);</pre> |
| 427 |
<p>Set the icon name of <em class="parameter"><code>directory</code></em> |
| 428 |
.</p> |
| 429 |
<div class="refsect3"> |
| 430 |
<a name="garcon-menu-directory-set-icon-name.parameters"></a><h4>Parameters</h4> |
| 431 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 432 |
<colgroup> |
| 433 |
<col width="150px" class="parameters_name"> |
| 434 |
<col class="parameters_description"> |
| 435 |
<col width="200px" class="parameters_annotations"> |
| 436 |
</colgroup> |
| 437 |
<tbody> |
| 438 |
<tr> |
| 439 |
<td class="parameter_name"><p>directory</p></td> |
| 440 |
<td class="parameter_description"><p>a <a class="link" href="GarconMenuDirectory.html" title="GarconMenuDirectory"><span class="type">GarconMenuDirectory</span></a></p></td> |
| 441 |
<td class="parameter_annotations"> </td> |
| 442 |
</tr> |
| 443 |
<tr> |
| 444 |
<td class="parameter_name"><p>icon_name</p></td> |
| 445 |
<td class="parameter_description"><p>the new icon name for <em class="parameter"><code>directory</code></em> |
| 446 |
.</p></td> |
| 447 |
<td class="parameter_annotations"> </td> |
| 448 |
</tr> |
| 449 |
</tbody> |
| 450 |
</table></div> |
| 451 |
</div> |
| 452 |
</div> |
| 453 |
<hr> |
| 454 |
<div class="refsect2"> |
| 455 |
<a name="garcon-menu-directory-get-no-display"></a><h3>garcon_menu_directory_get_no_display ()</h3> |
| 456 |
<pre class="programlisting"><span class="returnvalue">gboolean</span> |
| 457 |
garcon_menu_directory_get_no_display (<em class="parameter"><code><a class="link" href="GarconMenuDirectory.html" title="GarconMenuDirectory"><span class="type">GarconMenuDirectory</span></a> *directory</code></em>);</pre> |
| 458 |
<p>Whether <em class="parameter"><code>directory</code></em> |
| 459 |
should be displayed. |
| 460 |
For applications you want to call <a class="link" href="GarconMenuDirectory.html#garcon-menu-directory-get-visible" title="garcon_menu_directory_get_visible ()"><code class="function">garcon_menu_directory_get_visible()</code></a>.</p> |
| 461 |
<div class="refsect3"> |
| 462 |
<a name="garcon-menu-directory-get-no-display.parameters"></a><h4>Parameters</h4> |
| 463 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 464 |
<colgroup> |
| 465 |
<col width="150px" class="parameters_name"> |
| 466 |
<col class="parameters_description"> |
| 467 |
<col width="200px" class="parameters_annotations"> |
| 468 |
</colgroup> |
| 469 |
<tbody><tr> |
| 470 |
<td class="parameter_name"><p>directory</p></td> |
| 471 |
<td class="parameter_description"><p>a <a class="link" href="GarconMenuDirectory.html" title="GarconMenuDirectory"><span class="type">GarconMenuDirectory</span></a></p></td> |
| 472 |
<td class="parameter_annotations"> </td> |
| 473 |
</tr></tbody> |
| 474 |
</table></div> |
| 475 |
</div> |
| 476 |
<div class="refsect3"> |
| 477 |
<a name="garcon-menu-directory-get-no-display.returns"></a><h4>Returns</h4> |
| 478 |
<p> a the no-display key for <em class="parameter"><code>directory</code></em> |
| 479 |
.</p> |
| 480 |
</div> |
| 481 |
</div> |
| 482 |
<hr> |
| 483 |
<div class="refsect2"> |
| 484 |
<a name="garcon-menu-directory-set-no-display"></a><h3>garcon_menu_directory_set_no_display ()</h3> |
| 485 |
<pre class="programlisting"><span class="returnvalue">void</span> |
| 486 |
garcon_menu_directory_set_no_display (<em class="parameter"><code><a class="link" href="GarconMenuDirectory.html" title="GarconMenuDirectory"><span class="type">GarconMenuDirectory</span></a> *directory</code></em>, |
| 487 |
<em class="parameter"><code><span class="type">gboolean</span> no_display</code></em>);</pre> |
| 488 |
<p>Set the NoDisplay key of <em class="parameter"><code>directory</code></em> |
| 489 |
.</p> |
| 490 |
<div class="refsect3"> |
| 491 |
<a name="garcon-menu-directory-set-no-display.parameters"></a><h4>Parameters</h4> |
| 492 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 493 |
<colgroup> |
| 494 |
<col width="150px" class="parameters_name"> |
| 495 |
<col class="parameters_description"> |
| 496 |
<col width="200px" class="parameters_annotations"> |
| 497 |
</colgroup> |
| 498 |
<tbody> |
| 499 |
<tr> |
| 500 |
<td class="parameter_name"><p>directory</p></td> |
| 501 |
<td class="parameter_description"><p>a <a class="link" href="GarconMenuDirectory.html" title="GarconMenuDirectory"><span class="type">GarconMenuDirectory</span></a></p></td> |
| 502 |
<td class="parameter_annotations"> </td> |
| 503 |
</tr> |
| 504 |
<tr> |
| 505 |
<td class="parameter_name"><p>no_display</p></td> |
| 506 |
<td class="parameter_description"><p>whether <em class="parameter"><code>directory</code></em> |
| 507 |
should be displayed.</p></td> |
| 508 |
<td class="parameter_annotations"> </td> |
| 509 |
</tr> |
| 510 |
</tbody> |
| 511 |
</table></div> |
| 512 |
</div> |
| 513 |
</div> |
| 514 |
<hr> |
| 515 |
<div class="refsect2"> |
| 516 |
<a name="garcon-menu-directory-get-hidden"></a><h3>garcon_menu_directory_get_hidden ()</h3> |
| 517 |
<pre class="programlisting"><span class="returnvalue">gboolean</span> |
| 518 |
garcon_menu_directory_get_hidden (<em class="parameter"><code><a class="link" href="GarconMenuDirectory.html" title="GarconMenuDirectory"><span class="type">GarconMenuDirectory</span></a> *directory</code></em>);</pre> |
| 519 |
<p>Whether <em class="parameter"><code>directory</code></em> |
| 520 |
should be hidden. |
| 521 |
For applications you want to call <a class="link" href="GarconMenuDirectory.html#garcon-menu-directory-get-visible" title="garcon_menu_directory_get_visible ()"><code class="function">garcon_menu_directory_get_visible()</code></a>.</p> |
| 522 |
<div class="refsect3"> |
| 523 |
<a name="garcon-menu-directory-get-hidden.parameters"></a><h4>Parameters</h4> |
| 524 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 525 |
<colgroup> |
| 526 |
<col width="150px" class="parameters_name"> |
| 527 |
<col class="parameters_description"> |
| 528 |
<col width="200px" class="parameters_annotations"> |
| 529 |
</colgroup> |
| 530 |
<tbody><tr> |
| 531 |
<td class="parameter_name"><p>directory</p></td> |
| 532 |
<td class="parameter_description"><p>a <a class="link" href="GarconMenuDirectory.html" title="GarconMenuDirectory"><span class="type">GarconMenuDirectory</span></a></p></td> |
| 533 |
<td class="parameter_annotations"> </td> |
| 534 |
</tr></tbody> |
| 535 |
</table></div> |
| 536 |
</div> |
| 537 |
<div class="refsect3"> |
| 538 |
<a name="garcon-menu-directory-get-hidden.returns"></a><h4>Returns</h4> |
| 539 |
<p> a the hidden key for <em class="parameter"><code>directory</code></em> |
| 540 |
.</p> |
| 541 |
</div> |
| 542 |
</div> |
| 543 |
<hr> |
| 544 |
<div class="refsect2"> |
| 545 |
<a name="garcon-menu-directory-get-show-in-environment"></a><h3>garcon_menu_directory_get_show_in_environment ()</h3> |
| 546 |
<pre class="programlisting"><span class="returnvalue">gboolean</span> |
| 547 |
garcon_menu_directory_get_show_in_environment |
| 548 |
(<em class="parameter"><code><a class="link" href="GarconMenuDirectory.html" title="GarconMenuDirectory"><span class="type">GarconMenuDirectory</span></a> *directory</code></em>);</pre> |
| 549 |
<p>Whether <em class="parameter"><code>directory</code></em> |
| 550 |
is visible in the current environment |
| 551 |
which has been set by <a class="link" href="garcon-Desktop-Environment-Configuration.html#garcon-set-environment" title="garcon_set_environment ()"><code class="function">garcon_set_environment()</code></a>. |
| 552 |
For applications you want to call <a class="link" href="GarconMenuDirectory.html#garcon-menu-directory-get-visible" title="garcon_menu_directory_get_visible ()"><code class="function">garcon_menu_directory_get_visible()</code></a>.</p> |
| 553 |
<div class="refsect3"> |
| 554 |
<a name="garcon-menu-directory-get-show-in-environment.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>directory</p></td> |
| 563 |
<td class="parameter_description"><p>a <a class="link" href="GarconMenuDirectory.html" title="GarconMenuDirectory"><span class="type">GarconMenuDirectory</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-directory-get-show-in-environment.returns"></a><h4>Returns</h4> |
| 570 |
<p> <code class="literal">TRUE</code> is visible in environment, else <code class="literal">FALSE</code>.</p> |
| 571 |
</div> |
| 572 |
</div> |
| 573 |
<hr> |
| 574 |
<div class="refsect2"> |
| 575 |
<a name="garcon-menu-directory-get-visible"></a><h3>garcon_menu_directory_get_visible ()</h3> |
| 576 |
<pre class="programlisting"><span class="returnvalue">gboolean</span> |
| 577 |
garcon_menu_directory_get_visible (<em class="parameter"><code><a class="link" href="GarconMenuDirectory.html" title="GarconMenuDirectory"><span class="type">GarconMenuDirectory</span></a> *directory</code></em>);</pre> |
| 578 |
<p>Check which runs the following checks: |
| 579 |
<a class="link" href="GarconMenuDirectory.html#garcon-menu-directory-get-show-in-environment" title="garcon_menu_directory_get_show_in_environment ()"><code class="function">garcon_menu_directory_get_show_in_environment()</code></a>, |
| 580 |
<a class="link" href="GarconMenuDirectory.html#garcon-menu-directory-get-hidden" title="garcon_menu_directory_get_hidden ()"><code class="function">garcon_menu_directory_get_hidden()</code></a> and |
| 581 |
<a class="link" href="GarconMenuDirectory.html#garcon-menu-directory-get-no-display" title="garcon_menu_directory_get_no_display ()"><code class="function">garcon_menu_directory_get_no_display()</code></a>.</p> |
| 582 |
<div class="refsect3"> |
| 583 |
<a name="garcon-menu-directory-get-visible.parameters"></a><h4>Parameters</h4> |
| 584 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 585 |
<colgroup> |
| 586 |
<col width="150px" class="parameters_name"> |
| 587 |
<col class="parameters_description"> |
| 588 |
<col width="200px" class="parameters_annotations"> |
| 589 |
</colgroup> |
| 590 |
<tbody><tr> |
| 591 |
<td class="parameter_name"><p>directory</p></td> |
| 592 |
<td class="parameter_description"><p>a <a class="link" href="GarconMenuDirectory.html" title="GarconMenuDirectory"><span class="type">GarconMenuDirectory</span></a></p></td> |
| 593 |
<td class="parameter_annotations"> </td> |
| 594 |
</tr></tbody> |
| 595 |
</table></div> |
| 596 |
</div> |
| 597 |
<div class="refsect3"> |
| 598 |
<a name="garcon-menu-directory-get-visible.returns"></a><h4>Returns</h4> |
| 599 |
<p> if visible <code class="literal">TRUE</code>, else <code class="literal">FALSE</code>.</p> |
| 600 |
</div> |
| 601 |
</div> |
| 602 |
<hr> |
| 603 |
<div class="refsect2"> |
| 604 |
<a name="garcon-menu-directory-equal"></a><h3>garcon_menu_directory_equal ()</h3> |
| 605 |
<pre class="programlisting"><span class="returnvalue">gboolean</span> |
| 606 |
garcon_menu_directory_equal (<em class="parameter"><code><a class="link" href="GarconMenuDirectory.html" title="GarconMenuDirectory"><span class="type">GarconMenuDirectory</span></a> *directory</code></em>, |
| 607 |
<em class="parameter"><code><a class="link" href="GarconMenuDirectory.html" title="GarconMenuDirectory"><span class="type">GarconMenuDirectory</span></a> *other</code></em>);</pre> |
| 608 |
<p>Checks if both directories point to the same file.</p> |
| 609 |
<div class="refsect3"> |
| 610 |
<a name="garcon-menu-directory-equal.parameters"></a><h4>Parameters</h4> |
| 611 |
<div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| 612 |
<colgroup> |
| 613 |
<col width="150px" class="parameters_name"> |
| 614 |
<col class="parameters_description"> |
| 615 |
<col width="200px" class="parameters_annotations"> |
| 616 |
</colgroup> |
| 617 |
<tbody> |
| 618 |
<tr> |
| 619 |
<td class="parameter_name"><p>directory</p></td> |
| 620 |
<td class="parameter_description"><p>a <a class="link" href="GarconMenuDirectory.html" title="GarconMenuDirectory"><span class="type">GarconMenuDirectory</span></a></p></td> |
| 621 |
<td class="parameter_annotations"> </td> |
| 622 |
</tr> |
| 623 |
<tr> |
| 624 |
<td class="parameter_name"><p>other</p></td> |
| 625 |
<td class="parameter_description"><p>a <a class="link" href="GarconMenuDirectory.html" title="GarconMenuDirectory"><span class="type">GarconMenuDirectory</span></a></p></td> |
| 626 |
<td class="parameter_annotations"> </td> |
| 627 |
</tr> |
| 628 |
</tbody> |
| 629 |
</table></div> |
| 630 |
</div> |
| 631 |
<div class="refsect3"> |
| 632 |
<a name="garcon-menu-directory-equal.returns"></a><h4>Returns</h4> |
| 633 |
<p> if files are equal <code class="literal">TRUE</code>, else <code class="literal">FALSE</code>.</p> |
| 634 |
</div> |
| 635 |
</div> |
| 636 |
</div> |
| 637 |
<div class="refsect1"> |
| 638 |
<a name="GarconMenuDirectory.property-details"></a><h2>Property Details</h2> |
| 639 |
<div class="refsect2"> |
| 640 |
<a name="GarconMenuDirectory--comment"></a><h3>The <code class="literal">“comment”</code> property</h3> |
| 641 |
<pre class="programlisting"> “comment” <span class="type">char</span> *</pre> |
| 642 |
<p>Directory description (comment).</p> |
| 643 |
<p>Owner: GarconMenuDirectory</p> |
| 644 |
<p>Flags: Read / Write</p> |
| 645 |
<p>Default value: NULL</p> |
| 646 |
</div> |
| 647 |
<hr> |
| 648 |
<div class="refsect2"> |
| 649 |
<a name="GarconMenuDirectory--file"></a><h3>The <code class="literal">“file”</code> property</h3> |
| 650 |
<pre class="programlisting"> “file” <span class="type">GFile</span> *</pre> |
| 651 |
<p>File.</p> |
| 652 |
<p>Owner: GarconMenuDirectory</p> |
| 653 |
<p>Flags: Read / Write / Construct Only</p> |
| 654 |
</div> |
| 655 |
<hr> |
| 656 |
<div class="refsect2"> |
| 657 |
<a name="GarconMenuDirectory--icon-name"></a><h3>The <code class="literal">“icon-name”</code> property</h3> |
| 658 |
<pre class="programlisting"> “icon-name” <span class="type">char</span> *</pre> |
| 659 |
<p>Icon associated with this directory.</p> |
| 660 |
<p>Owner: GarconMenuDirectory</p> |
| 661 |
<p>Flags: Read / Write</p> |
| 662 |
<p>Default value: NULL</p> |
| 663 |
</div> |
| 664 |
<hr> |
| 665 |
<div class="refsect2"> |
| 666 |
<a name="GarconMenuDirectory--name"></a><h3>The <code class="literal">“name”</code> property</h3> |
| 667 |
<pre class="programlisting"> “name” <span class="type">char</span> *</pre> |
| 668 |
<p>Name of the directory.</p> |
| 669 |
<p>Owner: GarconMenuDirectory</p> |
| 670 |
<p>Flags: Read / Write</p> |
| 671 |
<p>Default value: NULL</p> |
| 672 |
</div> |
| 673 |
<hr> |
| 674 |
<div class="refsect2"> |
| 675 |
<a name="GarconMenuDirectory--no-display"></a><h3>The <code class="literal">“no-display”</code> property</h3> |
| 676 |
<pre class="programlisting"> “no-display” <span class="type">gboolean</span></pre> |
| 677 |
<p>Whether this menu item is hidden in menus.</p> |
| 678 |
<p>Owner: GarconMenuDirectory</p> |
| 679 |
<p>Flags: Read / Write</p> |
| 680 |
<p>Default value: FALSE</p> |
| 681 |
</div> |
| 682 |
</div> |
| 683 |
</div> |
| 684 |
<div class="footer"> |
| 685 |
<hr>Generated by GTK-Doc V1.34.0</div> |
| 686 |
</body> |
| 687 |
</html> |