X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=dali-toolkit%2Fpublic-api%2Fcontrols%2Fbuttons%2Fpush-button.h;h=0bb665635f18b2b14a4093475e31e0d7bd712bdb;hp=0e53a9c6b1a8c9c96f479074fdda2e195de51870;hb=2eb0f016cf4d8a8282681283ae0e842c0c67bded;hpb=8269fc656ce5c08314e340932c2af762e7234628 diff --git a/dali-toolkit/public-api/controls/buttons/push-button.h b/dali-toolkit/public-api/controls/buttons/push-button.h index 0e53a9c..0bb6656 100644 --- a/dali-toolkit/public-api/controls/buttons/push-button.h +++ b/dali-toolkit/public-api/controls/buttons/push-button.h @@ -35,6 +35,10 @@ namespace Internal DALI_INTERNAL class PushButton; } +/** + * @addtogroup dali_toolkit_controls_buttons + * @{ + */ /** * @brief A PushButton changes its appearance when is pressed and returns to its original when is released. @@ -43,6 +47,7 @@ class PushButton; * and a Button::ReleasedSignal() signal when it's released or having pressed it, the touch point leaves the boundary of the button. * * See Button for more detail on signals and modifying appearance via properties. + * @SINCE_1_0.0 */ class DALI_IMPORT_API PushButton : public Button { @@ -50,25 +55,27 @@ public: /** * @brief The start and end property ranges for this control. + * @SINCE_1_0.0 */ enum PropertyRange { - PROPERTY_START_INDEX = Button::PROPERTY_END_INDEX + 1, - PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000 ///< Reserving 1000 property indices + PROPERTY_START_INDEX = Button::PROPERTY_END_INDEX + 1, ///< @SINCE_1_0.0 + PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000 ///< Reserving 1000 property indices @SINCE_1_0.0 }; /** * @brief An enumeration of properties belonging to the PushButton class. + * @SINCE_1_0.0 */ struct Property { enum { - UNSELECTED_ICON = PROPERTY_START_INDEX, ///< Property, name "unselected-icon", type std::string - SELECTED_ICON, ///< Property, name "selected-icon", type std::string - ICON_ALIGNMENT, ///< Property, name "icon-alignment", type std::string - LABEL_PADDING, ///< Property, name "label-padding", type Vector4 - ICON_PADDING, ///< Property, name "icon-padding", type Vector4 + UNSELECTED_ICON = PROPERTY_START_INDEX, ///< Property, name "unselectedIcon", type std::string @SINCE_1_0.0 + SELECTED_ICON, ///< Property, name "selectedIcon", type std::string @SINCE_1_0.0 + ICON_ALIGNMENT, ///< Property, name "iconAlignment", type std::string @SINCE_1_0.0 + LABEL_PADDING, ///< Property, name "labelPadding", type Vector4 @SINCE_1_0.0 + ICON_PADDING, ///< Property, name "iconPadding", type Vector4 @SINCE_1_0.0 }; }; @@ -78,16 +85,19 @@ public: * @brief Create an uninitialized PushButton; this can be initialized with PushButton::New(). * * Calling member functions with an uninitialized Dali::Object is not allowed. + * @SINCE_1_0.0 */ PushButton(); /** * @brief Copy constructor. + * @SINCE_1_0.0 */ PushButton( const PushButton& pushButton ); /** * @brief Assignment operator. + * @SINCE_1_0.0 */ PushButton& operator=( const PushButton& pushButton ); @@ -95,12 +105,14 @@ public: * @brief Destructor * * This is non-virtual since derived Handle types must not contain data or virtual methods. + * @SINCE_1_0.0 */ ~PushButton(); /** * @brief Create an initialized PushButton. * + * @SINCE_1_0.0 * @return A handle to a newly allocated Dali resource. */ static PushButton New(); @@ -111,6 +123,7 @@ public: * If handle points to a PushButton the downcast produces valid * handle. If not the returned handle is left uninitialized. * + * @SINCE_1_0.0 * @param[in] handle Handle to an object * @return handle to a PushButton or an uninitialized handle */ @@ -122,7 +135,11 @@ public: using Button::SetButtonImage; /** - * @deprecated Sets the unselected image with an Actor. + * @deprecated DALi 1.0.50 + * + * @brief Sets the unselected image with an Actor. + * + * @SINCE_1_0.0 * @param[in] image The Actor to use. */ void SetButtonImage( Actor image ); @@ -130,7 +147,11 @@ public: using Button::SetBackgroundImage; /** - * @deprecated Sets the background image with an Actor. + * @deprecated DALi 1.0.50 + * + * @brief Sets the background image with an Actor. + * + * @SINCE_1_0.0 * @param[in] image The Actor to use. */ void SetBackgroundImage( Actor image ); @@ -138,7 +159,11 @@ public: using Button::SetSelectedImage; /** - * @deprecated Sets the selected image with an Actor. + * @deprecated DALi 1.0.50 + * + * @brief Sets the selected image with an Actor. + * + * @SINCE_1_0.0 * @param[in] image The Actor to use. */ void SetSelectedImage( Actor image ); @@ -146,7 +171,11 @@ public: using Button::SetSelectedBackgroundImage; /** - * @deprecated Sets the selected background image with an Actor. + * @deprecated DALi 1.0.50 + * + * @brief Sets the selected background image with an Actor. + * + * @SINCE_1_0.0 * @param[in] image The Actor to use. */ void SetSelectedBackgroundImage( Actor image ); @@ -154,7 +183,11 @@ public: using Button::SetDisabledBackgroundImage; /** - * @deprecated Sets the disabled background image with an Actor. + * @deprecated DALi 1.0.50 + * + * @brief Sets the disabled background image with an Actor. + * + * @SINCE_1_0.0 * @param[in] image The Actor to use. */ void SetDisabledBackgroundImage( Actor image ); @@ -162,7 +195,11 @@ public: using Button::SetDisabledImage; /** - * @deprecated Sets the disabled image with an Actor. + * @deprecated DALi 1.0.50 + * + * @brief Sets the disabled image with an Actor. + * + * @SINCE_1_0.0 * @param[in] image The Actor to use. */ void SetDisabledImage( Actor image ); @@ -170,7 +207,11 @@ public: using Button::SetDisabledSelectedImage; /** - * @deprecated Sets the disabled selected image with an Actor. + * @deprecated DALi 1.0.50 + * + * @brief Sets the disabled selected image with an Actor. + * + * @SINCE_1_0.0 * @param[in] image The Actor to use. */ void SetDisabledSelectedImage( Actor image ); @@ -181,6 +222,7 @@ public: // Not intended for application developers /** * @brief Creates a handle using the Toolkit::Internal implementation. * + * @SINCE_1_0.0 * @param[in] implementation The Control implementation. */ DALI_INTERNAL PushButton( Internal::PushButton& implementation ); @@ -188,11 +230,15 @@ public: // Not intended for application developers /** * @brief Allows the creation of this Control from an Internal::CustomActor pointer. * + * @SINCE_1_0.0 * @param[in] internal A pointer to the internal CustomActor. */ DALI_INTERNAL PushButton( Dali::Internal::CustomActor* internal ); }; +/** + * @} + */ } // namespace Toolkit } // namespace Dali