Added version when deprecated to the documentation for Button/PushButton
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / public-api / controls / buttons / button.h
index 9ba5348..34ea28f 100644 (file)
@@ -31,6 +31,10 @@ namespace Internal DALI_INTERNAL
 {
 class Button;
 }
+/**
+ * @addtogroup dali-toolkit-controls-buttons
+ * @{
+ */
 
 /**
  * @brief Button is a base class for different kind of buttons.
@@ -106,8 +110,11 @@ public:
       UNSELECTED_STATE_IMAGE,          ///< name "unselected-state-image",       @see SetUnselectedImage(),           type std::string
       SELECTED_STATE_IMAGE,            ///< name "selected-state-image",         @see SetSelectedImage(),             type std::string
       DISABLED_STATE_IMAGE,            ///< name "disabled-state-image",         @see SetDisabledImage(),             type std::string
-      UNSELECTED_COLOR,                ///< name "unselected-color",             @see SetUnselectedColor(),           type Vector4
-      SELECTED_COLOR,                  ///< name "selected-color",               @see SetSelectedColor(),             type Vector4
+      UNSELECTED_COLOR,                ///< name "unselected-color",                                                  type Vector4
+      SELECTED_COLOR,                  ///< name "selected-color",                                                    type Vector4
+      LABEL,                           ///< name "label",                                                             type Property::Map
+
+      // Deprecated properties:
       LABEL_TEXT,                      ///< name "label-text",                   @see SetLabelText(),                 type std::string
     };
   };
@@ -319,31 +326,46 @@ public:
   // Deprecated API
 
   /**
-   * @deprecated Sets the label with an actor.
+   * @brief Sets the label with an actor.
+   *
+   * @deprecated DALi 1.0.50
+   *
    * @param[in]  label The actor to use as a label
    */
   void SetLabel( Actor label );
 
   /**
-   * @deprecated Sets the button image.
+   * @brief Sets the button image.
+   *
+   * @deprecated DALi 1.0.50
+   *
    * @param[in]  image The button image.
    */
   void SetButtonImage( Image image );
 
   /**
-   * @deprecated Sets the selected image.
+   * @brief Sets the selected image.
+   *
+   * @deprecated DALi 1.0.50
+   *
    * @param[in]  image The selected image.
    */
   void SetSelectedImage( Image image );
 
   /**
-   * @deprecated Gets the button image.
+   * @brief Gets the button image.
+   *
+   * @deprecated DALi 1.0.50
+   *
    * @return     An actor with the button image.
    */
   Actor GetButtonImage() const;
 
   /**
-   * @deprecated Gets the selected image.
+   * @brief Gets the selected image.
+   *
+   * @deprecated DALi 1.0.50
+   *
    * @return     An actor with the selected image.
    */
   Actor GetSelectedImage() const;
@@ -417,6 +439,9 @@ public: // Not intended for application developers
   DALI_INTERNAL Button( Dali::Internal::CustomActor* internal );
 };
 
+/**
+ * @}
+ */
 } // namespace Toolkit
 
 } // namespace Dali