1 #ifndef DALI_TOOLKIT_PUSH_BUTTON_H
2 #define DALI_TOOLKIT_PUSH_BUTTON_H
5 * Copyright (c) 2020 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.
28 // Forward declarations
30 namespace Internal DALI_INTERNAL
32 // Forward declarations
35 } // namespace DALI_INTERNAL
37 * @addtogroup dali_toolkit_controls_buttons
42 * @brief A PushButton changes its appearance when is pressed and returns to its original when is released.
44 * By default, a PushButton emits a Button::PressedSignal() signal when the button is pressed, a Button::ClickedSignal() signal when it's clicked.
45 * and a Button::ReleasedSignal() signal when it's released or having pressed it, the touch point leaves the boundary of the button.
50 * // in Creating a DALi Application
51 * void HelloWorldExample::Create( Application& application )
53 * PushButton button = PushButton::New();
54 * button.SetProperty( Actor::Property::PARENT_ORIGIN, ParentOrigin::CENTER );
55 * button.SetProperty( Button::Property::LABEL, "Press" );
56 * Stage::GetCurrent().Add( button );
58 * // Connect to button signals emitted by the button
59 * button.ClickedSignal().Connect( this, &HelloWorldExample::OnButtonClicked );
60 * button.PressedSignal().Connect( this, &HelloWorldExample::OnButtonPressed );
61 * button.ReleasedSignal().Connect( this, &HelloWorldExample::OnButtonReleased );
64 * bool HelloWorldExample::OnButtonClicked( Button button )
66 * // Do something when the button is clicked
70 * bool HelloWorldExample::OnButtonPressed( Button button )
72 * // Do something when the button is pressed
76 * bool HelloWorldExample::OnButtonReleased( Button button )
78 * // Do something when the button is released
83 * See Button for more details on signals and modifying appearance via properties.
86 class DALI_TOOLKIT_API PushButton : public Button
90 * @brief Enumeration for the start and end property ranges for this control.
95 PROPERTY_START_INDEX = Button::PROPERTY_END_INDEX + 1, ///< @SINCE_1_0.0
96 PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000 ///< Reserving 1000 property indices @SINCE_1_0.0
100 * @brief Enumeration for the instance of properties belonging to the PushButton class.
106 * @brief Enumeration for the instance of properties belonging to the PushButton class.
111 LABEL_PADDING = PROPERTY_START_INDEX, ///< Property, name "labelPadding", type Vector4 @SINCE_1_0.0
112 ICON_PADDING, ///< Property, name "iconPadding", type Vector4 @SINCE_1_0.0
118 * @brief Creates an uninitialized PushButton; this can be initialized with PushButton::New().
120 * Calling member functions with an uninitialized Dali::Object is not allowed.
126 * @brief Copy constructor.
128 * @param[in] pushButton Handle to an object
130 PushButton(const PushButton& pushButton);
133 * @brief Move constructor
136 * @param[in] rhs A reference to the moved handle
138 PushButton(PushButton&& rhs) noexcept;
141 * @brief Assignment operator.
143 * @param[in] pushButton Handle to an object
144 * @return A reference to this
146 PushButton& operator=(const PushButton& pushButton);
149 * @brief Move assignment
152 * @param[in] rhs A reference to the moved handle
153 * @return A reference to this
155 PushButton& operator=(PushButton&& rhs) noexcept;
160 * This is non-virtual since derived Handle types must not contain data or virtual methods.
166 * @brief Creates an initialized PushButton.
169 * @return A handle to a newly allocated Dali resource
171 static PushButton New();
174 * @brief Downcasts a handle to PushButton handle.
176 * If handle points to a PushButton, the downcast produces valid handle.
177 * If not, the returned handle is left uninitialized.
180 * @param[in] handle Handle to an object
181 * @return handle to a PushButton or an uninitialized handle
183 static PushButton DownCast(BaseHandle handle);
185 public: // Not intended for application developers
188 * @brief Creates a handle using the Toolkit::Internal implementation.
191 * @param[in] implementation The Control implementation
193 DALI_INTERNAL PushButton(Internal::PushButton& implementation);
196 * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
199 * @param[in] internal A pointer to the internal CustomActor
201 DALI_INTERNAL PushButton(Dali::Internal::CustomActor* internal);
208 } // namespace Toolkit
212 #endif // DALI_TOOLKIT_PUSH_BUTTON_H