Elementary: colorselector documentation.

[framework/uifw/elementary.git] / src / lib / Elementary.h.in

diff --git a/src/lib/Elementary.h.in b/src/lib/Elementary.h.in
index 715fb58..27d622d 100644 (file)
--- a/src/lib/Elementary.h.in
+++ b/src/lib/Elementary.h.in
@@ -5717,12 +5717,81 @@ extern "C" {
     * "selected" - when item is selected (scroller stops)
     */
 
-   /* colorselector */
+   /**
+    * @page tutorial_colorselector Color selector example
+    * @dontinclude colorselector_example_01.c
+    *
+    * This example shows how to change the color of a rectangle using a color
+    * selector. We aren't going to explain a lot of the code since it's the
+    * usual setup code:
+    * @until show(rect)
+    *
+    * Now that we have a window with background and a rectangle we can create
+    * our color_selector and set it's initial color to fully opaque blue:
+    * @until show
+    *
+    * Next we tell ask to be notified whenever the color changes:
+    * @until changed
+    *
+    * We follow that we some more run of the mill setup code:
+    * @until ELM_MAIN()
+    *
+    * And now get to the callback that sets the color of the rectangle:
+    * @until }
+    *
+    * This example will look like this:
+    * @image html screenshots/colorselector_example_01.png
+    * @image latex screenshots/colorselector_example_01.eps
+    *
+    * @example colorselector_example_01.c
+    */
+   /**
+    * @defgroup Colorselector Colorselector
+    *
+    * @{
+    *
+    * @brief Widget for user to select a color.
+    *
+    * Signals that you can add callbacks for are:
+    * "changed" - When the color value changes(event_info is NULL).
+    *
+    * See @ref tutorial_colorselector.
+    */
+   /**
+    * @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) EINA_ARG_NONNULL(1);
+   /**
+    * Set a color for the 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) EINA_ARG_NONNULL(1);
+   /**
+    * Get a color from the 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) EINA_ARG_NONNULL(1);
-   /* smart callbacks called:
-    * "changed" - when the color value changes
+   /**
+    * @}
     */
 
    /* Contextual Popup */