Add Control::GetBackgroudColor() implementation

[platform/core/uifw/dali-toolkit.git] / dali-toolkit / public-api / controls / control.h

diff --git a/dali-toolkit/public-api/controls/control.h b/dali-toolkit/public-api/controls/control.h
index 35587f9..6d6ca11 100644 (file)
--- a/dali-toolkit/public-api/controls/control.h
+++ b/dali-toolkit/public-api/controls/control.h
@@ -41,7 +41,7 @@ namespace Internal
 class Control;
 }
 /**
- * @addtogroup dali-toolkit-controls
+ * @addtogroup dali_toolkit_controls
  * @{
  */
 
@@ -54,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                             |
- * |-------------------------|----------------------------------------------------|
- * | accessibility-activated | %OnAccessibilityActivated()                        |
+ * | %Action Name           | %Control method called                             |
+ * |------------------------|----------------------------------------------------|
+ * | accessibilityActivated | %OnAccessibilityActivated()                        |
  */
 class DALI_IMPORT_API Control : public CustomActor
 {
@@ -88,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
     };
   };
 
@@ -262,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.
@@ -271,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;
@@ -278,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 );