dali-toolkit/internal/text/text-scroller-data.h

   1 #ifndef DALI_TOOLKIT_TEXT_SCROLLER_DATA_H
   2 #define DALI_TOOLKIT_TEXT_SCROLLER_DATA_H
   3
   4 /*
   5  * Copyright (c) 2016 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali/public-api/math/vector2.h>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali-toolkit/internal/text/text-definitions.h>
  26
  27 namespace Dali
  28 {
  29
  30 namespace Toolkit
  31 {
  32
  33 namespace Text
  34 {
  35
  36 extern const int MINIMUM_SCROLL_SPEED; // Speed should be set by Property system.
  37
  38 /**
  39  * @brief Stores the autoscroll data.
  40  */
  41 struct ScrollerData
  42 {
  43   ScrollerData();
  44   ~ScrollerData();
  45
  46   Size               mControlSize;            ///< The size of the control to scroll within.
  47   Size               mOffscreenSize;          ///< The size of the sourceActor.
  48   int                mScrollSpeed;            ///< Speed which text should automatically scroll at.
  49   int                mLoopCount;              ///< Number of time the text should scroll.
  50   float              mWrapGap;                ///< Gap before text wraps around when scrolling.
  51   float              mAlignmentOffset;        ///< The alignment offset of the first line of text to be scrolled.
  52   CharacterDirection mAutoScrollDirectionRTL; ///< Direction of auto scrolling, true if rtl.
  53 };
  54
  55 } // namespace Text
  56
  57 } // namespace Toolkit
  58
  59 } // namespace Dali
  60
  61 #endif // DALI_TOOLKIT_TEXT_SCROLLER_H
  62