GarconMenu

GarconMenu — Menu element.

Synopsis

#include <garcon/garcon.h>

struct              GarconMenuClass;
void                garcon_menu_add_menu                (GarconMenu *menu,
                                                         GarconMenu *submenu);
GarconMenuDirectory * garcon_menu_get_directory         (GarconMenu *menu);
GList *             garcon_menu_get_elements            (GarconMenu *menu);
GFile *             garcon_menu_get_file                (GarconMenu *menu);
GarconMenuItemPool * garcon_menu_get_item_pool          (GarconMenu *menu);
GList *             garcon_menu_get_items               (GarconMenu *menu);
GarconMenu *        garcon_menu_get_menu_with_name      (GarconMenu *menu,
                                                         const gchar *name);
GList *             garcon_menu_get_menus               (GarconMenu *menu);
GarconMenu *        garcon_menu_get_parent              (GarconMenu *menu);
gboolean            garcon_menu_load                    (GarconMenu *menu,
                                                         GCancellable *cancellable,
                                                         GError **error);
GarconMenu *        garcon_menu_new                     (GFile *file);
GarconMenu *        garcon_menu_new_applications        (void);
GarconMenu *        garcon_menu_new_for_path            (const gchar *filename);

Description

Main element the contains the parsed menu.

Details

struct GarconMenuClass

struct GarconMenuClass {
  GObjectClass __parent__;
};

garcon_menu_add_menu ()

void                garcon_menu_add_menu                (GarconMenu *menu,
                                                         GarconMenu *submenu);

Adds submenu as a sub menu to menu.

menu :

 a GarconMenu

submenu :

 a GarconMenu

garcon_menu_get_directory ()

GarconMenuDirectory * garcon_menu_get_directory         (GarconMenu *menu);

Returns the GarconMenuDirectory of menu or NULL if the <Menu> element that corresponds to menu has no valid <Directory> element. The menu directory may contain a lot of useful information about the menu like the display and icon name, desktop environments it should show up in etc.

menu :

 a GarconMenu.

Returns :

 GarconMenuDirectory of menu or NULL if menu has no valid directory element. The returned object should be unreffed with g_object_unref() when no longer needed.

garcon_menu_get_elements ()

GList *             garcon_menu_get_elements            (GarconMenu *menu);

Get all the menu element in menu. This contains sub menus, menu items and separators.

menu :

 a GarconMenu.

Returns :

 a list of GarconMenuItem elements or NULL. Free the list with g_list_free().

garcon_menu_get_file ()

GFile *             garcon_menu_get_file                (GarconMenu *menu);

Get the file for menu. It refers to the .menu file from which menu was or will be loaded.

menu :

 a GarconMenu.

Returns :

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

garcon_menu_get_item_pool ()

GarconMenuItemPool * garcon_menu_get_item_pool          (GarconMenu *menu);

Get the item pool of the menu. This pool contains all items in this menu (for that of its submenus).

menu :

 a GarconMenu.

Returns :

 a GarconMenuItemPool.

garcon_menu_get_items ()

GList *             garcon_menu_get_items               (GarconMenu *menu);

Returns all GarconMenuItems included in menu. The items are sorted by their display names in ascending order.

The caller is responsible to free the returned list using 

1
2
3
4