Support stop mode(FINISH_LOOP, IMMEDIATE) of auto scroll
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / devel-api / controls / text-controls / text-label-devel.h
index 0d0ca82..40c6c70 100644 (file)
@@ -70,9 +70,37 @@ namespace Property
        * @details name "ellipsis", type bool
        */
       ELLIPSIS = OUTLINE + 2,
+
+      /**
+       * @brief delay starting time of auto scrolling and further loops
+       * @details name "autoScrollLoopDelay", type float.
+       */
+      AUTO_SCROLL_LOOP_DELAY = OUTLINE + 3,
+
+      /**
+       * @brief Auto scrolling stop behaviour.
+       * @details name "autoScrollStopMode", type [Type](@ref Dali::Toolkit::DevelTextLabel::AutoScrollStopMode::Type) (Property::INTEGER) or Property::STRING.
+       *          values FINISH_LOOP, IMMEDIATE, defualt FINISH_LOOP
+       */
+      AUTO_SCROLL_STOP_MODE = OUTLINE + 4,
   };
 } // namespace Property
 
+/**
+* @brief The type for TextLabel::Property::AUTO_SCROLL_STOP_MODE
+*/
+namespace AutoScrollStopMode
+{
+/**
+* @ref Dali::Toolkit::DevelTextLabel::AutoScrollStopMode
+*/
+enum Type
+{
+  FINISH_LOOP = 0,  ///< stop animation after current loop finished.
+  IMMEDIATE         ///< stop animation immediatly and reset position.
+};
+} // namespace AutoScrollStopMode
+
 } // namespace DevelText
 
 } // namespace Toolkit