Tizen Native API  5.0
Colorselector

colorselector_inheritance_tree.png

A ColorSelector is a color selection widget. It allows application to set a series of colors.It also allows to load/save colors from/to config with a unique identifier, by default, the colors are loaded/saved from/to config using "default" identifier. The colors can be picked by user from the color set by clicking on individual color item on the palette or by selecting it from selector.

This widget inherits from the Layout one, so that all the functions acting on it also work for check objects.

This widget emits the following signals, besides the ones sent from Layout :

  • "changed" - When the color value changes on selector event_info is NULL.
  • "color,item,selected" - When user clicks on color item. The event_info parameter of the callback will be the selected color item.
  • "color,item,longpressed" - When user long presses on color item. The event info parameter of the callback contains selected color item.
  • "focused" - When the colorselector has received focus. (since 1.8)
  • "unfocused" - When the colorselector has lost focus. (since 1.8)
  • "language,changed" - the program's language changed (since 1.9)

See Color selector example.

Functions

void elm_colorselector_color_set (Elm_Colorselector *obj, int r, int g, int b, int a)
 Set color to colorselector.
void elm_colorselector_color_get (const Elm_Colorselector *obj, int *r, int *g, int *b, int *a)
 Get current color from colorselector.
void elm_colorselector_palette_name_set (Elm_Colorselector *obj, const char *palette_name)
 Set current palette's name.
const char * elm_colorselector_palette_name_get (const Elm_Colorselector *obj)
 Get current palette's name.
void elm_colorselector_mode_set (Elm_Colorselector *obj, Elm_Colorselector_Mode mode)
 Set Colorselector's mode.
Elm_Colorselector_Mode elm_colorselector_mode_get (const Elm_Colorselector *obj)
 Get Colorselector's mode.
const Eina_Listelm_colorselector_palette_items_get (const Elm_Colorselector *obj)
 Get list of palette items.
Elm_Widget_Itemelm_colorselector_palette_selected_item_get (const Elm_Colorselector *obj)
 Get the selected item in colorselector palette.
Elm_Widget_Itemelm_colorselector_palette_color_add (Elm_Colorselector *obj, int r, int g, int b, int a)
 Add a new color item to palette.
void elm_colorselector_palette_clear (Elm_Colorselector *obj)
void elm_colorselector_palette_item_color_get (const Elm_Object_Item *it, int *r, int *g, int *b, int *a)
 Get Palette item's color.
void elm_colorselector_palette_item_color_set (Elm_Object_Item *it, int r, int g, int b, int a)
 Set palette item's color.
Eina_Bool elm_colorselector_palette_item_selected_get (const Elm_Object_Item *it)
 Get the selected state of color palette item.
void elm_colorselector_palette_item_selected_set (Elm_Object_Item *it, Eina_Bool selected)
 Set the selected state of color palette item.
Evas_Objectelm_colorselector_add (Evas_Object *parent)
 Add a new colorselector to the parent.

Enumeration Type Documentation

Different modes supported by Colorselector.

See also elm_colorselector_mode_set, elm_colorselector_mode_get.

Enumerator:
ELM_COLORSELECTOR_PALETTE 

Only color palette is displayed.

ELM_COLORSELECTOR_COMPONENTS 

Only color selector is displayed.

ELM_COLORSELECTOR_BOTH 

Both Palette and selector is displayed, default.

ELM_COLORSELECTOR_PICKER 

Only color picker is displayed.

ELM_COLORSELECTOR_ALL 

All possible color selector is displayed.


Function Documentation

Add a new colorselector to the parent.

Parameters:
parentThe parent object
Returns:
The new object or NULL if it cannot be created
Since :
2.3
Examples:
colorselector_example_01.c.
void elm_colorselector_color_get ( const Elm_Colorselector *  obj,
int *  r,
int *  g,
int *  b,
int *  a 
)

Get current color from colorselector.

Parameters:
[in]objThe object.
[out]rRed value of color
[out]gGreen value of color
[out]bBlue value of color
[out]aAlpha value of color
Since :
2.3
Examples:
colorselector_example_01.c.
void elm_colorselector_color_set ( Elm_Colorselector *  obj,
int  r,
int  g,
int  b,
int  a 
)

Set color to colorselector.

Parameters:
[in]objThe object.
[in]rRed value of color
[in]gGreen value of color
[in]bBlue value of color
[in]aAlpha value of color
Since :
2.3
Examples:
colorselector_example_01.c.
Elm_Colorselector_Mode elm_colorselector_mode_get ( const Elm_Colorselector *  obj)

Get Colorselector's mode.

Parameters:
[in]objThe object.
Returns:
Elm_Colorselector_Mode
Since :
2.3
void elm_colorselector_mode_set ( Elm_Colorselector *  obj,
Elm_Colorselector_Mode  mode 
)

Set Colorselector's mode.

Colorselector supports three modes palette only, selector only and both.

Parameters:
[in]objThe object.
[in]modeElm_Colorselector_Mode
Since :
2.3
void elm_colorselector_palette_clear ( Elm_Colorselector *  obj)

Clear the palette items.

Since :
2.3
Elm_Widget_Item* elm_colorselector_palette_color_add ( Elm_Colorselector *  obj,
int  r,
int  g,
int  b,
int  a 
)

Add a new color item to palette.

Parameters:
[in]objThe object.
[in]rRed value of color
[in]gGreen value of color
[in]bBlue value of color
[in]aAlpha value of color
Returns:
A new color palette Item.
Since :
2.3
void elm_colorselector_palette_item_color_get ( const Elm_Object_Item it,
int *  r,
int *  g,
int *  b,
int *  a 
)

Get Palette item's color.

Parameters:
[in]itThe color palette item.
[out]rinteger pointer for r-value of color
[out]ginteger pointer for g-value of color
[out]binteger pointer for b-value of color
[out]ainteger pointer for a-value of color
Since :
2.3
Examples:
colorselector_example_01.c.
void elm_colorselector_palette_item_color_set ( Elm_Object_Item it,
int  r,
int  g,
int  b,
int  a 
)

Set palette item's color.

Parameters:
[in]itThe color palette item.
[in]rr-value of color
[in]gg-value of color
[in]bb-value of color
[in]aa-value of color
Since :
2.3

Get the selected state of color palette item.

Parameters:
[in]itThe colorpalette item
Returns:
EINA_TRUE if the item is selected, EINA_FALSE otherwise.
Since :
3.0

Set the selected state of color palette item.

Parameters:
[in]itThe colorpalette item
[in]selectedThe selected state
Since :
3.0
const Eina_List* elm_colorselector_palette_items_get ( const Elm_Colorselector *  obj)

Get list of palette items.

Note That palette item list is internally managed by colorselector widget and it should not be freed/modified by application.

Parameters:
[in]objThe object.
Returns:
The list of color palette items.
Since (EFL) :
1.9
Since :
2.3
const char* elm_colorselector_palette_name_get ( const Elm_Colorselector *  obj)

Get current palette's name.

Returns the currently set palette name using which colors will be saved/loaded in to config.

Parameters:
[in]objThe object.
Returns:
Name of palette
Since :
2.3
void elm_colorselector_palette_name_set ( Elm_Colorselector *  obj,
const char *  palette_name 
)

Set current palette's name.

When colorpalette name is set, colors will be loaded from and saved to config using the set name. If no name is set then colors will be loaded from or saved to "default" config.

Parameters:
[in]objThe object.
[in]palette_nameName of palette
Since :
2.3
Examples:
colorselector_example_01.c.
Elm_Widget_Item* elm_colorselector_palette_selected_item_get ( const Elm_Colorselector *  obj)

Get the selected item in colorselector palette.

Parameters:
[in]objThe object.
Returns:
The selected item, or null if none selected.
Since (EFL) :
1.9