summaryrefslogtreecommitdiff
path: root/legacy/elementary/src/lib/elm_theme.h
diff options
context:
space:
mode:
authorChunEon Park <hermet@hermet.pe.kr>2012-04-17 01:35:46 +0000
committerChunEon Park <hermet@hermet.pe.kr>2012-04-17 01:35:46 +0000
commit855b8d2709e34532ddcfb81769640cfbfc15ae34 (patch)
tree5d11673f73f567592086fd4b23258372645efb0e /legacy/elementary/src/lib/elm_theme.h
parent347f4065e5d44af83c95f0c9f1bdbe866d600d44 (diff)
elementary - +ingroup, fixed indentations.
SVN revision: 70249
Diffstat (limited to '')
-rw-r--r--legacy/elementary/src/lib/elm_theme.h47
1 files changed, 47 insertions, 0 deletions
diff --git a/legacy/elementary/src/lib/elm_theme.h b/legacy/elementary/src/lib/elm_theme.h
index 86cc0c10..10c5f6a 100644
--- a/legacy/elementary/src/lib/elm_theme.h
+++ b/legacy/elementary/src/lib/elm_theme.h
@@ -1,5 +1,6 @@
1/** 1/**
2 * @defgroup Theme Theme 2 * @defgroup Theme Theme
3 * @ingroup Elementary
3 * 4 *
4 * Elementary uses Edje to theme its widgets, naturally. But for the most 5 * Elementary uses Edje to theme its widgets, naturally. But for the most
5 * part this is hidden behind a simpler interface that lets the user set 6 * part this is hidden behind a simpler interface that lets the user set
@@ -91,6 +92,8 @@ typedef struct _Elm_Theme Elm_Theme;
91 * actually apply it yet. The child of the scroller will have a specific 92 * actually apply it yet. The child of the scroller will have a specific
92 * theme set to show this preview before the user decides to apply it to all 93 * theme set to show this preview before the user decides to apply it to all
93 * applications). 94 * applications).
95 *
96 * @ingroup Theme
94 */ 97 */
95EAPI Elm_Theme *elm_theme_new(void); 98EAPI Elm_Theme *elm_theme_new(void);
96 99
@@ -100,6 +103,8 @@ EAPI Elm_Theme *elm_theme_new(void);
100 * @param th The theme to free 103 * @param th The theme to free
101 * 104 *
102 * This frees a theme created with elm_theme_new(). 105 * This frees a theme created with elm_theme_new().
106 *
107 * @ingroup Theme
103 */ 108 */
104EAPI void elm_theme_free(Elm_Theme *th); 109EAPI void elm_theme_free(Elm_Theme *th);
105 110
@@ -113,6 +118,8 @@ EAPI void elm_theme_free(Elm_Theme *th);
113 * and overlays from @p th to @p thdst. If @p th references a theme, then 118 * and overlays from @p th to @p thdst. If @p th references a theme, then
114 * @p thdst is also set to reference it, with all the theme settings, 119 * @p thdst is also set to reference it, with all the theme settings,
115 * overlays and extensions that @p th had. 120 * overlays and extensions that @p th had.
121 *
122 * @ingroup Theme
116 */ 123 */
117EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst); 124EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
118 125
@@ -125,6 +132,8 @@ EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
125 * This clears @p th to be empty and then sets it to refer to @p thref 132 * This clears @p th to be empty and then sets it to refer to @p thref
126 * so @p th acts as an override to @p thref, but where its overrides 133 * so @p th acts as an override to @p thref, but where its overrides
127 * don't apply, it will fall through to @p thref for configuration. 134 * don't apply, it will fall through to @p thref for configuration.
135 *
136 * @ingroup Theme
128 */ 137 */
129EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref); 138EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
130 139
@@ -136,6 +145,8 @@ EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
136 * 145 *
137 * This gets the theme set as the reference theme by elm_theme_ref_set(). 146 * This gets the theme set as the reference theme by elm_theme_ref_set().
138 * If no theme is set as a reference, NULL is returned. 147 * If no theme is set as a reference, NULL is returned.
148 *
149 * @ingroup Theme
139 */ 150 */
140EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th); 151EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
141 152
@@ -147,6 +158,8 @@ EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
147 * This returns the internal default theme setup handle that all widgets 158 * This returns the internal default theme setup handle that all widgets
148 * use implicitly unless a specific theme is set. This is also often use 159 * use implicitly unless a specific theme is set. This is also often use
149 * as a shorthand of NULL. 160 * as a shorthand of NULL.
161 *
162 * @ingroup Theme
150 */ 163 */
151EAPI Elm_Theme *elm_theme_default_get(void); 164EAPI Elm_Theme *elm_theme_default_get(void);
152 165
@@ -166,6 +179,8 @@ EAPI Elm_Theme *elm_theme_default_get(void);
166 * of trouble. 179 * of trouble.
167 * 180 *
168 * @see elm_theme_extension_add() 181 * @see elm_theme_extension_add()
182 *
183 * @ingroup Theme
169 */ 184 */
170EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item); 185EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
171 186
@@ -176,6 +191,8 @@ EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
176 * @param item The name of the theme overlay 191 * @param item The name of the theme overlay
177 * 192 *
178 * @see elm_theme_overlay_add() 193 * @see elm_theme_overlay_add()
194 *
195 * @ingroup Theme
179 */ 196 */
180EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item); 197EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
181 198
@@ -186,6 +203,8 @@ EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
186 * @return List of theme overlays. Do not free it. 203 * @return List of theme overlays. Do not free it.
187 * 204 *
188 * @see elm_theme_overlay_add() 205 * @see elm_theme_overlay_add()
206 *
207 * @ingroup Theme
189 */ 208 */
190EAPI const Eina_List *elm_theme_overlay_list_get(const Elm_Theme *th); 209EAPI const Eina_List *elm_theme_overlay_list_get(const Elm_Theme *th);
191 210
@@ -207,6 +226,8 @@ EAPI const Eina_List *elm_theme_overlay_list_get(const Elm_Theme *th);
207 * Use this call instead of elm_theme_overlay_add() for almost all cases. 226 * Use this call instead of elm_theme_overlay_add() for almost all cases.
208 * 227 *
209 * @see elm_object_style_set() 228 * @see elm_object_style_set()
229 *
230 * @ingroup Theme
210 */ 231 */
211EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item); 232EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
212 233
@@ -217,6 +238,8 @@ EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
217 * @param item The name of the theme extension 238 * @param item The name of the theme extension
218 * 239 *
219 * @see elm_theme_extension_add() 240 * @see elm_theme_extension_add()
241 *
242 * @ingroup Theme
220 */ 243 */
221EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item); 244EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
222 245
@@ -227,6 +250,8 @@ EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
227 * @return List of theme extensions. Do not free it. 250 * @return List of theme extensions. Do not free it.
228 * 251 *
229 * @see elm_theme_extension_add() 252 * @see elm_theme_extension_add()
253 *
254 * @ingroup Theme
230 */ 255 */
231EAPI const Eina_List *elm_theme_extension_list_get(const Elm_Theme *th); 256EAPI const Eina_List *elm_theme_extension_list_get(const Elm_Theme *th);
232 257
@@ -245,6 +270,8 @@ EAPI const Eina_List *elm_theme_extension_list_get(const Elm_Theme *th);
245 * 270 *
246 * @see elm_theme_get() 271 * @see elm_theme_get()
247 * @see elm_theme_list_get() 272 * @see elm_theme_list_get()
273 *
274 * @ingroup Theme
248 */ 275 */
249EAPI void elm_theme_set(Elm_Theme *th, const char *theme); 276EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
250 277
@@ -259,6 +286,8 @@ EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
259 * 286 *
260 * @see elm_theme_set() 287 * @see elm_theme_set()
261 * @see elm_theme_list_get() 288 * @see elm_theme_list_get()
289 *
290 * @ingroup Theme
262 */ 291 */
263EAPI const char *elm_theme_get(Elm_Theme *th); 292EAPI const char *elm_theme_get(Elm_Theme *th);
264 293
@@ -280,6 +309,8 @@ EAPI const char *elm_theme_get(Elm_Theme *th);
280 * 309 *
281 * @see elm_theme_set() 310 * @see elm_theme_set()
282 * @see elm_theme_get() 311 * @see elm_theme_get()
312 *
313 * @ingroup Theme
283 */ 314 */
284EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th); 315EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
285 316
@@ -298,6 +329,8 @@ EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
298 * relative to home. The @p in_search_path boolean pointed to is set to 329 * relative to home. The @p in_search_path boolean pointed to is set to
299 * EINA_TRUE if the file was a search-able file and is in the search path, 330 * EINA_TRUE if the file was a search-able file and is in the search path,
300 * and EINA_FALSE otherwise. 331 * and EINA_FALSE otherwise.
332 *
333 * @ingroup Theme
301 */ 334 */
302EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path); 335EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
303 336
@@ -310,6 +343,8 @@ EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_
310 * in the given theme. If @p th is NULL, then the default theme is flushed. 343 * in the given theme. If @p th is NULL, then the default theme is flushed.
311 * Call this function if source theme data has changed in such a way as to 344 * Call this function if source theme data has changed in such a way as to
312 * make any caches Elementary kept invalid. 345 * make any caches Elementary kept invalid.
346 *
347 * @ingroup Theme
313 */ 348 */
314EAPI void elm_theme_flush(Elm_Theme *th); 349EAPI void elm_theme_flush(Elm_Theme *th);
315 350
@@ -318,6 +353,8 @@ EAPI void elm_theme_flush(Elm_Theme *th);
318 * 353 *
319 * This will flush all themes in the current application context, by calling 354 * This will flush all themes in the current application context, by calling
320 * elm_theme_flush() on each of them. 355 * elm_theme_flush() on each of them.
356 *
357 * @ingroup Theme
321 */ 358 */
322EAPI void elm_theme_full_flush(void); 359EAPI void elm_theme_full_flush(void);
323 360
@@ -330,6 +367,8 @@ EAPI void elm_theme_full_flush(void);
330 * for theme elements, and returns them in alphabetical order as theme 367 * for theme elements, and returns them in alphabetical order as theme
331 * element names in a list of strings. Free this with 368 * element names in a list of strings. Free this with
332 * elm_theme_name_available_list_free() when you are done with the list. 369 * elm_theme_name_available_list_free() when you are done with the list.
370 *
371 * @ingroup Theme
333 */ 372 */
334EAPI Eina_List *elm_theme_name_available_list_new(void); 373EAPI Eina_List *elm_theme_name_available_list_new(void);
335 374
@@ -339,6 +378,8 @@ EAPI Eina_List *elm_theme_name_available_list_new(void);
339 * This frees the list of themes returned by 378 * This frees the list of themes returned by
340 * elm_theme_name_available_list_new(). Once freed the list should no longer 379 * elm_theme_name_available_list_new(). Once freed the list should no longer
341 * be used. a new list mys be created. 380 * be used. a new list mys be created.
381 *
382 * @ingroup Theme
342 */ 383 */
343EAPI void elm_theme_name_available_list_free(Eina_List *list); 384EAPI void elm_theme_name_available_list_free(Eina_List *list);
344 385
@@ -356,6 +397,8 @@ EAPI void elm_theme_name_available_list_free(Eina_List *list);
356 * Use special themes with great care as this will annoy users and make 397 * Use special themes with great care as this will annoy users and make
357 * configuration difficult. Avoid any custom themes at all if it can be 398 * configuration difficult. Avoid any custom themes at all if it can be
358 * helped. 399 * helped.
400 *
401 * @ingroup Theme
359 */ 402 */
360EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th); 403EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th);
361 404
@@ -369,6 +412,8 @@ EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th);
369 * set on that object. It will not return inherited themes from parents, only 412 * set on that object. It will not return inherited themes from parents, only
370 * the specific theme set for that specific object. See elm_object_theme_set() 413 * the specific theme set for that specific object. See elm_object_theme_set()
371 * for more information. 414 * for more information.
415 *
416 * @ingroup Theme
372 */ 417 */
373EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj); 418EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj);
374 419
@@ -381,6 +426,8 @@ EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj);
381 * 426 *
382 * This function is used to return data items from edc in @p th, an overlay, or an extension. 427 * This function is used to return data items from edc in @p th, an overlay, or an extension.
383 * It works the same way as edje_file_data_get() except that the return is stringshared. 428 * It works the same way as edje_file_data_get() except that the return is stringshared.
429 *
430 * @ingroup Theme
384 */ 431 */
385EAPI const char *elm_theme_data_get(Elm_Theme *th, const char *key); 432EAPI const char *elm_theme_data_get(Elm_Theme *th, const char *key);
386 433