-#ifndef __DALI_TOOLKIT_BUTTON_H__
-#define __DALI_TOOLKIT_BUTTON_H__
+#ifndef DALI_TOOLKIT_BUTTON_H
+#define DALI_TOOLKIT_BUTTON_H
/*
- * Copyright (c) 2015 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2020 Samsung Electronics Co., Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
namespace Dali
{
-
namespace Toolkit
{
-
namespace Internal DALI_INTERNAL
{
class Button;
*
* 'Visual' describes not just traditional images like png, bmp but refers to whatever is used to show the button, it could be a color, gradient or some other kind of renderer.
*
- * The button's appearance can be modified by setting properties for the various images.
+ * The button's appearance can be modified by setting properties for the various visuals/images.
*
* It is not mandatory to set all visuals. A button could be defined only by setting its \e background visual or by setting its \e background and \e selected visuals.
*
- * The \e button visual is shown over the \e background visual..
+ * The \e button visual is shown over the \e background visual.
* When pressed the unselected visuals are replaced by the \e selected visual. The text label is always placed on the top of all images.
*
* When the button is disabled, \e background, \e button and \e selected visuals are replaced by their \e disabled visuals.
*
-
- *
- * @brief A control which renders a short text string.
- *
- * Text labels are lightweight, non-editable and do not respond to user input.
- *
- *
- * @section ButtonProperties Properties
- * |%Property enum |String name |Type |Writable|Animatable|
- * |-------------------------------------------------------|----------------------------------------|--------------|--------|----------|
- * | Property::DISABLED | disabled | BOOLEAN | Y | N |
- * | Property::AUTO_REPEATING | autoRepeating | BOOLEAN | Y | N |
- * | Property::INITIAL_AUTO_REPEATING_DELAY | initialAutoRepeatingDelay | FLOAT | Y | N |
- * | Property::NEXT_AUTO_REPEATING_DELAY | nextAutoRepeatingDelay | FLOAT | Y | N |
- * | Property::TOGGLABLE | togglable | BOOLEAN | Y | N |
- * | Property::SELECTED | selected | BOOLEAN | Y | N |
- * | Property::LABEL | label | MAP | Y | N |
- * | Property::UNSELECTED_STATE_VISUAL | unselectedVisual | MAP | Y | N |
- * | Property::SELECTED_VISUAL | selectedVisual | MAP | Y | N |
- * | Property::DISABLED_SELECTED_VISUAL | disabledSelectedVisual | MAP | Y | N |
- * | Property::DISABLED_UNSELECTED_VISUAL | disabledUnselectedVisual | MAP | Y | N |
- * | Property::UNSELECTED_BACKGROUND_VISUAL | unselectedBackgroundVisual | MAP | Y | N |
- * | Property::SELECTED_BACKGROUND_VISUAL | selectedBackgroundVisual | MAP | Y | N |
- * | Property::DISABLED_UNSELECTED_BACKGROUND_VISUAL | disabledUnselectedBackgroundVisual | MAP | Y | N |
- * | Property::DISABLED_SELECTED_BACKGROUND_VISUAL | disabledSelectedBackgroundVisual | MAP | Y | N |
- * | Property::LABEL_RELATIVE_ALIGNMENT | labelRelativeAlignment | STRING | Y | N |
- * -------------------------------------------------------------------------------------------------------------------------------------
- *
- * Note, *_VISUAL properties of type MAP can also be passed a uri of type STRING
*
* Signals
* | %Signal Name | Method |
* | buttonClick | Doesn't have attributes | Simulates a button click. See @ref DoAction() |
* @SINCE_1_0.0
*/
-class DALI_IMPORT_API Button : public Control
+class DALI_TOOLKIT_API Button : public Control
{
public:
-
/**
- * @brief The start and end property ranges for this control.
+ * @brief Enumeration for the start and end property ranges for this control.
* @SINCE_1_0.0
*/
enum PropertyRange
{
PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1, ///< @SINCE_1_0.0
- PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000 ///< Reserve property indices @SINCE_1_0.0
+ PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000 ///< Reserve property indices @SINCE_1_0.0
};
/**
- * @brief An enumeration of properties belonging to the Button class.
+ * @brief Enumeration for the instance of properties belonging to the Button class.
* @SINCE_1_0.0
*/
struct Property
{
/**
- * @brief An enumeration of properties belonging to the Button class.
+ * @brief Enumeration for the instance of properties belonging to the Button class.
* @SINCE_1_0.0
*/
enum
SELECTED,
/**
- * @DEPRECATED_1_1.XX Use UNSELECTED_VISUAL
- * @brief name "unselectedStateImage", type string if it is a url, map otherwise
- * @details Sets the unselected button foreground image
- * @SINCE_1_0.0
- */
- UNSELECTED_STATE_IMAGE,
-
- /**
- * @DEPRECATED_1_1.XX Use SELECTED_VISUAL
- * @brief name "selectedStateImage", type string if it is a url, map otherwise
- * @details Sets the selected button foreground image
- * @SINCE_1_0.0
- */
- SELECTED_STATE_IMAGE,
-
- /**
- * @DEPRECATED_1_1.XX Use DISABLED_UNSELECTED_VISUAL
- * @brief name "disabledStateImage", type string if it is a url, map otherwise
- * @details Sets the disabled whilst unselected foreground button visual
- * @SINCE_1_0.0
- */
- DISABLED_STATE_IMAGE,
-
- /**
- * @DEPRECATED_1_1.XX Use UNSELECTED_BACKGROUND_VISUAL
- * @brief name "unselectedColor", type Vector4
- * @SINCE_1_0.0
- */
- UNSELECTED_COLOR,
-
- /**
- * @DEPRECATED_1_1.XX Use SELECTED_BACKGROUND_VISUAL
- * @brief name "selectedColor", type Vector4
- * @SINCE_1_0.0
- */
- SELECTED_COLOR,
-
- /**
- * @brief name "label", type Property::Map
- * @SINCE_1_0.0
- */
- LABEL,
-
- /**
- * @DEPRECATED_1_1.32 Use LABEL
- * @brief name "labelText", type std::string
- * @SINCE_1_0.0
- */
- LABEL_TEXT,
-
- /**
- * @brief name "unselectedVisual", type string if it is a url, map otherwise
+ * @brief name "unselectedVisual", type string if it is a url, map otherwise.
* @details Sets the unselected button foreground/icon visual
- * @SINCE_1_2.XX
+ * @SINCE_1_4.32
*/
UNSELECTED_VISUAL,
/**
* @brief name "selectedImage", type string if it is a url, map otherwise
* @details Sets the selected button foreground/icon visual
- * @SINCE_1_2.XX
+ * @SINCE_1_4.32
*/
SELECTED_VISUAL,
/**
* @brief name "disabledSelectedVisual", type string if it is a url, map otherwise
* @details Sets the disabled selected state foreground/icon button visual
- * @SINCE_1_2.XX
+ * @SINCE_1_4.32
*/
DISABLED_SELECTED_VISUAL,
/**
- * @brief name "disabledUnSelectedVisual", type string if it is a url, map otherwise
+ * @brief name "disabledUnselectedVisual", type string if it is a url, map otherwise
* @details Sets the disabled unselected state foreground/icon visual
- * @SINCE_1_2.XX
+ * @SINCE_1_4.32
*/
DISABLED_UNSELECTED_VISUAL,
/**
* @brief name "unselectedBackgroundVisual", type string if it is a url, map otherwise
* @details Sets the disabled in the unselected state background, button visual
- * @SINCE_1_2.XX
+ * @SINCE_1_4.32
*/
UNSELECTED_BACKGROUND_VISUAL,
/**
+ * @brief name "label", type Property::Map or std::string
+ * @SINCE_1_0.0
+ */
+ LABEL,
+
+ /**
* @brief name "selectedBackgroundVisual", type string if it is a url, map otherwise
* @details Sets the selected background button visual
- * @SINCE_1_2.XX
+ * @SINCE_1_4.32
*/
SELECTED_BACKGROUND_VISUAL,
/**
* @brief name "disabledUnselectedBackgroundVisual", type string if it is a url, map otherwise
* @details Sets the disabled while unselected background button visual
- * @SINCE_1_2.XX
+ * @SINCE_1_4.32
*/
DISABLED_UNSELECTED_BACKGROUND_VISUAL,
/**
* @brief name "disabledSelectedBackgroundVisual", type string if it is a url, map otherwise
* @details Sets the disabled while selected background button visual
- * @SINCE_1_2.XX
+ * @SINCE_1_4.32
*/
DISABLED_SELECTED_BACKGROUND_VISUAL,
-
- /**
- * @brief name "labelRelativeAlignment", type STRING
- * @details Sets the position of the the label in relation to the foreground/icon if both present
- * @SINCE_1_2.XX
- */
- LABEL_RELATIVE_ALIGNMENT,
};
};
public:
-
/**
- * @brief Create an uninitialized Button.
+ * @brief Creates an uninitialized Button.
*
* Only derived versions can be instantiated. Calling member
* functions with an uninitialized Dali::Object is not allowed.
* @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 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 A handle to a Button or an uninitialized handle
- */
- static Button DownCast( BaseHandle handle );
-
- /**
- * @brief Destructor
- *
- * This is non-virtual since derived Handle types must not contain data or virtual methods.
- * @SINCE_1_0.0
- */
- ~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.
- *
- * @SINCE_1_0.0
- * @param[in] disabled property.
- */
- void SetDisabled( bool disabled ) DALI_DEPRECATED_API;
-
- /**
- * @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 DALI_DEPRECATED_API;
-
- /**
- * @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
- * but no signal is emitted.
- *
- * @SINCE_1_0.0
- * @param[in] autoRepeating \e autorepeating property.
- */
- void SetAutoRepeating( bool autoRepeating ) DALI_DEPRECATED_API;
-
- /**
- * @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 DALI_DEPRECATED_API;
-
- /**
- * @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.
- *
- * @SINCE_1_0.0
- * @param[in] initialAutoRepeatingDelay in seconds.
- * @pre initialAutoRepeatingDelay must be greater than zero.
- */
- void SetInitialAutoRepeatingDelay( float initialAutoRepeatingDelay ) DALI_DEPRECATED_API;
-
- /**
- * @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 DALI_DEPRECATED_API;
-
- /**
- * @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.
- *
- * @SINCE_1_0.0
- * @param[in] nextAutoRepeatingDelay in seconds.
- * @pre nextAutoRepeatingDelay must be greater than zero.
- */
- void SetNextAutoRepeatingDelay( float nextAutoRepeatingDelay ) DALI_DEPRECATED_API;
+ Button(const Button& button);
/**
- * @DEPRECATED_1_1.32 GetProperty NEXT_AUTO_REPEATING_DELAY
+ * @brief Move constructor
+ * @SINCE_1_9.23
*
- * @brief Gets the next autorepeating delay in seconds.
- * @SINCE_1_0.0
- * @return the next autorepeating delay in seconds.
- */
- float GetNextAutoRepeatingDelay() const DALI_DEPRECATED_API;
-
- /**
- * @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.
- *
- * @SINCE_1_0.0
- * @param[in] togglable property.
+ * @param[in] rhs A reference to the moved handle
*/
- void SetTogglableButton( bool togglable ) DALI_DEPRECATED_API;
+ Button(Button&& rhs) noexcept;
/**
- * @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 DALI_DEPRECATED_API;
-
- /**
- * @DEPRECATED_1_1.32 SetProperty SELECTED
- *
- * @brief Sets the button as selected or unselected.
- *
- * \e togglable property must be set to \e true.
- *
- * Emits a Button::StateChangedSignal() signal.
- *
- * @SINCE_1_0.0
- * @param[in] selected property.
- */
- void SetSelected( bool selected ) DALI_DEPRECATED_API;
-
- /**
- * DEPRECATED_1_1.32 GetProperty 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.
- */
- bool IsSelected() const DALI_DEPRECATED_API;
-
- /**
- * @DEPRECATED_1_1.32 Use Styling file to set animation
- *
- * @brief Sets the animation time.
- *
- * @SINCE_1_0.0
- * @param[in] animationTime The animation time in seconds.
- */
- void SetAnimationTime( float animationTime ) DALI_DEPRECATED_API;
-
- /**
- * DEPRECATED_1_1.32 Use Styling file to set animation
- *
- * @brief Retrieves button's animation time.
- *
- * @SINCE_1_0.0
- * @return The animation time in seconds.
- */
- float GetAnimationTime() const DALI_DEPRECATED_API;
-
- /**
- * @DEPRECATED_1_1.32 SetProperty Property::LABEL or Styling file
- *
- * @brief Sets the button's label.
- *
- * @SINCE_1_0.0
- * @param[in] label The label text.
- */
- void SetLabelText( const std::string& label ) DALI_DEPRECATED_API;
-
- /**
- * DEPRECATED_1_1.32 GetProperty LABEL
- *
- * @brief Gets the label.
- *
- * @SINCE_1_0.0
- * @return The label text.
- */
- std::string GetLabelText() const DALI_DEPRECATED_API;
-
- /**
- * @DEPRECATED_1_1.32 Use Styling file Property::UNSELECTED_STATE_IMAGE
- *
- * @brief Sets the unselected button image.
- *
- * @SINCE_1_0.0
- * @param[in] filename The button image.
- */
- void SetUnselectedImage( const std::string& filename ) DALI_DEPRECATED_API;
-
- /**
- * @DEPRECATED_1_1.32 Use styling
- * Use Property::UNSELECTED_BACKGROUND_VISUAL
- *
- * @brief Sets the unselected background image.
- *
- * @SINCE_1_0.0
- * @param[in] filename The background image.
- */
- void SetBackgroundImage( const std::string& filename ) DALI_DEPRECATED_API;
-
- /**
- * @DEPRECATED_1_1.32 Use styling file, Property::SELECTED_STATE_IMAGE
- *
- * @brief Sets the selected image.
- *
- * @SINCE_1_0.0
- * @param[in] filename The selected image.
- */
- void SetSelectedImage( const std::string& filename ) DALI_DEPRECATED_API;
-
- /**
- * @DEPRECATED_1_2.32 Use styling file
- * Use Property::SELECTED_BACKGROUND_VISUAL
- *
- * @brief Sets the selected background image.
- *
- * @SINCE_1_0.0
- * @param[in] filename The selected background image.
- */
- void SetSelectedBackgroundImage( const std::string& filename ) DALI_DEPRECATED_API;
-
- /**
- * @DEPRECATED_1_1.32 Use styling file
- * Use Property::DISABLED_SELECTED_BACKGROUND_VISUAL
- *
- * @brief Sets the disabled background image.
- *
- * @SINCE_1_0.0
- * @param[in] filename The disabled background image.
- */
- void SetDisabledBackgroundImage( const std::string& filename ) DALI_DEPRECATED_API;
-
- /**
- * @DEPRECATED_1_1.32 Use styling file Property::DISABLED_STATE_IMAGE
- *
- * @brief Sets the disabled button image.
- *
- * @SINCE_1_0.0
- * @param[in] filename The disabled button image.
- */
- void SetDisabledImage( const std::string& filename ) DALI_DEPRECATED_API;
-
- /**
- * @DEPRECATED_1_1.32 Use styling file
- * Use Property::DISABLED_SELECTED_VISUAL
- *
- * @brief Sets the disabled selected button image.
- *
- * @SINCE_1_0.0
- * @param[in] filename The disabled selected button image.
- */
- void SetDisabledSelectedImage( const std::string& filename ) DALI_DEPRECATED_API;
-
- /**
- * @DEPRECATED_1_0.50. Instead, use SetLabelText.
- *
- * @brief Sets the label with an actor.
- *
- * @SINCE_1_0.0
- * @param[in] label The actor to use as a label
- */
- void SetLabel( Actor label ) DALI_DEPRECATED_API;
-
- /**
- * @DEPRECATED_1_0.50. Instead, use SetUnselectedImage.
- *
- * @brief Sets the button image.
- *
+ * @brief Assignment operator.
* @SINCE_1_0.0
- * @param[in] image The button image.
+ * @param[in] button Handle to an object
+ * @return A reference to this
*/
- void SetButtonImage( Image image ) DALI_DEPRECATED_API;
+ Button& operator=(const Button& button);
/**
- * @DEPRECATED_1_0.50. Instead, use SetSelectedImage( const std::string& filename ).
+ * @brief Move assignment
+ * @SINCE_1_9.23
*
- * @brief Sets the selected image.
- *
- * @SINCE_1_0.0
- * @param[in] image The selected image.
+ * @param[in] rhs A reference to the moved handle
+ * @return A reference to this
*/
- void SetSelectedImage( Image image ) DALI_DEPRECATED_API;
+ Button& operator=(Button&& rhs) noexcept;
/**
- * @DEPRECATED_1_0.50
+ * @brief Downcasts a handle to Button handle.
*
- * @brief Gets the button image.
+ * If handle points to a Button, the downcast produces valid handle.
+ * If not the returned handle is left uninitialized.
*
* @SINCE_1_0.0
- * @remarks Avoid using this method as it's a legacy code.
- * @return An actor with the button image.
+ * @param[in] handle Handle to an object
+ * @return A handle to a Button or an uninitialized handle
*/
- Actor GetButtonImage() const DALI_DEPRECATED_API;
+ static Button DownCast(BaseHandle handle);
/**
- * @DEPRECATED_1_0.50
- *
- * @brief Gets the selected image.
+ * @brief Destructor.
*
+ * This is non-virtual since derived Handle types must not contain data or virtual methods.
* @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 DALI_DEPRECATED_API;
+ ~Button();
public: //Signals
-
/**
- * @brief Button signal type
+ * @brief Button signal type.
* @SINCE_1_0.0
*/
- typedef Signal< bool ( Button ) > ButtonSignalType;
+ typedef Signal<bool(Button)> ButtonSignalType;
/**
* @brief This signal is emitted when the button is touched.
* bool YourCallbackName( Button button );
* @endcode
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @return The signal to connect to
*/
ButtonSignalType& PressedSignal();
* bool YourCallbackName( Button button );
* @endcode
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @return The signal to connect to
*/
ButtonSignalType& ReleasedSignal();
* bool YourCallbackName( Button button );
* @endcode
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @return The signal to connect to
*/
ButtonSignalType& ClickedSignal();
* bool YourCallbackName( Button button );
* @endcode
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @return The signal to connect to
*/
ButtonSignalType& StateChangedSignal();
public: // Not intended for application developers
-
/// @cond internal
/**
* @brief Creates a handle using the Toolkit::Internal implementation.
*
* @SINCE_1_0.0
- * @param[in] implementation The Control implementation.
+ * @param[in] implementation The Control implementation
*/
- DALI_INTERNAL Button( Internal::Button& implementation );
+ DALI_INTERNAL Button(Internal::Button& implementation);
/**
* @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.
+ * @param[in] internal A pointer to the internal CustomActor
*/
- DALI_INTERNAL Button( Dali::Internal::CustomActor* internal );
+ DALI_INTERNAL Button(Dali::Internal::CustomActor* internal);
/// @endcond
};
} // namespace Dali
-#endif // __DALI_TOOLKIT_BUTTON_H__
+#endif // DALI_TOOLKIT_BUTTON_H
projects / platform / core / uifw / dali-toolkit.git / blobdiff