1 #ifndef __DALI_TOOLKIT_SCROLLABLE_H__
2 #define __DALI_TOOLKIT_SCROLLABLE_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 Base class for derived Scrollables that contains actors that can be scrolled manually
37 * (via touch) or automatically.
39 * Scrollables such as ScrollView and ItemView can be derived from this class.
42 * | %Signal Name | Method |
43 * |-------------------|------------------------------|
44 * | scroll-started | @ref ScrollStartedSignal() |
45 * | scroll-completed | @ref ScrollUpdatedSignal() |
46 * | scroll-updated | @ref ScrollCompletedSignal() |
48 class DALI_IMPORT_API Scrollable : public Control
53 * @brief Scroll component types
55 enum ScrollComponentType
64 static const std::string SCROLL_RELATIVE_POSITION_PROPERTY_NAME; ///< Property, name "scroll-relative-position", type Vector3
65 static const std::string SCROLL_POSITION_MIN_PROPERTY_NAME; ///< Property, name "scroll-position-min", type Vector3
66 static const std::string SCROLL_POSITION_MAX_PROPERTY_NAME; ///< Property, name "scroll-position-max", type Vector3
67 static const std::string SCROLL_DIRECTION_PROPERTY_NAME; ///< Property, name "scroll-direction", type Vector2
70 * @brief The start and end property ranges for this control.
74 PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1,
75 PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000 ///< Reserve property indices
79 * @brief An enumeration of properties belonging to the Scrollable class.
85 OVERSHOOT_EFFECT_COLOR = PROPERTY_START_INDEX, ///< Property, name "overshoot-effect-color", @see SetOvershootEffectColor(), type Vector4
86 OVERSHOOT_ANIMATION_SPEED, ///< Property, name "overshoot-animation-speed", @see SetOvershootAnimationSpeed(), type float
92 typedef Signal< void ( const Vector3& ) > ScrollStartedSignalType; ///< ScrollStarted signal type
93 typedef Signal< void ( const Vector3& ) > ScrollCompletedSignalType; ///< ScrollCompleted signal type
94 typedef Signal< void ( const Vector3& ) > ScrollUpdatedSignalType; ///< Scroll updated signal type
97 * @brief Signal emitted when the Scrollable has moved (whether by touch or animation).
99 ScrollStartedSignalType& ScrollStartedSignal();
102 * @brief Signal emitted when the Scrollable has moved (whether by touch or animation).
104 ScrollUpdatedSignalType& ScrollUpdatedSignal();
107 * @brief Signal emitted when the Scrollable has completed movement (whether by touch or animation).
109 ScrollCompletedSignalType& ScrollCompletedSignal();
114 * @brief Creates an uninitialized Scrollable handle.
119 * @brief Copy constructor.
121 * Creates another handle that points to the same real object
123 * @param handle to copy from
125 Scrollable( const Scrollable& handle );
128 * @brief Assignment operator.
130 * Changes this handle to point to another real object
131 * @param[in] handle to copy from
132 * @return A reference to this
134 Scrollable& operator=( const Scrollable& handle );
139 * This is non-virtual since derived Handle types must not contain data or virtual methods.
144 * @brief Downcast an Object handle to Scrollable.
146 * If handle points to a Scrollable the downcast produces valid
147 * handle. If not the returned handle is left uninitialized.
149 * @param[in] handle Handle to an object
150 * @return handle to a Scrollable or an uninitialized handle
152 static Scrollable DownCast( BaseHandle handle );
155 * @brief Checks if a ScrollComponent has been enabled or not.
157 * @param[in] type The Scroll Component Type to check
158 * @return True (if Enabled)
160 bool IsScrollComponentEnabled(Scrollable::ScrollComponentType type) const;
163 * @brief Enables a ScrollComponent.
165 * @param[in] type The Scroll Component Type to enable
167 void EnableScrollComponent(Scrollable::ScrollComponentType type);
170 * @brief Disables a ScrollComponent.
172 * @param[in] type The Scroll Component Type to disable
174 void DisableScrollComponent(Scrollable::ScrollComponentType type);
177 * @brief Set the color of the overshoot effect.
179 * @param[in] color The color of the overshoot effect.
181 void SetOvershootEffectColor( const Vector4& color );
184 * @brief Get the color of the overshoot effect.
185 * @return The color of the overshoot effect.
187 Vector4 GetOvershootEffectColor() const;
190 * @brief Set the speed of overshoot animation in pixels per second.
191 * When the speed is not greater than 0, the overshoot is set instantly with no animation.
192 * @param[in] pixelsPerSecond The speed of the overshoot animation.
194 void SetOvershootAnimationSpeed( float pixelsPerSecond );
197 * @brief Get the speed of overshoot animation in pixels per second.
198 * @return The speed of the overshoot animation.
200 float GetOvershootAnimationSpeed() const;
202 public: // Not intended for application developers
205 * @brief Creates a handle using the Toolkit::Internal implementation.
207 * @param[in] implementation The Control implementation.
209 DALI_INTERNAL Scrollable(Internal::Scrollable& implementation);
212 * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
214 * @param[in] internal A pointer to the internal CustomActor.
216 explicit DALI_INTERNAL Scrollable( Dali::Internal::CustomActor* internal );
219 } // namespace Toolkit
223 #endif // __DALI_TOOLKIT_SCROLLABLE_H__