X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali-toolkit%2Fpublic-api%2Fcontrols%2Fbuttons%2Fbutton.h;h=2544d46c67aa0e45d92ed77d638e478ce670d59a;hb=73bd6099851981f1e166a809105e2096c5620303;hp=e447554129e2819f2500e353a038d1b71fd5cdd5;hpb=dcb7f468bb8be12336f8f35f637efa87130eab01;p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git diff --git a/dali-toolkit/public-api/controls/buttons/button.h b/dali-toolkit/public-api/controls/buttons/button.h index e447554..2544d46 100644 --- a/dali-toolkit/public-api/controls/buttons/button.h +++ b/dali-toolkit/public-api/controls/buttons/button.h @@ -1,8 +1,8 @@ -#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) 2019 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. @@ -85,12 +85,12 @@ class Button; * | 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 @@ -100,13 +100,13 @@ public: }; /** - * @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 @@ -154,42 +154,39 @@ public: 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 + * @brief name "unselectedVisual", type string if it is a url, map otherwise. + * @details Sets the unselected button foreground/icon visual + * @SINCE_1_4.32 */ - UNSELECTED_STATE_IMAGE, + UNSELECTED_VISUAL, /** - * @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 + * @brief name "selectedImage", type string if it is a url, map otherwise + * @details Sets the selected button foreground/icon visual + * @SINCE_1_4.32 */ - SELECTED_STATE_IMAGE, + SELECTED_VISUAL, /** - * @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 + * @brief name "disabledSelectedVisual", type string if it is a url, map otherwise + * @details Sets the disabled selected state foreground/icon button visual + * @SINCE_1_4.32 */ - DISABLED_STATE_IMAGE, + DISABLED_SELECTED_VISUAL, /** - * @DEPRECATED_1_1.XX Use UNSELECTED_BACKGROUND_VISUAL - * @brief name "unselectedColor", type Vector4 - * @SINCE_1_0.0 + * @brief name "disabledUnselectedVisual", type string if it is a url, map otherwise + * @details Sets the disabled unselected state foreground/icon visual + * @SINCE_1_4.32 */ - UNSELECTED_COLOR, + DISABLED_UNSELECTED_VISUAL, /** - * @DEPRECATED_1_1.XX Use SELECTED_BACKGROUND_VISUAL - * @brief name "selectedColor", type Vector4 - * @SINCE_1_0.0 + * @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_4.32 */ - SELECTED_COLOR, + UNSELECTED_BACKGROUND_VISUAL, /** * @brief name "label", type Property::Map or std::string @@ -198,18 +195,32 @@ public: LABEL, /** - * @DEPRECATED_1_1.32 Use LABEL - * @brief name "labelText", type std::string - * @SINCE_1_0.0 + * @brief name "selectedBackgroundVisual", type string if it is a url, map otherwise + * @details Sets the selected background button visual + * @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_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_4.32 */ - LABEL_TEXT + DISABLED_SELECTED_BACKGROUND_VISUAL, }; }; 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. @@ -233,10 +244,10 @@ public: Button& operator=( const Button& button ); /** - * @brief Downcast a handle to Button handle. + * @brief Downcasts a handle to Button handle. * - * If handle points to a Button the downcast produces valid - * handle. If not the returned handle is left uninitialized. + * 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 @@ -245,316 +256,17 @@ public: static Button DownCast( BaseHandle handle ); /** - * @brief Destructor + * @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; - - /** - * @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 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. - */ - void SetTogglableButton( bool togglable ) DALI_DEPRECATED_API; - - /** - * @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 Set Control::Property::BACKGROUND which is same as un-selected background - * Or use DevelButton::Property::UNSELECTED_BACKGROUND_VISUAL - * - * @brief Sets the 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_1.32 Set Control::Property::BACKGROUND which is same as un-selected background - * Or use DevelButton::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 Only able to set Property::DISABLED_STATE_IMAGE - * Or use DevelButton::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 Property::DISABLED_STATE_IMAGE which provides same disabled image for un/selected - * Or DevelButton::Property::DISABLED_SELECTED_VISUAL to disable 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. - * - * @SINCE_1_0.0 - * @param[in] image The button image. - */ - void SetButtonImage( Image image ) DALI_DEPRECATED_API; - - /** - * @DEPRECATED_1_0.50. Instead, use SetSelectedImage( const std::string& filename ). - * - * @brief Sets the selected image. - * - * @SINCE_1_0.0 - * @param[in] image The selected image. - */ - void SetSelectedImage( Image image ) DALI_DEPRECATED_API; - - /** - * @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 DALI_DEPRECATED_API; - - /** - * @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 DALI_DEPRECATED_API; - public: //Signals /** - * @brief Button signal type + * @brief Button signal type. * @SINCE_1_0.0 */ typedef Signal< bool ( Button ) > ButtonSignalType; @@ -567,7 +279,7 @@ public: //Signals * bool YourCallbackName( Button button ); * @endcode * @SINCE_1_0.0 - * @return The signal to connect to. + * @return The signal to connect to */ ButtonSignalType& PressedSignal(); @@ -579,7 +291,7 @@ public: //Signals * bool YourCallbackName( Button button ); * @endcode * @SINCE_1_0.0 - * @return The signal to connect to. + * @return The signal to connect to */ ButtonSignalType& ReleasedSignal(); @@ -591,7 +303,7 @@ public: //Signals * bool YourCallbackName( Button button ); * @endcode * @SINCE_1_0.0 - * @return The signal to connect to. + * @return The signal to connect to */ ButtonSignalType& ClickedSignal(); @@ -605,7 +317,7 @@ public: //Signals * bool YourCallbackName( Button button ); * @endcode * @SINCE_1_0.0 - * @return The signal to connect to. + * @return The signal to connect to */ ButtonSignalType& StateChangedSignal(); @@ -616,7 +328,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. + * @param[in] implementation The Control implementation */ DALI_INTERNAL Button( Internal::Button& implementation ); @@ -624,7 +336,7 @@ 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. + * @param[in] internal A pointer to the internal CustomActor */ DALI_INTERNAL Button( Dali::Internal::CustomActor* internal ); /// @endcond @@ -637,4 +349,4 @@ public: // Not intended for application developers } // namespace Dali -#endif // __DALI_TOOLKIT_BUTTON_H__ +#endif // DALI_TOOLKIT_BUTTON_H