1 #ifndef __DALI_TOOLKIT_BUTTON_H__
2 #define __DALI_TOOLKIT_BUTTON_H__
5 * Copyright (c) 2014 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
36 * @brief Button is a base class for different kind of buttons.
38 * This class provides the disabled property and the clicked signal.
40 * A ClickedSignal() is emitted when the button is touched and the touch
41 * point doesn't leave the boundary of the button.
43 * When the \e disabled property is set to \e true, no signal is emitted.
45 class DALI_IMPORT_API Button : public Control
50 static const char* const SIGNAL_CLICKED; ///< name "clicked"
51 static const char* const SIGNAL_STATE_CHANGED; ///< name "state-changed"
54 static const Property::Index PROPERTY_DISABLED; ///< name "disabled", @see SetDisabled(), type BOOLEAN
55 static const Property::Index PROPERTY_AUTO_REPEATING; ///< name "auto-repeating", @see SetAutoRepeating(), type BOOLEAN
56 static const Property::Index PROPERTY_INITIAL_AUTO_REPEATING_DELAY; ///< name "initial-auto-repeating-delay", @see SetInitialAutoRepeatingDelay(), type FLOAT
57 static const Property::Index PROPERTY_NEXT_AUTO_REPEATING_DELAY; ///< name "next-auto-repeating-delay", @see SetNextAutoRepeatingDelay(), type FLOAT
58 static const Property::Index PROPERTY_TOGGLABLE; ///< name "togglable", @see SetToggleButton(), type BOOLEAN
59 static const Property::Index PROPERTY_TOGGLED; ///< name "toggled", @see SetToggled(), type BOOLEAN
60 static const Property::Index PROPERTY_NORMAL_STATE_ACTOR; ///< name "button-state-actor", @see SetButtonImage(), type MAP
61 static const Property::Index PROPERTY_SELECTED_STATE_ACTOR; ///< name "selected-state-actor", @see SetSelectedImage(), type MAP
62 static const Property::Index PROPERTY_DISABLED_STATE_ACTOR; ///< name "disabled-state-actor", @see SetDisabledImage(), type MAP
63 static const Property::Index PROPERTY_LABEL_ACTOR; ///< name "label-actor", @see SetLabel(), type MAP
68 * @brief Create an uninitialized Button.
70 * Only derived versions can be instantiated. Calling member
71 * functions with an uninitialized Dali::Object is not allowed.
76 * @brief Copy constructor.
78 Button( const Button& button );
81 * @brief Assignment operator.
83 Button& operator=( const Button& button );
86 * @brief Downcast an Object handle to Button.
88 * If handle points to a Button the downcast produces valid
89 * handle. If not the returned handle is left uninitialized.
91 * @param[in] handle Handle to an object
92 * @return handle to a Button or an uninitialized handle
94 static Button DownCast( BaseHandle handle );
99 * This is non-virtual since derived Handle types must not contain data or virtual methods.
104 * @brief Sets the button as \e disabled.
106 * No signals are emitted when the \e disabled property is set.
108 * @param[in] disabled property.
110 void SetDisabled( bool disabled );
113 * @return \e true if the button is \e disabled.
115 bool IsDisabled() const;
118 * @brief Sets the animation time.
120 * @param [in] animationTime The animation time in seconds.
122 void SetAnimationTime( float animationTime );
125 * @brief Retrieves button's animation time.
127 * @return The animation time in seconds.
129 float GetAnimationTime() const;
134 * @brief Button Clicked signal type
136 typedef Signal< bool ( Button ) > ClickedSignalType;
139 * @brief Button state changed signal type
141 typedef Signal< bool ( Button, bool ) > StateChangedSignalType;
144 * @brief Signal emitted when the button is touched and the touch point doesn't leave the boundary of the button.
146 ClickedSignalType& ClickedSignal();
149 * @brief Signal emitted when the button's state is changed.
151 StateChangedSignalType& StateChangedSignal();
153 public: // Not intended for application developers
156 * @brief Creates a handle using the Toolkit::Internal implementation.
158 * @param[in] implementation The Control implementation.
160 DALI_INTERNAL Button( Internal::Button& implementation );
163 * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
165 * @param[in] internal A pointer to the internal CustomActor.
167 DALI_INTERNAL Button( Dali::Internal::CustomActor* internal );
170 } // namespace Toolkit
174 #endif // __DALI_TOOLKIT_BUTTON_H__