1 #ifndef __DALI_TOOLKIT_BUTTON_H__
2 #define __DALI_TOOLKIT_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/control.h>
30 namespace Internal DALI_INTERNAL
35 * @addtogroup dali_toolkit_controls_buttons
40 * @brief Button is a base class for different kind of buttons.
42 * This class provides the disabled property and the clicked signal.
44 * A ClickedSignal() is emitted when the button is touched and the touch point doesn't leave the boundary of the button.
46 * When the \e disabled property is set to \e true, no signal is emitted.
48 * Button provides the following properties which modify the signals emitted:
50 * <li>\e autorepeating
51 * When \e autorepeating is set to \e true, a Button::PressedSignal(), Button::ReleasedSignal() and Button::ClickedSignal() signals are emitted at regular
52 * intervals while the button is touched.
53 * The intervals could be modified with the Button::SetInitialAutoRepeatingDelay and Button::SetNextAutoRepeatingDelay methods.
55 * A \e togglable button can't be \e autorepeating. If the \e autorepeating property is set to \e true, then the \e togglable property is set to
56 * false but no signal is emitted.
59 * When \e togglable is set to \e true, a Button::StateChangedSignal() signal is emitted, with the selected state.
62 * The button's appearance can be modified by setting properties for the various image filenames.
64 * The \e background is always shown and doesn't change if the button is pressed or released. The \e button image is shown over the \e background image when the
65 * button is not pressed and is replaced by the \e selected image when the button is pressed. The text label is placed always on the top of all images.
67 * When the button is disabled, \e background, \e button and \e selected images are replaced by their \e disabled images.
69 * Is not mandatory to set all images. A button could be defined only by setting its \e background image or by setting its \e background and \e selected images.
72 * | %Signal Name | Method |
73 * |------------------|-----------------------------|
74 * | pressed | @ref PressedSignal() |
75 * | released | @ref ReleasedSignal() |
76 * | clicked | @ref ClickedSignal() |
77 * | stateChanged | @ref StateChangedSignal() |
80 * | %Action Name | Attributes | Description |
81 * |------------------|-------------------------|-----------------------------------------------|
82 * | buttonClick | Doesn't have attributes | Simulates a button click. See @ref DoAction() |
85 class DALI_IMPORT_API Button : public Control
90 * @brief The start and end property ranges for this control.
95 PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1, ///< @SINCE_1_0.0
96 PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000 ///< Reserve property indices @SINCE_1_0.0
100 * @brief An enumeration of properties belonging to the Button class.
107 DISABLED = PROPERTY_START_INDEX, ///< name "disabled", @see SetDisabled(), type bool @SINCE_1_0.0
108 AUTO_REPEATING, ///< name "autoRepeating", @see SetAutoRepeating(), type bool @SINCE_1_0.0
109 INITIAL_AUTO_REPEATING_DELAY, ///< name "initialAutoRepeatingDelay", @see SetInitialAutoRepeatingDelay(), type float @SINCE_1_0.0
110 NEXT_AUTO_REPEATING_DELAY, ///< name "nextAutoRepeatingDelay", @see SetNextAutoRepeatingDelay(), type float @SINCE_1_0.0
111 TOGGLABLE, ///< name "togglable", @see SetTogglableButton(), type bool @SINCE_1_0.0
112 SELECTED, ///< name "selected", @see SetSelected(), type bool @SINCE_1_0.0
113 UNSELECTED_STATE_IMAGE, ///< name "unselectedStateImage", @see SetUnselectedImage(), type std::string @SINCE_1_0.0
114 SELECTED_STATE_IMAGE, ///< name "selectedStateImage", @see SetSelectedImage(), type std::string @SINCE_1_0.0
115 DISABLED_STATE_IMAGE, ///< name "disabledStateImage", @see SetDisabledImage(), type std::string @SINCE_1_0.0
116 UNSELECTED_COLOR, ///< name "unselectedColor", type Vector4 @SINCE_1_0.0
117 SELECTED_COLOR, ///< name "selectedColor", type Vector4 @SINCE_1_0.0
118 LABEL, ///< name "label", type Property::Map @SINCE_1_0.0
120 // Deprecated properties:
121 LABEL_TEXT, ///< name "labelText", @see SetLabelText(), type std::string @SINCE_1_0.0
128 * @brief Create an uninitialized Button.
130 * Only derived versions can be instantiated. Calling member
131 * functions with an uninitialized Dali::Object is not allowed.
137 * @brief Copy constructor.
139 * @param[in] button Handle to an object
141 Button( const Button& button );
144 * @brief Assignment operator.
146 * @param[in] button Handle to an object
147 * @return A reference to this
149 Button& operator=( const Button& button );
152 * @brief Downcast a handle to Button handle.
154 * If handle points to a Button the downcast produces valid
155 * handle. If not the returned handle is left uninitialized.
158 * @param[in] handle Handle to an object
159 * @return A handle to a Button or an uninitialized handle
161 static Button DownCast( BaseHandle handle );
166 * This is non-virtual since derived Handle types must not contain data or virtual methods.
174 * @DEPRECATED_1_1.32 Use SetProperty DISABLED or Styling file
176 * @brief Sets the button as \e disabled.
178 * No signals are emitted when the \e disabled property is set.
181 * @param[in] disabled property.
183 void SetDisabled( bool disabled );
186 * @DEPRECATED_1_1.32 Use GetProperty DISABLED
188 * @brief Returns if the button is disabled.
190 * @return \e true if the button is \e disabled.
192 bool IsDisabled() const;
195 * @DEPRECATED_1_1.32 SetProperty AUTO_REPEATING or Styling file
197 * @brief Sets the \e autorepeating property.
199 * If the \e autorepeating property is set to \e true, then the \e togglable property is set to false
200 * but no signal is emitted.
203 * @param[in] autoRepeating \e autorepeating property.
205 void SetAutoRepeating( bool autoRepeating );
208 * @DEPRECATED_1_1.32 GetProperty AUTO_REPEATING
210 * @brief Returns if the autorepeating property is set.
212 * @return \e true if the \e autorepeating property is set.
214 bool IsAutoRepeating() const;
217 * @DEPRECATED_1_1.32 SetProperty INITIAL_AUTO_REPEATING_DELAY or Styling file
219 * @brief Sets the initial autorepeating delay.
221 * By default this value is set to 0.15 seconds.
224 * @param[in] initialAutoRepeatingDelay in seconds.
225 * @pre initialAutoRepeatingDelay must be greater than zero.
227 void SetInitialAutoRepeatingDelay( float initialAutoRepeatingDelay );
230 * @DEPRECATED_1_1.32 GetProperty INITIAL_AUTO_REPEATING_DELAY
232 * @brief Gets the initial autorepeating delay in seconds.
234 * @return the initial autorepeating delay in seconds.
236 float GetInitialAutoRepeatingDelay() const;
239 * @DEPRECATED_1_1.32 SetProperty NEXT_AUTO_REPEATING_DELAY or Styling file
241 * @brief Sets the next autorepeating delay.
243 * By default this value is set to 0.05 seconds.
246 * @param[in] nextAutoRepeatingDelay in seconds.
247 * @pre nextAutoRepeatingDelay must be greater than zero.
249 void SetNextAutoRepeatingDelay( float nextAutoRepeatingDelay );
252 * @DEPRECATED_1_1.32 GetProperty NEXT_AUTO_REPEATING_DELAY
254 * @brief Gets the next autorepeating delay in seconds.
256 * @return the next autorepeating delay in seconds.
258 float GetNextAutoRepeatingDelay() const;
261 * @DEPRECATED_1_1.32 SetProperty TOGGLABLE or Styling file
263 * @brief Sets the \e togglable property.
265 * If the \e togglable property is set to \e true, then the \e autorepeating property is set to false.
268 * @param[in] togglable property.
270 void SetTogglableButton( bool togglable );
273 * @DEPRECATED_1_1.32 GetProperty TOGGLABLE
275 * @brief Returns if the togglable property is set.
277 * @return \e true if the \e togglable property is set.
279 bool IsTogglableButton() const;
282 * @DEPRECATED_1_1.32 SetProperty SELECTED
284 * @brief Sets the button as selected or unselected.
286 * \e togglable property must be set to \e true.
288 * Emits a Button::StateChangedSignal() signal.
291 * @param[in] selected property.
293 void SetSelected( bool selected );
296 * DEPRECATED_1_1.32 SetProperty SELECTED
298 * @brief Returns if the selected property is set and the button is togglable.
300 * @return \e true if the button is \e selected.
302 bool IsSelected() const;
305 * @DEPRECATED_1_1.32 Use Styling file to set animation
307 * @brief Sets the animation time.
310 * @param[in] animationTime The animation time in seconds.
312 void SetAnimationTime( float animationTime );
315 * DEPRECATED_1_1.32 Use Styling file to set animation
317 * @brief Retrieves button's animation time.
320 * @return The animation time in seconds.
322 float GetAnimationTime() const;
325 * @DEPRECATED_1_1.32 SetProperty LABEL or Styling file
327 * @brief Sets the button's label.
330 * @param[in] label The label text.
332 void SetLabelText( const std::string& label );
335 * DEPRECATED_1_1.32 GetProperty LABEL
337 * @brief Gets the label.
340 * @return The label text.
342 std::string GetLabelText() const;
345 * @DEPRECATED_1_1.32 Use Styling file
347 * @brief Sets the unselected button image.
350 * @param[in] filename The button image.
352 void SetUnselectedImage( const std::string& filename );
355 * @DEPRECATED_1_1.32 Use styling
357 * @brief Sets the background image.
360 * @param[in] filename The background image.
362 void SetBackgroundImage( const std::string& filename );
365 * @DEPRECATED_1_1.32 Use styling file
367 * @brief Sets the selected image.
370 * @param[in] filename The selected image.
372 void SetSelectedImage( const std::string& filename );
375 * @DEPRECATED_1_1.32 Use styling file
377 * @brief Sets the selected background image.
380 * @param[in] filename The selected background image.
382 void SetSelectedBackgroundImage( const std::string& filename );
385 * @DEPRECATED_1_1.32 Use styling file
387 * @brief Sets the disabled background image.
390 * @param[in] filename The disabled background image.
392 void SetDisabledBackgroundImage( const std::string& filename );
395 * @DEPRECATED_1_1.32 Use styling file
397 * @brief Sets the disabled button image.
400 * @param[in] filename The disabled button image.
402 void SetDisabledImage( const std::string& filename );
405 * @DEPRECATED_1_1.32 Use styling file
407 * @brief Sets the disabled selected button image.
410 * @param[in] filename The disabled selected button image.
412 void SetDisabledSelectedImage( const std::string& filename );
415 * @DEPRECATED_1_0.50. Instead, use SetLabelText.
417 * @brief Sets the label with an actor.
420 * @param[in] label The actor to use as a label
422 void SetLabel( Actor label );
425 * @DEPRECATED_1_0.50. Instead, use SetUnselectedImage.
427 * @brief Sets the button image.
430 * @param[in] image The button image.
432 void SetButtonImage( Image image );
435 * @DEPRECATED_1_0.50. Instead, use SetSelectedImage( const std::string& filename ).
437 * @brief Sets the selected image.
440 * @param[in] image The selected image.
442 void SetSelectedImage( Image image );
447 * @brief Gets the button image.
450 * @remarks Avoid using this method as it's a legacy code.
451 * @return An actor with the button image.
453 Actor GetButtonImage() const;
458 * @brief Gets the selected image.
461 * @remarks Avoid using this method as it's a legacy code.
462 * @return An actor with the selected image.
464 Actor GetSelectedImage() const;
469 * @brief Button signal type
472 typedef Signal< bool ( Button ) > ButtonSignalType;
475 * @brief This signal is emitted when the button is touched.
477 * A callback of the following type may be connected:
479 * bool YourCallbackName( Button button );
482 * @return The signal to connect to.
484 ButtonSignalType& PressedSignal();
487 * @brief This signal is emitted when the button is touched and the touch point leaves the boundary of the button.
489 * A callback of the following type may be connected:
491 * bool YourCallbackName( Button button );
494 * @return The signal to connect to.
496 ButtonSignalType& ReleasedSignal();
499 * @brief This signal is emitted when the button is touched and the touch point doesn't leave the boundary of the button.
501 * A callback of the following type may be connected:
503 * bool YourCallbackName( Button button );
506 * @return The signal to connect to.
508 ButtonSignalType& ClickedSignal();
511 * @brief This signal is emitted when the button's state is changed.
513 * The application can get the state by calling IsSelected().
515 * A callback of the following type may be connected:
517 * bool YourCallbackName( Button button );
520 * @return The signal to connect to.
522 ButtonSignalType& StateChangedSignal();
524 public: // Not intended for application developers
528 * @brief Creates a handle using the Toolkit::Internal implementation.
531 * @param[in] implementation The Control implementation.
533 DALI_INTERNAL Button( Internal::Button& implementation );
536 * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
539 * @param[in] internal A pointer to the internal CustomActor.
541 DALI_INTERNAL Button( Dali::Internal::CustomActor* internal );
548 } // namespace Toolkit
552 #endif // __DALI_TOOLKIT_BUTTON_H__