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=2793710b04aadb5e16e85a643fc9c40a3af2dbb4;hp=2dc26b1e2a6800b4076999aac97d4ca4488265f2;hb=b694e7e2ae624e206e1548b1a863c554eb9cd4d7;hpb=030e7c680a6eb0e8d87bfdb8ec359a0267ef7db2 diff --git a/dali-toolkit/public-api/controls/buttons/radio-button.h b/dali-toolkit/public-api/controls/buttons/radio-button.h index 2dc26b1..2793710 100644 --- a/dali-toolkit/public-api/controls/buttons/radio-button.h +++ b/dali-toolkit/public-api/controls/buttons/radio-button.h @@ -1,8 +1,8 @@ -#ifndef __DALI_TOOLKIT_RADIO_BUTTON_H__ -#define __DALI_TOOLKIT_RADIO_BUTTON_H__ +#ifndef DALI_TOOLKIT_RADIO_BUTTON_H +#define DALI_TOOLKIT_RADIO_BUTTON_H /* - * Copyright (c) 2015 Samsung Electronics Co., Ltd. + * Copyright (c) 2019 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,13 +35,17 @@ namespace Internal DALI_INTERNAL class RadioButton; } +/** + * @addtogroup dali_toolkit_controls_buttons + * @{ + */ /** * @brief A RadioButton provides a radio button which two states \e selected or \e unselected. * * 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::Property::LABEL and Button::Property::SELECTED. * * RadioButton can change its current state using Button::SetSelected. * @@ -52,89 +56,123 @@ 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.SetProperty( Button::Property::LABEL, "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.SetProperty( Toolkit::Button::Property::LABEL, "button2" ); + * button2.SetBackgroundColor( Color::WHITE ); + * button2.SetPosition( 0, 40 ); + * radioGroup.Add( button2 ); + * + * @endcode + * @SINCE_1_0.0 */ -class DALI_IMPORT_API RadioButton: public Button +class DALI_TOOLKIT_API RadioButton: public Button { public: /** - * @brief Create an uninitialized RadioButton; this can be initialized with RadioButton::New(). + * @brief Creates an uninitialized RadioButton; this can be initialized with RadioButton::New(). * * Calling member functions with an uninitialized Dali::Object is not allowed. + * @SINCE_1_0.0 */ RadioButton(); /** * @brief Copy constructor. + * @SINCE_1_0.0 + * @param[in] radioButton Handle to an object */ RadioButton( const RadioButton& radioButton ); /** * @brief Assignment operator. + * @SINCE_1_0.0 + * @param[in] radioButton Handle to an object + * @return A reference to this */ RadioButton& operator=( const RadioButton& radioButton ); /** - * @brief Destructor + * @brief Destructor. * * This is non-virtual since derived Handle types must not contain data or virtual methods. + * @SINCE_1_0.0 */ ~RadioButton(); /** - * @brief Create an initialized RadioButton. + * @brief Creates an initialized RadioButton. * - * @return A handle to a newly allocated Dali resource. + * @SINCE_1_0.0 + * @return A handle to a newly allocated Dali resource */ static RadioButton New(); /** - * @brief Create an initialized RadioButton with given label. + * @brief Creates an initialized RadioButton with given label. * - * @param[in] label The button label. - * - * @return A handle to a newly allocated Dali resource. + * @SINCE_1_0.0 + * @param[in] label The button label + * @return A handle to a newly allocated Dali resource */ static RadioButton New( const std::string& label ); /** - * @brief Create an initialized RadioButton with existing Actor. - * - * @param[in] label An Actor with the label. - * - * @return A handle to a newly allocated Dali resource. - */ - static RadioButton New( Actor label ); - - /** - * @brief Downcast an Object handle to RadioButton. + * @brief Downcasts a handle to RadioButton handle. * - * If handle points to a RadioButton the downcast produces valid - * handle. If not the returned handle is left uninitialized. + * 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. * - * @param[in] implementation The Control implementation. + * @SINCE_1_0.0 + * @param[in] implementation The Control implementation */ DALI_INTERNAL RadioButton( Internal::RadioButton& implementation ); /** * @brief Allows the creation of this Control from an Internal::CustomActor pointer. * - * @param[in] internal A pointer to the internal CustomActor. + * @SINCE_1_0.0 + * @param[in] internal A pointer to the internal CustomActor */ DALI_INTERNAL RadioButton( Dali::Internal::CustomActor* internal ); + /// @endcond }; +/** + * @} + */ } // namespace Toolkit } // namespace Dali -#endif // __DALI_TOOLKIT_RADIO_BUTTON_H__ +#endif // DALI_TOOLKIT_RADIO_BUTTON_H