332 lines
9.1 KiB
C
332 lines
9.1 KiB
C
/**
|
|
* @defgroup Colorselector Colorselector
|
|
* @ingroup Elementary
|
|
*
|
|
* @image html colorselector_inheritance_tree.png
|
|
* @image latex colorselector_inheritance_tree.eps
|
|
*
|
|
* @image html img/widget/colorselector/preview-00.png
|
|
* @image latex img/widget/colorselector/preview-00.eps
|
|
*
|
|
* 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 @ref 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
|
|
* @ref Layout:
|
|
* - @c "changed" - When the color value changes on selector
|
|
* event_info is NULL.
|
|
* - @c "color,item,selected" - When user clicks on color item. The
|
|
* event_info parameter of the callback will be the selected color
|
|
* item.
|
|
* - @c "color,item,longpressed" - When user long presses on color
|
|
* item. The event info parameter of the callback contains selected
|
|
* color item.
|
|
*
|
|
* See @ref tutorial_colorselector.
|
|
* @{
|
|
*/
|
|
|
|
#define ELM_OBJ_COLORSELECTOR_CLASS elm_obj_colorselector_class_get()
|
|
|
|
const Eo_Class *elm_obj_colorselector_class_get(void) EINA_CONST;
|
|
|
|
extern EAPI Eo_Op ELM_OBJ_COLORSELECTOR_BASE_ID;
|
|
|
|
enum
|
|
{
|
|
ELM_OBJ_COLORSELECTOR_SUB_ID_COLOR_SET,
|
|
ELM_OBJ_COLORSELECTOR_SUB_ID_COLOR_GET,
|
|
ELM_OBJ_COLORSELECTOR_SUB_ID_MODE_SET,
|
|
ELM_OBJ_COLORSELECTOR_SUB_ID_MODE_GET,
|
|
ELM_OBJ_COLORSELECTOR_SUB_ID_PALETTE_COLOR_ADD,
|
|
ELM_OBJ_COLORSELECTOR_SUB_ID_PALETTE_CLEAR,
|
|
ELM_OBJ_COLORSELECTOR_SUB_ID_PALETTE_NAME_SET,
|
|
ELM_OBJ_COLORSELECTOR_SUB_ID_PALETTE_NAME_GET,
|
|
ELM_OBJ_COLORSELECTOR_SUB_ID_LAST
|
|
};
|
|
|
|
#define ELM_OBJ_COLORSELECTOR_ID(sub_id) (ELM_OBJ_COLORSELECTOR_BASE_ID + sub_id)
|
|
|
|
|
|
/**
|
|
* @def elm_obj_colorselector_color_set
|
|
* @since 1.8
|
|
*
|
|
* Set color to colorselector
|
|
*
|
|
* @param[in] r
|
|
* @param[in] g
|
|
* @param[in] b
|
|
* @param[in] a
|
|
*
|
|
* @see elm_colorselector_color_set
|
|
*/
|
|
#define elm_obj_colorselector_color_set(r, g, b, a) ELM_OBJ_COLORSELECTOR_ID(ELM_OBJ_COLORSELECTOR_SUB_ID_COLOR_SET), EO_TYPECHECK(int, r), EO_TYPECHECK(int, g), EO_TYPECHECK(int, b), EO_TYPECHECK(int, a)
|
|
|
|
/**
|
|
* @def elm_obj_colorselector_color_get
|
|
* @since 1.8
|
|
*
|
|
* Get current color from colorselector
|
|
*
|
|
* @param[out] r
|
|
* @param[out] g
|
|
* @param[out] b
|
|
* @param[out] a
|
|
*
|
|
* @see elm_colorselector_color_get
|
|
*/
|
|
#define elm_obj_colorselector_color_get(r, g, b, a) ELM_OBJ_COLORSELECTOR_ID(ELM_OBJ_COLORSELECTOR_SUB_ID_COLOR_GET), EO_TYPECHECK(int *, r), EO_TYPECHECK(int *, g), EO_TYPECHECK(int *, b), EO_TYPECHECK(int *, a)
|
|
|
|
/**
|
|
* @def elm_obj_colorselector_mode_set
|
|
* @since 1.8
|
|
*
|
|
* Set Colorselector's mode.
|
|
*
|
|
* @param[in] mode
|
|
*
|
|
* @see elm_colorselector_mode_set
|
|
*/
|
|
#define elm_obj_colorselector_mode_set(mode) ELM_OBJ_COLORSELECTOR_ID(ELM_OBJ_COLORSELECTOR_SUB_ID_MODE_SET), EO_TYPECHECK(Elm_Colorselector_Mode, mode)
|
|
|
|
/**
|
|
* @def elm_obj_colorselector_mode_get
|
|
* @since 1.8
|
|
*
|
|
* Get Colorselector's mode.
|
|
*
|
|
* @param[out] ret
|
|
*
|
|
* @see elm_colorselector_mode_get
|
|
*/
|
|
#define elm_obj_colorselector_mode_get(ret) ELM_OBJ_COLORSELECTOR_ID(ELM_OBJ_COLORSELECTOR_SUB_ID_MODE_GET), EO_TYPECHECK(Elm_Colorselector_Mode *, ret)
|
|
|
|
/**
|
|
* @def elm_obj_colorselector_palette_color_add
|
|
* @since 1.8
|
|
*
|
|
* Add a new color item to palette.
|
|
*
|
|
* @param[in] r
|
|
* @param[in] g
|
|
* @param[in] b
|
|
* @param[in] a
|
|
* @param[out] ret
|
|
*
|
|
* @see elm_colorselector_palette_color_add
|
|
*/
|
|
#define elm_obj_colorselector_palette_color_add(r, g, b, a, ret) ELM_OBJ_COLORSELECTOR_ID(ELM_OBJ_COLORSELECTOR_SUB_ID_PALETTE_COLOR_ADD), EO_TYPECHECK(int, r), EO_TYPECHECK(int, g), EO_TYPECHECK(int, b), EO_TYPECHECK(int, a), EO_TYPECHECK(Elm_Object_Item **, ret)
|
|
|
|
/**
|
|
* @def elm_obj_colorselector_palette_clear
|
|
* @since 1.8
|
|
*
|
|
* Clear the palette items.
|
|
*
|
|
*
|
|
* @see elm_colorselector_palette_clear
|
|
*/
|
|
#define elm_obj_colorselector_palette_clear() ELM_OBJ_COLORSELECTOR_ID(ELM_OBJ_COLORSELECTOR_SUB_ID_PALETTE_CLEAR)
|
|
|
|
/**
|
|
* @def elm_obj_colorselector_palette_name_set
|
|
* @since 1.8
|
|
*
|
|
* Set current palette's name
|
|
*
|
|
* @param[in] palette_name
|
|
*
|
|
* @see elm_colorselector_palette_name_set
|
|
*/
|
|
#define elm_obj_colorselector_palette_name_set(palette_name) ELM_OBJ_COLORSELECTOR_ID(ELM_OBJ_COLORSELECTOR_SUB_ID_PALETTE_NAME_SET), EO_TYPECHECK(const char *, palette_name)
|
|
|
|
/**
|
|
* @def elm_obj_colorselector_palette_name_get
|
|
* @since 1.8
|
|
*
|
|
* Get current palette's name
|
|
*
|
|
* @param[out] ret
|
|
*
|
|
* @see elm_colorselector_palette_name_get
|
|
*/
|
|
#define elm_obj_colorselector_palette_name_get(ret) ELM_OBJ_COLORSELECTOR_ID(ELM_OBJ_COLORSELECTOR_SUB_ID_PALETTE_NAME_GET), EO_TYPECHECK(const char **, ret)
|
|
|
|
typedef struct _Elm_Color_RGBA
|
|
{
|
|
unsigned int r;
|
|
unsigned int g;
|
|
unsigned int b;
|
|
unsigned int a;
|
|
} Elm_Color_RGBA;
|
|
|
|
typedef struct _Elm_Custom_Palette
|
|
{
|
|
const char *palette_name;
|
|
Eina_List *color_list;
|
|
} Elm_Custom_Palette;
|
|
|
|
/**
|
|
* @enum Elm_Colorselector_Mode
|
|
* @typedef Elm_Colorselector_Mode
|
|
*
|
|
* Different modes supported by Colorselector
|
|
*
|
|
* @see elm_colorselector_mode_set()
|
|
* @see elm_colorselector_mode_get()
|
|
*/
|
|
typedef enum
|
|
{
|
|
ELM_COLORSELECTOR_PALETTE = 0, /**< 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 */
|
|
} Elm_Colorselector_Mode;
|
|
|
|
/**
|
|
* @brief Add a new colorselector to the parent
|
|
*
|
|
* @param parent The parent object
|
|
* @return The new object or NULL if it cannot be created
|
|
*
|
|
* @ingroup Colorselector
|
|
*/
|
|
EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent);
|
|
|
|
/**
|
|
* Set color to colorselector
|
|
*
|
|
* @param obj Colorselector object
|
|
* @param r r-value of color
|
|
* @param g g-value of color
|
|
* @param b b-value of color
|
|
* @param a a-value of color
|
|
*
|
|
* @ingroup Colorselector
|
|
*/
|
|
EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g, int b, int a);
|
|
|
|
/**
|
|
* Get current color from colorselector
|
|
*
|
|
* @param obj Colorselector object
|
|
* @param r integer pointer for r-value of color
|
|
* @param g integer pointer for g-value of color
|
|
* @param b integer pointer for b-value of color
|
|
* @param a integer pointer for a-value of color
|
|
*
|
|
* @ingroup Colorselector
|
|
*/
|
|
EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a);
|
|
|
|
/**
|
|
* Set Colorselector's mode.
|
|
*
|
|
* @param obj Colorselector object
|
|
* @param mode Elm_Colorselector_Mode
|
|
*
|
|
* Colorselector supports three modes palette only, selector only and both.
|
|
*
|
|
* @ingroup Colorselector
|
|
*/
|
|
EAPI void elm_colorselector_mode_set(Evas_Object *obj, Elm_Colorselector_Mode mode);
|
|
|
|
/**
|
|
* Get Colorselector's mode.
|
|
*
|
|
* @param obj Colorselector object
|
|
* @return mode The current mode of colorselector
|
|
*
|
|
* @ingroup Colorselector
|
|
*/
|
|
EAPI Elm_Colorselector_Mode elm_colorselector_mode_get(const Evas_Object *obj);
|
|
|
|
/**
|
|
* Get Palette item's color.
|
|
*
|
|
* @param it The color palette item.
|
|
* @param r integer pointer for r-value of color
|
|
* @param g integer pointer for g-value of color
|
|
* @param b integer pointer for b-value of color
|
|
* @param a integer pointer for a-value of color
|
|
*
|
|
* @ingroup Colorselector
|
|
*/
|
|
EAPI void elm_colorselector_palette_item_color_get(const Elm_Object_Item *it, int *r, int *g, int *b, int *a);
|
|
|
|
/**
|
|
* Set palette item's color.
|
|
*
|
|
* @param it The color palette item.
|
|
* @param r r-value of color
|
|
* @param g g-value of color
|
|
* @param b b-value of color
|
|
* @param a a-value of color
|
|
*
|
|
* @ingroup Colorselector
|
|
*/
|
|
EAPI void elm_colorselector_palette_item_color_set(Elm_Object_Item *it, int r, int g, int b, int a);
|
|
|
|
/**
|
|
* Add a new color item to palette.
|
|
*
|
|
* @param obj The Colorselector object
|
|
* @param r r-value of color
|
|
* @param g g-value of color
|
|
* @param b b-value of color
|
|
* @param a a-value of color
|
|
* @return A new color palette Item.
|
|
*
|
|
* @ingroup Colorselector
|
|
*/
|
|
EAPI Elm_Object_Item *elm_colorselector_palette_color_add(Evas_Object *obj, int r, int g, int b, int a);
|
|
|
|
/**
|
|
* Clear the palette items.
|
|
*
|
|
* @param obj The Colorselector object
|
|
*
|
|
* @ingroup Colorselector
|
|
*/
|
|
EAPI void elm_colorselector_palette_clear(Evas_Object *obj);
|
|
|
|
/**
|
|
* Set current palette's name
|
|
*
|
|
* @param obj The Colorselector object
|
|
* @param palette_name Name of palette
|
|
*
|
|
* 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.
|
|
*
|
|
* @ingroup Colorselector
|
|
*/
|
|
EAPI void elm_colorselector_palette_name_set(Evas_Object *obj, const char *palette_name);
|
|
|
|
/**
|
|
* Get current palette's name
|
|
*
|
|
* @param obj The Colorselector object
|
|
* @return Name of palette
|
|
*
|
|
* Returns the currently set palette name using which colors will be
|
|
* saved/loaded in to config.
|
|
*
|
|
* @ingroup Colorselector
|
|
*/
|
|
EAPI const char *elm_colorselector_palette_name_get(const Evas_Object *obj);
|
|
|
|
/**
|
|
* @}
|
|
*/
|