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%2Fscrollable.h;h=df051bdca19a336ebc9ae589d61a7096ab4e46f0;hp=d43a29a7b0ecc465f9b2c8b48b60c91365484208;hb=675f5551ef3c7ca20ec45c36b865a5092883af43;hpb=bfba32ee6a85f1ca0feefe8778dd406afedaeac8 diff --git a/dali-toolkit/public-api/controls/scrollable/scrollable.h b/dali-toolkit/public-api/controls/scrollable/scrollable.h index d43a29a..df051bd 100644 --- a/dali-toolkit/public-api/controls/scrollable/scrollable.h +++ b/dali-toolkit/public-api/controls/scrollable/scrollable.h @@ -32,7 +32,7 @@ namespace Internal DALI_INTERNAL class Scrollable; } /** - * @addtogroup dali-toolkit-controls-scrollable + * @addtogroup dali_toolkit_controls_scrollable * @{ */ @@ -43,11 +43,12 @@ class Scrollable; * Scrollables such as ScrollView and ItemView can be derived from this class. * * Signals - * | %Signal Name | Method | - * |-------------------|------------------------------| - * | scroll-started | @ref ScrollStartedSignal() | - * | scroll-completed | @ref ScrollUpdatedSignal() | - * | scroll-updated | @ref ScrollCompletedSignal() | + * | %Signal Name | Method | + * |------------------|------------------------------| + * | scrollStarted | @ref ScrollStartedSignal() | + * | scrollCompleted | @ref ScrollCompletedSignal() | + * | scrollUpdated | @ref ScrollUpdatedSignal() | + * @SINCE_1_0.0 */ class DALI_IMPORT_API Scrollable : public Control { @@ -55,58 +56,69 @@ public: /** * @brief The start and end property ranges for this control. + * @SINCE_1_0.0 */ enum PropertyRange { - PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1, - PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000, ///< Reserve property indices + 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 ANIMATABLE_PROPERTY_START_INDEX = ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX, - ANIMATABLE_PROPERTY_END_INDEX = ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX + 1000 ///< Reserve animatable property indices + 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. + * @SINCE_1_0.0 */ struct Property { + /** + * @brief An enumeration of properties belonging to the Scrollable class. + * @SINCE_1_0.0 + */ enum { // Event side properties - OVERSHOOT_EFFECT_COLOR = PROPERTY_START_INDEX, ///< Property, name "overshoot-effect-color", @see SetOvershootEffectColor(), type Vector4 - OVERSHOOT_ANIMATION_SPEED, ///< Property, name "overshoot-animation-speed", @see SetOvershootAnimationSpeed(), type float + 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 "scroll-relative-position", type Vector2 - SCROLL_POSITION_MIN, ///< Property, name "scroll-position-min", type Vector2 - SCROLL_POSITION_MIN_X, ///< Property, name "scroll-position-min-x", type float - SCROLL_POSITION_MIN_Y, ///< Property, name "scroll-position-min-y", type float - SCROLL_POSITION_MAX, ///< Property, name "scroll-position-max", type Vector2 - SCROLL_POSITION_MAX_X, ///< Property, name "scroll-position-max-x", type float - SCROLL_POSITION_MAX_Y, ///< Property, name "scroll-position-max-y", type float - CAN_SCROLL_VERTICAL, ///< Property, name "can-scroll-vertical", type bool - CAN_SCROLL_HORIZONTAL ///< Property, name "can-scroll-horizontal", type bool + SCROLL_RELATIVE_POSITION = ANIMATABLE_PROPERTY_START_INDEX, ///< Property, name "scrollRelativePosition", type Vector2 @SINCE_1_0.0 + SCROLL_POSITION_MIN, ///< Property, name "scrollPositionMin", type Vector2 @SINCE_1_0.0 + SCROLL_POSITION_MIN_X, ///< Property, name "scrollPositionMinX", type float @SINCE_1_0.0 + SCROLL_POSITION_MIN_Y, ///< Property, name "scrollPositionMinY", type float @SINCE_1_0.0 + SCROLL_POSITION_MAX, ///< Property, name "scrollPositionMax", type Vector2 @SINCE_1_0.0 + SCROLL_POSITION_MAX_X, ///< Property, name "scrollPositionMaxX", type float @SINCE_1_0.0 + SCROLL_POSITION_MAX_Y, ///< Property, name "scrollPositionMaxY", type float @SINCE_1_0.0 + CAN_SCROLL_VERTICAL, ///< Property, name "canScrollVertical", type bool @SINCE_1_0.0 + CAN_SCROLL_HORIZONTAL ///< Property, name "canScrollHorizontal", type bool @SINCE_1_0.0 }; }; // Typedefs - typedef Signal< void ( const Vector2& ) > ScrollStartedSignalType; ///< ScrollStarted signal type - typedef Signal< void ( const Vector2& ) > ScrollCompletedSignalType; ///< ScrollCompleted signal type - typedef Signal< void ( const Vector2& ) > ScrollUpdatedSignalType; ///< Scroll updated signal type + 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 public: /** * @brief Creates an uninitialized Scrollable handle. + * @SINCE_1_0.0 */ Scrollable(); /** * @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 ); @@ -114,7 +126,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 to copy from * @return A reference to this */ @@ -124,56 +137,65 @@ public: * @brief Destructor * * This is non-virtual since derived Handle types must not contain data or virtual methods. + * @SINCE_1_0.0 */ ~Scrollable(); /** - * @brief Downcast an Object handle to Scrollable. + * @brief Downcast a handle to Scrollable handle. * * 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 ); /** * @brief Checks if scroll overshoot has been enabled or not. * - * @return Whether the scroll obvershoot is enabled + * @SINCE_1_0.0 + * @return Whether the scroll overshoot is enabled */ bool IsOvershootEnabled() const; /** * @brief Sets whether to enables or disable scroll overshoot. * - * @param[in] enable Whether to enable the scroll obvershoot or not + * @SINCE_1_0.0 + * @param[in] enable Whether to enable the scroll overshoot or not */ void SetOvershootEnabled(bool enable); /** * @brief Set the color of the overshoot effect. * + * @SINCE_1_0.0 * @param[in] color The color of the overshoot effect. */ void SetOvershootEffectColor( const Vector4& color ); /** * @brief Get the color of the overshoot effect. + * @SINCE_1_0.0 * @return The color of the overshoot effect. */ Vector4 GetOvershootEffectColor() const; /** * @brief Set 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. */ void SetOvershootAnimationSpeed( float pixelsPerSecond ); /** * @brief Get the speed of overshoot animation in pixels per second. + * @SINCE_1_0.0 * @return The speed of the overshoot animation. */ float GetOvershootAnimationSpeed() const; @@ -187,8 +209,9 @@ public: // Signals * @code * void YourCallbackName(const Vector2& currentScrollPosition); * @endcode - * @pre The Object has been initialized. + * @SINCE_1_0.0 * @return The signal to connect to. + * @pre The Object has been initialized. */ ScrollStartedSignalType& ScrollStartedSignal(); @@ -199,8 +222,9 @@ public: // Signals * @code * void YourCallbackName(const Vector2& currentScrollPosition); * @endcode - * @pre The Object has been initialized. + * @SINCE_1_0.0 * @return The signal to connect to. + * @pre The Object has been initialized. */ ScrollUpdatedSignalType& ScrollUpdatedSignal(); @@ -211,16 +235,19 @@ public: // Signals * @code * void YourCallbackName(const Vector2& currentScrollPosition); * @endcode - * @pre The Object has been initialized. + * @SINCE_1_0.0 * @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. */ DALI_INTERNAL Scrollable(Internal::Scrollable& implementation); @@ -228,9 +255,11 @@ 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 Scrollable( Dali::Internal::CustomActor* internal ); + /// @endcond }; /**