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=c887574a298a247fc9a5c67dcee78fa9449eb801;hp=dfc3409f16b4de25294e06438bdf46a023402f8f;hb=615572d21ca43c37388d9de980a8d1265e8c21fd;hpb=2acdedcc7c7e732a9ec97d08c8cee7423ed6ebf7 diff --git a/dali-toolkit/public-api/controls/buttons/push-button.h b/dali-toolkit/public-api/controls/buttons/push-button.h index dfc3409..c887574 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,44 +46,39 @@ 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: - * - * - * 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. + * See Button for more detail on signals and modifying appearance via properties. */ class DALI_IMPORT_API PushButton : public Button { public: /** + * @brief The start and end property ranges for this control. + */ + enum PropertyRange + { + PROPERTY_START_INDEX = Button::PROPERTY_END_INDEX + 1, + PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000 ///< Reserving 1000 property indices + }; + + /** + * @brief An enumeration of properties belonging to the PushButton class. + */ + struct Property + { + enum + { + UNSELECTED_ICON = PROPERTY_START_INDEX, ///< Property, name "unselected-icon", type std::string + SELECTED_ICON, ///< Property, name "selected-icon", type std::string + ICON_ALIGNMENT, ///< Property, name "icon-alignment", type std::string + LABEL_PADDING, ///< Property, name "label-padding", type Vector4 + ICON_PADDING, ///< Property, name "icon-padding", type Vector4 + }; + }; + +public: + + /** * @brief Create an uninitialized PushButton; this can be initialized with PushButton::New(). * * Calling member functions with an uninitialized Dali::Object is not allowed. @@ -121,100 +120,86 @@ public: */ 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 DALi 1.0.50 + * + * @brief Sets the unselected image with an Actor. * - * @param[in] image The background image. + * @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 DALi 1.0.50 * - * @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. + * @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 DALi 1.0.50 * - * @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. + * @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 DALi 1.0.50 + * + * @brief Sets the selected background image with an Actor. * - * @return An actor with the disabled background image. + * @param[in] image The Actor to use. */ - Actor GetDisabledBackgroundImage() const; + void SetSelectedBackgroundImage( Actor image ); + + using Button::SetDisabledBackgroundImage; /** - * @brief Sets the disabled button image. + * @deprecated DALi 1.0.50 + * + * @brief Sets the disabled background image with an Actor. * - * @param[in] image The disabled button image. + * @param[in] image The Actor to use. */ - void SetDisabledImage( Image image ); + void SetDisabledBackgroundImage( Actor image ); + + using Button::SetDisabledImage; /** - * @copydoc SetDisabledImage( Image image ) + * @deprecated DALi 1.0.50 + * + * @brief Sets the disabled image with an Actor. + * + * @param[in] image The Actor to use. */ void SetDisabledImage( Actor image ); + using Button::SetDisabledSelectedImage; + /** - * @brief Gets the disabled image. + * @deprecated DALi 1.0.50 + * + * @brief Sets the disabled selected image with an Actor. * - * @return An actor with the disabled image. + * @param[in] image The Actor to use. */ - Actor GetDisabledImage() const; + void SetDisabledSelectedImage( Actor image ); + public: // Not intended for application developers @@ -233,6 +218,9 @@ public: // Not intended for application developers DALI_INTERNAL PushButton( Dali::Internal::CustomActor* internal ); }; +/** + * @} + */ } // namespace Toolkit } // namespace Dali