X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=capi%2Fdali-toolkit%2Fpublic-api%2Fcontrols%2Fscrollable%2Fscroll-view%2Fscroll-view.h;h=3d4027c991ed8a18c9f71ece29072776fe487f25;hb=998d982768c7f211d948cfd7921ec27ff739ce49;hp=963955c0325d6339a8d51935fd6bc0ac9bef12d1;hpb=63106d0a9407c87ff624f4b93e2627a0c7cc1e2a;p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git diff --git a/capi/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view.h b/capi/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view.h index 963955c..3d4027c 100644 --- a/capi/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view.h +++ b/capi/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view.h @@ -137,11 +137,6 @@ public: Ruler(); /** - * @brief Destructor - A reference counted object may only be deleted by calling Unreference(). - */ - virtual ~Ruler(); - - /** * @brief Snaps (x) in accordance to the ruler settings. * * @param[in] x The input value on the ruler to be snapped. @@ -296,6 +291,13 @@ public: protected: + /** + * @brief Destructor - A reference counted object may only be deleted by calling Unreference(). + */ + virtual ~Ruler(); + +protected: + RulerType mType; ///< Type of Ruler (Fixed or Free). bool mEnabled; ///< If the ruler is enabled. RulerDomain mDomain; ///< The domain of the ruler. @@ -405,8 +407,6 @@ public: static const std::string SCROLL_OVERSHOOT_X_PROPERTY_NAME; ///< Property, name "scroll-overshoot-x", type float static const std::string SCROLL_OVERSHOOT_Y_PROPERTY_NAME; ///< Property, name "scroll-overshoot-y", type float static const std::string SCROLL_FINAL_PROPERTY_NAME; ///< Property, name "scroll-final", type VECTOR3 - static const std::string SCROLL_X_PROPERTY_NAME; ///< Property, name "scroll-x", type FLOAT - static const std::string SCROLL_Y_PROPERTY_NAME; ///< Property, name "scroll-y", type FLOAT static const std::string SCROLL_SCALE_PROPERTY_NAME; ///< Property, name "scroll-scale", type VECTOR3 static const std::string SCROLL_WRAP_PROPERTY_NAME; ///< Property, name "scroll-wrap", type BOOLEAN static const std::string SCROLL_PANNING_PROPERTY_NAME; ///< Property, name "scroll-panning", type BOOLEAN @@ -451,8 +451,6 @@ public: { SnapType type; ///< Current snap commencing Vector3 position; ///< Target snap position - Vector3 scale; ///< Target snap scale - float rotation; ///< Target snap rotation float duration; ///< Duration of snap animation. }; @@ -490,11 +488,11 @@ public: ScrollView& operator=( const ScrollView& handle ); /** - * @brief Virtual destructor. + * @brief Destructor * - * Dali::Object derived classes typically do not contain member data. + * This is non-virtual since derived Handle types must not contain data or virtual methods. */ - virtual ~ScrollView(); + ~ScrollView(); /** * @brief Create an initialized ScrollView. @@ -607,6 +605,8 @@ public: * (domain) to which scaling can be performed e.g. 10% to 200% * * @param[in] ruler The ruler to be used for the Scale-X axis + * + * @deprecated Scaling not supported */ void SetRulerScaleX(RulerPtr ruler); @@ -617,6 +617,8 @@ public: * (domain) to which scaling can be performed e.g. 10% to 200% * * @param[in] ruler The ruler to be used for the Scale-Y axis + * + * @deprecated Scaling not supported */ void SetRulerScaleY(RulerPtr ruler); @@ -701,6 +703,7 @@ public: void SetWrapMode(bool enable); /** + * @deprecated * @brief Gets the current refresh interval in milliseconds. * * @return Current refresh interval in milliseconds @@ -708,6 +711,7 @@ public: int GetRefreshInterval() const; /** + * @deprecated * @brief Sets the refresh interval in milliseconds. * * The refresh interval is a notification signal @@ -721,6 +725,23 @@ public: void SetRefreshInterval(int milliseconds); /** + * @brief Gets the current distance needed to scroll for ScrollUpdatedSignal to be emitted + * + * @return Current scroll update distance + */ + int GetScrollUpdateDistance() const; + + /** + * @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 + * + * @param[in] distance The distance for ScrollView to move before emitting update signal + */ + void SetScrollUpdateDistance(int distance); + + /** * @brief Returns state of Axis Auto Lock mode. * * @return Whether Axis Auto Lock mode has been enabled or not. @@ -807,6 +828,36 @@ public: void SetFlickSpeedCoefficient(float speed); /** + * @brief Returns the minimum pan distance required for a flick gesture in pixels + * + * @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 + * + * 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 + * + * @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 + * + * @return Minimum pan speed + */ + float GetMinimumSpeedForFlick() const; + + /** + * @brief Sets the minimum pan speed required for a flick in pixels per second + * + * @param[in] speed The minimum pan speed for a flick + */ + void SetMinimumSpeedForFlick( float speed ); + + /** * @brief Gets the maximum flick speed setting for ScrollView when * flicking in free panning mode. * @@ -870,6 +921,8 @@ public: * @brief Retrieves current scroll scale. * * @returns The current scroll scale. + * + * @deprecated Scaling not supported */ Vector3 GetCurrentScrollScale() const; @@ -891,16 +944,20 @@ public: * @param[in] position The position to transform to. * @param[in] scale The scale to transform to. * @param[in] rotation The rotation to transform to. + * + * @deprecated Scaling or rotation not supported, use ScrollTo(const Vector3&) */ void TransformTo(const Vector3& position, const Vector3& scale, float rotation); /** - * @brief Transforms View to position, scale and rotation specified. + * @brief Transforms View to position, scale and rotation specified in the duration specified. * * @param[in] position The position to transform to. * @param[in] scale The scale to transform to. * @param[in] rotation The rotation to transform to. * @param[in] duration The duration for this animation in seconds. + * + * @deprecated Scaling or rotation not supported, use ScrollTo(const Vector3&, float) */ void TransformTo(const Vector3& position, const Vector3& scale, float rotation, float duration); @@ -1025,6 +1082,8 @@ public: * @brief Scales View to (scale). * * @param[in] scale The scale factor the animate to. + * + * @deprecated Scaling not supported */ void ScaleTo(const Vector3& scale); @@ -1033,6 +1092,8 @@ public: * * @param[in] scale The scale factor the animate to. * @param[in] duration The duration of the animation in seconds. + * + * @deprecated Scaling not supported */ void ScaleTo(const Vector3& scale, float duration);