summaryrefslogtreecommitdiff
path: root/legacy/elementary/src/lib/elm_theme.h
diff options
context:
space:
mode:
authorStefan Schmidt <stefan@osg.samsung.com>2016-03-16 22:52:23 +0100
committerStefan Schmidt <stefan@osg.samsung.com>2016-03-16 22:52:23 +0100
commit407a717200f51cbdce60049f05d9bd271d6183b1 (patch)
treed0b1c4b5bd7792ca2bcb14eeb14190c683fb7467 /legacy/elementary/src/lib/elm_theme.h
parent6dcd4f6287b9164a3d52a7770c4b46b7500c0151 (diff)
docs: bring back docs from eo files by switching to the new group name
During the migration of docs to the eo file the group name changed to have a Elm_ prefix which resulted in our docs not including this group and not showing any of the docs in there. Switching to the new name fixes this. Having this prefix makes sense especially as we are now merging elm into efl. Hopefully that will be the last change. @fix Ref T3109
Diffstat (limited to '')
-rw-r--r--legacy/elementary/src/lib/elm_theme.h64
1 files changed, 32 insertions, 32 deletions
diff --git a/legacy/elementary/src/lib/elm_theme.h b/legacy/elementary/src/lib/elm_theme.h
index b5a1dbd..cb524b2 100644
--- a/legacy/elementary/src/lib/elm_theme.h
+++ b/legacy/elementary/src/lib/elm_theme.h
@@ -1,5 +1,5 @@
1/** 1/**
2 * @defgroup Theme Theme 2 * @defgroup Elm_Theme Theme
3 * @ingroup Elementary 3 * @ingroup Elementary
4 * 4 *
5 * 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
@@ -93,7 +93,7 @@ typedef struct _Elm_Theme Elm_Theme;
93 * 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
94 * applications). 94 * applications).
95 * 95 *
96 * @ingroup Theme 96 * @ingroup Elm_Theme
97 */ 97 */
98EAPI Elm_Theme *elm_theme_new(void); 98EAPI Elm_Theme *elm_theme_new(void);
99 99
@@ -104,7 +104,7 @@ EAPI Elm_Theme *elm_theme_new(void);
104 * 104 *
105 * This frees a theme created with elm_theme_new(). 105 * This frees a theme created with elm_theme_new().
106 * 106 *
107 * @ingroup Theme 107 * @ingroup Elm_Theme
108 */ 108 */
109EAPI void elm_theme_free(Elm_Theme *th); 109EAPI void elm_theme_free(Elm_Theme *th);
110 110
@@ -119,7 +119,7 @@ EAPI void elm_theme_free(Elm_Theme *th);
119 * @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,
120 * overlays and extensions that @p th had. 120 * overlays and extensions that @p th had.
121 * 121 *
122 * @ingroup Theme 122 * @ingroup Elm_Theme
123 */ 123 */
124EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst); 124EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
125 125
@@ -133,7 +133,7 @@ EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
133 * 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
134 * 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 * 135 *
136 * @ingroup Theme 136 * @ingroup Elm_Theme
137 */ 137 */
138EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref); 138EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
139 139
@@ -146,7 +146,7 @@ EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
146 * 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().
147 * If no theme is set as a reference, NULL is returned. 147 * If no theme is set as a reference, NULL is returned.
148 * 148 *
149 * @ingroup Theme 149 * @ingroup Elm_Theme
150 */ 150 */
151EAPI Elm_Theme *elm_theme_ref_get(const Elm_Theme *th); 151EAPI Elm_Theme *elm_theme_ref_get(const Elm_Theme *th);
152 152
@@ -159,7 +159,7 @@ EAPI Elm_Theme *elm_theme_ref_get(const Elm_Theme *th);
159 * 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
160 * as a shorthand of NULL. 160 * as a shorthand of NULL.
161 * 161 *
162 * @ingroup Theme 162 * @ingroup Elm_Theme
163 */ 163 */
164EAPI Elm_Theme *elm_theme_default_get(void); 164EAPI Elm_Theme *elm_theme_default_get(void);
165 165
@@ -181,7 +181,7 @@ EAPI Elm_Theme *elm_theme_default_get(void);
181 * @see elm_theme_extension_add() 181 * @see elm_theme_extension_add()
182 * @see elm_theme_overlay_mmap_add() 182 * @see elm_theme_overlay_mmap_add()
183 * 183 *
184 * @ingroup Theme 184 * @ingroup Elm_Theme
185 */ 185 */
186EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item); 186EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
187 187
@@ -193,7 +193,7 @@ EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
193 * 193 *
194 * @see elm_theme_overlay_add() 194 * @see elm_theme_overlay_add()
195 * 195 *
196 * @ingroup Theme 196 * @ingroup Elm_Theme
197 */ 197 */
198EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item); 198EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
199 199
@@ -215,7 +215,7 @@ EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
215 * @see elm_theme_extension_add() 215 * @see elm_theme_extension_add()
216 * @see elm_theme_overlay_add() 216 * @see elm_theme_overlay_add()
217 * 217 *
218 * @ingroup Theme 218 * @ingroup Elm_Theme
219 */ 219 */
220EAPI void elm_theme_overlay_mmap_add(Elm_Theme *th, const Eina_File *f); 220EAPI void elm_theme_overlay_mmap_add(Elm_Theme *th, const Eina_File *f);
221 221
@@ -227,7 +227,7 @@ EAPI void elm_theme_overlay_mmap_add(Elm_Theme *th, const Eina_File
227 * 227 *
228 * @see elm_theme_overlay_mmap_add() 228 * @see elm_theme_overlay_mmap_add()
229 * 229 *
230 * @ingroup Theme 230 * @ingroup Elm_Theme
231 */ 231 */
232EAPI void elm_theme_overlay_mmap_del(Elm_Theme *th, const Eina_File *f); 232EAPI void elm_theme_overlay_mmap_del(Elm_Theme *th, const Eina_File *f);
233 233
@@ -239,7 +239,7 @@ EAPI void elm_theme_overlay_mmap_del(Elm_Theme *th, const Eina_File
239 * 239 *
240 * @see elm_theme_overlay_add() 240 * @see elm_theme_overlay_add()
241 * 241 *
242 * @ingroup Theme 242 * @ingroup Elm_Theme
243 */ 243 */
244EAPI const Eina_List *elm_theme_overlay_list_get(const Elm_Theme *th); 244EAPI const Eina_List *elm_theme_overlay_list_get(const Elm_Theme *th);
245 245
@@ -262,7 +262,7 @@ EAPI const Eina_List *elm_theme_overlay_list_get(const Elm_Theme *th);
262 * 262 *
263 * @see elm_object_style_set() 263 * @see elm_object_style_set()
264 * 264 *
265 * @ingroup Theme 265 * @ingroup Elm_Theme
266 */ 266 */
267EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item); 267EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
268 268
@@ -274,7 +274,7 @@ EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
274 * 274 *
275 * @see elm_theme_extension_add() 275 * @see elm_theme_extension_add()
276 * 276 *
277 * @ingroup Theme 277 * @ingroup Elm_Theme
278 */ 278 */
279EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item); 279EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
280 280
@@ -297,7 +297,7 @@ EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
297 * 297 *
298 * @see elm_object_style_set() 298 * @see elm_object_style_set()
299 * 299 *
300 * @ingroup Theme 300 * @ingroup Elm_Theme
301 */ 301 */
302EAPI void elm_theme_extension_mmap_add(Elm_Theme *th, const Eina_File *f); 302EAPI void elm_theme_extension_mmap_add(Elm_Theme *th, const Eina_File *f);
303 303
@@ -309,7 +309,7 @@ EAPI void elm_theme_extension_mmap_add(Elm_Theme *th, const Eina_Fil
309 * 309 *
310 * @see elm_theme_extension_add() 310 * @see elm_theme_extension_add()
311 * 311 *
312 * @ingroup Theme 312 * @ingroup Elm_Theme
313 */ 313 */
314EAPI void elm_theme_extension_mmap_del(Elm_Theme *th, const Eina_File *f); 314EAPI void elm_theme_extension_mmap_del(Elm_Theme *th, const Eina_File *f);
315 315
@@ -321,7 +321,7 @@ EAPI void elm_theme_extension_mmap_del(Elm_Theme *th, const Eina_Fil
321 * 321 *
322 * @see elm_theme_extension_add() 322 * @see elm_theme_extension_add()
323 * 323 *
324 * @ingroup Theme 324 * @ingroup Elm_Theme
325 */ 325 */
326EAPI const Eina_List *elm_theme_extension_list_get(const Elm_Theme *th); 326EAPI const Eina_List *elm_theme_extension_list_get(const Elm_Theme *th);
327 327
@@ -341,7 +341,7 @@ EAPI const Eina_List *elm_theme_extension_list_get(const Elm_Theme *th);
341 * @see elm_theme_get() 341 * @see elm_theme_get()
342 * @see elm_theme_list_get() 342 * @see elm_theme_list_get()
343 * 343 *
344 * @ingroup Theme 344 * @ingroup Elm_Theme
345 */ 345 */
346EAPI void elm_theme_set(Elm_Theme *th, const char *theme); 346EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
347 347
@@ -357,7 +357,7 @@ EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
357 * @see elm_theme_set() 357 * @see elm_theme_set()
358 * @see elm_theme_list_get() 358 * @see elm_theme_list_get()
359 * 359 *
360 * @ingroup Theme 360 * @ingroup Elm_Theme
361 */ 361 */
362EAPI const char *elm_theme_get(Elm_Theme *th); 362EAPI const char *elm_theme_get(Elm_Theme *th);
363 363
@@ -380,7 +380,7 @@ EAPI const char *elm_theme_get(Elm_Theme *th);
380 * @see elm_theme_set() 380 * @see elm_theme_set()
381 * @see elm_theme_get() 381 * @see elm_theme_get()
382 * 382 *
383 * @ingroup Theme 383 * @ingroup Elm_Theme
384 */ 384 */
385EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th); 385EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
386 386
@@ -400,7 +400,7 @@ EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
400 * @c EINA_TRUE if the file was a search-able file and is in the search path, 400 * @c EINA_TRUE if the file was a search-able file and is in the search path,
401 * and @c EINA_FALSE otherwise. 401 * and @c EINA_FALSE otherwise.
402 * 402 *
403 * @ingroup Theme 403 * @ingroup Elm_Theme
404 */ 404 */
405EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path); 405EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
406 406
@@ -414,7 +414,7 @@ EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_
414 * Call this function if source theme data has changed in such a way as to 414 * Call this function if source theme data has changed in such a way as to
415 * make any caches Elementary kept invalid. 415 * make any caches Elementary kept invalid.
416 * 416 *
417 * @ingroup Theme 417 * @ingroup Elm_Theme
418 */ 418 */
419EAPI void elm_theme_flush(Elm_Theme *th); 419EAPI void elm_theme_flush(Elm_Theme *th);
420 420
@@ -424,7 +424,7 @@ EAPI void elm_theme_flush(Elm_Theme *th);
424 * This will flush all themes in the current application context, by calling 424 * This will flush all themes in the current application context, by calling
425 * elm_theme_flush() on each of them. 425 * elm_theme_flush() on each of them.
426 * 426 *
427 * @ingroup Theme 427 * @ingroup Elm_Theme
428 */ 428 */
429EAPI void elm_theme_full_flush(void); 429EAPI void elm_theme_full_flush(void);
430 430
@@ -438,7 +438,7 @@ EAPI void elm_theme_full_flush(void);
438 * element names in a list of strings. Free this with 438 * element names in a list of strings. Free this with
439 * elm_theme_name_available_list_free() when you are done with the list. 439 * elm_theme_name_available_list_free() when you are done with the list.
440 * 440 *
441 * @ingroup Theme 441 * @ingroup Elm_Theme
442 */ 442 */
443EAPI Eina_List *elm_theme_name_available_list_new(void); 443EAPI Eina_List *elm_theme_name_available_list_new(void);
444 444
@@ -449,7 +449,7 @@ EAPI Eina_List *elm_theme_name_available_list_new(void);
449 * elm_theme_name_available_list_new(). Once freed the list should no longer 449 * elm_theme_name_available_list_new(). Once freed the list should no longer
450 * be used. a new list mys be created. 450 * be used. a new list mys be created.
451 * 451 *
452 * @ingroup Theme 452 * @ingroup Elm_Theme
453 */ 453 */
454EAPI void elm_theme_name_available_list_free(Eina_List *list); 454EAPI void elm_theme_name_available_list_free(Eina_List *list);
455 455
@@ -468,7 +468,7 @@ EAPI void elm_theme_name_available_list_free(Eina_List *list);
468 * configuration difficult. Avoid any custom themes at all if it can be 468 * configuration difficult. Avoid any custom themes at all if it can be
469 * helped. 469 * helped.
470 * 470 *
471 * @ingroup Theme 471 * @ingroup Elm_Theme
472 */ 472 */
473EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th); 473EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th);
474 474
@@ -483,7 +483,7 @@ EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th);
483 * the specific theme set for that specific object. See elm_object_theme_set() 483 * the specific theme set for that specific object. See elm_object_theme_set()
484 * for more information. 484 * for more information.
485 * 485 *
486 * @ingroup Theme 486 * @ingroup Elm_Theme
487 */ 487 */
488EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj); 488EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj);
489 489
@@ -497,7 +497,7 @@ EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj);
497 * This function is used to return data items from edc in @p th, an overlay, or an extension. 497 * This function is used to return data items from edc in @p th, an overlay, or an extension.
498 * It works the same way as edje_file_data_get() except that the return is stringshared. 498 * It works the same way as edje_file_data_get() except that the return is stringshared.
499 * 499 *
500 * @ingroup Theme 500 * @ingroup Elm_Theme
501 */ 501 */
502EAPI const char *elm_theme_data_get(Elm_Theme *th, const char *key); 502EAPI const char *elm_theme_data_get(Elm_Theme *th, const char *key);
503 503
@@ -521,7 +521,7 @@ EAPI const char *elm_theme_data_get(Elm_Theme *th, const char *key);
521 * request. 521 * request.
522 * 522 *
523 * @since 1.8 523 * @since 1.8
524 * @ingroup Theme 524 * @ingroup Elm_Theme
525 */ 525 */
526EAPI const char *elm_theme_group_path_find(Elm_Theme *th, const char *group); 526EAPI const char *elm_theme_group_path_find(Elm_Theme *th, const char *group);
527 527
@@ -543,7 +543,7 @@ EAPI const char *elm_theme_group_path_find(Elm_Theme *th, const char *group);
543 * may result in a leak. 543 * may result in a leak.
544 * 544 *
545 * @since 1.8 545 * @since 1.8
546 * @ingroup Theme 546 * @ingroup Elm_Theme
547 */ 547 */
548 EAPI Eina_List *elm_theme_group_base_list(Elm_Theme *th, const char *base); 548 EAPI Eina_List *elm_theme_group_base_list(Elm_Theme *th, const char *base);
549 549
@@ -558,7 +558,7 @@ EAPI const char *elm_theme_group_path_find(Elm_Theme *th, const char *group);
558 * example a theme selector. 558 * example a theme selector.
559 * 559 *
560 * @since 1.8 560 * @since 1.8
561 * @ingroup Theme 561 * @ingroup Elm_Theme
562 */ 562 */
563EAPI const char *elm_theme_system_dir_get(void); 563EAPI const char *elm_theme_system_dir_get(void);
564 564
@@ -576,7 +576,7 @@ EAPI const char *elm_theme_system_dir_get(void);
576 * directory is normally expected to be writable by the user. 576 * directory is normally expected to be writable by the user.
577 * 577 *
578 * @since 1.8 578 * @since 1.8
579 * @ingroup Theme 579 * @ingroup Elm_Theme
580 */ 580 */
581EAPI const char *elm_theme_user_dir_get(void); 581EAPI const char *elm_theme_user_dir_get(void);
582 582