1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
|
#ifndef EFREET_MENU_H
#define EFREET_MENU_H
/**
* @file efreet_menu.h
* @brief Contains the structures and methods to support the Desktop
* Menu Specification.
* @addtogroup Efreet_Menu Efreet_Menu: The FDO Desktop Menu Specification
* functions and structures
* @ingroup Efreet
*
* @{
*/
/**
* The type of entry
*/
typedef enum Efreet_Menu_Entry_Type
{
EFREET_MENU_ENTRY_MENU,
EFREET_MENU_ENTRY_DESKTOP,
EFREET_MENU_ENTRY_SEPARATOR,
EFREET_MENU_ENTRY_HEADER
} Efreet_Menu_Entry_Type;
/**
* Efreet_Menu
*/
typedef struct Efreet_Menu Efreet_Menu;
/**
* Efreet_Menu
* Stores information on a entry in the menu
*/
struct Efreet_Menu
{
Efreet_Menu_Entry_Type type;
const char *id; /**< File-id for desktop and relative name for menu */
const char *name; /**< Name this entry should show */
const char *icon; /**< Icon for this entry */
Efreet_Desktop *desktop; /**< The desktop we refer too */
Eina_List *entries; /**< The menu items */
int references; /**< refcount (keeps menu util ref is at 0) @since 1.11 */
};
/**
* A callback used with efreet_menu_async_get() and efreet_menu_async_parse()
*
* @since 1.8
*/
typedef void (*Efreet_Menu_Cb) (void *data, Efreet_Menu *menu);
/**
* @return Returns no value
* @brief Initialize legacy kde support. This function blocks while
* the kde-config script is run.
*/
EAPI int efreet_menu_kde_legacy_init(void);
/**
* @param name The internal name of the menu
* @return Returns the Efreet_Menu on success or
* NULL on failure
* @brief Creates a new menu
*/
EAPI Efreet_Menu *efreet_menu_new(const char *name);
/**
* @brief Override which file is used for menu creation
* @param file The file to use for menu creation
*
* This file is only used if it exists, else the standard files will be used
* for the menu.
*/
EAPI void efreet_menu_file_set(const char *file);
/**
* Creates the Efreet_Menu representation of the default menu or
* NULL if none found and returns it in the callback.
* @param func function to call when menu is created
* @param data user data to return in callback
*
* @since 1.8
*/
EAPI void efreet_menu_async_get(Efreet_Menu_Cb func, const void *data);
/**
* @return Returns the Efreet_Menu representation of the default menu or
* NULL if none found
* @brief Creates the default menu representation
*/
EAPI Efreet_Menu *efreet_menu_get(void);
/**
* Parses the given .menu file and creates the menu representation, and
* returns it in the callback
* @param path The path of the menu to load
* @param func function to call when menu is created
* @param data user data to return in callback
*
* @since 1.8
*/
EAPI void efreet_menu_async_parse(const char *path, Efreet_Menu_Cb func, const void *data);
/**
* @param path The path of the menu to load
* @return Returns the Efreet_Menu representation on success or NULL on
* failure
* @brief Parses the given .menu file and creates the menu representation
*/
EAPI Efreet_Menu *efreet_menu_parse(const char *path);
/**
* @param menu The menu to work with
* @param path The path where the menu should be saved
* @return Returns 1 on success, 0 on failure
* @brief Saves the menu to file
*/
EAPI int efreet_menu_save(Efreet_Menu *menu, const char *path);
/**
* @param menu The Efreet_Menu to free
* @return Returns no value
* @brief Frees the given structure (if refcount at 1 at the time of this call)
*/
EAPI void efreet_menu_free(Efreet_Menu *menu);
/**
* @param menu The Efreet_Menu to reference
* @return Returns no value
* @brief Incriments refcount for the menu
* @since 1.11
*/
EAPI void efreet_menu_ref(Efreet_Menu *menu);
/**
* @param menu The Efreet_Menu to unreference
* @return Returns no value
* @brief Decrements refcount for the menu, and on 0 frees
* @since 1.11
*/
EAPI void efreet_menu_unref(Efreet_Menu *menu);
/**
* @param menu The menu to work with
* @param desktop The desktop to insert
* @param pos The position to place the new desktop
* @return Returns 1 on success, 0 on failure
* @brief Insert a desktop element in a menu structure. Only accepts desktop files
* in default directories.
*/
EAPI int efreet_menu_desktop_insert(Efreet_Menu *menu,
Efreet_Desktop *desktop,
int pos);
/**
* @param menu The menu to work with
* @param desktop The desktop to remove
* @return Returns 1 on success, 0 on failure
* @brief Remove a desktop element in a menu structure. Only accepts desktop files
* in default directories.
*/
EAPI int efreet_menu_desktop_remove(Efreet_Menu *menu,
Efreet_Desktop *desktop);
/**
* @param menu The menu to work with
* @param menu The menu to work with
* @param indent The indent level to print the menu at
* @return Returns no value
* @brief Dumps the contents of the menu to the command line
*/
EAPI void efreet_menu_dump(Efreet_Menu *menu, const char *indent);
/**
* @}
*/
#endif
|
