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

   1 #ifndef DALI_TOOLKIT_TEXT_VIEW_MODEL_H
   2 #define DALI_TOOLKIT_TEXT_VIEW_MODEL_H
   3
   4 /*
   5  * Copyright (c) 2018 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/common/dali-vector.h>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali-toolkit/public-api/text/text-enumerations.h>
  26 #include <dali-toolkit/internal/text/text-model-interface.h>
  27 #include <dali-toolkit/devel-api/text/text-enumerations-devel.h>
  28
  29 namespace Dali
  30 {
  31
  32 namespace Toolkit
  33 {
  34
  35 namespace Text
  36 {
  37
  38 /**
  39  * @brief Responsible of creating and store temporary modifications of the text model.
  40  * i.e. The elide of text.
  41  */
  42 class ViewModel : public ModelInterface
  43 {
  44 public:
  45   /**
  46    * @brief Constructor.
  47    *
  48    * Keeps the pointer to the text's model. It initializes all the members of the class to their defaults.
  49    *
  50    * @param[in] model Pointer to the text's model interface.
  51    */
  52   ViewModel( const ModelInterface* const model );
  53
  54   /**
  55    * @brief Virtual destructor.
  56    *
  57    * It's a default destructor.
  58    */
  59   virtual ~ViewModel();
  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 Text::HorizontalAlignment::Type GetHorizontalAlignment() const;
  80
  81   /**
  82    * @copydoc ModelInterface::GetVerticalAlignment()
  83    */
  84   virtual Text::VerticalAlignment::Type GetVerticalAlignment() const;
  85
  86   /**
  87  * @copydoc ModelInterface::GetVerticalLineAlignment()
  88  */
  89   virtual DevelText::VerticalLineAlignment::Type GetVerticalLineAlignment() const;
  90
  91   /**
  92    * @copydoc ModelInterface::IsTextElideEnabled()
  93    */
  94   virtual bool IsTextElideEnabled() const;
  95
  96   /**
  97    * @copydoc ModelInterface::GetNumberOfLines()
  98    */
  99   virtual Length GetNumberOfLines() const;
 100
 101   /**
 102    * @copydoc ModelInterface::GetLines()
 103    */
 104   virtual const LineRun* const GetLines() const;
 105
 106   /**
 107    * @copydoc ModelInterface::GetNumberOfScripts()
 108    */
 109   virtual Length GetNumberOfScripts() const;
 110
 111   /**
 112    * @copydoc ModelInterface::GetScriptRuns()
 113    */
 114   virtual const ScriptRun* const GetScriptRuns() const;
 115
 116   /**
 117    * @copydoc ModelInterface::GetNumberOfGlyphs()
 118    */
 119   virtual Length GetNumberOfGlyphs() const;
 120
 121   /**
 122    * @copydoc ModelInterface::GetGlyphs()
 123    */
 124   virtual const GlyphInfo* const GetGlyphs() const;
 125
 126   /**
 127    * @copydoc ModelInterface::GetLayout()
 128    */
 129   virtual const Vector2* const GetLayout() const;
 130
 131   /**
 132    * @copydoc ModelInterface::GetColors()
 133    */
 134   virtual const Vector4* const GetColors() const;
 135
 136   /**
 137    * @copydoc ModelInterface::GetColorIndices()
 138    */
 139   virtual const ColorIndex* const GetColorIndices() const;
 140
 141   /**
 142    * @copydoc ModelInterface::GetDefaultColor()
 143    */
 144   virtual const Vector4& GetDefaultColor() const;
 145
 146   /**
 147    * @copydoc ModelInterface::GetShadowOffset()
 148    */
 149   virtual const Vector2& GetShadowOffset() const;
 150
 151   /**
 152    * @copydoc ModelInterface::GetShadowColor()
 153    */
 154   virtual const Vector4& GetShadowColor() const;
 155
 156   /**
 157    * @copydoc ModelInterface::GetShadowBlurRadius()
 158    */
 159   virtual const float& GetShadowBlurRadius() const;
 160
 161   /**
 162    * @copydoc ModelInterface::GetUnderlineColor()
 163    */
 164   virtual const Vector4& GetUnderlineColor() const;
 165
 166   /**
 167    * @copydoc ModelInterface::IsUnderlineEnabled()
 168    */
 169   virtual bool IsUnderlineEnabled() const;
 170
 171   /**
 172    * @copydoc ModelInterface::GetUnderlineHeight()
 173    */
 174   virtual float GetUnderlineHeight() const;
 175
 176   /**
 177    * @copydoc ModelInterface::GetNumberOfUnderlineRuns()
 178    */
 179   virtual Length GetNumberOfUnderlineRuns() const;
 180
 181   /**
 182    * @copydoc ModelInterface::GetUnderlineRuns()
 183    */
 184   virtual void GetUnderlineRuns( GlyphRun* underlineRuns, UnderlineRunIndex index, Length numberOfRuns ) const;
 185
 186   /**
 187    * @copydoc ModelInterface::GetOutlineColor()
 188    */
 189   virtual const Vector4& GetOutlineColor() const;
 190
 191   /**
 192    * @copydoc ModelInterface::GetOutlineWidth()
 193    */
 194   virtual uint16_t GetOutlineWidth() const;
 195
 196   /**
 197    * @copydoc ModelInterface::GetBackgroundColor()
 198    */
 199   virtual const Vector4& GetBackgroundColor() const;
 200
 201   /**
 202    * @copydoc ModelInterface::IsBackgroundEnabled()
 203    */
 204   virtual bool IsBackgroundEnabled() const;
 205
 206 /**
 207    * @brief Does the text elide.
 208    *
 209    * It stores a copy of the visible glyphs and removes as many glyphs as needed
 210    * from the last visible line to add the ellipsis glyph.
 211    *
 212    * It stores as well a copy of the positions for each visible glyph.
 213    */
 214   void ElideGlyphs();
 215
 216 private:
 217   const ModelInterface* const mModel;            ///< Pointer to the text's model.
 218   Vector<GlyphInfo>           mElidedGlyphs;     ///< Stores the glyphs of the elided text.
 219   Vector<Vector2>             mElidedLayout;     ///< Stores the positions of each glyph of the elided text.
 220   bool                        mIsTextElided : 1; ///< Whether the text has been elided.
 221 };
 222
 223 } // namespace Text
 224
 225 } // namespace Toolkit
 226
 227 } // namespace Dali
 228
 229 #endif // DALI_TOOLKIT_TEXT_VIEW_MODEL_H