1 #ifndef __DALI_TOOLKIT_RADIO_BUTTON_H__
2 #define __DALI_TOOLKIT_RADIO_BUTTON_H__
5 * Copyright (c) 2014 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.
24 namespace Dali DALI_IMPORT_API
30 // Forward declarations
32 namespace Internal DALI_INTERNAL
34 // Forward declarations
40 * @brief A RadioButton provides a radio button which two states \e active or \e inactive.
42 * Radio buttons are designed to select one of many option at the same time.
44 * Every button have its own \e label and \e state, which can be modified by RadioButton::SetLabel and RadioBUtton::SetActive.
46 * RadioButton can change its current state using RadioButton::ToggleState.
48 * RadioButtons can be grouped.
49 * Two or more RadioButtons are in one group when they have this same parent.
50 * In each groups only one RadioButton can be \e active at a given time.
51 * So when RadioButton is set to \e active, other RadioButtons in its group are set to \e inactive.
52 * When \e active RadioButton is set to \e inactive no other RadioButtons in his group is set to \e active.
54 * A Button::ClickedSignal() is emitted when the RadioButton change its state to \e active or \e inactive.
56 class RadioButton: public Button
61 static const Property::Index PROPERTY_ACTIVE; ///< name "active", @see SetActive(), type BOOLEAN
62 static const Property::Index PROPERTY_LABEL_ACTOR; ///< name "label-actor", @see SetLabel(), type MAP
66 * @brief Create an uninitialized RadioButton; this can be initialized with RadioButton::New().
68 * Calling member functions with an uninitialized Dali::Object is not allowed.
73 * @brief Copy constructor.
75 RadioButton(const RadioButton& radioButton);
78 * @brief Assignment operator.
80 RadioButton& operator=(const RadioButton& radioButton);
85 * This is non-virtual since derived Handle types must not contain data or virtual methods.
90 * @brief Create an initialized RadioButton.
92 * @return A handle to a newly allocated Dali resource.
94 static RadioButton New();
97 * @brief Create an initialized RadioButton with given label.
99 * @param[in] label The button label.
101 * @return A handle to a newly allocated Dali resource.
103 static RadioButton New(const std::string& label);
106 * @brief Create an initialized RadioButton with existing Actor.
108 * @param[in] label An Actor with the label.
110 * @return A handle to a newly allocated Dali resource.
112 static RadioButton New(Actor label);
115 * @brief Downcast an Object handle to RadioButton.
117 * If handle points to a RadioButton the downcast produces valid
118 * handle. If not the returned handle is left uninitialized.
120 * @param[in] handle Handle to an object
121 * @return handle to a RadioButton or an uninitialized handle
123 static RadioButton DownCast(BaseHandle handle);
126 * @brief Sets the button label.
128 * @param[in] label The button label.
130 void SetLabel(const std::string& label);
133 * @brief Sets the button label using existing Actor.
135 * @param[in] label An Actor with the label.
137 void SetLabel(Actor label);
140 * @brief Gets the label.
142 * @return An Actor with the label.
144 Actor GetLabel() const;
147 * @brief Sets the button as active or inactive.
149 * @param[in] active property
151 void SetActive(bool active);
154 * @return true if button is active, false if button is inactive.
156 bool IsActive()const;
159 * @brief Change button state.
161 * If button is active deactivate it. If button is inactive activate it.
165 public: // Not intended for application developers
168 * @brief Creates a handle using the Toolkit::Internal implementation.
170 * @param[in] implementation The Control implementation.
172 RadioButton(Internal::RadioButton& implementation);
175 * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
177 * @param[in] internal A pointer to the internal CustomActor.
179 RadioButton(Dali::Internal::CustomActor* internal);
182 } // namespace Toolkit
186 #endif // __DALI_TOOLKIT_RADIO_BUTTON_H__