dali-toolkit property type comment to represent type instead of property enum

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

diff --git a/dali-toolkit/public-api/controls/scrollable/scrollable.h b/dali-toolkit/public-api/controls/scrollable/scrollable.h
index 0e34526..0b315f3 100644 (file)
--- a/dali-toolkit/public-api/controls/scrollable/scrollable.h
+++ b/dali-toolkit/public-api/controls/scrollable/scrollable.h
@@ -33,35 +33,6 @@ class Scrollable;
 }
 
 /**
- * @brief How axes/rotation or scale are clamped
- */
-enum ClampState
-{
-  NotClamped,   ///< The quantity isn't clamped
-  ClampedToMin, ///< The quantity is clamped to the min value
-  ClampedToMax  ///< The quantity is clamped to the max value
-};
-
-/**
- * @brief A 2 dimensional clamp
- */
-struct ClampState2
-{
-  ClampState x; ///< The clamp state of the x axis
-  ClampState y; ///< The clamp state of the y axis
-};
-
-/**
- * @brief A 3 dimensional clamp
- */
-struct ClampState3
-{
-  ClampState x; ///< The clamp state of the x axis
-  ClampState y; ///< The clamp state of the y axis
-  ClampState z; ///< The clamp state of the z axis
-};
-
-/**
  * @brief Base class for derived Scrollables that contains actors that can be scrolled manually
  * (via touch) or automatically.
  *
@@ -73,23 +44,12 @@ struct ClampState3
  * | scroll-started    | @ref ScrollStartedSignal()   |
  * | scroll-completed  | @ref ScrollUpdatedSignal()   |
  * | scroll-updated    | @ref ScrollCompletedSignal() |
- * | scroll-clamped    | @ref ScrollClampedSignal()   |
  */
 class DALI_IMPORT_API Scrollable : public Control
 {
 public:
 
   /**
-   * @brief Clamp signal event's data
-   */
-  struct ClampEvent
-  {
-    ClampState3 scale;       ///< Clamp information for scale axes
-    ClampState3 position;    ///< Clamp information for position axes
-    ClampState rotation;     ///< Clamp information for rotation
-  };
-
-  /**
    * @brief Scroll component types
    */
   enum ScrollComponentType
@@ -101,23 +61,37 @@ public:
 
   // Custom properties
 
-  static const std::string SCROLL_RELATIVE_POSITION_PROPERTY_NAME;      ///< Property, name "scroll-relative-position", type VECTOR3
-  static const std::string SCROLL_POSITION_MIN_PROPERTY_NAME;           ///< Property, name "scroll-position-min",      type VECTOR3
-  static const std::string SCROLL_POSITION_MAX_PROPERTY_NAME;           ///< Property, name "scroll-position-max",      type VECTOR3
-  static const std::string SCROLL_DIRECTION_PROPERTY_NAME;              ///< Property, name "scroll-direction",         type VECTOR2
+  static const std::string SCROLL_RELATIVE_POSITION_PROPERTY_NAME;      ///< Property, name "scroll-relative-position", type Vector3
+  static const std::string SCROLL_POSITION_MIN_PROPERTY_NAME;           ///< Property, name "scroll-position-min",      type Vector3
+  static const std::string SCROLL_POSITION_MAX_PROPERTY_NAME;           ///< Property, name "scroll-position-max",      type Vector3
+  static const std::string SCROLL_DIRECTION_PROPERTY_NAME;              ///< Property, name "scroll-direction",         type Vector2
+
+  /**
+   * @brief The start and end property ranges for this control.
+   */
+  enum PropertyRange
+  {
+    PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1,
+    PROPERTY_END_INDEX =   PROPERTY_START_INDEX + 1000              ///< Reserve property indices
+  };
 
-  /// @name Properties
-  /** @{ */
-  static const Property::Index PROPERTY_OVERSHOOT_EFFECT_COLOR;         ///< Property, name "overshoot-effect-color",  @see SetOvershootEffectColor(),  type VECTOR4
-  static const Property::Index PROPERTY_OVERSHOOT_ANIMATION_SPEED;      ///< Property, name "overshoot-animation-speed",  @see SetOvershootAnimationSpeed(),  type FLOAT
-  /** @} */
+  /**
+   * @brief An enumeration of properties belonging to the Scrollable class.
+   */
+  struct Property
+  {
+    enum
+    {
+      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
+    };
+  };
 
 public:
 
   typedef Signal< void ( const Vector3& ) > ScrollStartedSignalType;   ///< ScrollStarted signal type
   typedef Signal< void ( const Vector3& ) > ScrollCompletedSignalType; ///< ScrollCompleted signal type
   typedef Signal< void ( const Vector3& ) > ScrollUpdatedSignalType;   ///< Scroll updated signal type
-  typedef Signal< void ( const ClampEvent& ) > ScrollClampedSignalType; ///< Scroll clamped signal type
 
   /**
    * @brief Signal emitted when the Scrollable has moved (whether by touch or animation).
@@ -134,14 +108,6 @@ public:
    */
   ScrollCompletedSignalType& ScrollCompletedSignal();
 
-  /**
-   * @brief Signal emitted when the Scrollable is pushing against a domain boundary
-   * (in either position, scale, or rotation).
-   *
-   * @return The signal to connect to
-   */
-  ScrollClampedSignalType& ScrollClampedSignal();
-
 public:
 
   /**