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%2Fradio-button.h;h=3dcd111e3690c67f739dc24df6fdcf747797c6df;hp=f99afaeec51dd9d4541f79e893ee21971346fa35;hb=6b7c807d4a72e4fae1bbcc7aa64c024f5f84944d;hpb=2eb0f016cf4d8a8282681283ae0e842c0c67bded diff --git a/dali-toolkit/public-api/controls/buttons/radio-button.h b/dali-toolkit/public-api/controls/buttons/radio-button.h index f99afae..3dcd111 100644 --- a/dali-toolkit/public-api/controls/buttons/radio-button.h +++ b/dali-toolkit/public-api/controls/buttons/radio-button.h @@ -45,7 +45,7 @@ class RadioButton; * * Radio buttons are designed to select one of many option at the same time. * - * Every button have its own \e label and \e state, which can be modified by RadioButton::SetLabel and Button::SetSelected. + * Every button have its own \e label and \e state, which can be modified by Button::SetLabelText and Button::SetSelected. * * RadioButton can change its current state using Button::SetSelected. * @@ -56,6 +56,32 @@ class RadioButton; * When \e selected RadioButton is set to \e unselected no other RadioButtons in his group is set to \e selected. * * A Button::StateChangedSignal() is emitted when the RadioButton change its state to \e selected or \e unselected. + * + * Usage example: - + * + * @code + * // in Creating a DALi Application + * + * // Create a group to bind two or more RadioButtons together + * Actor radioGroup = Actor::New(); + * radioGroup.SetParentOrigin( ParentOrigin::CENTER ); + * Stage::GetCurrent().Add( radioGroup ); + * + * // Make the first RadioButton and add it to its parent + * RadioButton button1 = RadioButton::New(); + * button1.SetLabelText( "button1" ); + * button1.SetBackgroundColor( Color::WHITE ); + * button1.SetPosition( 0, -40 ); + * radioGroup.Add( button1 ); + * + * // Make more RadioButtons and add them to their parent + * RadioButton button2 = RadioButton::New(); + * button2.SetLabelText( "button2" ); + * button2.SetBackgroundColor( Color::WHITE ); + * button2.SetPosition( 0, 40 ); + * radioGroup.Add( button2 ); + * + * @endcode * @SINCE_1_0.0 */ class DALI_IMPORT_API RadioButton: public Button @@ -108,19 +134,20 @@ class DALI_IMPORT_API RadioButton: public Button static RadioButton New( const std::string& label ); /** - * @brief Downcast an Object handle to RadioButton. + * @brief Downcast a handle to RadioButton handle. * * If handle points to a RadioButton 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 RadioButton or an uninitialized handle + * @return A handle to a RadioButton or an uninitialized handle */ static RadioButton DownCast( BaseHandle handle ); public: // Not intended for application developers + /// @cond internal /** * @brief Creates a handle using the Toolkit::Internal implementation. * @@ -136,6 +163,7 @@ class DALI_IMPORT_API RadioButton: public Button * @param[in] internal A pointer to the internal CustomActor. */ DALI_INTERNAL RadioButton( Dali::Internal::CustomActor* internal ); + /// @endcond }; /**