X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali-toolkit%2Fpublic-api%2Fcontrols%2Fscrollable%2Fscrollable.h;h=a12e3c22a65e25fef01d4c8882e302633e654b89;hb=e74563220e35ea81a5b932186221623eed0fc62e;hp=71ad8ab76c4c8c97aa4671ce2607f019e46a7f66;hpb=2eb0f016cf4d8a8282681283ae0e842c0c67bded;p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git diff --git a/dali-toolkit/public-api/controls/scrollable/scrollable.h b/dali-toolkit/public-api/controls/scrollable/scrollable.h index 71ad8ab..a12e3c2 100644 --- a/dali-toolkit/public-api/controls/scrollable/scrollable.h +++ b/dali-toolkit/public-api/controls/scrollable/scrollable.h @@ -1,8 +1,8 @@ -#ifndef __DALI_TOOLKIT_SCROLLABLE_H__ -#define __DALI_TOOLKIT_SCROLLABLE_H__ +#ifndef DALI_TOOLKIT_SCROLLABLE_H +#define DALI_TOOLKIT_SCROLLABLE_H /* - * Copyright (c) 2015 Samsung Electronics Co., Ltd. + * Copyright (c) 2020 Samsung Electronics Co., Ltd. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -23,10 +23,8 @@ namespace Dali { - namespace Toolkit { - namespace Internal DALI_INTERNAL { class Scrollable; @@ -46,39 +44,44 @@ class Scrollable; * | %Signal Name | Method | * |------------------|------------------------------| * | scrollStarted | @ref ScrollStartedSignal() | - * | scrollCompleted | @ref ScrollUpdatedSignal() | - * | scrollUpdated | @ref ScrollCompletedSignal() | + * | scrollCompleted | @ref ScrollCompletedSignal() | + * | scrollUpdated | @ref ScrollUpdatedSignal() | * @SINCE_1_0.0 */ -class DALI_IMPORT_API Scrollable : public Control +class DALI_TOOLKIT_API Scrollable : public Control { public: - /** - * @brief The start and end property ranges for this control. + * @brief Enumeration for the start and end property ranges for this control. * @SINCE_1_0.0 */ enum PropertyRange { PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1, ///< @SINCE_1_0.0 - PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000, ///< Reserve property indices @SINCE_1_0.0 + PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000, ///< Reserve property indices @SINCE_1_0.0 ANIMATABLE_PROPERTY_START_INDEX = ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX, - ANIMATABLE_PROPERTY_END_INDEX = ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX + 1000 ///< Reserve animatable property indices @SINCE_1_0.0 + ANIMATABLE_PROPERTY_END_INDEX = ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX + 1000 ///< Reserve animatable property indices @SINCE_1_0.0 }; /** - * @brief An enumeration of properties belonging to the Scrollable class. + * @brief Enumeration for the instance of properties belonging to the Scrollable class. * @SINCE_1_0.0 */ struct Property { + /** + * @brief Enumeration for the instance of properties belonging to the Scrollable class. + * @SINCE_1_0.0 + */ enum { // Event side properties OVERSHOOT_EFFECT_COLOR = PROPERTY_START_INDEX, ///< Property, name "overshootEffectColor", @see SetOvershootEffectColor(), type Vector4 @SINCE_1_0.0 OVERSHOOT_ANIMATION_SPEED, ///< Property, name "overshootAnimationSpeed", @see SetOvershootAnimationSpeed(), type float @SINCE_1_0.0 OVERSHOOT_ENABLED, ///< Property, name "overshootEnabled", @see SetOvershootEnabled(), type bool, @SINCE_1_1.18 + OVERSHOOT_SIZE, ///< Property, name "overshootSize", type Vector2, @SINCE_1_1.31 + SCROLL_TO_ALPHA_FUNCTION, ///< Property, name "scrollToAlphaFunction", type int, @SINCE_1_1.33 // Animatable properties SCROLL_RELATIVE_POSITION = ANIMATABLE_PROPERTY_START_INDEX, ///< Property, name "scrollRelativePosition", type Vector2 @SINCE_1_0.0 @@ -95,12 +98,11 @@ public: // Typedefs - typedef Signal< void ( const Vector2& ) > ScrollStartedSignalType; ///< ScrollStarted signal type @SINCE_1_0.0 - typedef Signal< void ( const Vector2& ) > ScrollCompletedSignalType; ///< ScrollCompleted signal type @SINCE_1_0.0 - typedef Signal< void ( const Vector2& ) > ScrollUpdatedSignalType; ///< Scroll updated signal type @SINCE_1_0.0 + typedef Signal ScrollStartedSignalType; ///< ScrollStarted signal type @SINCE_1_0.0 + typedef Signal ScrollCompletedSignalType; ///< ScrollCompleted signal type @SINCE_1_0.0 + typedef Signal ScrollUpdatedSignalType; ///< Scroll updated signal type @SINCE_1_0.0 public: - /** * @brief Creates an uninitialized Scrollable handle. * @SINCE_1_0.0 @@ -110,25 +112,42 @@ public: /** * @brief Copy constructor. * - * Creates another handle that points to the same real object + * Creates another handle that points to the same real object. * * @SINCE_1_0.0 * @param handle to copy from */ - Scrollable( const Scrollable& handle ); + Scrollable(const Scrollable& handle); + + /** + * @brief Move constructor + * @SINCE_1_9.23 + * + * @param[in] rhs A reference to the moved handle + */ + Scrollable(Scrollable&& rhs); /** * @brief Assignment operator. * - * Changes this handle to point to another real object + * Changes this handle to point to another real object. * @SINCE_1_0.0 - * @param[in] handle to copy from + * @param[in] handle Handle to copy from * @return A reference to this */ - Scrollable& operator=( const Scrollable& handle ); + Scrollable& operator=(const Scrollable& handle); /** - * @brief Destructor + * @brief Move assignment + * @SINCE_1_9.23 + * + * @param[in] rhs A reference to the moved handle + * @return A reference to this + */ + Scrollable& operator=(Scrollable&& rhs); + + /** + * @brief Destructor. * * This is non-virtual since derived Handle types must not contain data or virtual methods. * @SINCE_1_0.0 @@ -136,22 +155,22 @@ public: ~Scrollable(); /** - * @brief Downcast an Object handle to Scrollable. + * @brief Downcasts a handle to Scrollable handle. * - * If handle points to a Scrollable the downcast produces valid - * handle. If not the returned handle is left uninitialized. + * If handle points to a Scrollable, the downcast produces valid handle. + * If not, the returned handle is left uninitialized. * * @SINCE_1_0.0 * @param[in] handle Handle to an object - * @return handle to a Scrollable or an uninitialized handle + * @return A handle to a Scrollable or an uninitialized handle */ - static Scrollable DownCast( BaseHandle handle ); + static Scrollable DownCast(BaseHandle handle); /** * @brief Checks if scroll overshoot has been enabled or not. * * @SINCE_1_0.0 - * @return Whether the scroll obvershoot is enabled + * @return Whether the scroll overshoot is enabled */ bool IsOvershootEnabled() const; @@ -159,42 +178,42 @@ public: * @brief Sets whether to enables or disable scroll overshoot. * * @SINCE_1_0.0 - * @param[in] enable Whether to enable the scroll obvershoot or not + * @param[in] enable Whether to enable the scroll overshoot or not */ void SetOvershootEnabled(bool enable); /** - * @brief Set the color of the overshoot effect. + * @brief Sets the color of the overshoot effect. * * @SINCE_1_0.0 - * @param[in] color The color of the overshoot effect. + * @param[in] color The color of the overshoot effect */ - void SetOvershootEffectColor( const Vector4& color ); + void SetOvershootEffectColor(const Vector4& color); /** - * @brief Get the color of the overshoot effect. + * @brief Gets the color of the overshoot effect. * @SINCE_1_0.0 - * @return The color of the overshoot effect. + * @return The color of the overshoot effect */ Vector4 GetOvershootEffectColor() const; /** - * @brief Set the speed of overshoot animation in pixels per second. + * @brief Sets the speed of overshoot animation in pixels per second. + * * When the speed is not greater than 0, the overshoot is set instantly with no animation. * @SINCE_1_0.0 - * @param[in] pixelsPerSecond The speed of the overshoot animation. + * @param[in] pixelsPerSecond The speed of the overshoot animation */ - void SetOvershootAnimationSpeed( float pixelsPerSecond ); + void SetOvershootAnimationSpeed(float pixelsPerSecond); /** - * @brief Get the speed of overshoot animation in pixels per second. + * @brief Gets the speed of overshoot animation in pixels per second. * @SINCE_1_0.0 - * @return The speed of the overshoot animation. + * @return The speed of the overshoot animation */ float GetOvershootAnimationSpeed() const; public: // Signals - /** * @brief Signal emitted when the Scrollable has moved (whether by touch or animation). * @@ -203,7 +222,7 @@ public: // Signals * void YourCallbackName(const Vector2& currentScrollPosition); * @endcode * @SINCE_1_0.0 - * @return The signal to connect to. + * @return The signal to connect to * @pre The Object has been initialized. */ ScrollStartedSignalType& ScrollStartedSignal(); @@ -216,7 +235,7 @@ public: // Signals * void YourCallbackName(const Vector2& currentScrollPosition); * @endcode * @SINCE_1_0.0 - * @return The signal to connect to. + * @return The signal to connect to * @pre The Object has been initialized. */ ScrollUpdatedSignalType& ScrollUpdatedSignal(); @@ -229,18 +248,18 @@ public: // Signals * void YourCallbackName(const Vector2& currentScrollPosition); * @endcode * @SINCE_1_0.0 - * @return The signal to connect to. + * @return The signal to connect to * @pre The Object has been initialized. */ ScrollCompletedSignalType& ScrollCompletedSignal(); public: // Not intended for application developers - + /// @cond internal /** * @brief Creates a handle using the Toolkit::Internal implementation. * * @SINCE_1_0.0 - * @param[in] implementation The Control implementation. + * @param[in] implementation The Control implementation */ DALI_INTERNAL Scrollable(Internal::Scrollable& implementation); @@ -248,9 +267,10 @@ public: // Not intended for application developers * @brief Allows the creation of this Control from an Internal::CustomActor pointer. * * @SINCE_1_0.0 - * @param[in] internal A pointer to the internal CustomActor. + * @param[in] internal A pointer to the internal CustomActor */ - explicit DALI_INTERNAL Scrollable( Dali::Internal::CustomActor* internal ); + explicit DALI_INTERNAL Scrollable(Dali::Internal::CustomActor* internal); + /// @endcond }; /** @@ -260,4 +280,4 @@ public: // Not intended for application developers } // namespace Dali -#endif // __DALI_TOOLKIT_SCROLLABLE_H__ +#endif // DALI_TOOLKIT_SCROLLABLE_H