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 dimmed 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 dimmed 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_TOGGLED; ///< name "toggled"
54 static const Property::Index PROPERTY_DIMMED; ///< name "dimmed", @see SetDimmed(), type BOOLEAN
59 * @brief Create an uninitialized Button.
61 * Only derived versions can be instantiated. Calling member
62 * functions with an uninitialized Dali::Object is not allowed.
67 * @brief Copy constructor.
69 Button( const Button& button );
72 * @brief Assignment operator.
74 Button& operator=( const Button& button );
77 * @brief Downcast an Object handle to Button.
79 * If handle points to a Button the downcast produces valid
80 * handle. If not the returned handle is left uninitialized.
82 * @param[in] handle Handle to an object
83 * @return handle to a Button or an uninitialized handle
85 static Button DownCast( BaseHandle handle );
90 * This is non-virtual since derived Handle types must not contain data or virtual methods.
95 * @brief Sets the button as \e dimmed.
97 * No signals are emitted when the \e dimmed property is set.
99 * @param[in] dimmed property.
101 void SetDimmed( bool dimmed );
104 * @return \e true if the button is \e dimmed.
106 bool IsDimmed() const;
109 * @brief Sets the animation time.
111 * @param [in] animationTime The animation time in seconds.
113 void SetAnimationTime( float animationTime );
116 * @brief Retrieves button's animation time.
118 * @return The animation time in seconds.
120 float GetAnimationTime() const;
125 * @brief Button Clicked signal type
127 typedef SignalV2< bool ( Button ) > ClickedSignalV2;
130 * @brief Button toggled signal type
132 typedef SignalV2< bool ( Button, bool ) > ToggledSignalV2;
135 * @brief Signal emitted when the button is touched and the touch point doesn't leave the boundary of the button.
137 ClickedSignalV2& ClickedSignal();
140 * @brief Signal emitted when the button's state is toggled.
142 ToggledSignalV2& ToggledSignal();
144 public: // Not intended for application developers
147 * @brief Creates a handle using the Toolkit::Internal implementation.
149 * @param[in] implementation The Control implementation.
151 DALI_INTERNAL Button( Internal::Button& implementation );
154 * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
156 * @param[in] internal A pointer to the internal CustomActor.
158 DALI_INTERNAL Button( Dali::Internal::CustomActor* internal );
161 } // namespace Toolkit
165 #endif // __DALI_TOOLKIT_BUTTON_H__