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%2Fpush-button.h;h=e237cc8551bba9701b09d155939bb4490f6ccc29;hp=a74610abad2f014c91d7b067a661f9d40b348557;hb=dea624eb348a4926d8761c8a1364f03f9f71acf5;hpb=f60d2ee843df1c81ea988c4a986e9168c905fcc9 diff --git a/dali-toolkit/public-api/controls/buttons/push-button.h b/dali-toolkit/public-api/controls/buttons/push-button.h index a74610a..e237cc8 100644 --- a/dali-toolkit/public-api/controls/buttons/push-button.h +++ b/dali-toolkit/public-api/controls/buttons/push-button.h @@ -1,8 +1,8 @@ -#ifndef __DALI_TOOLKIT_PUSH_BUTTON_H__ -#define __DALI_TOOLKIT_PUSH_BUTTON_H__ +#ifndef DALI_TOOLKIT_PUSH_BUTTON_H +#define DALI_TOOLKIT_PUSH_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. @@ -35,205 +35,183 @@ namespace Internal DALI_INTERNAL class PushButton; } +/** + * @addtogroup dali_toolkit_controls_buttons + * @{ + */ /** * @brief A PushButton changes its appearance when is pressed and returns to its original when is released. * - * By default a PushButton emits a Button::PressedSignal() signal when the button is pressed, a Button::ClickedSignal() signal when it's clicked + * By default, a PushButton emits a Button::PressedSignal() signal when the button is pressed, a Button::ClickedSignal() signal when it's clicked. * and a Button::ReleasedSignal() signal when it's released or having pressed it, the touch point leaves the boundary of the button. * - * PushButton provides the following properties which modify signals emitted: - * - * - * The button's appearance could be modified by setting images or actors with PushButton::SetButtonImage, PushButton::SetBackgroundImage, - * PushButton::SetSelectedImage, PushButton::SetDisabledBackgroundImage and PushButton::SetDisabledImage or setting a text with - * PushButton::SetLabel. - * - * The \e background is always shown and doesn't change if the button is pressed or released. The \e button image is shown over the \e background image when the - * button is not pressed and is replaced by the \e selected image when the button is pressed. The text label is placed always on the top of all images. - * - * When the button is disabled, \e background, \e button and \e selected images are replaced by their \e disabled images. - * - * The methods used to modify the button's appearance could receive Dali::Actor objects as a parameter, so more complex images could be defined. - * - * 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. + * Usage example: - + * + * @code + * // in Creating a DALi Application + * void HelloWorldExample::Create( Application& application ) + * { + * PushButton button = PushButton::New(); + * button.SetProperty( Actor::Property::PARENT_ORIGIN, ParentOrigin::CENTER ); + * button.SetProperty( Button::Property::LABEL, "Press" ); + * Stage::GetCurrent().Add( button ); + * + * // Connect to button signals emitted by the button + * button.ClickedSignal().Connect( this, &HelloWorldExample::OnButtonClicked ); + * button.PressedSignal().Connect( this, &HelloWorldExample::OnButtonPressed ); + * button.ReleasedSignal().Connect( this, &HelloWorldExample::OnButtonReleased ); + * } + * + * bool HelloWorldExample::OnButtonClicked( Button button ) + * { + * // Do something when the button is clicked + * return true; + * } + * + * bool HelloWorldExample::OnButtonPressed( Button button ) + * { + * // Do something when the button is pressed + * return true; + * } + * + * bool HelloWorldExample::OnButtonReleased( Button button ) + * { + * // Do something when the button is released + * return true; + * } + * @endcode + * + * See Button for more details on signals and modifying appearance via properties. + * @SINCE_1_0.0 */ -class DALI_IMPORT_API PushButton : public Button +class DALI_TOOLKIT_API PushButton : public Button { public: /** - * @brief Create an uninitialized PushButton; this can be initialized with PushButton::New(). - * - * Calling member functions with an uninitialized Dali::Object is not allowed. + * @brief Enumeration for the start and end property ranges for this control. + * @SINCE_1_0.0 */ - PushButton(); + enum PropertyRange + { + PROPERTY_START_INDEX = Button::PROPERTY_END_INDEX + 1, ///< @SINCE_1_0.0 + PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000 ///< Reserving 1000 property indices @SINCE_1_0.0 + }; /** - * @brief Copy constructor. + * @brief Enumeration for the instance of properties belonging to the PushButton class. + * @SINCE_1_0.0 */ - PushButton( const PushButton& pushButton ); + struct Property + { + /** + * @brief Enumeration for the instance of properties belonging to the PushButton class. + * @SINCE_1_0.0 + */ + enum + { + LABEL_PADDING = PROPERTY_START_INDEX, ///< Property, name "labelPadding", type Vector4 @SINCE_1_0.0 + ICON_PADDING, ///< Property, name "iconPadding", type Vector4 @SINCE_1_0.0 + }; + }; - /** - * @brief Assignment operator. - */ - PushButton& operator=( const PushButton& pushButton ); - - /** - * @brief Destructor - * - * This is non-virtual since derived Handle types must not contain data or virtual methods. - */ - ~PushButton(); - - /** - * @brief Create an initialized PushButton. - * - * @return A handle to a newly allocated Dali resource. - */ - static PushButton New(); +public: /** - * @brief Downcast an Object handle to PushButton. - * - * If handle points to a PushButton the downcast produces valid - * handle. If not the returned handle is left uninitialized. + * @brief Creates an uninitialized PushButton; this can be initialized with PushButton::New(). * - * @param[in] handle Handle to an object - * @return handle to a PushButton or an uninitialized handle + * Calling member functions with an uninitialized Dali::Object is not allowed. + * @SINCE_1_0.0 */ - static PushButton DownCast( BaseHandle handle ); - - using Button::SetButtonImage; + PushButton(); /** - * @brief SetButtonImage - * - * @param[in] image The Actor to be used as the button image. - * - * The natural size of the button would be the size of this Actor - * if it's larger than the background and label + * @brief Copy constructor. + * @SINCE_1_0.0 + * @param[in] pushButton Handle to an object */ - void SetButtonImage( Actor image ); + PushButton( const PushButton& pushButton ); /** - * @brief Gets the button image. + * @brief Move constructor + * @SINCE_1_9.23 * - * @return An actor with the button image. + * @param[in] rhs A reference to the moved handle */ - Actor GetButtonImage() const; - - using Button::SetBackgroundImage; + PushButton( PushButton&& rhs ); /** - * @brief SetBackgroundImage - * - * @param[in] image The Actor to be used as the background image. - * - * The natural size of the button would be the size of this Actor - * if it's larger than the button and label + * @brief Assignment operator. + * @SINCE_1_0.0 + * @param[in] pushButton Handle to an object + * @return A reference to this */ - void SetBackgroundImage( Actor image ); + PushButton& operator=( const PushButton& pushButton ); /** - * @brief Gets the background image. + * @brief Move assignment + * @SINCE_1_9.23 * - * @return An actor with the background image. - */ - Actor GetBackgroundImage() const; - - using Button::SetSelectedImage; - - /** - * @copydoc SetSelectedImage( Image image ) + * @param[in] rhs A reference to the moved handle + * @return A reference to this */ - void SetSelectedImage( Actor image ); + PushButton& operator=( PushButton&& rhs ); /** - * @brief Gets the selected image. + * @brief Destructor. * - * @return An actor with the selected image. - */ - Actor GetSelectedImage() const; - - using Button::SetSelectedBackgroundImage; - - /** - * @copydoc SetSelectedBackgroundImage( Image image ) + * This is non-virtual since derived Handle types must not contain data or virtual methods. + * @SINCE_1_0.0 */ - void SetSelectedBackgroundImage( Actor image ); + ~PushButton(); /** - * @brief Gets the selected background image. + * @brief Creates an initialized PushButton. * - * @return An actor with the selected background image. - */ - Actor GetSelectedBackgroundImage() const; - - using Button::SetDisabledBackgroundImage; - - /** - * @copydoc SetDisabledBackgroundImage( Image image ) + * @SINCE_1_0.0 + * @return A handle to a newly allocated Dali resource */ - void SetDisabledBackgroundImage( Actor image ); + static PushButton New(); /** - * @brief Gets the disabled background image. + * @brief Downcasts a handle to PushButton handle. * - * @return An actor with the disabled background image. - */ - Actor GetDisabledBackgroundImage() const; - - using Button::SetDisabledImage; - - /** - * @copydoc SetDisabledImage( Image image ) - */ - void SetDisabledImage( Actor image ); - - /** - * @brief Gets the disabled image. + * If handle points to a PushButton, the downcast produces valid handle. + * If not, the returned handle is left uninitialized. * - * @return An actor with the disabled image. + * @SINCE_1_0.0 + * @param[in] handle Handle to an object + * @return handle to a PushButton or an uninitialized handle */ - Actor GetDisabledImage() const; + static PushButton DownCast( BaseHandle handle ); public: // Not intended for application developers + /// @cond internal /** * @brief Creates a handle using the Toolkit::Internal implementation. * - * @param[in] implementation The Control implementation. + * @SINCE_1_0.0 + * @param[in] implementation The Control implementation */ DALI_INTERNAL PushButton( Internal::PushButton& implementation ); /** * @brief Allows the creation of this Control from an Internal::CustomActor pointer. * - * @param[in] internal A pointer to the internal CustomActor. + * @SINCE_1_0.0 + * @param[in] internal A pointer to the internal CustomActor */ DALI_INTERNAL PushButton( Dali::Internal::CustomActor* internal ); + /// @endcond }; +/** + * @} + */ } // namespace Toolkit } // namespace Dali -#endif // __DALI_TOOLKIT_PUSH_BUTTON_H__ +#endif // DALI_TOOLKIT_PUSH_BUTTON_H