X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali-toolkit%2Fpublic-api%2Fcontrols%2Fcontrol.h;h=6d6ca1185fbe4a66fd056ba898b074a540cebb34;hb=12ba8f6537fee9e4ad8c4fc11bbbea01691833b2;hp=e7511a11f9c374f32d995fb70c94c7c29842a9c6;hpb=511ab5d892c68a8bbbc3846e85fc5ec8f7323470;p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git diff --git a/dali-toolkit/public-api/controls/control.h b/dali-toolkit/public-api/controls/control.h index e7511a1..6d6ca11 100644 --- a/dali-toolkit/public-api/controls/control.h +++ b/dali-toolkit/public-api/controls/control.h @@ -40,6 +40,10 @@ namespace Internal { class Control; } +/** + * @addtogroup dali_toolkit_controls + * @{ + */ /** * @brief Control is the base class for all controls. @@ -50,18 +54,18 @@ class Control; * Signals * | %Signal Name | Method | * |------------------------|-----------------------------------------------------| - * | key-event | @ref KeyEventSignal() | - * | key-input-focus-gained | @ref KeyInputFocusGainedSignal() | - * | key-input-focus-lost | @ref KeyInputFocusLostSignal() | + * | keyEvent | @ref KeyEventSignal() | + * | keyInputFocusGained | @ref KeyInputFocusGainedSignal() | + * | keyInputFocusLost | @ref KeyInputFocusLostSignal() | * | tapped | @ref GetTapGestureDetector().DetectedSignal() | * | panned | @ref GetPanGestureDetector().DetectedSignal() | * | pinched | @ref GetPinchGestureDetector().DetectedSignal() | - * | long-pressed | @ref GetLongPressGestureDetector().DetectedSignal() | + * | longPressed | @ref GetLongPressGestureDetector().DetectedSignal() | * * Actions - * | %Action Name | %Control method called | - * |-------------------|-----------------------------------------------------| - * | control-activated | %OnActivated() | + * | %Action Name | %Control method called | + * |------------------------|----------------------------------------------------| + * | accessibilityActivated | %OnAccessibilityActivated() | */ class DALI_IMPORT_API Control : public CustomActor { @@ -84,10 +88,9 @@ public: { enum { - STYLE_NAME = PROPERTY_START_INDEX, ///< name "style-name", @see SetStyleName, type std::string - BACKGROUND_COLOR, ///< name "background-color", @see SetBackgroundColor, type Vector4 - BACKGROUND_IMAGE, ///< name "background-image", @see SetBackgroundImage, type Map - KEY_INPUT_FOCUS, ///< name "key-input-focus", @see SetKeyInputFocus, type bool + STYLE_NAME = PROPERTY_START_INDEX, ///< name "styleName", @see SetStyleName, type std::string + BACKGROUND, ///< name "background", @since DALi 1.1.4, type Map + KEY_INPUT_FOCUS, ///< name "keyInputFocus", @see SetKeyInputFocus, type bool }; }; @@ -258,6 +261,8 @@ public: /** * @brief Sets the background color of the control. * + * @note if SetBackgroundImage is called later, this background color is removed. + * * @param[in] color The required background color of the control * * @note The background color fully blends with the actor color. @@ -267,6 +272,8 @@ public: /** * @brief Retrieves the background color of the control. * + * @deprecated DALi 1.1.3 API removed. + * * @return The background color of the control. */ Vector4 GetBackgroundColor() const; @@ -274,8 +281,6 @@ public: /** * @brief Sets an image as the background of the control. * - * The color of this image is blended with the background color @see SetBackgroundColor - * * @param[in] image The image to set as the background. */ void SetBackgroundImage( Image image ); @@ -403,6 +408,9 @@ public: // Templates for Deriving Classes }; +/** + * @} + */ } // namespace Toolkit } // namespace Dali