From c2a1d9649f15850cae3c10479aa7d3c0ec15bde5 Mon Sep 17 00:00:00 2001 From: JunsuChoi Date: Fri, 21 Sep 2018 15:14:26 +0900 Subject: [PATCH] Colorselector : Add docs of elm_colorselector_palette_item_* APIs elm_colorselector_palette_item_color_get elm_colorselector_palette_item_color_set elm_colorselector_palette_item_selected_get elm_colorselector_palette_item_selected_set Change-Id: Ib1cc58af3b1e76a6ae9edc0d2e52ddd0f9d367f4 --- src/lib/elm_colorselector_common.h | 52 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) diff --git a/src/lib/elm_colorselector_common.h b/src/lib/elm_colorselector_common.h index 29f2076..a79a4d9 100644 --- a/src/lib/elm_colorselector_common.h +++ b/src/lib/elm_colorselector_common.h @@ -35,12 +35,64 @@ typedef enum } Elm_Colorselector_Mode; /* END */ +/** + * @brief Get Palette item's color. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif + * + * @param[in] it The color palette item. + * @param[out] r integer pointer for r-value of color + * @param[out] g integer pointer for g-value of color + * @param[out] b integer pointer for b-value of color + * @param[out] 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); +/** + * @brief Set palette item's color. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif + * + * @param[in] it The color palette item. + * @param[in] r r-value of color + * @param[in] g g-value of color + * @param[in] b b-value of color + * @param[in] 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); +/** + * @brief Get the selected state of color palette item. + * + * @if MOBILE @since_tizen 2.3.1 + * @endif + * + * @param[in] it The Colorpalette item + * @return @c EINA_TRUE if the item is selected, @c EINA_FALSE otherwise. + + * @ingroup Colorselector + */ EAPI Eina_Bool elm_colorselector_palette_item_selected_get(const Elm_Object_Item *it); +/** + * @brief Set the selected state of color palette item. + * + * @if MOBILE @since_tizen 2.3.1 + * @endif + * + * @param[in] it The Colorpalette item + * @param[in] selected The selected state + + * @ingroup Colorselector + */ EAPI void elm_colorselector_palette_item_selected_set(Elm_Object_Item *it, Eina_Bool selected); /** -- 2.7.4