X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali-toolkit%2Fpublic-api%2Fcontrols%2Fbuttons%2Fpush-button.h;h=a74610abad2f014c91d7b067a661f9d40b348557;hb=5cc78df05271786e4c1c18a0eaab32e05612df9d;hp=09c480c2c0f9b8105efbfb1b4232130abc4bd739;hpb=2ddfbb9e23a7c3fc30e604236c41e0ef6d2ed6a2;p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git diff --git a/dali-toolkit/public-api/controls/buttons/push-button.h b/dali-toolkit/public-api/controls/buttons/push-button.h index 09c480c..a74610a 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. @@ -39,27 +39,27 @@ class PushButton; /** * @brief A PushButton changes its appearance when is pressed and returns to its original when is released. * - * By default a PushButton emits a PushButton::PressedSignal() signal when the button is pressed, a Button::ClickedSignal() signal when it's clicked - * and a PushButton::ReleasedSignal() signal when it's released or having pressed it, the touch point leaves the boundary of the button. + * 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, @@ -79,15 +79,6 @@ class DALI_IMPORT_API PushButton : public Button { public: - //Signal Names - static const char* const SIGNAL_PRESSED; ///< name "pressed" - static const char* const SIGNAL_RELEASED; ///< name "released" - - //Action Names - static const char* const ACTION_PUSH_BUTTON_CLICK; ///< name "push-button-click" - -public: - /** * @brief Create an uninitialized PushButton; this can be initialized with PushButton::New(). * @@ -130,90 +121,15 @@ public: */ static PushButton DownCast( BaseHandle handle ); - /** - * @brief Sets the \e autorepeating property. - * - * If the \e autorepeating property is set to \e true, then the \e toggled property is set to false - * but no signal is emitted. - * - * @param[in] autoRepeating \e autorepeating property. - */ - void SetAutoRepeating( bool autoRepeating ); - - /** - * @return \e true if the \e autorepeating property is set. - */ - bool IsAutoRepeating() const; + using Button::SetButtonImage; /** - * @brief Sets the initial autorepeating delay. + * @brief SetButtonImage * - * By default this value is set to 0.15 seconds. - * - * @pre initialAutoRepeatingDelay must be greater than zero. - * @param[in] initialAutoRepeatingDelay in seconds. - */ - void SetInitialAutoRepeatingDelay( float initialAutoRepeatingDelay ); - - /** - * @return the initial autorepeating delay in seconds. - */ - float GetInitialAutoRepeatingDelay() const; - - /** - * @brief Sets the next autorepeating delay. - * - * By default this value is set to 0.05 seconds. - * - * @pre nextAutoRepeatingDelay must be greater than zero. - * @param[in] nextAutoRepeatingDelay in seconds. - */ - void SetNextAutoRepeatingDelay( float nextAutoRepeatingDelay ); - - /** - * @return the next autorepeating delay in seconds. - */ - float GetNextAutoRepeatingDelay() const; - - /** - * @brief Sets the \e toggled property. - * - * If the \e toggled property is set to \e true, then the \e autorepeating property is set to false. - * - * @param[in] toggle property. - */ - void SetToggleButton( bool toggle ); - - /** - * @return \e true if the \e toggled property is set. - */ - bool IsToggleButton() const; - - /** - * @brief Sets the button as toggled or not toggled. - * - * \e toggled property must be set to \e true. - * - * Emits a Button::StateChangedSignal() signal. - * - * @param[in] toggle state. - */ - void SetToggled( bool toggle ); - - /** - * @return \e true if the \e toggled property is set and the button is toggled. - */ - bool IsToggled() const; - - /** - * @brief Sets the button image. + * @param[in] image The Actor to be used as the button image. * - * @param[in] image The button image. - */ - void SetButtonImage( Image image ); - - /** - * @copydoc SetButtonImage( Image image ) + * The natural size of the button would be the size of this Actor + * if it's larger than the background and label */ void SetButtonImage( Actor image ); @@ -224,15 +140,15 @@ public: */ Actor GetButtonImage() const; - /** - * @brief Sets the background image. - * - * @param[in] image The background image. - */ - void SetBackgroundImage( Image image ); + using Button::SetBackgroundImage; /** - * @copydoc SetBackgroundImage( Image image ) + * @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 */ void SetBackgroundImage( Actor image ); @@ -243,12 +159,7 @@ public: */ Actor GetBackgroundImage() const; - /** - * @brief Sets the selected image. - * - * @param[in] image The selected image. - */ - void SetSelectedImage( Image image ); + using Button::SetSelectedImage; /** * @copydoc SetSelectedImage( Image image ) @@ -262,12 +173,21 @@ public: */ Actor GetSelectedImage() const; + using Button::SetSelectedBackgroundImage; + + /** + * @copydoc SetSelectedBackgroundImage( Image image ) + */ + void SetSelectedBackgroundImage( Actor image ); + /** - * @brief Sets the disabled background image. + * @brief Gets the selected background image. * - * @param[in] image The disabled background image. + * @return An actor with the selected background image. */ - void SetDisabledBackgroundImage( Image image ); + Actor GetSelectedBackgroundImage() const; + + using Button::SetDisabledBackgroundImage; /** * @copydoc SetDisabledBackgroundImage( Image image ) @@ -281,12 +201,7 @@ public: */ Actor GetDisabledBackgroundImage() const; - /** - * @brief Sets the disabled button image. - * - * @param[in] image The disabled button image. - */ - void SetDisabledImage( Image image ); + using Button::SetDisabledImage; /** * @copydoc SetDisabledImage( Image image ) @@ -300,43 +215,6 @@ public: */ Actor GetDisabledImage() const; - /** - * @brief Sets the button label. - * - * @param[in] label The button label. - */ - void SetLabel( const std::string& label ); - - /** - * @copydoc SetLabel( const std::string& label ) - */ - void SetLabel( Actor label ); - - /** - * @brief Gets the label. - * - * @return An actor with the label. - */ - Actor GetLabel() const; - -public: //Signals - - /// @brief PushButton Pressed signal type. - typedef Signal< bool ( Button ) > PressedSignalType; - - /// @brief PushButton Released signal type. - typedef Signal< bool ( Button ) > ReleasedSignalType; - - /** - * @brief Signal emitted when the button is touched. - */ - PressedSignalType& PressedSignal(); - - /** - * @brief Signal emitted when the button is touched and the touch point leaves the boundary of the button. - */ - ReleasedSignalType& ReleasedSignal(); - public: // Not intended for application developers /**