*
* 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 |
* | 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
/**
* @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 );
/**
- * @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 );
*/
~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.
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
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.
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.
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.
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.
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
void SetAnimationTime( float animationTime );
/**
+ * DEPRECATED_1_1.32 Use Styling file to set animation
+ *
* @brief Retrieves button's animation time.
*
* @SINCE_1_0.0
float GetAnimationTime() const;
/**
+ * @DEPRECATED_1_1.32 SetProperty LABEL or Styling file
+ *
* @brief Sets the button's label.
*
* @SINCE_1_0.0
void SetLabelText( const std::string& label );
/**
+ * DEPRECATED_1_1.32 GetProperty LABEL
+ *
* @brief Gets the label.
*
* @SINCE_1_0.0
std::string GetLabelText() const;
/**
+ * @DEPRECATED_1_1.32 Use Styling file
+ *
* @brief Sets the unselected button image.
*
* @SINCE_1_0.0
void SetUnselectedImage( const std::string& filename );
/**
+ * @DEPRECATED_1_1.32 Use styling
+ *
* @brief Sets the background image.
*
* @SINCE_1_0.0
void SetBackgroundImage( const std::string& filename );
/**
+ * @DEPRECATED_1_1.32 Use styling file
+ *
* @brief Sets the selected image.
*
* @SINCE_1_0.0
void SetSelectedImage( const std::string& filename );
/**
+ * @DEPRECATED_1_1.32 Use styling file
+ *
* @brief Sets the selected background image.
*
* @SINCE_1_0.0
void SetSelectedBackgroundImage( const std::string& filename );
/**
+ * @DEPRECATED_1_1.32 Use styling file
+ *
* @brief Sets the disabled background image.
*
* @SINCE_1_0.0
void SetDisabledBackgroundImage( const std::string& filename );
/**
+ * @DEPRECATED_1_1.32 Use styling file
+ *
* @brief Sets the disabled button image.
*
* @SINCE_1_0.0
void SetDisabledImage( const std::string& filename );
/**
+ * @DEPRECATED_1_1.32 Use styling file
+ *
* @brief Sets the disabled selected button image.
*
* @SINCE_1_0.0
*/
void SetDisabledSelectedImage( const std::string& filename );
- // Deprecated API
-
/**
- * @DEPRECATED_1_0.50
+ * @DEPRECATED_1_0.50. Instead, use SetLabelText.
*
* @brief Sets the label with an actor.
*
void SetLabel( Actor label );
/**
- * @DEPRECATED_1_0.50
+ * @DEPRECATED_1_0.50. Instead, use SetUnselectedImage.
*
* @brief Sets the button image.
*
void SetButtonImage( Image image );
/**
- * @DEPRECATED_1_0.50
+ * @DEPRECATED_1_0.50. Instead, use SetSelectedImage( const std::string& filename ).
*
* @brief Sets the selected image.
*
* @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;
* @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;
/**
* @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:
public: // Not intended for application developers
+ /// @cond internal
/**
* @brief Creates a handle using the Toolkit::Internal implementation.
*
* @param[in] internal A pointer to the internal CustomActor.
*/
DALI_INTERNAL Button( Dali::Internal::CustomActor* internal );
+ /// @endcond
};
/**
projects / platform / core / uifw / dali-toolkit.git / blobdiff