fomatting of headers -> fixup. and documentation fixing.
[framework/uifw/elementary.git] / src / lib / elm_colorselector.h
1 /**
2  * @defgroup Colorselector Colorselector
3  *
4  * @{
5  *
6  * @image html img/widget/colorselector/preview-00.png
7  * @image latex img/widget/colorselector/preview-00.eps
8  *
9  * @brief Widget for user to select a color.
10  *
11  * Signals that you can add callbacks for are:
12  * "changed" - When the color value changes(event_info is NULL).
13  *
14  * See @ref tutorial_colorselector.
15  */
16 /**
17  * @brief Add a new colorselector to the parent
18  *
19  * @param parent The parent object
20  * @return The new object or NULL if it cannot be created
21  *
22  * @ingroup Colorselector
23  */
24 EAPI Evas_Object *
25           elm_colorselector_add(Evas_Object *parent)
26 EINA_ARG_NONNULL(1);
27 /**
28  * Set a color for the colorselector
29  *
30  * @param obj   Colorselector object
31  * @param r     r-value of color
32  * @param g     g-value of color
33  * @param b     b-value of color
34  * @param a     a-value of color
35  *
36  * @ingroup Colorselector
37  */
38 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g, int b, int a) EINA_ARG_NONNULL(1);
39 /**
40  * Get a color from the colorselector
41  *
42  * @param obj   Colorselector object
43  * @param r     integer pointer for r-value of color
44  * @param g     integer pointer for g-value of color
45  * @param b     integer pointer for b-value of color
46  * @param a     integer pointer for a-value of color
47  *
48  * @ingroup Colorselector
49  */
50 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a) EINA_ARG_NONNULL(1);
51 /**
52  * @}
53  */