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%2Fcheck-box-button.h;h=ca5c288c9b1a3feb67d8e03093fdb514880e7a6e;hp=fb8e5e8e22258e7ba0662660f03402365361d331;hb=938ea2d2a1a42930cf12c743d839aded892949ea;hpb=594b2670227659f2f2905b60c4d3387674a6d846 diff --git a/dali-toolkit/public-api/controls/buttons/check-box-button.h b/dali-toolkit/public-api/controls/buttons/check-box-button.h index fb8e5e8..ca5c288 100644 --- a/dali-toolkit/public-api/controls/buttons/check-box-button.h +++ b/dali-toolkit/public-api/controls/buttons/check-box-button.h @@ -52,6 +52,30 @@ class CheckBoxButton; * * When the button is disabled, \e background image and \e selected image are replaced by \e disabled images. * + * Usage example: - + * + * @code + * // in Creating a DALi Application + * void HelloWorldExample::Create( Application& application ) + * { + * CheckBoxButton button = CheckBoxButton::New(); + * button.SetParentOrigin( ParentOrigin::CENTER ); + * button.SetLabelText( "Check" ); + * button.SetSize( 200, 40 ); + * button.SetBackgroundColor( Color::WHITE ); + * Stage::GetCurrent().Add( button ); + * + * // Connect to a button signal emitted by the button + * button.StateChangedSignal().Connect( this, &HelloWorldExample::OnButtonStateChanged ); + * } + * + * bool HelloWorldExample::OnButtonStateChanged( Button button ) + * { + * // Do something when the button state is changed + * // You can get the state using button.IsSelected() call + * return true; + * } + * @endcode * @SINCE_1_0.0 */ class DALI_IMPORT_API CheckBoxButton : public Button @@ -105,6 +129,7 @@ public: public: // Not intended for application developers + /// @cond internal /** * @brief Creates a handle using the Toolkit::Internal implementation. * @SINCE_1_0.0 @@ -118,6 +143,7 @@ public: // Not intended for application developers * @param[in] internal A pointer to the internal CustomActor. */ DALI_INTERNAL CheckBoxButton( Dali::Internal::CustomActor* internal ); + /// @endcond }; /**