Changed all property & signal names to lowerCamelCase

[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 eebf4da..9a66cfc 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
@@ -455,27 +459,27 @@ 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
+      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
     };
   };
 
@@ -840,24 +844,24 @@ public:
 
   /**
    * @brief Gets the step of scroll distance in actor coordinates for
-   * each mouse wheel event received in free panning mode.
+   * each wheel event received in free panning mode.
    *
    * @return The step of scroll distance(pixel) in X and Y axes.
    */
-  Vector2 GetMouseWheelScrollDistanceStep() const;
+  Vector2 GetWheelScrollDistanceStep() const;
 
   /**
    * @brief Sets the step of scroll distance in actor coordinates for
-   * each mouse wheel event received in free panning mode.
+   * each wheel event received in free panning mode.
    *
    * @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
    * scroll to the next snap point towards the scroll direction while
-   * receiving the mouse wheel events.
+   * receiving the wheel events.
    *
    */
-  void SetMouseWheelScrollDistanceStep(Vector2 step);
+  void SetWheelScrollDistanceStep(Vector2 step);
 
   /**
    * @brief Retrieves current scroll position.
@@ -867,14 +871,6 @@ public:
   Vector2 GetCurrentScrollPosition() const;
 
   /**
-   * @brief Sets the current scroll position, overriding current scroll animations. If panning is currently taking place
-   *        SetScrollPosition will have no effect. Try to ensure panning has stopped before calling this function.
-   *
-   * @param[in] position The new scroll position to set.
-   */
-  void SetScrollPosition(const Vector2& position);
-
-  /**
    * @brief Retrieves current scroll page based on ScrollView
    * dimensions being the size of one page, and all pages laid out in
    * a grid fashion, increasing from left to right until the end of
@@ -1144,6 +1140,9 @@ public: // Not intended for application developers
   explicit DALI_INTERNAL ScrollView( Dali::Internal::CustomActor* internal );
 };
 
+/**
+ * @}
+ */
 } // namespace Toolkit
 
 } // namespace Dali