Added new properties to make ScrollView more scriptable

[platform/core/uifw/dali-toolkit.git] / dali-toolkit / public-api / controls / scrollable / scroll-view / scroll-view.h

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..0e656d4 100644 (file)
--- 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,6 +34,10 @@ namespace Internal DALI_INTERNAL
 {
 class ScrollView;
 }
+/**
+ * @addtogroup dali_toolkit_controls_scroll_view
+ * @{
+ */
 
 /**
  * @brief How axes/rotation or scale are clamped
@@ -444,6 +448,9 @@ public:
    */
   enum PropertyRange
   {
+    PROPERTY_START_INDEX = Toolkit::Scrollable::PROPERTY_END_INDEX + 1,                        ///< @since DALi 1.1.18
+    PROPERTY_END_INDEX =   PROPERTY_START_INDEX + 1000,                                        ///< Reserve property indices, @since DALi 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
   };
@@ -455,27 +462,33 @@ public:
   {
     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
+      // Event side properties
+      WRAP_ENABLED = PROPERTY_START_INDEX,               ///< Property, name "wrapEnabled",              @see SetWrapMode(),                 type bool,     @since DALi 1.1.18
+      PANNING_ENABLED,                                   ///< Property, name "panningEnabled",           @see SetScrollSensitive(),          type bool,     @since DALi 1.1.18
+      AXIS_AUTO_LOCK_ENABLED,                            ///< Property, name "axisAutoLockEnabled",      @see SetAxisAutoLock(),             type bool,     @since DALi 1.1.18
+      WHEEL_SCROLL_DISTANCE_STEP,                        ///< Property, name "wheelScrollDistanceStep",  @see SetWheelScrollDistanceStep(),  type Vector2,  @since DALi 1.1.18
+
+      SCROLL_POSITION = ANIMATABLE_PROPERTY_START_INDEX, ///< Property, name "scrollPosition",            type Vector2
+      SCROLL_PRE_POSITION,                               ///< Property, name "scrollPrePosition",         type Vector2
+      SCROLL_PRE_POSITION_X,                             ///< Property, name "scrollPrePositionX",        type float
+      SCROLL_PRE_POSITION_Y,                             ///< Property, name "scrollPrePositionY",        type float
+      SCROLL_PRE_POSITION_MAX,                           ///< Property, name "scrollPrePositionMax",      type Vector2
+      SCROLL_PRE_POSITION_MAX_X,                         ///< Property, name "scrollPrePositionMaxX",     type float
+      SCROLL_PRE_POSITION_MAX_Y,                         ///< Property, name "scrollPrePositionMaxY",     type float
+      OVERSHOOT_X,                                       ///< Property, name "overshootX",                type float
+      OVERSHOOT_Y,                                       ///< Property, name "overshootY",                type float
+      SCROLL_FINAL,                                      ///< Property, name "scrollFinal",               type Vector2
+      SCROLL_FINAL_X,                                    ///< Property, name "scrollFinalX",              type float
+      SCROLL_FINAL_Y,                                    ///< Property, name "scrollFinalY",              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
+      SCROLL_DOMAIN_SIZE,                                ///< Property, name "scrollDomainSize",          type Vector2
+      SCROLL_DOMAIN_SIZE_X,                              ///< Property, name "scrollDomainSizeX",         type float
+      SCROLL_DOMAIN_SIZE_Y,                              ///< Property, name "scrollDomainSizeY",         type float
+      SCROLL_DOMAIN_OFFSET,                              ///< Property, name "scrollDomainOffset",        type Vector2
+      SCROLL_POSITION_DELTA,                             ///< Property, name "scrollPositionDelta",       type Vector2
+      START_PAGE_POSITION                                ///< Property, name "startPagePosition",         type Vector3
     };
   };
 
@@ -1136,6 +1149,9 @@ public: // Not intended for application developers
   explicit DALI_INTERNAL ScrollView( Dali::Internal::CustomActor* internal );
 };
 
+/**
+ * @}
+ */
 } // namespace Toolkit
 
 } // namespace Dali