summaryrefslogtreecommitdiff
path: root/src/lib/efreet/efreet_utils.h
diff options
context:
space:
mode:
authorGustavo Sverzut Barbieri <barbieri@gmail.com>2012-12-29 23:04:40 +0000
committerGustavo Sverzut Barbieri <barbieri@gmail.com>2012-12-29 23:04:40 +0000
commit4bc0210bd31ed1de6554441562bd93ea863ee9d9 (patch)
tree5d83be12538f8c8d3816bbf65916ce383d050c2e /src/lib/efreet/efreet_utils.h
parent727ddbeaf0c53f31cd62c254fdebe26823d537eb (diff)
efl: merge efreet.
seems to be fine, pass distcheck and friends. please report. changes: - documentation hierarchy fixes - replaced __UNUSED__ with EINA_UNUSED - replaced PKG_DATA_DIR with PACKAGE_DATA_DIR"/efreet" SVN revision: 81889
Diffstat (limited to 'src/lib/efreet/efreet_utils.h')
-rw-r--r--src/lib/efreet/efreet_utils.h158
1 files changed, 158 insertions, 0 deletions
diff --git a/src/lib/efreet/efreet_utils.h b/src/lib/efreet/efreet_utils.h
new file mode 100644
index 0000000..4075abc
--- /dev/null
+++ b/src/lib/efreet/efreet_utils.h
@@ -0,0 +1,158 @@
1#ifndef EFREET_UTILS_H
2#define EFREET_UTILS_H
3
4/**
5 * @file efreet_utils.h
6 * @brief Contains utility functions to ease usage of Efreet.
7 * FDO desktop entry specificiation.
8 * @addtogroup Efreet_Utils Efreet utilities for FDO
9 * @ingroup Efreet
10 *
11 * @{
12 */
13
14
15/**
16 * Returns the fdo file id for a given path. If the file isn't inside
17 * a default fdo path it will return NULL.
18 *
19 * @param path The path to find the file id for
20 *
21 * @return File id for path or NULL
22 */
23EAPI const char *efreet_util_path_to_file_id(const char *path);
24
25
26/**
27 * Find all desktops for a given mime type
28 *
29 * This list must be freed using EINA_LIST_FREE / efreet_desktop_free
30 *
31 * @param mime the mime type
32 * @return a list of desktops
33 */
34EAPI Eina_List *efreet_util_desktop_mime_list(const char *mime);
35
36
37/**
38 * Find all desktops for a given wm class
39 *
40 * This list must be freed using EINA_LIST_FREE / efreet_desktop_free
41 *
42 * @param wmname the wm name
43 * @param wmclass the wm class
44 * @return a list of desktops
45 */
46EAPI Efreet_Desktop *efreet_util_desktop_wm_class_find(const char *wmname, const char *wmclass);
47
48/**
49 * Find a desktop by file id
50 *
51 * return value must be freed by efreet_desktop_free
52 *
53 * @param file_id the file id
54 * @return a desktop
55 */
56EAPI Efreet_Desktop *efreet_util_desktop_file_id_find(const char *file_id);
57
58/**
59 * Find a desktop by exec
60 *
61 * return value must be freed by efreet_desktop_free
62 *
63 * @param exec the exec name
64 * @return a desktop
65 */
66EAPI Efreet_Desktop *efreet_util_desktop_exec_find(const char *exec);
67
68/**
69 * Find a desktop by name
70 *
71 * return value must be freed by efreet_desktop_free
72 *
73 * @param name the name
74 * @return a desktop
75 */
76EAPI Efreet_Desktop *efreet_util_desktop_name_find(const char *name);
77
78/**
79 * Find a desktop by generic name
80 *
81 * return value must be freed by efreet_desktop_free
82 *
83 * @param generic_name the generic name
84 * @return a desktop
85 */
86EAPI Efreet_Desktop *efreet_util_desktop_generic_name_find(const char *generic_name);
87
88
89/**
90 * Find all desktops where name matches a glob pattern
91 *
92 * This list must be freed using EINA_LIST_FREE / efreet_desktop_free
93 *
94 * @param glob the pattern to match
95 * @return a list of desktops
96 */
97EAPI Eina_List *efreet_util_desktop_name_glob_list(const char *glob);
98
99/**
100 * Find all desktops where exec matches a glob pattern
101 *
102 * This list must be freed using EINA_LIST_FREE / efreet_desktop_free
103 *
104 * @param glob the pattern to match
105 * @return a list of desktops
106 */
107EAPI Eina_List *efreet_util_desktop_exec_glob_list(const char *glob);
108
109/**
110 * Find all desktops where generic name matches a glob pattern
111 *
112 * This list must be freed using EINA_LIST_FREE / efreet_desktop_free
113 *
114 * @param glob the pattern to match
115 * @return a list of desktops
116 */
117EAPI Eina_List *efreet_util_desktop_generic_name_glob_list(const char *glob);
118
119/**
120 * Find all desktops where comment matches a glob pattern
121 *
122 * This list must be freed using EINA_LIST_FREE / efreet_desktop_free
123 *
124 * @param glob the pattern to match
125 * @return a list of desktops
126 */
127EAPI Eina_List *efreet_util_desktop_comment_glob_list(const char *glob);
128
129
130/**
131 * Find all desktop categories
132 * This list must be freed using EINA_LIST_FREE
133 *
134 * @return an Eina_List of category names (const char *)
135 */
136EAPI Eina_List *efreet_util_desktop_categories_list(void);
137
138/**
139 * Find all desktops in a given category
140 *
141 * This list must be freed using EINA_LIST_FREE / efreet_desktop_free
142 *
143 * @param category the category name
144 * @return a list of desktops
145 */
146EAPI Eina_List *efreet_util_desktop_category_list(const char *category);
147
148
149/**
150 * Returns a list of .menu files found in the various config dirs.
151 * @return An eina list of menu file paths (const char *). This must be freed with EINA_LIST_FREE.
152 */
153EAPI Eina_List *efreet_util_menus_find(void);
154
155/**
156 * @}
157 */
158#endif