1 #ifndef DALI_TOOLKIT_CHECK_BOX_BUTTON_H
2 #define DALI_TOOLKIT_CHECK_BOX_BUTTON_H
5 * Copyright (c) 2019 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 Button::SetUnselectedImage, Button::SetBackgroundImage,
47 * Button::SetSelectedImage, Button::SetSelectedBackgroundImage, Button::SetDisabledBackgroundImage,
48 * Button::SetDisabledImage, and Button::SetDisabledSelectedImage.
50 * 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
51 * \e background image when the box is selected (\e background image is not replaced by \e selected image).
53 * When the button is disabled, \e background image and \e selected image are replaced by \e disabled images.
58 * // in Creating a DALi Application
59 * void HelloWorldExample::Create( Application& application )
61 * CheckBoxButton button = CheckBoxButton::New();
62 * button.SetParentOrigin( ParentOrigin::CENTER );
63 * button.SetProperty( Button::Property::LABEL, "Check" );
64 * button.SetSize( 200, 40 );
65 * button.SetBackgroundColor( Color::WHITE );
66 * Stage::GetCurrent().Add( button );
68 * // Connect to a button signal emitted by the button
69 * button.StateChangedSignal().Connect( this, &HelloWorldExample::OnButtonStateChanged );
72 * bool HelloWorldExample::OnButtonStateChanged( Button button )
74 * // Do something when the button state is changed
75 * // You can get the state using button.IsSelected() call
81 class DALI_TOOLKIT_API CheckBoxButton : public Button
86 * @brief Creates an uninitialized CheckBoxButton; this can be initialized with CheckBoxButton::New().
87 * Calling member functions with an uninitialized Dali::Object is not allowed.
93 * @brief Copy constructor.
95 * @param[in] checkBox Handle to an object
97 CheckBoxButton( const CheckBoxButton& checkBox );
100 * @brief Assignment operator.
102 * @param[in] checkBox Handle to an object
103 * @return A reference to this
105 CheckBoxButton& operator=( const CheckBoxButton& checkBox );
110 * This is non-virtual since derived Handle types must not contain data or virtual methods.
116 * @brief Creates an initialized CheckBoxButton.
118 * @return A handle to a newly allocated Dali resource
120 static CheckBoxButton New();
123 * @brief Downcasts a handle to CheckBoxButton handle.
125 * If handle points to a CheckBoxButton, the downcast produces valid handle.
126 * If not, the returned handle is left uninitialized.
128 * @param[in] handle Handle to an object
129 * @return Handle to a CheckBoxButton or an uninitialized handle
131 static CheckBoxButton DownCast( BaseHandle handle );
133 public: // Not intended for application developers
137 * @brief Creates a handle using the Toolkit::Internal implementation.
139 * @param[in] implementation The Control implementation
141 DALI_INTERNAL CheckBoxButton( Internal::CheckBoxButton& implementation );
144 * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
146 * @param[in] internal A pointer to the internal CustomActor
148 DALI_INTERNAL CheckBoxButton( Dali::Internal::CustomActor* internal );
155 } // namespace Toolkit
159 #endif // DALI_TOOLKIT_CHECK_BOX_BUTTON_H