X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali-toolkit%2Fpublic-api%2Fcontrols%2Fscrollable%2Fscrollable.h;h=c14f203534d82dcc9b6ddeea8e1db83f4611650f;hb=d43575da616e1370372b1331f47dce36dc4ac145;hp=b2622126f31421d56a258ce987bb474c792c0755;hpb=df89f9f230cadaac7be4007d1b1a7cf7dc893011;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 b262212..c14f203 100644 --- a/dali-toolkit/public-api/controls/scrollable/scrollable.h +++ b/dali-toolkit/public-api/controls/scrollable/scrollable.h @@ -31,6 +31,10 @@ namespace Internal DALI_INTERNAL { class Scrollable; } +/** + * @addtogroup dali_toolkit_controls_scrollable + * @{ + */ /** * @brief Base class for derived Scrollables that contains actors that can be scrolled manually @@ -39,11 +43,11 @@ 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 ScrollUpdatedSignal() | + * | scrollUpdated | @ref ScrollCompletedSignal() | */ class DALI_IMPORT_API Scrollable : public Control { @@ -69,19 +73,20 @@ public: 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 + OVERSHOOT_ANIMATION_SPEED, ///< Property, name "overshootAnimationSpeed", @see SetOvershootAnimationSpeed(), type float + OVERSHOOT_ENABLED, ///< Property, name "overshootEnabled", @see SetOvershootEnabled(), type bool, @since DALi 1.1.18 // 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 + SCROLL_POSITION_MIN, ///< Property, name "scrollPositionMin", type Vector2 + SCROLL_POSITION_MIN_X, ///< Property, name "scrollPositionMinX", type float + SCROLL_POSITION_MIN_Y, ///< Property, name "scrollPositionMinY", type float + SCROLL_POSITION_MAX, ///< Property, name "scrollPositionMax", type Vector2 + SCROLL_POSITION_MAX_X, ///< Property, name "scrollPositionMaxX", type float + SCROLL_POSITION_MAX_Y, ///< Property, name "scrollPositionMaxY", type float + CAN_SCROLL_VERTICAL, ///< Property, name "canScrollVertical", type bool + CAN_SCROLL_HORIZONTAL ///< Property, name "canScrollHorizontal", type bool }; }; @@ -229,6 +234,9 @@ public: // Not intended for application developers explicit DALI_INTERNAL Scrollable( Dali::Internal::CustomActor* internal ); }; +/** + * @} + */ } // namespace Toolkit } // namespace Dali