GarconMenuDirectory

GarconMenuDirectory — Garcon element for .directory files.

Synopsis

#include <garcon/garcon.h>

struct              GarconMenuDirectoryClass;
gboolean            garcon_menu_directory_equal         (GarconMenuDirectory *directory,
                                                         GarconMenuDirectory *other);
const gchar *       garcon_menu_directory_get_comment   (GarconMenuDirectory *directory);
GFile *             garcon_menu_directory_get_file      (GarconMenuDirectory *directory);
gboolean            garcon_menu_directory_get_hidden    (GarconMenuDirectory *directory);
const gchar *       garcon_menu_directory_get_icon_name (GarconMenuDirectory *directory);
const gchar *       garcon_menu_directory_get_name      (GarconMenuDirectory *directory);
gboolean            garcon_menu_directory_get_no_display
                                                        (GarconMenuDirectory *directory);
gboolean            garcon_menu_directory_get_show_in_environment
                                                        (GarconMenuDirectory *directory);
gboolean            garcon_menu_directory_get_visible   (GarconMenuDirectory *directory);
GarconMenuDirectory * garcon_menu_directory_new         (GFile *file);
void                garcon_menu_directory_set_comment   (GarconMenuDirectory *directory,
                                                         const gchar *comment);
void                garcon_menu_directory_set_icon_name (GarconMenuDirectory *directory,
                                                         const gchar *icon);
void                garcon_menu_directory_set_name      (GarconMenuDirectory *directory,
                                                         const gchar *name);
void                garcon_menu_directory_set_no_display
                                                        (GarconMenuDirectory *directory,
                                                         gboolean no_display);

Description

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().

Details

struct GarconMenuDirectoryClass

struct GarconMenuDirectoryClass {
  GObjectClass __parent__;
};


garcon_menu_directory_equal ()

gboolean            garcon_menu_directory_equal         (GarconMenuDirectory *directory,
                                                         GarconMenuDirectory *other);

Checks if both directories point to the same file.

directory :

a GarconMenuDirectory

other :

a GarconMenuDirectory

Returns :

if files are equal TRUE, else FALSE.

garcon_menu_directory_get_comment ()

const gchar *       garcon_menu_directory_get_comment   (GarconMenuDirectory *directory);

Get the comment of directory.

directory :

a GarconMenuDirectory

Returns :

a the description for directory.

garcon_menu_directory_get_file ()

GFile *             garcon_menu_directory_get_file      (GarconMenuDirectory *directory);

Get the file for directory.

directory :

a GarconMenuDirectory

Returns :

a GFile. The returned object should be unreffed with g_object_unref() when no longer needed.

garcon_menu_directory_get_hidden ()

gboolean            garcon_menu_directory_get_hidden    (GarconMenuDirectory *directory);

Whether directory should be hidden. For applications you want to call garcon_menu_directory_get_visible().

directory :

a GarconMenuDirectory

Returns :

a the hidden key for directory.

garcon_menu_directory_get_icon_name ()

const gchar *       garcon_menu_directory_get_icon_name (GarconMenuDirectory *directory);

Get the icon name of directory.

directory :

a GarconMenuDirectory

Returns :

a the icon-name key for directory.

garcon_menu_directory_get_name ()

const gchar *       garcon_menu_directory_get_name      (GarconMenuDirectory *directory);

Get the name of directory.

directory :

a GarconMenuDirectory

Returns :

a the name for directory.

garcon_menu_directory_get_no_display ()

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().

directory :

a GarconMenuDirectory

Returns :

a the no-display key for directory.

garcon_menu_directory_get_show_in_environment ()

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().

directory :

a GarconMenuDirectory

Returns :

TRUE is visible in environment, else FALSE.

garcon_menu_directory_get_visible ()

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().

directory :

a GarconMenuDirectory

Returns :

if visible TRUE, else FALSE.

garcon_menu_directory_new ()

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().

file :

a GFile

Returns :

a GarconMenuDirectory.

garcon_menu_directory_set_comment ()

void                garcon_menu_directory_set_comment   (GarconMenuDirectory *directory,
                                                         const gchar *comment);

Set the comment of directory.

directory :

a GarconMenuDirectory

comment :

the new description for directory.

garcon_menu_directory_set_icon_name ()

void                garcon_menu_directory_set_icon_name (GarconMenuDirectory *directory,
                                                         const gchar *icon);

Set the icon name of directory.

directory :

a GarconMenuDirectory

garcon_menu_directory_set_name ()

void                garcon_menu_directory_set_name      (GarconMenuDirectory *directory,
                                                         const gchar *name);

Set the name of directory.

directory :

a GarconMenuDirectory

name :

the new name for directory.

garcon_menu_directory_set_no_display ()

void                garcon_menu_directory_set_no_display
                                                        (GarconMenuDirectory *directory,
                                                         gboolean no_display);

Set the NoDisplay key of directory.

directory :

a GarconMenuDirectory

no_display :

whether directory should be displayed.