1 #ifndef __DALI_TOOLKIT_CHECK_BOX_BUTTON_H__
2 #define __DALI_TOOLKIT_CHECK_BOX_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.
22 #include <dali-toolkit/public-api/controls/buttons/button.h>
30 // Forward declarations
32 namespace Internal DALI_INTERNAL
38 * CheckBoxButton provides a check box button which user can check or uncheck.
40 * By default a CheckBoxButton emits a Button::ClickedSignal() signal when the button changes its state to checked or unchecked.
42 * The button's appearance could be modified by setting images or actors with CheckBoxButton::SetBackgroundImage,
43 * CheckBoxButton::SetCheckedImage, CheckBoxButton::SetDisabledBackgroundImage and CheckBoxButton::SetDisabledCheckedImage.
45 * When the button is not disabled, if it's not checked it only shows the \e background image. The \e checked image is shown over the
46 * \e background image when the box is checked (\e background image is not replaced by \e checked image).
48 * When the button is disabled, \e background image and \e checked image are replaced by \e disabled images.
50 * CheckBoxButton doesn't have a text. However, a Dali::Toolkit::TableView with a Dali::TextActor or a Dali::Toolkit::TextView
51 * and a CheckBoxButton could be used instead.
53 class DALI_IMPORT_API CheckBoxButton : public Button
57 static const char* const ACTION_CHECK_BOX_BUTTON_CLICK;
62 * Create an uninitialized CheckBoxButton; this can be initialized with CheckBoxButton::New()
63 * Calling member functions with an uninitialized Dali::Object is not allowed.
70 CheckBoxButton( const CheckBoxButton& checkBox );
73 * Assignment operator.
75 CheckBoxButton& operator=( const CheckBoxButton& checkBox );
80 * This is non-virtual since derived Handle types must not contain data or virtual methods.
85 * Create an initialized CheckBoxButton.
86 * @return A handle to a newly allocated Dali resource.
88 static CheckBoxButton New();
91 * Downcast an Object handle to CheckBoxButton. If handle points to a CheckBoxButton the
92 * downcast produces valid handle. If not the returned handle is left uninitialized.
93 * @param[in] handle Handle to an object
94 * @return handle to a CheckBoxButton or an uninitialized handle
96 static CheckBoxButton DownCast( BaseHandle handle );
99 * Sets the button as checked or unchecked.
101 * Emits a Button::ClickedSignal() signal if the checkbox is not disabled and the new state,
102 * given in the \e checked param, is different than the previous one.
104 * @param[in] checked state.
106 void SetChecked( bool checked );
109 * @return \e true if the button is checked.
111 bool IsChecked() const;
114 * Sets the background image.
116 * @param[in] image The background image.
118 void SetBackgroundImage( Image image );
121 * @copydoc SetBackgroundImage( Image image )
123 void SetBackgroundImage( Actor image );
126 * Gets the background image.
127 * @return An actor with the background image.
129 Actor GetBackgroundImage() const;
132 * Sets the checked image.
134 * @param[in] image The checked image.
136 void SetCheckedImage( Image image );
139 * @copydoc SetCheckedImage( Image image )
141 void SetCheckedImage( Actor image );
144 * Gets the checked image.
145 * @return An actor with the checked image.
147 Actor GetCheckedImage() const;
150 * Sets the disabled background image.
152 * @param[in] image The disabled background image.
154 void SetDisabledBackgroundImage( Image image );
157 * @copydoc SetDisabledBackgroundImage( Image image )
159 void SetDisabledBackgroundImage( Actor image );
162 * Gets the disabled background image.
163 * @return An actor with the disabled background image.
165 Actor GetDisabledBackgroundImage() const;
168 * Sets the disabled checked image.
170 * @param[in] image The disabled checked image.
172 void SetDisabledCheckedImage( Image image );
175 * @copydoc SetDisabledCheckedImage( Image image )
177 void SetDisabledCheckedImage( Actor image );
180 * Gets the disabled checked image.
181 * @return An actor with the disabled checked image.
183 Actor GetDisabledCheckedImage() const;
185 public: // Not intended for application developers
188 * Creates a handle using the Toolkit::Internal implementation.
189 * @param[in] implementation The Control implementation.
191 DALI_INTERNAL CheckBoxButton( Internal::CheckBoxButton& implementation );
194 * Allows the creation of this Control from an Internal::CustomActor pointer.
195 * @param[in] internal A pointer to the internal CustomActor.
197 DALI_INTERNAL CheckBoxButton( Dali::Internal::CustomActor* internal );
200 } // namespace Toolkit
204 #endif // __DALI_TOOLKIT_CHECK_BOX_BUTTON_H__