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=8ebbf58789dfd288c07d9f26aebf5801df187ebb;hb=938ea2d2a1a42930cf12c743d839aded892949ea;hpb=5c07fde9dd6a022e2080c871994499e56eff89aa;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 8ebbf58..603601d 100644 --- a/dali-toolkit/public-api/controls/buttons/push-button.h +++ b/dali-toolkit/public-api/controls/buttons/push-button.h @@ -36,7 +36,7 @@ namespace Internal DALI_INTERNAL class PushButton; } /** - * @addtogroup dali-toolkit-controls-buttons + * @addtogroup dali_toolkit_controls_buttons * @{ */ @@ -46,7 +46,44 @@ 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. * + * Usage example: - + * + * @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 ); + * + * // 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 detail on signals and modifying appearance via properties. + * @SINCE_1_0.0 */ class DALI_IMPORT_API PushButton : public Button { @@ -54,25 +91,27 @@ 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, - PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000 ///< Reserving 1000 property indices + 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 "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 + 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 }; }; @@ -82,16 +121,19 @@ 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 ); @@ -99,22 +141,25 @@ 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 */ @@ -126,7 +171,11 @@ public: using Button::SetButtonImage; /** - * @deprecated Sets the unselected image with an Actor. + * @DEPRECATED_1_0.50. Instead, use Button::SetUnselectedImage. + * + * @brief Sets the unselected image with an Actor. + * + * @SINCE_1_0.0 * @param[in] image The Actor to use. */ void SetButtonImage( Actor image ); @@ -134,7 +183,11 @@ public: using Button::SetBackgroundImage; /** - * @deprecated Sets the background image with an Actor. + * @DEPRECATED_1_0.50. Instead, use Button::SetBackgroundImage. + * + * @brief Sets the background image with an Actor. + * + * @SINCE_1_0.0 * @param[in] image The Actor to use. */ void SetBackgroundImage( Actor image ); @@ -142,7 +195,11 @@ public: using Button::SetSelectedImage; /** - * @deprecated Sets the selected image with an Actor. + * @DEPRECATED_1_0.50. Instead, use Button::SetSelectedImage( const std::string& filename ). + * + * @brief Sets the selected image with an Actor. + * + * @SINCE_1_0.0 * @param[in] image The Actor to use. */ void SetSelectedImage( Actor image ); @@ -150,7 +207,11 @@ public: using Button::SetSelectedBackgroundImage; /** - * @deprecated Sets the selected background image with an Actor. + * @DEPRECATED_1_0.50. Instead, use Button::SetSelectedBackgroundImage. + * + * @brief Sets the selected background image with an Actor. + * + * @SINCE_1_0.0 * @param[in] image The Actor to use. */ void SetSelectedBackgroundImage( Actor image ); @@ -158,7 +219,11 @@ public: using Button::SetDisabledBackgroundImage; /** - * @deprecated Sets the disabled background image with an Actor. + * @DEPRECATED_1_0.50. Instead, use Button::SetDisabledBackgroundImage. + * + * @brief Sets the disabled background image with an Actor. + * + * @SINCE_1_0.0 * @param[in] image The Actor to use. */ void SetDisabledBackgroundImage( Actor image ); @@ -166,7 +231,11 @@ public: using Button::SetDisabledImage; /** - * @deprecated Sets the disabled image with an Actor. + * @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 ); @@ -174,7 +243,11 @@ public: using Button::SetDisabledSelectedImage; /** - * @deprecated Sets the disabled selected image with an Actor. + * @DEPRECATED_1_0.50. Instead, use Button::SetDisabledSelectedImage. + * + * @brief Sets the disabled selected image with an Actor. + * + * @SINCE_1_0.0 * @param[in] image The Actor to use. */ void SetDisabledSelectedImage( Actor image ); @@ -182,9 +255,11 @@ public: 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 ); @@ -192,9 +267,11 @@ 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 }; /**