dali-toolkit/internal/text/text-model.h

   1 #ifndef DALI_TOOLKIT_TEXT_MODEL_H
   2 #define DALI_TOOLKIT_TEXT_MODEL_H
   3
   4 /*
   5  * Copyright (c) 2017 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/object/ref-object.h>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali-toolkit/public-api/text/text-enumerations.h>
  26 #include <dali-toolkit/internal/text/logical-model-impl.h>
  27 #include <dali-toolkit/internal/text/text-model-interface.h>
  28 #include <dali-toolkit/internal/text/visual-model-impl.h>
  29
  30 namespace Dali
  31 {
  32
  33 namespace Toolkit
  34 {
  35
  36 namespace Text
  37 {
  38
  39 // Forward declarations.
  40 class Model;
  41
  42 typedef IntrusivePtr<Model> ModelPtr;
  43
  44 /**
  45  * @brief Implementation class used to retrieve the text's model from the text-controller.
  46  */
  47 class Model : public RefObject, public ModelInterface
  48 {
  49
  50 public: // Constructor.
  51
  52   /**
  53    * @brief Create a new instance of a text Model.
  54    *
  55    * @return A pointer to a new text Model.
  56    */
  57   static ModelPtr New();
  58
  59 public:
  60
  61   /**
  62    * @copydoc ModelInterface::GetControlSize()
  63    */
  64   virtual const Size& GetControlSize() const;
  65
  66   /**
  67    * @copydoc ModelInterface::GetLayoutSize()
  68    */
  69   virtual const Size& GetLayoutSize() const;
  70
  71   /**
  72    * @copydoc ModelInterface::GetScrollPosition()
  73    */
  74   virtual const Vector2& GetScrollPosition() const;
  75
  76   /**
  77    * @copydoc ModelInterface::GetHorizontalAlignment()
  78    */
  79   virtual HorizontalAlignment::Type GetHorizontalAlignment() const;
  80
  81   /**
  82    * @copydoc ModelInterface::GetVerticalAlignment()
  83    */
  84   virtual VerticalAlignment::Type GetVerticalAlignment() const;
  85
  86   /**
  87    * @copydoc ModelInterface::IsTextElideEnabled()
  88    */
  89   virtual bool IsTextElideEnabled() const;
  90
  91   /**
  92    * @copydoc ModelInterface::GetNumberOfLines()
  93    */
  94   virtual Length GetNumberOfLines() const;
  95
  96   /**
  97    * @copydoc ModelInterface::GetLines()
  98    */
  99   virtual const LineRun* const GetLines() const;
 100
 101   /**
 102    * @copydoc ModelInterface::GetNumberOfScripts()
 103    */
 104   virtual Length GetNumberOfScripts() const;
 105
 106   /**
 107    * @copydoc ModelInterface::GetScriptRuns()
 108    */
 109   virtual const ScriptRun* const GetScriptRuns() const;
 110
 111   /**
 112    * @copydoc ModelInterface::GetNumberOfGlyphs()
 113    */
 114   virtual Length GetNumberOfGlyphs() const;
 115
 116   /**
 117    * @copydoc ModelInterface::GetGlyphs()
 118    */
 119   virtual const GlyphInfo* const GetGlyphs() const;
 120
 121   /**
 122    * @copydoc ModelInterface::GetLayout()
 123    */
 124   virtual const Vector2* const GetLayout() const;
 125
 126   /**
 127    * @copydoc ModelInterface::GetColors()
 128    */
 129   virtual const Vector4* const GetColors() const;
 130
 131   /**
 132    * @copydoc ModelInterface::GetColorIndices()
 133    */
 134   virtual const ColorIndex* const GetColorIndices() const;
 135
 136   /**
 137    * @copydoc ModelInterface::GetDefaultColor()
 138    */
 139   virtual const Vector4& GetDefaultColor() const;
 140
 141   /**
 142    * @copydoc ModelInterface::GetShadowOffset()
 143    */
 144   virtual const Vector2& GetShadowOffset() const;
 145
 146   /**
 147    * @copydoc ModelInterface::GetShadowColor()
 148    */
 149   virtual const Vector4& GetShadowColor() const;
 150
 151   /**
 152    * @copydoc ModelInterface::GetShadowBlurRadius()
 153    */
 154   virtual const float& GetShadowBlurRadius() const;
 155
 156   /**
 157    * @copydoc ModelInterface::GetUnderlineColor()
 158    */
 159   virtual const Vector4& GetUnderlineColor() const;
 160
 161   /**
 162    * @copydoc ModelInterface::IsUnderlineEnabled()
 163    */
 164   virtual bool IsUnderlineEnabled() const;
 165
 166   /**
 167    * @copydoc ModelInterface::GetUnderlineHeight()
 168    */
 169   virtual float GetUnderlineHeight() const;
 170
 171   /**
 172    * @copydoc ModelInterface::GetNumberOfUnderlineRuns()
 173    */
 174   virtual Length GetNumberOfUnderlineRuns() const;
 175
 176   /**
 177    * @copydoc ModelInterface::GetUnderlineRuns()
 178    */
 179   virtual void GetUnderlineRuns( GlyphRun* underlineRuns, UnderlineRunIndex index, Length numberOfRuns ) const;
 180
 181   /**
 182    * @copydoc ModelInterface::GetOutlineColor()
 183    */
 184   virtual const Vector4& GetOutlineColor() const;
 185
 186   /**
 187    * @copydoc ModelInterface::GetOutlineWidth()
 188    */
 189   virtual float GetOutlineWidth() const;
 190
 191 private: // Private contructors & copy operator.
 192
 193   /**
 194    * @brief Private constructor.
 195    */
 196   Model();
 197
 198   // Undefined.
 199   Model( const Model& handle );
 200
 201   // Undefined.
 202   Model& operator=( const Model& handle );
 203
 204 protected:
 205
 206   /**
 207    * @brief A reference counted object may only be deleted by calling Unreference().
 208    */
 209   virtual ~Model();
 210
 211 public:
 212   LogicalModelPtr             mLogicalModel;        ///< Pointer to the logical model.
 213   VisualModelPtr              mVisualModel;         ///< Pointer to the visual model.
 214   /**
 215    * 0,0 means that the top-left corner of the layout matches the top-left corner of the UI control.
 216    * Typically this will have a negative value with scrolling occurs.
 217    */
 218   Vector2                            mScrollPosition;      ///< The text is offset by this position when scrolling.
 219   Vector2                            mScrollPositionLast;  ///< The last offset value of mScrollPosition
 220   HorizontalAlignment::Type          mHorizontalAlignment; ///< The layout's horizontal alignment.
 221   VerticalAlignment::Type            mVerticalAlignment;   ///< The layout's vertical alignment.
 222   Text::LineWrap::Mode               mLineWrapMode;        ///< The text wrap mode
 223   float                              mAlignmentOffset;     ///< The alignment offset.
 224   bool                               mElideEnabled:1;      ///< Whether the text's elide is enabled.
 225 };
 226
 227 } // namespace Text
 228
 229 } // namespace Toolkit
 230
 231 } // namespace Dali
 232
 233 #endif // DALI_TOOLKIT_TEXT_MODEL_H