1 #ifndef __DALI_TOOLKIT_PUSH_BUTTON_H__
2 #define __DALI_TOOLKIT_PUSH_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.
30 // Forward declarations
32 namespace Internal DALI_INTERNAL
34 // Forward declarations
39 * @addtogroup dali_toolkit_controls_buttons
44 * @brief A PushButton changes its appearance when is pressed and returns to its original when is released.
46 * By default a PushButton emits a Button::PressedSignal() signal when the button is pressed, a Button::ClickedSignal() signal when it's clicked
47 * and a Button::ReleasedSignal() signal when it's released or having pressed it, the touch point leaves the boundary of the button.
52 * // in Creating a DALi Application
53 * void HelloWorldExample::Create( Application& application )
55 * PushButton button = PushButton::New();
56 * button.SetParentOrigin( ParentOrigin::CENTER );
57 * button.SetLabelText( "Press" );
58 * Stage::GetCurrent().Add( button );
60 * // Connect to button signals emitted by the button
61 * button.ClickedSignal().Connect( this, &HelloWorldExample::OnButtonClicked );
62 * button.PressedSignal().Connect( this, &HelloWorldExample::OnButtonPressed );
63 * button.ReleasedSignal().Connect( this, &HelloWorldExample::OnButtonReleased );
66 * bool HelloWorldExample::OnButtonClicked( Button button )
68 * // Do something when the button is clicked
72 * bool HelloWorldExample::OnButtonPressed( Button button )
74 * // Do something when the button is pressed
78 * bool HelloWorldExample::OnButtonReleased( Button button )
80 * // Do something when the button is released
85 * See Button for more detail on signals and modifying appearance via properties.
88 class DALI_IMPORT_API PushButton : public Button
93 * @brief The start and end property ranges for this control.
98 PROPERTY_START_INDEX = Button::PROPERTY_END_INDEX + 1, ///< @SINCE_1_0.0
99 PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000 ///< Reserving 1000 property indices @SINCE_1_0.0
103 * @brief An enumeration of properties belonging to the PushButton class.
110 UNSELECTED_ICON = PROPERTY_START_INDEX, ///< Property, name "unselectedIcon", type std::string @SINCE_1_0.0
111 SELECTED_ICON, ///< Property, name "selectedIcon", type std::string @SINCE_1_0.0
112 ICON_ALIGNMENT, ///< Property, name "iconAlignment", type std::string @SINCE_1_0.0
113 LABEL_PADDING, ///< Property, name "labelPadding", type Vector4 @SINCE_1_0.0
114 ICON_PADDING, ///< Property, name "iconPadding", type Vector4 @SINCE_1_0.0
121 * @brief Create an uninitialized PushButton; this can be initialized with PushButton::New().
123 * Calling member functions with an uninitialized Dali::Object is not allowed.
129 * @brief Copy constructor.
131 * @param[in] pushButton Handle to an object
133 PushButton( const PushButton& pushButton );
136 * @brief Assignment operator.
138 * @param[in] pushButton Handle to an object
139 * @return A reference to this
141 PushButton& operator=( const PushButton& pushButton );
146 * This is non-virtual since derived Handle types must not contain data or virtual methods.
152 * @brief Create an initialized PushButton.
155 * @return A handle to a newly allocated Dali resource.
157 static PushButton New();
160 * @brief Downcast a handle to PushButton handle.
162 * If handle points to a PushButton the downcast produces valid
163 * handle. If not the returned handle is left uninitialized.
166 * @param[in] handle Handle to an object
167 * @return handle to a PushButton or an uninitialized handle
169 static PushButton DownCast( BaseHandle handle );
174 using Button::SetButtonImage;
177 * @DEPRECATED_1_0.50. Instead, use Button::SetUnselectedImage.
179 * @brief Sets the unselected image with an Actor.
182 * @param[in] image The Actor to use.
184 void SetButtonImage( Actor image );
186 using Button::SetBackgroundImage;
189 * @DEPRECATED_1_0.50. Instead, use Button::SetBackgroundImage.
191 * @brief Sets the background image with an Actor.
194 * @param[in] image The Actor to use.
196 void SetBackgroundImage( Actor image );
198 using Button::SetSelectedImage;
201 * @DEPRECATED_1_0.50. Instead, use Button::SetSelectedImage( const std::string& filename ).
203 * @brief Sets the selected image with an Actor.
206 * @param[in] image The Actor to use.
208 void SetSelectedImage( Actor image );
210 using Button::SetSelectedBackgroundImage;
213 * @DEPRECATED_1_0.50. Instead, use Button::SetSelectedBackgroundImage.
215 * @brief Sets the selected background image with an Actor.
218 * @param[in] image The Actor to use.
220 void SetSelectedBackgroundImage( Actor image );
222 using Button::SetDisabledBackgroundImage;
225 * @DEPRECATED_1_0.50. Instead, use Button::SetDisabledBackgroundImage.
227 * @brief Sets the disabled background image with an Actor.
230 * @param[in] image The Actor to use.
232 void SetDisabledBackgroundImage( Actor image );
234 using Button::SetDisabledImage;
237 * @DEPRECATED_1_0.50. Instead, use Button::SetDisabledImage.
239 * @brief Sets the disabled image with an Actor.
242 * @param[in] image The Actor to use.
244 void SetDisabledImage( Actor image );
246 using Button::SetDisabledSelectedImage;
249 * @DEPRECATED_1_0.50. Instead, use Button::SetDisabledSelectedImage.
251 * @brief Sets the disabled selected image with an Actor.
254 * @param[in] image The Actor to use.
256 void SetDisabledSelectedImage( Actor image );
259 public: // Not intended for application developers
263 * @brief Creates a handle using the Toolkit::Internal implementation.
266 * @param[in] implementation The Control implementation.
268 DALI_INTERNAL PushButton( Internal::PushButton& implementation );
271 * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
274 * @param[in] internal A pointer to the internal CustomActor.
276 DALI_INTERNAL PushButton( Dali::Internal::CustomActor* internal );
283 } // namespace Toolkit
287 #endif // __DALI_TOOLKIT_PUSH_BUTTON_H__