X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;ds=sidebyside;f=dali-toolkit%2Fpublic-api%2Fcontrols%2Fscrollable%2Fscrollable.h;h=38050ae8e09b3cfdb02705f82a1b3346a14eb217;hb=05fc311b489e5c929433c722439eef45116f0e8b;hp=cd04e0753e31200a02140cdc5ffc97a6a7d683a4;hpb=b2075341afcb68b5f6eea7308f10d65b589c1be4;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 cd04e07..38050ae 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) 2019 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. @@ -46,16 +46,16 @@ 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 @@ -68,17 +68,23 @@ public: }; /** - * @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 @@ -122,13 +128,13 @@ public: * * 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 ); /** - * @brief Destructor + * @brief Destructor. * * This is non-virtual since derived Handle types must not contain data or virtual methods. * @SINCE_1_0.0 @@ -136,10 +142,10 @@ public: ~Scrollable(); /** - * @brief Downcast a handle to Scrollable handle. + * @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 @@ -164,33 +170,33 @@ public: 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 ); /** - * @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 ); /** - * @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; @@ -204,7 +210,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(); @@ -217,7 +223,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(); @@ -230,18 +236,19 @@ 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); @@ -249,9 +256,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 ); + /// @endcond }; /** @@ -261,4 +269,4 @@ public: // Not intended for application developers } // namespace Dali -#endif // __DALI_TOOLKIT_SCROLLABLE_H__ +#endif // DALI_TOOLKIT_SCROLLABLE_H