1 #ifndef __DALI_TOOLKIT_CHECK_BOX_BUTTON_H__
2 #define __DALI_TOOLKIT_CHECK_BOX_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.
22 #include <dali-toolkit/public-api/controls/buttons/button.h>
30 // Forward declarations
32 namespace Internal DALI_INTERNAL
37 * @addtogroup dali_toolkit_controls_buttons
42 * @brief CheckBoxButton provides a check box button which user can check or uncheck.
44 * By default a CheckBoxButton emits a Button::ClickedSignal() signal when the button changes its state to selected or unselected.
46 * The button's appearance could be modified by setting images or actors with CheckBoxButton::SetBackgroundImage,
47 * CheckBoxButton::SetSelectedImage, CheckBoxButton::SetDisabledBackgroundImage and CheckBoxButton::SetDisabledSelectedImage.
49 * When the button is not disabled, if it's not selected it only shows the \e background image. The \e selected image is shown over the
50 * \e background image when the box is selected (\e background image is not replaced by \e selected image).
52 * When the button is disabled, \e background image and \e selected image are replaced by \e disabled images.
54 * CheckBoxButton doesn't have a text. However, a Dali::Toolkit::TableView with a Dali::TextActor or a Dali::Toolkit::TextView
55 * and a CheckBoxButton could be used instead.
58 class DALI_IMPORT_API CheckBoxButton : public Button
63 * @brief Create an uninitialized CheckBoxButton; this can be initialized with CheckBoxButton::New()
64 * Calling member functions with an uninitialized Dali::Object is not allowed.
70 * @brief Copy constructor.
73 CheckBoxButton( const CheckBoxButton& checkBox );
76 * @brief Assignment operator.
79 CheckBoxButton& operator=( const CheckBoxButton& checkBox );
84 * This is non-virtual since derived Handle types must not contain data or virtual methods.
90 * @brief Create an initialized CheckBoxButton.
92 * @return A handle to a newly allocated Dali resource.
94 static CheckBoxButton New();
97 * @brief Downcast an Object handle to CheckBoxButton. If handle points to a CheckBoxButton the
98 * downcast produces valid handle. If not the returned handle is left uninitialized.
100 * @param[in] handle Handle to an object
101 * @return handle to a CheckBoxButton or an uninitialized handle
103 static CheckBoxButton DownCast( BaseHandle handle );
105 public: // Not intended for application developers
108 * @brief Creates a handle using the Toolkit::Internal implementation.
110 * @param[in] implementation The Control implementation.
112 DALI_INTERNAL CheckBoxButton( Internal::CheckBoxButton& implementation );
115 * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
117 * @param[in] internal A pointer to the internal CustomActor.
119 DALI_INTERNAL CheckBoxButton( Dali::Internal::CustomActor* internal );
125 } // namespace Toolkit
129 #endif // __DALI_TOOLKIT_CHECK_BOX_BUTTON_H__