X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=dali-toolkit%2Fpublic-api%2Fcontrols%2Fscrollable%2Fscroll-view%2Fscroll-view.h;h=cb24960a84db6992b8159af92086afc358ad7ce3;hp=fb9d5cb4a38e863514eab7356c269c1fe8259b90;hb=fcc87538717836a4f9d9ca9ec7dfc242f5aa8431;hpb=06990b10c42c9f1ec0ec3c44b690d83b8b14b366 diff --git a/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view.h b/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view.h index fb9d5cb..cb24960 100644 --- a/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view.h +++ b/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view.h @@ -34,19 +34,25 @@ namespace Internal DALI_INTERNAL { class ScrollView; } +/** + * @addtogroup dali_toolkit_controls_scroll_view + * @{ + */ /** * @brief How axes/rotation or scale are clamped + * @SINCE_1_0.0 */ enum ClampState { - NotClamped, ///< The quantity isn't clamped - ClampedToMin, ///< The quantity is clamped to the min value - ClampedToMax ///< The quantity is clamped to the max value + NotClamped, ///< The quantity isn't clamped @SINCE_1_0.0 + ClampedToMin, ///< The quantity is clamped to the min value @SINCE_1_0.0 + ClampedToMax ///< The quantity is clamped to the max value @SINCE_1_0.0 }; /** * @brief A 2 dimensional clamp + * @SINCE_1_0.0 */ struct ClampState2D { @@ -56,25 +62,28 @@ struct ClampState2D /** * @brief The snap type + * @SINCE_1_0.0 */ enum SnapType { - Snap, ///< Snap - Flick ///< Flick + Snap, ///< Snap @SINCE_1_0.0 + Flick ///< Flick @SINCE_1_0.0 }; /** * @brief DirectionBias types. + * @SINCE_1_0.0 */ enum DirectionBias { - DirectionBiasLeft = -1, ///< Bias scroll snap to Left - DirectionBiasNone = 0, ///< Don't bias scroll snap - DirectionBiasRight = 1 ///< Bias scroll snap to Right + DirectionBiasLeft = -1, ///< Bias scroll snap to Left @SINCE_1_0.0 + DirectionBiasNone = 0, ///< Don't bias scroll snap @SINCE_1_0.0 + DirectionBiasRight = 1 ///< Bias scroll snap to Right @SINCE_1_0.0 }; /** * @brief Used for specifying minimum/maximum extents of a ruler. + * @SINCE_1_0.0 */ class DALI_IMPORT_API RulerDomain { @@ -83,6 +92,7 @@ public: /** * @brief Creates Ruler domain allowing a point to traverse between min and max extents. * + * @SINCE_1_0.0 * @param[in] min Minimum extent (point cannot traverse less than this) * @param[in] max Maximum extent (point cannot traverse greater than this) * @param[in] enabled Whether domain has been enabled or not. @@ -101,6 +111,7 @@ public: * An optional length parameter can be specified to suggest that the * subject is not a point but a line to that should be clamped. * + * @SINCE_1_0.0 * @param[in] x X point to be clamped between (min) and (max) extents. * @param[in] length (optional) The Length of the line from (x) to (x + length) to be clamped. * @param[in] scale Scaling parameter which treats domain as scaled in calculations. @@ -114,6 +125,7 @@ public: * An optional length parameter can be specified to suggest that the * subject is not a point but a line to that should be clamped. * + * @SINCE_1_0.0 * @param[in] x X point to be clamped between (min) and (max) extents. * @param[in] length (optional) The Length of the line from (x) to (x + length) to be clamped. * @param[in] scale Scaling parameter which treats domain as scaled in calculations. @@ -125,6 +137,7 @@ public: /** * @brief Returns (max-min) size of ruler. * + * @SINCE_1_0.0 * @return The size of the ruler from min to max. */ float GetSize() const; @@ -139,26 +152,29 @@ class RulerExtension; * * It can specify whether they are traversable, where their snap * points are and their domain. + * @SINCE_1_0.0 */ class DALI_IMPORT_API Ruler : public RefObject { public: /// @brief The type of the ruler enum RulerType { - Fixed, ///< A fixed ruler - Free ///< A free ruler + Fixed, ///< A fixed ruler @SINCE_1_0.0 + Free ///< A free ruler @SINCE_1_0.0 }; public: /** * @brief Constructs ruler, default enabled, with limitless domain. + * @SINCE_1_0.0 */ Ruler(); /** * @brief Snaps (x) in accordance to the ruler settings. * + * @SINCE_1_0.0 * @param[in] x The input value on the ruler to be snapped. * @param[in] bias (optional) The biasing employed for snapping * 0 floor input (floor x) "Used for Flick Left" @@ -177,6 +193,7 @@ public: * number of pages within the domain), while wrapping the position * within the domain. * + * @SINCE_1_0.0 * @param[in] page The page index * @param[out] volume The overflow volume when the page exceeds the domain (wrap must be enabled) * @param[in] wrap Enable wrap mode @@ -190,6 +207,7 @@ public: * * If (wrap) is true, then will return a page wrapped within the domain. * + * @SINCE_1_0.0 * @param[in] position The position on the domain * @param[in] wrap Enable wrap mode * @return The page where this position resides. @@ -199,6 +217,7 @@ public: /** * @brief Returns the total number of pages within this Ruler. * + * @SINCE_1_0.0 * @return The number of pages in the Ruler. */ virtual unsigned int GetTotalPages() const = 0; @@ -206,6 +225,7 @@ public: /** * @brief Gets the extension interface of the Ruler. * + * @SINCE_1_0.0 * @return The extension interface of the Ruler */ virtual RulerExtension* GetExtension() { return NULL; } @@ -215,6 +235,7 @@ public: /** * @brief Gets the ruler type. * + * @SINCE_1_0.0 * @return The ruler type. */ Ruler::RulerType GetType() const; @@ -222,23 +243,27 @@ public: /** * @brief Returns whether this axis has been enabled or not. * + * @SINCE_1_0.0 * @return true if axis is enabled */ bool IsEnabled() const; /** * @brief Enables ruler (ruler must be enabled in order to traverse along it). + * @SINCE_1_0.0 */ void Enable(); /** * @brief Disables ruler. + * @SINCE_1_0.0 */ void Disable(); /** * @brief Sets Domain. * + * @SINCE_1_0.0 * @param[in] domain Ruler domain object. */ void SetDomain(RulerDomain domain); @@ -246,12 +271,14 @@ public: /** * @brief Gets Domain. * + * @SINCE_1_0.0 * @return The domain */ const RulerDomain &GetDomain() const; /** * @brief Disables Domain (minimum/maximum extents for this axis). + * @SINCE_1_0.0 */ void DisableDomain(); @@ -261,6 +288,7 @@ public: * An optional length parameter can be specified to suggest that the * subject is not a point but a line that should be clamped. * + * @SINCE_1_0.0 * @param[in] x X point to be clamped between (min) and (max) extents. * @param[in] length (optional) The Length of the line from (x) to (x + length) to be clamped. * @param[in] scale Scaling parameter which treats domain as scaled in calculations. @@ -275,6 +303,7 @@ public: * An optional length parameter can be specified to suggest that the * subject is not a point but a line to that should be clamped. * + * @SINCE_1_0.0 * @param[in] x X point to be clamped between (min) and (max) extents. * @param[in] length (optional) The Length of the line from (x) to (x + length) to be clamped. * @param[in] scale Scaling parameter which treats domain as scaled in calculations. @@ -286,6 +315,7 @@ public: /** * @brief Snaps and Clamps (x) in accordance to ruler settings. * + * @SINCE_1_0.0 * @param[in] x value to be snapped in accordance to ruler snap value, * and clamped in accordance to the ruler's domain (if set). * @param[in] bias (optional) The biasing employed for snapping @@ -302,6 +332,7 @@ public: /** * @brief Snaps and Clamps (x) in accordance to ruler settings. * + * @SINCE_1_0.0 * @param[in] x value to be snapped in accordance to ruler snap value, * and clamped in accordance to the ruler's domain (if set). * @param[in] bias (optional) The biasing employed for snapping @@ -320,6 +351,7 @@ protected: /** * @brief Destructor - A reference counted object may only be deleted by calling Unreference(). + * @SINCE_1_0.0 */ virtual ~Ruler(); @@ -331,16 +363,18 @@ protected: }; -typedef IntrusivePtr RulerPtr; ///< Pointer to Dali::Toolkit::Ruler object +typedef IntrusivePtr RulerPtr; ///< Pointer to Dali::Toolkit::Ruler object @SINCE_1_0.0 /** * @brief Concrete implementation of Ruler that has no snapping and has one single page. + * @SINCE_1_0.0 */ class DALI_IMPORT_API DefaultRuler : public Ruler { public: /** * @brief DefaultRuler constructor. + * @SINCE_1_0.0 */ DefaultRuler(); @@ -367,6 +401,7 @@ public: /** * @brief Concrete implementation of Ruler that has fixed snapping. + * @SINCE_1_0.0 */ class DALI_IMPORT_API FixedRuler : public Ruler { @@ -374,6 +409,7 @@ public: /** * @brief Constructor * + * @SINCE_1_0.0 * @param[in] spacing The spacing between each interval on this ruler. */ FixedRuler(float spacing = 1.0f); @@ -413,6 +449,7 @@ class ScrollView; * | %Signal Name | Method | * |-------------------|----------------------------| * | snap-started | @ref SnapStartedSignal() | + * @SINCE_1_0.0 */ class DALI_IMPORT_API ScrollView : public Scrollable { @@ -421,6 +458,7 @@ public: /** * @brief Clamp signal event's data + * @SINCE_1_0.0 */ struct ClampEvent { @@ -431,6 +469,7 @@ public: /** * @brief Snap signal event's data. + * @SINCE_1_0.0 */ struct SnapEvent { @@ -441,60 +480,77 @@ public: /** * @brief The start and end property ranges for this control. + * @SINCE_1_0.0 */ enum PropertyRange { + PROPERTY_START_INDEX = Toolkit::Scrollable::PROPERTY_END_INDEX + 1, ///< @SINCE_1_1.18 + PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000, ///< Reserve property indices, @SINCE_1_1.18 + ANIMATABLE_PROPERTY_START_INDEX = Toolkit::Scrollable::ANIMATABLE_PROPERTY_END_INDEX + 1, - ANIMATABLE_PROPERTY_END_INDEX = ANIMATABLE_PROPERTY_START_INDEX + 1000 ///< Reserve animatable property indices + ANIMATABLE_PROPERTY_END_INDEX = ANIMATABLE_PROPERTY_START_INDEX + 1000 ///< Reserve animatable property indices @SINCE_1_0.0 }; /** - * @brief An enumeration of properties belonging to the ScrollView class. + * @brief Enumeration for the instance of properties belonging to the ScrollView class. + * @SINCE_1_0.0 */ struct Property { + /** + * @brief Enumeration for the instance of properties belonging to the ScrollView class. + * @SINCE_1_0.0 + */ enum { - SCROLL_POSITION = ANIMATABLE_PROPERTY_START_INDEX, ///< Property, name "scroll-position", type Vector2 - SCROLL_PRE_POSITION, ///< Property, name "scroll-pre-position", type Vector2 - SCROLL_PRE_POSITION_X, ///< Property, name "scroll-pre-position-x", type float - SCROLL_PRE_POSITION_Y, ///< Property, name "scroll-pre-position-y", type float - SCROLL_PRE_POSITION_MAX, ///< Property, name "scroll-pre-position-max", type Vector2 - SCROLL_PRE_POSITION_MAX_X, ///< Property, name "scroll-pre-position-max-x", type float - SCROLL_PRE_POSITION_MAX_Y, ///< Property, name "scroll-pre-position-max-y", type float - OVERSHOOT_X, ///< Property, name "overshoot-x", type float - OVERSHOOT_Y, ///< Property, name "overshoot-y", type float - SCROLL_FINAL, ///< Property, name "scroll-final", type Vector2 - SCROLL_FINAL_X, ///< Property, name "scroll-final-x", type float - SCROLL_FINAL_Y, ///< Property, name "scroll-final-y", type float - WRAP, ///< Property, name "wrap", type bool - PANNING, ///< Property, name "panning", type bool - SCROLLING, ///< Property, name "scrolling", type bool - SCROLL_DOMAIN_SIZE, ///< Property, name "scroll-domain-size" type Vector2 - SCROLL_DOMAIN_SIZE_X, ///< Property, name "scroll-domain-size-x" type float - SCROLL_DOMAIN_SIZE_Y, ///< Property, name "scroll-domain-size-y" type float - SCROLL_DOMAIN_OFFSET, ///< Property, name "scroll-domain-offset" type Vector2 - SCROLL_POSITION_DELTA, ///< Property, name "scroll-position-delta" type Vector2 - START_PAGE_POSITION ///< Property, name "start-page-position" type Vector3 + // Event side properties + WRAP_ENABLED = PROPERTY_START_INDEX, ///< Property, name "wrapEnabled", @see SetWrapMode(), type bool, @SINCE_1_1.18 + PANNING_ENABLED, ///< Property, name "panningEnabled", @see SetScrollSensitive(), type bool, @SINCE_1_1.18 + AXIS_AUTO_LOCK_ENABLED, ///< Property, name "axisAutoLockEnabled", @see SetAxisAutoLock(), type bool, @SINCE_1_1.18 + WHEEL_SCROLL_DISTANCE_STEP, ///< Property, name "wheelScrollDistanceStep", @see SetWheelScrollDistanceStep(), type Vector2, @SINCE_1_1.18 + + SCROLL_POSITION = ANIMATABLE_PROPERTY_START_INDEX, ///< Property, name "scrollPosition", type Vector2 @SINCE_1_0.0 + SCROLL_PRE_POSITION, ///< Property, name "scrollPrePosition", type Vector2 @SINCE_1_0.0 + SCROLL_PRE_POSITION_X, ///< Property, name "scrollPrePositionX", type float @SINCE_1_0.0 + SCROLL_PRE_POSITION_Y, ///< Property, name "scrollPrePositionY", type float @SINCE_1_0.0 + SCROLL_PRE_POSITION_MAX, ///< Property, name "scrollPrePositionMax", type Vector2 @SINCE_1_0.0 + SCROLL_PRE_POSITION_MAX_X, ///< Property, name "scrollPrePositionMaxX", type float @SINCE_1_0.0 + SCROLL_PRE_POSITION_MAX_Y, ///< Property, name "scrollPrePositionMaxY", type float @SINCE_1_0.0 + OVERSHOOT_X, ///< Property, name "overshootX", type float @SINCE_1_0.0 + OVERSHOOT_Y, ///< Property, name "overshootY", type float @SINCE_1_0.0 + SCROLL_FINAL, ///< Property, name "scrollFinal", type Vector2 @SINCE_1_0.0 + SCROLL_FINAL_X, ///< Property, name "scrollFinalX", type float @SINCE_1_0.0 + SCROLL_FINAL_Y, ///< Property, name "scrollFinalY", type float @SINCE_1_0.0 + WRAP, ///< Property, name "wrap", type bool @SINCE_1_0.0 + PANNING, ///< Property, name "panning", type bool @SINCE_1_0.0 + SCROLLING, ///< Property, name "scrolling", type bool @SINCE_1_0.0 + SCROLL_DOMAIN_SIZE, ///< Property, name "scrollDomainSize", type Vector2 @SINCE_1_0.0 + SCROLL_DOMAIN_SIZE_X, ///< Property, name "scrollDomainSizeX", type float @SINCE_1_0.0 + SCROLL_DOMAIN_SIZE_Y, ///< Property, name "scrollDomainSizeY", type float @SINCE_1_0.0 + SCROLL_DOMAIN_OFFSET, ///< Property, name "scrollDomainOffset", type Vector2 @SINCE_1_0.0 + SCROLL_POSITION_DELTA, ///< Property, name "scrollPositionDelta", type Vector2 @SINCE_1_0.0 + START_PAGE_POSITION ///< Property, name "startPagePosition", type Vector3 @SINCE_1_0.0 }; }; // Typedefs - typedef Signal< void ( const SnapEvent& ) > SnapStartedSignalType; ///< SnapStarted signal type + typedef Signal< void ( const SnapEvent& ) > SnapStartedSignalType; ///< SnapStarted signal type @SINCE_1_0.0 public: /** * @brief Creates an empty ScrollView handle. + * @SINCE_1_0.0 */ ScrollView(); /** * @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[in] handle to copy from */ ScrollView( const ScrollView& handle ); @@ -502,7 +558,8 @@ public: /** * @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 The handle to copy from * @return A reference to this */ @@ -512,24 +569,27 @@ public: * @brief Destructor * * This is non-virtual since derived Handle types must not contain data or virtual methods. + * @SINCE_1_0.0 */ ~ScrollView(); /** * @brief Create an initialized ScrollView. * + * @SINCE_1_0.0 * @return A handle to a newly allocated Dali resource. */ static ScrollView New(); /** - * @brief Downcast an Object handle to ScrollView. + * @brief Downcast a handle to ScrollView handle. * * If handle points to a ScrollView 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 ScrollView or an uninitialized handle + * @return A handle to a ScrollView or an uninitialized handle */ static ScrollView DownCast( BaseHandle handle ); @@ -538,6 +598,7 @@ public: /** * @brief Get snap-animation's AlphaFunction. * + * @SINCE_1_0.0 * @return Current easing alpha function of the snap animation. */ AlphaFunction GetScrollSnapAlphaFunction() const; @@ -545,6 +606,7 @@ public: /** * @brief Set snap-animation's AlphaFunction. * + * @SINCE_1_0.0 * @param[in] alpha Easing alpha function of the snap animation. */ void SetScrollSnapAlphaFunction(AlphaFunction alpha); @@ -552,6 +614,7 @@ public: /** * @brief Get flick-animation's AlphaFunction. * + * @SINCE_1_0.0 * @return Current easing alpha function of the flick animation. */ AlphaFunction GetScrollFlickAlphaFunction() const; @@ -559,6 +622,7 @@ public: /** * @brief Set flick-animation's AlphaFunction. * + * @SINCE_1_0.0 * @param[in] alpha Easing alpha function of the flick animation. */ void SetScrollFlickAlphaFunction(AlphaFunction alpha); @@ -568,6 +632,7 @@ public: * * This animation occurs when the user drags, and releases. * + * @SINCE_1_0.0 * @return The time in seconds for the animation to take. */ float GetScrollSnapDuration() const; @@ -577,6 +642,7 @@ public: * * This animation occurs when the user drags, and releases. * + * @SINCE_1_0.0 * @param[in] time The time in seconds for the animation to take. */ void SetScrollSnapDuration(float time); @@ -586,6 +652,7 @@ public: * * This animation occurs when the user flicks scroll view. * + * @SINCE_1_0.0 * @return The time in seconds for the animation to take. */ float GetScrollFlickDuration() const; @@ -595,6 +662,7 @@ public: * * This animation occurs when the user flicks scroll view. * + * @SINCE_1_0.0 * @param[in] time The time in seconds for the animation to take. */ void SetScrollFlickDuration(float time); @@ -605,6 +673,7 @@ public: * Defines how scrolling horizontally is snapped, and * the boundary (domain) in which the ScrollView can pan. * + * @SINCE_1_0.0 * @param[in] ruler The ruler to be used for the X axis */ void SetRulerX(RulerPtr ruler); @@ -615,17 +684,19 @@ public: * Defines how scrolling vertically is snapped, and the boundary * (domain) in which the ScrollView can pan. * + * @SINCE_1_0.0 * @param[in] ruler The ruler to be used for the Y axis */ void SetRulerY(RulerPtr ruler); /** - * @brief Set Scroll's touch sensitivity. + * @brief Set scroll sensibility of pan gesture. * - * @note Unlike SetSensitive(), this determines whether this ScrollView + * @SINCE_1_0.0 + * @param[in] sensitive true to enable scroll, false to disable scrolling + * @note Unlike Actor::SetSensitive(), this determines whether this ScrollView * should react (e.g. pan), without disrupting the sensitivity of it's children. * - * @param[in] sensitive true to enable scroll, false to disable scrolling */ void SetScrollSensitive(bool sensitive); @@ -635,16 +706,18 @@ public: * The final overshoot value is within 0.0f to 1.0f, but the maximum * overshoot is in pixels (e.g. if you scroll 75 pixels beyond the * edge of a scrollable area and the maximum overshoot is 100 then - * the final overshoot value will be 0.75f) + * the final overshoot value will be 0.75f). * - * @param[in] overshootX the maximum number of horizontally scrolled pixels before overshoot X reaches 1.0f - * @param[in] overshootY the maximum number of vertically scrolled pixels before overshoot Y reaches 1.0f + * @SINCE_1_0.0 + * @param[in] overshootX The maximum number of horizontally scrolled pixels before overshoot X reaches 1.0f + * @param[in] overshootY The maximum number of vertically scrolled pixels before overshoot Y reaches 1.0f */ void SetMaxOvershoot(float overshootX, float overshootY); /** * @brief Set Snap Overshoot animation's AlphaFunction. * + * @SINCE_1_0.0 * @param[in] alpha Easing alpha function of the overshoot snap animation. */ void SetSnapOvershootAlphaFunction(AlphaFunction alpha); @@ -652,9 +725,10 @@ public: /** * @brief Set Snap Overshoot animation's Duration. * + * @SINCE_1_0.0 + * @param[in] duration The duration of the overshoot snap animation. * @note Set duration to 0 seconds, to disable Animation. * - * @param[in] duration The duration of the overshoot snap animation. */ void SetSnapOvershootDuration(float duration); @@ -665,6 +739,7 @@ public: * snap to the closest actor (The closest actor will appear in the center of * the ScrollView). * + * @SINCE_1_0.0 * @param[in] enable Enables (true), or disables (false) Actor AutoSnap */ void SetActorAutoSnap(bool enable); @@ -674,26 +749,29 @@ public: * * When enabled, the ScrollView contents are wrapped over the X/Y Domain. * + * @SINCE_1_0.0 + * @param[in] enable Enables (true), or disables (false) Wrap Mode. * @note You must apply a position constraint that causes Wrapping * to all children. * - * @param[in] enable Enables (true), or disables (false) Wrap Mode. */ void SetWrapMode(bool enable); /** - * @brief Gets the current distance needed to scroll for ScrollUpdatedSignal to be emitted + * @brief Gets the current distance needed to scroll for ScrollUpdatedSignal to be emitted. * + * @SINCE_1_0.0 * @return Current scroll update distance */ int GetScrollUpdateDistance() const; /** - * @brief Sets the distance needed to scroll for ScrollUpdatedSignal to be emitted + * @brief Sets the distance needed to scroll for ScrollUpdatedSignal to be emitted. * * The scroll update distance tells ScrollView how far to move before ScrollUpdatedSignal the informs application. - * Each time the ScrollView crosses this distance the signal will be emitted + * Each time the ScrollView crosses this distance the signal will be emitted. * + * @SINCE_1_0.0 * @param[in] distance The distance for ScrollView to move before emitting update signal */ void SetScrollUpdateDistance(int distance); @@ -701,6 +779,7 @@ public: /** * @brief Returns state of Axis Auto Lock mode. * + * @SINCE_1_0.0 * @return Whether Axis Auto Lock mode has been enabled or not. */ bool GetAxisAutoLock() const; @@ -712,6 +791,7 @@ public: * vertical, will be automatically restricted to horizontal only or vertical * only panning, until the pan gesture has completed. * + * @SINCE_1_0.0 * @param[in] enable Enables (true), or disables (false) AxisAutoLock mode. */ void SetAxisAutoLock(bool enable); @@ -720,6 +800,7 @@ public: * @brief Gets the gradient threshold at which a panning gesture * should be locked to the Horizontal or Vertical axis. * + * @SINCE_1_0.0 * @return The gradient, a value between 0.0 and 1.0f. */ float GetAxisAutoLockGradient() const; @@ -731,10 +812,11 @@ public: * By default this is 0.36 (0.36:1) which means angles less than 20 * degrees to an axis will lock to that axis. * - * @note: Specifying a value of 1.0 (the maximum value accepted) indicates that + * @SINCE_1_0.0 + * @param[in] gradient A value between 0.0 and 1.0 (auto-lock for all angles) + * @note Specifying a value of 1.0 (the maximum value accepted) indicates that * all panning gestures will auto-lock. Either to the horizontal or vertical axis. * - * @param[in] gradient A value between 0.0 and 1.0 (auto-lock for all angles) */ void SetAxisAutoLockGradient(float gradient); @@ -744,6 +826,7 @@ public: * * This is a value in stage-diagonals per second^2. * stage-diagonal = Length( stage.width, stage.height ) + * @SINCE_1_0.0 * @return Friction coefficient is returned. */ float GetFrictionCoefficient() const; @@ -758,6 +841,7 @@ public: * A stage 480x800 in size has a diagonal length of 933. * Friction coefficient of 1.0 means the swipe velocity will * reduce by 1.0 * 933 pixels/sec^2. + * @SINCE_1_0.0 * @param[in] friction Friction coefficient, must be greater than 0.0 (default = 1.0) */ void SetFrictionCoefficient(float friction); @@ -769,6 +853,7 @@ public: * This is a constant which multiplies the input touch * flick velocity to determine the actual velocity at * which to move the scrolling area. + * @SINCE_1_0.0 * @return The flick speed coefficient is returned. */ float GetFlickSpeedCoefficient() const; @@ -780,36 +865,41 @@ public: * This is a constant which multiplies the input touch * flick velocity to determine the actual velocity at * which to move the scrolling area. + * @SINCE_1_0.0 * @param[in] speed The flick speed coefficient (default = 1.0). */ void SetFlickSpeedCoefficient(float speed); /** - * @brief Returns the minimum pan distance required for a flick gesture in pixels + * @brief Returns the minimum pan distance required for a flick gesture in pixels. * + * @SINCE_1_0.0 * @return Minimum pan distance vector with separate x and y distance */ Vector2 GetMinimumDistanceForFlick() const; /** - * @brief Sets the minimum pan distance required for a flick in pixels + * @brief Sets the minimum pan distance required for a flick in pixels. * - * Takes a Vector2 containing separate x and y values. As long as the pan distance exceeds one of these axes a flick will be allowed + * Takes a Vector2 containing separate x and y values. As long as the pan distance exceeds one of these axes a flick will be allowed. * + * @SINCE_1_0.0 * @param[in] distance The minimum pan distance for a flick */ void SetMinimumDistanceForFlick( const Vector2& distance ); /** - * @brief Returns the minimum pan speed required for a flick gesture in pixels per second + * @brief Returns the minimum pan speed required for a flick gesture in pixels per second. * + * @SINCE_1_0.0 * @return Minimum pan speed */ float GetMinimumSpeedForFlick() const; /** - * @brief Sets the minimum pan speed required for a flick in pixels per second + * @brief Sets the minimum pan speed required for a flick in pixels per second. * + * @SINCE_1_0.0 * @param[in] speed The minimum pan speed for a flick */ void SetMinimumSpeedForFlick( float speed ); @@ -820,6 +910,7 @@ public: * * This is a value in stage-diagonals per second. * stage-diagonal = Length( stage.width, stage.height ) + * @SINCE_1_0.0 * @return Maximum flick speed is returned */ float GetMaxFlickSpeed() const; @@ -834,6 +925,7 @@ public: * A stage 480x800 in size has a diagonal length of 933. * Max Flick speed of 1.0 means the maximum velocity of * a swipe can be 1.0 * 933 pixels/sec. + * @SINCE_1_0.0 * @param[in] speed Maximum flick speed (default = 3.0) */ void SetMaxFlickSpeed(float speed); @@ -842,6 +934,7 @@ public: * @brief Gets the step of scroll distance in actor coordinates for * each wheel event received in free panning mode. * + * @SINCE_1_0.0 * @return The step of scroll distance(pixel) in X and Y axes. */ Vector2 GetWheelScrollDistanceStep() const; @@ -850,9 +943,10 @@ public: * @brief Sets the step of scroll distance in actor coordinates for * each wheel event received in free panning mode. * + * @SINCE_1_0.0 * @param[in] step The step of scroll distance(pixel) in X and Y axes. * - * @note: If snap points are defined in the rulers, it will always + * @note If snap points are defined in the rulers, it will always * scroll to the next snap point towards the scroll direction while * receiving the wheel events. * @@ -863,6 +957,7 @@ public: * @brief Retrieves current scroll position. * * @returns The current scroll position. + * @SINCE_1_0.0 */ Vector2 GetCurrentScrollPosition() const; @@ -872,7 +967,8 @@ public: * a grid fashion, increasing from left to right until the end of * the X-domain. * - * @note: Pages start from 0 as the first page, not 1. + * @SINCE_1_0.0 + * @note Pages start from 0 as the first page, not 1. * * @returns The Current page. */ @@ -885,9 +981,10 @@ public: * increasing Y scrolls contents up. * - If Rulers have been applied to the axes, then the contents will scroll until * reaching the domain boundary. + * @SINCE_1_0.0 + * @param[in] position The position to scroll to. * @note Contents will not snap to ruler snap points. * - * @param[in] position The position to scroll to. */ void ScrollTo(const Vector2& position); @@ -898,25 +995,27 @@ public: * increasing Y scrolls contents up. * - If Rulers have been applied to the axes, then the contents will scroll until * reaching the domain boundary. - * @note Contents will not snap to ruler snap points. - * + * @SINCE_1_0.0 * @param[in] position The position to scroll to. * @param[in] duration The duration of the animation in seconds + * @note Contents will not snap to ruler snap points. + * */ void ScrollTo(const Vector2& position, float duration); /** - * @brief Scrolls View to position specified (contents will scroll to this position) + * @brief Scrolls View to position specified (contents will scroll to this position). * * Position 0,0 is the origin. Increasing X scrolls contents left, while * increasing Y scrolls contents up. * - If Rulers have been applied to the axes, then the contents will scroll until * reaching the domain boundary. - * @note Contents will not snap to ruler snap points. - * + * @SINCE_1_0.0 * @param[in] position The position to scroll to. * @param[in] duration The duration of the animation in seconds * @param[in] alpha The alpha function to use + * @note Contents will not snap to ruler snap points. + * */ void ScrollTo(const Vector2& position, float duration, AlphaFunction alpha); @@ -927,36 +1026,38 @@ public: * increasing Y scrolls contents up. * - If Rulers have been applied to the axes, then the contents will scroll until * reaching the domain boundary. - * @note Contents will not snap to ruler snap points. - * Biasing parameters are provided such that in scenarios with 2 or 2x2 pages in - * wrap mode, the application developer can decide whether to scroll left or right - * to get to the target page - * + * @SINCE_1_0.0 * @param[in] position The position to scroll to. * @param[in] duration The duration of the animation in seconds * @param[in] horizontalBias Whether to bias scrolling to left or right. * @param[in] verticalBias Whether to bias scrolling to top or bottom. + * @note Contents will not snap to ruler snap points. + * Biasing parameters are provided such that in scenarios with 2 or 2x2 pages in + * wrap mode, the application developer can decide whether to scroll left or right + * to get to the target page. + * */ void ScrollTo(const Vector2& position, float duration, DirectionBias horizontalBias, DirectionBias verticalBias); /** - * @brief Scrolls View to position specified (contents will scroll to this position) + * @brief Scrolls View to position specified (contents will scroll to this position). * * Position 0,0 is the origin. Increasing X scrolls contents left, while * increasing Y scrolls contents up. * - If Rulers have been applied to the axes, then the contents will scroll until * reaching the domain boundary. - * @note Contents will not snap to ruler snap points. - * Biasing parameters are provided such that in scenarios with 2 or 2x2 pages in - * wrap mode, the application developer can decide whether to scroll left or right - * to get to the target page - * + * @SINCE_1_0.0 * @param[in] position The position to scroll to. * @param[in] duration The duration of the animation in seconds * @param[in] horizontalBias Whether to bias scrolling to left or right. * @param[in] verticalBias Whether to bias scrolling to top or bottom. * @param[in] alpha Alpha function to use + * @note Contents will not snap to ruler snap points. + * Biasing parameters are provided such that in scenarios with 2 or 2x2 pages in + * wrap mode, the application developer can decide whether to scroll left or right + * to get to the target page. + * */ void ScrollTo(const Vector2& position, float duration, AlphaFunction alpha, DirectionBias horizontalBias, DirectionBias verticalBias); @@ -965,11 +1066,12 @@ public: * @brief Scrolls View to page currently based on assumption that each page is * "(page) * ScrollViewSize.width, 0". * + * @SINCE_1_0.0 + * @param[in] page to scroll to * @note Should probably be upgraded so that page is an abstract class, that can be * a function of ScrollViewSize, ruler domain, ruler snap points etc. as pages may be * orchestrated in a 2D grid fashion, or variable width. * - * @param[in] page to scroll to */ void ScrollTo(unsigned int page); @@ -977,12 +1079,13 @@ public: * @brief Scrolls View to page currently based on assumption that each page is * "(page) * ScrollViewSize.width, 0". * + * @SINCE_1_0.0 + * @param[in] page to scroll to + * @param[in] duration The duration of the animation in seconds * @note Should probably be upgraded so that page is an abstract class, that can be * a function of ScrollViewSize, ruler domain, ruler snap points etc. as pages may be * orchestrated in a 2D grid fashion, or variable width. * - * @param[in] page to scroll to - * @param[in] duration The duration of the animation in seconds */ void ScrollTo(unsigned int page, float duration); @@ -990,6 +1093,10 @@ public: * @brief Scrolls View to page currently based on assumption that each page is * "(page) * ScrollViewSize.width, 0". * + * @SINCE_1_0.0 + * @param[in] page to scroll to + * @param[in] duration The duration of the animation in seconds + * @param[in] bias Whether to bias scrolling to left or right. * @note Should probably be upgraded so that page is an abstract class, that can be * a function of ScrollViewSize, ruler domain, ruler snap points etc. as pages may be * orchestrated in a 2D grid fashion, or variable width. @@ -997,28 +1104,27 @@ public: * the application developer can decide whether to scroll left or right to get to * the target page. * - * @param[in] page to scroll to - * @param[in] duration The duration of the animation in seconds - * @param[in] bias Whether to bias scrolling to left or right. */ void ScrollTo(unsigned int page, float duration, DirectionBias bias); /** * @brief Scrolls View such that actor appears in the center of the ScrollView. * + * @SINCE_1_0.0 + * @param[in] actor The actor to center in on (via Scrolling). * @note Actor must be a direct child of ScrollView, otherwise will * cause an assertion failure. - * @param[in] actor The actor to center in on (via Scrolling). */ void ScrollTo(Actor& actor); /** * @brief Scrolls View such that actor appears in the center of the ScrollView. * - * @note Actor must be a direct child of ScrollView, otherwise will - * cause an assertion failure. + * @SINCE_1_0.0 * @param[in] actor The actor to center in on (via Scrolling). * @param[in] duration The duration of the animation in seconds + * @note Actor must be a direct child of ScrollView, otherwise will + * cause an assertion failure. */ void ScrollTo(Actor& actor, float duration); @@ -1027,6 +1133,7 @@ public: * * If already at snap points, then will return false, and not scroll. * + * @SINCE_1_0.0 * @return True if Snapping necessary. */ bool ScrollToSnapPoint(); @@ -1034,15 +1141,17 @@ public: /** * @brief Applies a constraint that will affect the children of ScrollView. * - * @note this affects all existing and future Actors that are added to scrollview. + * @SINCE_1_0.0 * @param[in] constraint The constraint to apply + * @note This affects all existing and future Actors that are added to scrollview. */ void ApplyConstraintToChildren(Constraint constraint); /** * @brief Removes all constraints that will affect the children of ScrollView. * - * @note this removes all constraints from actors that have been added + * @SINCE_1_0.0 + * @note This removes all constraints from actors that have been added * to scrollview. */ void RemoveConstraintsFromChildren(); @@ -1050,6 +1159,7 @@ public: /** * @brief Apply Effect to ScrollView. * + * @SINCE_1_0.0 * @param[in] effect The effect to apply to scroll view */ void ApplyEffect(ScrollViewEffect effect); @@ -1057,12 +1167,14 @@ public: /** * @brief Remove Effect from ScrollView. * + * @SINCE_1_0.0 * @param[in] effect The effect to remove. */ void RemoveEffect(ScrollViewEffect effect); /** * @brief Remove All Effects from ScrollView. + * @SINCE_1_0.0 */ void RemoveAllEffects(); @@ -1072,6 +1184,7 @@ public: * Once an actor is bound to a ScrollView, it will be subject to * that ScrollView's properties. * + * @SINCE_1_0.0 * @param[in] child The actor to add to this ScrollView. */ void BindActor(Actor child); @@ -1080,15 +1193,17 @@ public: * @brief Unbind Actor from this ScrollView. * * Once Unbound, this ScrollView will not affect the actor. - * @note this does not remove the child from the ScrollView container - * + * @SINCE_1_0.0 * @param[in] child The actor to be unbound. + * @note This does not remove the child from the ScrollView container + * */ void UnbindActor(Actor child); /** * @brief Allows the user to constrain the scroll view in a particular direction. * + * @SINCE_1_0.0 * @param[in] direction The axis to constrain the scroll-view to. * Usually set to PanGestureDetector::DIRECTION_VERTICAL or PanGestureDetector::DIRECTION_HORIZONTAL (but can be any other angle if desired). * @param[in] threshold The threshold to apply around the axis. @@ -1099,6 +1214,7 @@ public: /** * @brief Remove a direction constraint from the scroll view. * + * @SINCE_1_0.0 * @param[in] direction The axis to stop constraining to. * Usually will be PanGestureDetector::DIRECTION_VERTICAL or PanGestureDetector::DIRECTION_HORIZONTAL (but can be any other angle if desired). */ @@ -1108,22 +1224,25 @@ public: // Signals /** * @brief Signal emitted when the ScrollView has started to snap or flick (it tells the target - * position, scale, rotation for the snap or flick) + * position, scale, rotation for the snap or flick). * * A callback of the following type may be connected: * @code * void YourCallbackName(const SnapEvent& event); * @endcode - * @pre The Object has been initialized. + * @SINCE_1_0.0 * @return The signal to connect to. + * @pre The Object has been initialized. */ SnapStartedSignalType& SnapStartedSignal(); 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. */ DALI_INTERNAL ScrollView(Internal::ScrollView& implementation); @@ -1131,11 +1250,16 @@ 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. */ explicit DALI_INTERNAL ScrollView( Dali::Internal::CustomActor* internal ); + /// @endcond }; +/** + * @} + */ } // namespace Toolkit } // namespace Dali