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%2Fbutton.h;h=1cd6f6e0ddcf5ee0f69038cfae709337a65c5f3d;hp=8d11252af6b8d6c9443764c2e6176e87cd752715;hb=049a2eb5fc5f2fbd180ab85a72da8ca923fbf6b5;hpb=594b2670227659f2f2905b60c4d3387674a6d846 diff --git a/dali-toolkit/public-api/controls/buttons/button.h b/dali-toolkit/public-api/controls/buttons/button.h index 8d11252..1cd6f6e 100644 --- a/dali-toolkit/public-api/controls/buttons/button.h +++ b/dali-toolkit/public-api/controls/buttons/button.h @@ -66,7 +66,7 @@ class Button; * * When the button is disabled, \e background, \e button and \e selected images are replaced by their \e disabled images. * - * Is not mandatory set all images. A button could be defined only by setting its \e background image or by setting its \e background and \e selected images. + * Is not mandatory to set all images. A button could be defined only by setting its \e background image or by setting its \e background and \e selected images. * * Signals * | %Signal Name | Method | @@ -77,9 +77,9 @@ class Button; * | stateChanged | @ref StateChangedSignal() | * * Actions - * | %Action Name | %Button method called | - * |------------------|-----------------------------| - * | buttonClick | %DoClickAction() | + * | %Action Name | Attributes | Description | + * |------------------|-------------------------|-----------------------------------------------| + * | buttonClick | Doesn't have attributes | Simulates a button click. See @ref DoAction() | * @SINCE_1_0.0 */ class DALI_IMPORT_API Button : public Control @@ -102,6 +102,10 @@ public: */ struct Property { + /** + * @brief An enumeration of properties belonging to the Button class. + * @SINCE_1_0.0 + */ enum { DISABLED = PROPERTY_START_INDEX, ///< name "disabled", @see SetDisabled(), type bool @SINCE_1_0.0 @@ -136,12 +140,15 @@ public: /** * @brief Copy constructor. * @SINCE_1_0.0 + * @param[in] button Handle to an object */ Button( const Button& button ); /** * @brief Assignment operator. * @SINCE_1_0.0 + * @param[in] button Handle to an object + * @return A reference to this */ Button& operator=( const Button& button ); @@ -165,7 +172,11 @@ public: */ ~Button(); + // Deprecated API + /** + * @DEPRECATED_1_1.32 Use SetProperty DISABLED or Styling file + * * @brief Sets the button as \e disabled. * * No signals are emitted when the \e disabled property is set. @@ -176,6 +187,8 @@ public: void SetDisabled( bool disabled ); /** + * @DEPRECATED_1_1.32 Use GetProperty DISABLED + * * @brief Returns if the button is disabled. * @SINCE_1_0.0 * @return \e true if the button is \e disabled. @@ -183,6 +196,8 @@ public: bool IsDisabled() const; /** + * @DEPRECATED_1_1.32 SetProperty AUTO_REPEATING or Styling file + * * @brief Sets the \e autorepeating property. * * If the \e autorepeating property is set to \e true, then the \e togglable property is set to false @@ -194,6 +209,8 @@ public: void SetAutoRepeating( bool autoRepeating ); /** + * @DEPRECATED_1_1.32 GetProperty AUTO_REPEATING + * * @brief Returns if the autorepeating property is set. * @SINCE_1_0.0 * @return \e true if the \e autorepeating property is set. @@ -201,6 +218,8 @@ public: bool IsAutoRepeating() const; /** + * @DEPRECATED_1_1.32 SetProperty INITIAL_AUTO_REPEATING_DELAY or Styling file + * * @brief Sets the initial autorepeating delay. * * By default this value is set to 0.15 seconds. @@ -212,6 +231,8 @@ public: void SetInitialAutoRepeatingDelay( float initialAutoRepeatingDelay ); /** + * @DEPRECATED_1_1.32 GetProperty INITIAL_AUTO_REPEATING_DELAY + * * @brief Gets the initial autorepeating delay in seconds. * @SINCE_1_0.0 * @return the initial autorepeating delay in seconds. @@ -219,6 +240,8 @@ public: float GetInitialAutoRepeatingDelay() const; /** + * @DEPRECATED_1_1.32 SetProperty NEXT_AUTO_REPEATING_DELAY or Styling file + * * @brief Sets the next autorepeating delay. * * By default this value is set to 0.05 seconds. @@ -230,6 +253,8 @@ public: void SetNextAutoRepeatingDelay( float nextAutoRepeatingDelay ); /** + * @DEPRECATED_1_1.32 GetProperty NEXT_AUTO_REPEATING_DELAY + * * @brief Gets the next autorepeating delay in seconds. * @SINCE_1_0.0 * @return the next autorepeating delay in seconds. @@ -237,6 +262,8 @@ public: float GetNextAutoRepeatingDelay() const; /** + * @DEPRECATED_1_1.32 SetProperty TOGGLABLE or Styling file + * * @brief Sets the \e togglable property. * * If the \e togglable property is set to \e true, then the \e autorepeating property is set to false. @@ -247,6 +274,8 @@ public: void SetTogglableButton( bool togglable ); /** + * @DEPRECATED_1_1.32 GetProperty TOGGLABLE + * * @brief Returns if the togglable property is set. * @SINCE_1_0.0 * @return \e true if the \e togglable property is set. @@ -254,6 +283,8 @@ public: bool IsTogglableButton() const; /** + * @DEPRECATED_1_1.32 SetProperty SELECTED + * * @brief Sets the button as selected or unselected. * * \e togglable property must be set to \e true. @@ -266,6 +297,8 @@ public: void SetSelected( bool selected ); /** + * DEPRECATED_1_1.32 SetProperty SELECTED + * * @brief Returns if the selected property is set and the button is togglable. * @SINCE_1_0.0 * @return \e true if the button is \e selected. @@ -273,6 +306,8 @@ public: bool IsSelected() const; /** + * @DEPRECATED_1_1.32 Use Styling file to set animation + * * @brief Sets the animation time. * * @SINCE_1_0.0 @@ -281,6 +316,8 @@ public: void SetAnimationTime( float animationTime ); /** + * DEPRECATED_1_1.32 Use Styling file to set animation + * * @brief Retrieves button's animation time. * * @SINCE_1_0.0 @@ -289,6 +326,8 @@ public: float GetAnimationTime() const; /** + * @DEPRECATED_1_1.32 SetProperty LABEL or Styling file + * * @brief Sets the button's label. * * @SINCE_1_0.0 @@ -297,6 +336,8 @@ public: void SetLabelText( const std::string& label ); /** + * DEPRECATED_1_1.32 GetProperty LABEL + * * @brief Gets the label. * * @SINCE_1_0.0 @@ -305,6 +346,8 @@ public: std::string GetLabelText() const; /** + * @DEPRECATED_1_1.32 Use Styling file + * * @brief Sets the unselected button image. * * @SINCE_1_0.0 @@ -313,6 +356,8 @@ public: void SetUnselectedImage( const std::string& filename ); /** + * @DEPRECATED_1_1.32 Use styling + * * @brief Sets the background image. * * @SINCE_1_0.0 @@ -321,6 +366,8 @@ public: void SetBackgroundImage( const std::string& filename ); /** + * @DEPRECATED_1_1.32 Use styling file + * * @brief Sets the selected image. * * @SINCE_1_0.0 @@ -329,6 +376,8 @@ public: void SetSelectedImage( const std::string& filename ); /** + * @DEPRECATED_1_1.32 Use styling file + * * @brief Sets the selected background image. * * @SINCE_1_0.0 @@ -337,6 +386,8 @@ public: void SetSelectedBackgroundImage( const std::string& filename ); /** + * @DEPRECATED_1_1.32 Use styling file + * * @brief Sets the disabled background image. * * @SINCE_1_0.0 @@ -345,6 +396,8 @@ public: void SetDisabledBackgroundImage( const std::string& filename ); /** + * @DEPRECATED_1_1.32 Use styling file + * * @brief Sets the disabled button image. * * @SINCE_1_0.0 @@ -353,6 +406,8 @@ public: void SetDisabledImage( const std::string& filename ); /** + * @DEPRECATED_1_1.32 Use styling file + * * @brief Sets the disabled selected button image. * * @SINCE_1_0.0 @@ -360,8 +415,6 @@ public: */ void SetDisabledSelectedImage( const std::string& filename ); - // Deprecated API - /** * @DEPRECATED_1_0.50. Instead, use SetLabelText. * @@ -474,6 +527,7 @@ public: //Signals public: // Not intended for application developers + /// @cond internal /** * @brief Creates a handle using the Toolkit::Internal implementation. * @@ -489,6 +543,7 @@ public: // Not intended for application developers * @param[in] internal A pointer to the internal CustomActor. */ DALI_INTERNAL Button( Dali::Internal::CustomActor* internal ); + /// @endcond }; /**