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=603601d6a8d9d1ee67a95dfa6f8735ea6f0735cb;hp=dfc3409f16b4de25294e06438bdf46a023402f8f;hb=938ea2d2a1a42930cf12c743d839aded892949ea;hpb=2acdedcc7c7e732a9ec97d08c8cee7423ed6ebf7;ds=sidebyside diff --git a/dali-toolkit/public-api/controls/buttons/push-button.h b/dali-toolkit/public-api/controls/buttons/push-button.h index dfc3409..603601d 100644 --- a/dali-toolkit/public-api/controls/buttons/push-button.h +++ b/dali-toolkit/public-api/controls/buttons/push-button.h @@ -2,7 +2,7 @@ #define __DALI_TOOLKIT_PUSH_BUTTON_H__ /* - * Copyright (c) 2014 Samsung Electronics Co., Ltd. + * Copyright (c) 2015 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,6 +35,10 @@ 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. @@ -42,57 +46,94 @@ class PushButton; * 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: - * + * @code + * // in Creating a DALi Application + * void HelloWorldExample::Create( Application& application ) + * { + * PushButton button = PushButton::New(); + * button.SetParentOrigin( ParentOrigin::CENTER ); + * button.SetLabelText( "Press" ); + * Stage::GetCurrent().Add( button ); * - * 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. + * // 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 ); + * } * - * 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. + * bool HelloWorldExample::OnButtonClicked( Button button ) + * { + * // Do something when the button is clicked + * return true; + * } * - * When the button is disabled, \e background, \e button and \e selected images are replaced by their \e disabled images. + * bool HelloWorldExample::OnButtonPressed( Button button ) + * { + * // Do something when the button is pressed + * return true; + * } * - * The methods used to modify the button's appearance could receive Dali::Actor objects as a parameter, so more complex images could be defined. + * bool HelloWorldExample::OnButtonReleased( Button button ) + * { + * // Do something when the button is released + * return true; + * } + * @endcode * - * 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. + * See Button for more detail on signals and modifying appearance via properties. + * @SINCE_1_0.0 */ class DALI_IMPORT_API PushButton : public Button { public: /** + * @brief The start and end property ranges for this control. + * @SINCE_1_0.0 + */ + 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 An enumeration of properties belonging to the PushButton class. + * @SINCE_1_0.0 + */ + struct Property + { + enum + { + UNSELECTED_ICON = PROPERTY_START_INDEX, ///< Property, name "unselectedIcon", type std::string @SINCE_1_0.0 + SELECTED_ICON, ///< Property, name "selectedIcon", type std::string @SINCE_1_0.0 + ICON_ALIGNMENT, ///< Property, name "iconAlignment", type std::string @SINCE_1_0.0 + LABEL_PADDING, ///< Property, name "labelPadding", type Vector4 @SINCE_1_0.0 + ICON_PADDING, ///< Property, name "iconPadding", type Vector4 @SINCE_1_0.0 + }; + }; + +public: + + /** * @brief Create an uninitialized PushButton; this can be initialized with PushButton::New(). * * Calling member functions with an uninitialized Dali::Object is not allowed. + * @SINCE_1_0.0 */ PushButton(); /** * @brief Copy constructor. + * @SINCE_1_0.0 */ PushButton( const PushButton& pushButton ); /** * @brief Assignment operator. + * @SINCE_1_0.0 */ PushButton& operator=( const PushButton& pushButton ); @@ -100,127 +141,125 @@ public: * @brief Destructor * * This is non-virtual since derived Handle types must not contain data or virtual methods. + * @SINCE_1_0.0 */ ~PushButton(); /** * @brief Create an initialized PushButton. * + * @SINCE_1_0.0 * @return A handle to a newly allocated Dali resource. */ static PushButton New(); /** - * @brief Downcast an Object handle to PushButton. + * @brief Downcast a handle to PushButton handle. * * If handle points to a PushButton 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 PushButton or an uninitialized handle */ static PushButton DownCast( BaseHandle handle ); - /** - * @brief Sets the button image. - * - * @param[in] image The button image. - */ - void SetButtonImage( Image image ); - /** - * @copydoc SetButtonImage( Image image ) - */ - void SetButtonImage( Actor image ); + // Deprecated API - /** - * @brief Gets the button image. - * - * @return An actor with the button image. - */ - Actor GetButtonImage() const; + using Button::SetButtonImage; /** - * @brief Sets the background image. + * @DEPRECATED_1_0.50. Instead, use Button::SetUnselectedImage. + * + * @brief Sets the unselected image with an Actor. * - * @param[in] image The background image. + * @SINCE_1_0.0 + * @param[in] image The Actor to use. */ - void SetBackgroundImage( Image image ); + void SetButtonImage( Actor image ); - /** - * @copydoc SetBackgroundImage( Image image ) - */ - void SetBackgroundImage( Actor image ); + using Button::SetBackgroundImage; /** - * @brief Gets the background image. + * @DEPRECATED_1_0.50. Instead, use Button::SetBackgroundImage. * - * @return An actor with the background image. - */ - Actor GetBackgroundImage() const; - - /** - * @brief Sets the selected image. + * @brief Sets the background image with an Actor. * - * @param[in] image The selected image. + * @SINCE_1_0.0 + * @param[in] image The Actor to use. */ - void SetSelectedImage( Image image ); + void SetBackgroundImage( Actor image ); - /** - * @copydoc SetSelectedImage( Image image ) - */ - void SetSelectedImage( Actor image ); + using Button::SetSelectedImage; /** - * @brief Gets the selected image. + * @DEPRECATED_1_0.50. Instead, use Button::SetSelectedImage( const std::string& filename ). * - * @return An actor with the selected image. - */ - Actor GetSelectedImage() const; - - /** - * @brief Sets the disabled background image. + * @brief Sets the selected image with an Actor. * - * @param[in] image The disabled background image. + * @SINCE_1_0.0 + * @param[in] image The Actor to use. */ - void SetDisabledBackgroundImage( Image image ); + void SetSelectedImage( Actor image ); - /** - * @copydoc SetDisabledBackgroundImage( Image image ) - */ - void SetDisabledBackgroundImage( Actor image ); + using Button::SetSelectedBackgroundImage; /** - * @brief Gets the disabled background image. + * @DEPRECATED_1_0.50. Instead, use Button::SetSelectedBackgroundImage. + * + * @brief Sets the selected background image with an Actor. * - * @return An actor with the disabled background image. + * @SINCE_1_0.0 + * @param[in] image The Actor to use. */ - Actor GetDisabledBackgroundImage() const; + void SetSelectedBackgroundImage( Actor image ); + + using Button::SetDisabledBackgroundImage; /** - * @brief Sets the disabled button image. + * @DEPRECATED_1_0.50. Instead, use Button::SetDisabledBackgroundImage. + * + * @brief Sets the disabled background image with an Actor. * - * @param[in] image The disabled button image. + * @SINCE_1_0.0 + * @param[in] image The Actor to use. */ - void SetDisabledImage( Image image ); + void SetDisabledBackgroundImage( Actor image ); + + using Button::SetDisabledImage; /** - * @copydoc SetDisabledImage( Image image ) + * @DEPRECATED_1_0.50. Instead, use Button::SetDisabledImage. + * + * @brief Sets the disabled image with an Actor. + * + * @SINCE_1_0.0 + * @param[in] image The Actor to use. */ void SetDisabledImage( Actor image ); + using Button::SetDisabledSelectedImage; + /** - * @brief Gets the disabled image. + * @DEPRECATED_1_0.50. Instead, use Button::SetDisabledSelectedImage. + * + * @brief Sets the disabled selected image with an Actor. * - * @return An actor with the disabled image. + * @SINCE_1_0.0 + * @param[in] image The Actor to use. */ - Actor GetDisabledImage() const; + void SetDisabledSelectedImage( Actor image ); + 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. */ DALI_INTERNAL PushButton( Internal::PushButton& implementation ); @@ -228,11 +267,16 @@ 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. */ DALI_INTERNAL PushButton( Dali::Internal::CustomActor* internal ); + /// @endcond }; +/** + * @} + */ } // namespace Toolkit } // namespace Dali