News

Documentation

Efreet_Menu: The FDO Desktop Menu Specification


Detailed Description

functions and structures


Data Structures

struct  Efreet_Menu

Typedefs

typedef Efreet_Menu Efreet_Menu
typedef enum Efreet_Menu_Entry_Type Efreet_Menu_Entry_Type

Enumerations

enum  Efreet_Menu_Entry_Type { EFREET_MENU_ENTRY_MENU, EFREET_MENU_ENTRY_DESKTOP, EFREET_MENU_ENTRY_SEPARATOR, EFREET_MENU_ENTRY_HEADER }

Functions

int efreet_menu_desktop_insert (Efreet_Menu *menu, Efreet_Desktop *desktop, int pos)
 Insert a desktop element in a menu structure. Only accepts desktop files in default directories.
int efreet_menu_desktop_remove (Efreet_Menu *menu, Efreet_Desktop *desktop)
 Remove a desktop element in a menu structure. Only accepts desktop files in default directories.
void efreet_menu_dump (Efreet_Menu *menu, const char *indent)
 Dumps the contents of the menu to the command line.
void efreet_menu_free (Efreet_Menu *menu)
Efreet_Menuefreet_menu_get (void)
 Creates the default menu representation.
int efreet_menu_kde_legacy_init (void)
 Initialize legacy kde support. This function blocks while the kde-config script is run.
Efreet_Menuefreet_menu_parse (const char *path)
 Parses the given .menu file and creates the menu representation.
int efreet_menu_save (Efreet_Menu *menu, const char *path)
 Saves the menu to file.

Typedef Documentation

typedef struct Efreet_Menu Efreet_Menu

Efreet_Menu_Entry_Type


Enumeration Type Documentation

The type of entry

Enumerator:
EFREET_MENU_ENTRY_MENU 
EFREET_MENU_ENTRY_DESKTOP 
EFREET_MENU_ENTRY_SEPARATOR 
EFREET_MENU_ENTRY_HEADER 


Function Documentation

int efreet_menu_desktop_insert ( Efreet_Menu menu,
Efreet_Desktop desktop,
int  pos 
)

Insert a desktop element in a menu structure. Only accepts desktop files in default directories.

Parameters:
menu,: The menu to work with
desktop,: The desktop to insert
Returns:
Returns 1 on success, 0 on failure

int efreet_menu_desktop_remove ( Efreet_Menu menu,
Efreet_Desktop desktop 
)

Remove a desktop element in a menu structure. Only accepts desktop files in default directories.

Parameters:
desktop,: The desktop to remove
Returns:
Returns 1 on success, 0 on failure

void efreet_menu_dump ( Efreet_Menu menu,
const char *  indent 
)

Dumps the contents of the menu to the command line.

Parameters:
menu,: The menu to work with
menu,: The menu to work with
indent,: The indent level to print the menu at
Returns:
Returns no value

void efreet_menu_free ( Efreet_Menu menu  ) 

Efreet_Menu* efreet_menu_get ( void   ) 

Creates the default menu representation.

Returns:
Returns the Efreet_Menu_Internal representation of the default menu or NULL if none found

int efreet_menu_kde_legacy_init ( void   ) 

Initialize legacy kde support. This function blocks while the kde-config script is run.

Returns:
Returns no value

Efreet_Menu* efreet_menu_parse ( const char *  path  ) 

Parses the given .menu file and creates the menu representation.

Parameters:
path,: The path of the menu to load
Returns:
Returns the Efreet_Menu_Internal representation on success or NULL on failure

int efreet_menu_save ( Efreet_Menu menu,
const char *  path 
)

Saves the menu to file.

Parameters:
menu,: The menu to work with
path,: The path where the menu should be saved
Returns:
Returns 1 on success, 0 on failure


Copyright © Enlightenment.org

Efreet Documentation Generated: Sat Apr 7 17:55:55 2007