1 #ifndef __DALI_TOOLKIT_RADIO_BUTTON_H__
2 #define __DALI_TOOLKIT_RADIO_BUTTON_H__
5 * Copyright (c) 2017 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
30 // Forward declarations
32 namespace Internal DALI_INTERNAL
34 // Forward declarations
39 * @addtogroup dali_toolkit_controls_buttons
44 * @brief A RadioButton provides a radio button which two states \e selected or \e unselected.
46 * Radio buttons are designed to select one of many option at the same time.
48 * Every button have its own \e label and \e state, which can be modified by Button::Property::LABEL and Button::Property::SELECTED.
50 * RadioButton can change its current state using Button::SetSelected.
52 * RadioButtons can be grouped.
53 * Two or more RadioButtons are in one group when they have this same parent.
54 * In each groups only one RadioButton can be \e selected at a given time.
55 * So when RadioButton is set to \e selected, other RadioButtons in its group are set to \e unselected.
56 * When \e selected RadioButton is set to \e unselected no other RadioButtons in his group is set to \e selected.
58 * A Button::StateChangedSignal() is emitted when the RadioButton change its state to \e selected or \e unselected.
63 * // In Creating a DALi Application
65 * // Create a group to bind two or more RadioButtons together
66 * Actor radioGroup = Actor::New();
67 * radioGroup.SetParentOrigin( ParentOrigin::CENTER );
68 * Stage::GetCurrent().Add( radioGroup );
70 * // Make the first RadioButton and add it to its parent
71 * RadioButton button1 = RadioButton::New();
72 * button1.SetProperty( Button::Property::LABEL, "button1" );
73 * button1.SetBackgroundColor( Color::WHITE );
74 * button1.SetPosition( 0, -40 );
75 * radioGroup.Add( button1 );
77 * // Make more RadioButtons and add them to their parent
78 * RadioButton button2 = RadioButton::New();
79 * button2.SetProperty( Toolkit::Button::Property::LABEL, "button2" );
80 * button2.SetBackgroundColor( Color::WHITE );
81 * button2.SetPosition( 0, 40 );
82 * radioGroup.Add( button2 );
87 class DALI_IMPORT_API RadioButton: public Button
91 * @brief Creates an uninitialized RadioButton; this can be initialized with RadioButton::New().
93 * Calling member functions with an uninitialized Dali::Object is not allowed.
99 * @brief Copy constructor.
101 * @param[in] radioButton Handle to an object
103 RadioButton( const RadioButton& radioButton );
106 * @brief Assignment operator.
108 * @param[in] radioButton Handle to an object
109 * @return A reference to this
111 RadioButton& operator=( const RadioButton& radioButton );
116 * This is non-virtual since derived Handle types must not contain data or virtual methods.
122 * @brief Creates an initialized RadioButton.
125 * @return A handle to a newly allocated Dali resource
127 static RadioButton New();
130 * @brief Creates an initialized RadioButton with given label.
133 * @param[in] label The button label
134 * @return A handle to a newly allocated Dali resource
136 static RadioButton New( const std::string& label );
139 * @brief Downcasts a handle to RadioButton handle.
141 * If handle points to a RadioButton, the downcast produces valid handle.
142 * If not, the returned handle is left uninitialized.
145 * @param[in] handle Handle to an object
146 * @return A handle to a RadioButton or an uninitialized handle
148 static RadioButton DownCast( BaseHandle handle );
150 public: // Not intended for application developers
154 * @brief Creates a handle using the Toolkit::Internal implementation.
157 * @param[in] implementation The Control implementation
159 DALI_INTERNAL RadioButton( Internal::RadioButton& implementation );
162 * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
165 * @param[in] internal A pointer to the internal CustomActor
167 DALI_INTERNAL RadioButton( Dali::Internal::CustomActor* internal );
174 } // namespace Toolkit
178 #endif // __DALI_TOOLKIT_RADIO_BUTTON_H__