1 #ifndef __DALI_TOOLKIT_RADIO_BUTTON_H__
2 #define __DALI_TOOLKIT_RADIO_BUTTON_H__
5 * Copyright (c) 2015 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 RadioButton::SetLabel and Button::SetSelected.
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.
60 class DALI_IMPORT_API RadioButton: public Button
64 * @brief Create an uninitialized RadioButton; this can be initialized with RadioButton::New().
66 * Calling member functions with an uninitialized Dali::Object is not allowed.
71 * @brief Copy constructor.
73 RadioButton( const RadioButton& radioButton );
76 * @brief Assignment operator.
78 RadioButton& operator=( const RadioButton& radioButton );
83 * This is non-virtual since derived Handle types must not contain data or virtual methods.
88 * @brief Create an initialized RadioButton.
90 * @return A handle to a newly allocated Dali resource.
92 static RadioButton New();
95 * @brief Create an initialized RadioButton with given label.
97 * @param[in] label The button label.
99 * @return A handle to a newly allocated Dali resource.
101 static RadioButton New( const std::string& label );
104 * @brief Downcast an Object handle to RadioButton.
106 * If handle points to a RadioButton the downcast produces valid
107 * handle. If not the returned handle is left uninitialized.
109 * @param[in] handle Handle to an object
110 * @return handle to a RadioButton or an uninitialized handle
112 static RadioButton DownCast( BaseHandle handle );
114 public: // Not intended for application developers
117 * @brief Creates a handle using the Toolkit::Internal implementation.
119 * @param[in] implementation The Control implementation.
121 DALI_INTERNAL RadioButton( Internal::RadioButton& implementation );
124 * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
126 * @param[in] internal A pointer to the internal CustomActor.
128 DALI_INTERNAL RadioButton( Dali::Internal::CustomActor* internal );
134 } // namespace Toolkit
138 #endif // __DALI_TOOLKIT_RADIO_BUTTON_H__