|  |  |  | garcon Reference Manual |  | 
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Properties | ||||
#include <garcon/garcon.h>
                    GarconMenuDirectoryPrivate;
                    GarconMenuDirectoryClass;
                    GarconMenuDirectory;
GarconMenuDirectory * garcon_menu_directory_new         (GFile *file);
GFile *             garcon_menu_directory_get_file      (GarconMenuDirectory *directory);
const gchar *       garcon_menu_directory_get_name      (GarconMenuDirectory *directory);
void                garcon_menu_directory_set_name      (GarconMenuDirectory *directory,
                                                         const gchar *name);
const gchar *       garcon_menu_directory_get_comment   (GarconMenuDirectory *directory);
void                garcon_menu_directory_set_comment   (GarconMenuDirectory *directory,
                                                         const gchar *comment);
const gchar *       garcon_menu_directory_get_icon_name (GarconMenuDirectory *directory);
void                garcon_menu_directory_set_icon_name (GarconMenuDirectory *directory,
                                                         const gchar *icon);
gboolean            garcon_menu_directory_get_no_display
                                                        (GarconMenuDirectory *directory);
void                garcon_menu_directory_set_no_display
                                                        (GarconMenuDirectory *directory,
                                                         gboolean no_display);
gboolean            garcon_menu_directory_get_hidden    (GarconMenuDirectory *directory);
gboolean            garcon_menu_directory_get_show_in_environment
                                                        (GarconMenuDirectory *directory);
gboolean            garcon_menu_directory_get_visible   (GarconMenuDirectory *directory);
gboolean            garcon_menu_directory_equal         (GarconMenuDirectory *directory,
                                                         GarconMenuDirectory *other);
"comment" gchar* : Read / Write "file" GFile* : Read / Write / Construct Only "icon-name" gchar* : Read / Write "name" gchar* : Read / Write "no-display" gboolean : Read / Write
Element that represents a .directory file in the menu configurations.
Each menu (except for the root menu) has a GarconMenuDirectory,
see garcon_menu_get_directory().
GarconMenuDirectory * garcon_menu_directory_new         (GFile *file);
Create a new GarconMenuDirectory for file. You most likely never
use this, but retrieve the info from garcon_menu_get_directory().
| 
 | a GFile | 
| Returns : | a GarconMenuDirectory. | 
GFile *             garcon_menu_directory_get_file      (GarconMenuDirectory *directory);
Get the file for directory.
| 
 | a GarconMenuDirectory | 
| Returns : | a GFile. The returned object
should be unreffed with g_object_unref()when no longer needed. | 
const gchar *       garcon_menu_directory_get_name      (GarconMenuDirectory *directory);
Get the name of directory.
| 
 | a GarconMenuDirectory | 
| Returns : | a the name for directory. | 
void garcon_menu_directory_set_name (GarconMenuDirectory *directory,const gchar *name);
Set the name of directory.
| 
 | a GarconMenuDirectory | 
| 
 | the new name for directory. | 
const gchar *       garcon_menu_directory_get_comment   (GarconMenuDirectory *directory);
Get the comment of directory.
| 
 | a GarconMenuDirectory | 
| Returns : | a the description for directory. | 
void garcon_menu_directory_set_comment (GarconMenuDirectory *directory,const gchar *comment);
Set the comment of directory.
| 
 | a GarconMenuDirectory | 
| 
 | the new description for directory. | 
const gchar *       garcon_menu_directory_get_icon_name (GarconMenuDirectory *directory);
Get the icon name of directory.
| 
 | a GarconMenuDirectory | 
| Returns : | a the icon-name key for directory. | 
void garcon_menu_directory_set_icon_name (GarconMenuDirectory *directory,const gchar *icon);
Set the icon name of directory.
| 
 | a GarconMenuDirectory | 
| 
 | 
gboolean            garcon_menu_directory_get_no_display
                                                        (GarconMenuDirectory *directory);
Whether directory should be displayed.
For applications you want to call garcon_menu_directory_get_visible().
| 
 | a GarconMenuDirectory | 
| Returns : | a the no-display key for directory. | 
void garcon_menu_directory_set_no_display (GarconMenuDirectory *directory,gboolean no_display);
Set the NoDisplay key of directory.
| 
 | a GarconMenuDirectory | 
| 
 | whether directoryshould be displayed. | 
gboolean            garcon_menu_directory_get_hidden    (GarconMenuDirectory *directory);
Whether directory should be hidden.
For applications you want to call garcon_menu_directory_get_visible().
| 
 | a GarconMenuDirectory | 
| Returns : | a the hidden key for directory. | 
gboolean            garcon_menu_directory_get_show_in_environment
                                                        (GarconMenuDirectory *directory);
Whether directory is visible in the current environment
which has been set by garcon_set_environment().
For applications you want to call garcon_menu_directory_get_visible().
| 
 | a GarconMenuDirectory | 
| Returns : | TRUEis visible in environment, elseFALSE. | 
gboolean            garcon_menu_directory_get_visible   (GarconMenuDirectory *directory);
Check which runs the following checks:
garcon_menu_directory_get_show_in_environment(),
garcon_menu_directory_get_hidden() and
garcon_menu_directory_get_no_display().
| 
 | a GarconMenuDirectory | 
| Returns : | if visible TRUE, elseFALSE. | 
gboolean garcon_menu_directory_equal (GarconMenuDirectory *directory,GarconMenuDirectory *other);
Checks if both directories point to the same file.
| 
 | a GarconMenuDirectory | 
| 
 | a GarconMenuDirectory | 
| Returns : | if files are equal TRUE, elseFALSE. | 
"comment" property"comment" gchar* : Read / Write
Directory description (comment).
Default value: NULL
"icon-name" property"icon-name" gchar* : Read / Write
Icon associated with this directory.
Default value: NULL
"no-display" property"no-display" gboolean : Read / Write
Whether this menu item is hidden in menus.
Default value: FALSE