Typedefs | Functions
Color Class Editor

This group provides a UI for editing color classes in applications. More...

Typedefs

typedef char *(* Elm_Color_Class_Name_Cb) (char *)
 A callback used to translate color class descriptions. More...
 
typedef Eina_List *(* Elm_Color_Class_List_Cb) (void)
 A callback used to provide a list of allocated Edje_Color_Class structs used by an application. More...
 

Functions

Evas_Objectelm_color_class_editor_add (Evas_Object *obj)
 Create a new color class editor. More...
 
void elm_color_class_translate_cb_set (Elm_Color_Class_Name_Cb cb)
 Set a callback to provide translations for color class descriptions. More...
 
void elm_color_class_list_cb_set (Elm_Color_Class_List_Cb cb)
 Set a callback to provide a list of supplementary color classes. More...
 
Eina_Listelm_color_class_util_edje_file_list (Eina_File *f)
 Create an allocated list of allocated Edje_Color_Class structs from an open edje file. More...
 

Detailed Description

This group provides a UI for editing color classes in applications.

Typedef Documentation

◆ Elm_Color_Class_Name_Cb

Elm_Color_Class_Name_Cb

A callback used to translate color class descriptions.

Since
1.14

◆ Elm_Color_Class_List_Cb

Elm_Color_Class_List_Cb

A callback used to provide a list of allocated Edje_Color_Class structs used by an application.

Since
1.14

The list and its members will be freed internally.

Function Documentation

◆ elm_color_class_editor_add()

Evas_Object * elm_color_class_editor_add ( Evas_Object obj)

Create a new color class editor.

Parameters
objThe parent object

A color class editor is a visual representation of the color schemes in an application. Values changed in the editor are stored in Elementary's config and will remain until they are reset or the config is cleared. By default, the editor will load only the currently active color classes in an application.

Since
1.14
  • FIXME: translate *‍/

References edje_color_class_active_iterator_new(), edje_color_class_set(), eina_hash_add(), eina_hash_string_superfast_new(), EINA_ITERATOR_FOREACH, eina_iterator_free(), eina_list_append(), eina_stringshare_add(), and eldbus_connection_get().

◆ elm_color_class_translate_cb_set()

void elm_color_class_translate_cb_set ( Elm_Color_Class_Name_Cb  cb)

Set a callback to provide translations for color class descriptions.

Parameters
cbThe callback to use

This callback will be called globally by the application to translate any available color class description strings from the theme's color classes.

Since
1.14

◆ elm_color_class_list_cb_set()

void elm_color_class_list_cb_set ( Elm_Color_Class_List_Cb  cb)

Set a callback to provide a list of supplementary color classes.

Parameters
cbThe callback to use

This callback will be called globally by the application to provide extra color classes that an application may use but which may not be currently loaded.

See also
Elm_Color_Class_List_Cb
Since
1.14

◆ elm_color_class_util_edje_file_list()

Eina_List * elm_color_class_util_edje_file_list ( Eina_File f)

Create an allocated list of allocated Edje_Color_Class structs from an open edje file.

Parameters
fThe file to list color classes from
Returns
The list of color classes present in the file

This is a helper function to create a list for use with Elm_Color_Class_List_Cb callbacks.

See also
Elm_Color_Class_List_Cb
Since
1.14

References edje_mmap_color_class_iterator_new(), EINA_ITERATOR_FOREACH, eina_iterator_free(), eina_list_append(), EINA_SAFETY_ON_NULL_RETURN_VAL, and eina_stringshare_add().