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=79c1b80353c05fd298ff7732c0531f5e45fc4fc0;hp=daeb4033d8d5509862e9e553cdfdf97ff13517ec;hb=683d9badef4220d710d29f7967aa9ad093372cd6;hpb=2eb0f016cf4d8a8282681283ae0e842c0c67bded diff --git a/dali-toolkit/public-api/controls/buttons/button.h b/dali-toolkit/public-api/controls/buttons/button.h index daeb403..79c1b80 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 | @@ -146,14 +146,14 @@ public: Button& operator=( const Button& button ); /** - * @brief Downcast an Object handle to Button. + * @brief Downcast a handle to Button handle. * * If handle points to a Button 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 Button or an uninitialized handle + * @return A handle to a Button or an uninitialized handle */ static Button DownCast( BaseHandle handle ); @@ -165,7 +165,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,12 +180,17 @@ 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. */ 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 @@ -193,12 +202,17 @@ 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. */ 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. @@ -210,12 +224,17 @@ 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. */ 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. @@ -227,12 +246,17 @@ 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. */ 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. @@ -243,12 +267,17 @@ 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. */ 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. @@ -261,12 +290,17 @@ 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 \e selected property is set and the button is togglable. + * @return \e true if the button is \e selected. */ bool IsSelected() const; /** + * @DEPRECATED_1_1.32 Use Styling file to set animation + * * @brief Sets the animation time. * * @SINCE_1_0.0 @@ -275,6 +309,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 @@ -283,6 +319,8 @@ public: float GetAnimationTime() const; /** + * @DEPRECATED_1_1.32 SetProperty LABEL or Styling file + * * @brief Sets the button's label. * * @SINCE_1_0.0 @@ -291,6 +329,8 @@ public: void SetLabelText( const std::string& label ); /** + * DEPRECATED_1_1.32 GetProperty LABEL + * * @brief Gets the label. * * @SINCE_1_0.0 @@ -299,6 +339,8 @@ public: std::string GetLabelText() const; /** + * @DEPRECATED_1_1.32 Use Styling file + * * @brief Sets the unselected button image. * * @SINCE_1_0.0 @@ -307,6 +349,8 @@ public: void SetUnselectedImage( const std::string& filename ); /** + * @DEPRECATED_1_1.32 Use styling + * * @brief Sets the background image. * * @SINCE_1_0.0 @@ -315,6 +359,8 @@ public: void SetBackgroundImage( const std::string& filename ); /** + * @DEPRECATED_1_1.32 Use styling file + * * @brief Sets the selected image. * * @SINCE_1_0.0 @@ -323,6 +369,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 @@ -331,6 +379,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 @@ -339,6 +389,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 @@ -347,6 +399,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 @@ -354,10 +408,8 @@ public: */ void SetDisabledSelectedImage( const std::string& filename ); - // Deprecated API - /** - * @deprecated DALi 1.0.50 + * @DEPRECATED_1_0.50. Instead, use SetLabelText. * * @brief Sets the label with an actor. * @@ -367,7 +419,7 @@ public: void SetLabel( Actor label ); /** - * @deprecated DALi 1.0.50 + * @DEPRECATED_1_0.50. Instead, use SetUnselectedImage. * * @brief Sets the button image. * @@ -377,7 +429,7 @@ public: void SetButtonImage( Image image ); /** - * @deprecated DALi 1.0.50 + * @DEPRECATED_1_0.50. Instead, use SetSelectedImage( const std::string& filename ). * * @brief Sets the selected image. * @@ -387,21 +439,23 @@ public: void SetSelectedImage( Image image ); /** - * @deprecated DALi 1.0.50 + * @DEPRECATED_1_0.50 * * @brief Gets the button image. * * @SINCE_1_0.0 + * @remarks Avoid using this method as it's a legacy code. * @return An actor with the button image. */ Actor GetButtonImage() const; /** - * @deprecated DALi 1.0.50 + * @DEPRECATED_1_0.50 * * @brief Gets the selected image. * * @SINCE_1_0.0 + * @remarks Avoid using this method as it's a legacy code. * @return An actor with the selected image. */ Actor GetSelectedImage() const; @@ -452,6 +506,7 @@ public: //Signals /** * @brief This signal is emitted when the button's state is changed. + * * The application can get the state by calling IsSelected(). * * A callback of the following type may be connected: