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 * @addtogroup CAPI_DALI_TOOLKIT_BUTTONS_MODULE
27 #include <dali-toolkit/public-api/controls/control.h>
29 namespace Dali DALI_IMPORT_API
32 namespace Internal DALI_INTERNAL
40 namespace Internal DALI_INTERNAL
46 * @brief Button is a base class for different kind of buttons.
48 * This class provides the dimmed property and the clicked signal.
50 * A ClickedSignal() is emitted when the button is touched and the touch
51 * point doesn't leave the boundary of the button.
53 * When the \e dimmed property is set to \e true, no signal is emitted.
55 class Button : public Control
60 static const char* const SIGNAL_CLICKED; ///< name "clicked"
63 static const Property::Index PROPERTY_DIMMED; ///< name "dimmed", @see SetDimmed(), type BOOLEAN
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 );
97 * @brief Virtual destructor.
99 * Dali::Object derived classes typically do not contain member data.
104 * @brief Sets the button as \e dimmed.
106 * No signals are emitted when the \e dimmed property is set.
108 * @param[in] dimmed property.
110 void SetDimmed( bool dimmed );
113 * @return \e true if the button is \e dimmed.
115 bool IsDimmed() 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 SignalV2< bool ( Button ) > ClickedSignalV2;
139 * @brief Signal emitted when the button is touched and the touch point doesn't leave the boundary of the button.
141 ClickedSignalV2& ClickedSignal();
143 public: // Not intended for application developers
146 * @brief Creates a handle using the Toolkit::Internal implementation.
148 * @param[in] implementation The Control implementation.
150 Button( Internal::Button& implementation );
153 * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
155 * @param[in] internal A pointer to the internal CustomActor.
157 Button( Dali::Internal::CustomActor* internal );
160 } // namespace Toolkit
167 #endif // __DALI_TOOLKIT_BUTTON_H__