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

   1 #ifndef DALI_TOOLKIT_TEXT_MODEL_INTERFACE_H
   2 #define DALI_TOOLKIT_TEXT_MODEL_INTERFACE_H
   3
   4 /*
   5  * Copyright (c) 2022 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/devel-api/text/text-enumerations-devel.h>
  26 #include <dali-toolkit/internal/text/line-run.h>
  27 #include <dali-toolkit/internal/text/script-run.h>
  28 #include <dali-toolkit/internal/text/strikethrough-glyph-run.h>
  29 #include <dali-toolkit/internal/text/text-definitions.h>
  30 #include <dali-toolkit/public-api/text/text-enumerations.h>
  31
  32 namespace Dali
  33 {
  34 namespace Toolkit
  35 {
  36 namespace Text
  37 {
  38 /**
  39  * @brief Interface class used to retrieve the text's model from the text-controller.
  40  */
  41 class ModelInterface
  42 {
  43 public:
  44   /**
  45    * @brief Virtual destructor.
  46    */
  47   virtual ~ModelInterface()
  48   {
  49   }
  50
  51   /**
  52    * @brief Retrives the control's size.
  53    *
  54    * @return The control's size.
  55    */
  56   virtual const Size& GetControlSize() const = 0;
  57
  58   /**
  59    * @brief Retrives the layout's size.
  60    *
  61    * @return The layout's size.
  62    */
  63   virtual const Size& GetLayoutSize() const = 0;
  64
  65   /**
  66    * @brief Retrieves the text's scroll position.
  67    *
  68    * @return The scroll position.
  69    */
  70   virtual const Vector2& GetScrollPosition() const = 0;
  71
  72   /**
  73    * @brief Retrieves the text's horizontal alignment.
  74    *
  75    * @return The horizontal alignment.
  76    */
  77   virtual HorizontalAlignment::Type GetHorizontalAlignment() const = 0;
  78
  79   /**
  80    * @brief Retrieves the text's vertical alignment.
  81    *
  82    * @return The vertical alignment.
  83    */
  84   virtual VerticalAlignment::Type GetVerticalAlignment() const = 0;
  85
  86   /**
  87    * @brief Retrieves the text's vertical line alignment.
  88    *
  89    * @return The vertical line alignment.
  90    */
  91   virtual DevelText::VerticalLineAlignment::Type GetVerticalLineAlignment() const = 0;
  92
  93   /**
  94    * @brief Retrieves ellipsis position for text.
  95    *
  96    * @return The ellipsis position.
  97    */
  98   virtual DevelText::EllipsisPosition::Type GetEllipsisPosition() const = 0;
  99
 100   /**
 101    * @brief Whether the text elide property is enabled.
 102    *
 103    * @return @e true if the text elide property is enabled, @e false otherwise.
 104    */
 105   virtual bool IsTextElideEnabled() const = 0;
 106
 107   /**
 108    * @brief Retrieves the number of laid-out lines.
 109    *
 110    * @return The number of laid-out lines.
 111    */
 112   virtual Length GetNumberOfLines() const = 0;
 113
 114   /**
 115    * @brief Retrieves the laid-out lines.
 116    *
 117    * @return A pointer to the vector with the laid-out lines.
 118    */
 119   virtual const LineRun* const GetLines() const = 0;
 120
 121   /**
 122    * @brief Retrieves the number of script runs.
 123    *
 124    * @return The number of script runs.
 125    */
 126   virtual Length GetNumberOfScripts() const = 0;
 127
 128   /**
 129    * @brief Retrieves the script runs.
 130    *
 131    * @return A pointer to the vector with the runs of characters with the same script..
 132    */
 133   virtual const ScriptRun* const GetScriptRuns() const = 0;
 134
 135   /**
 136    * @brief Retrieves the number of laid-out glyphs.
 137    *
 138    * @return The number of laid-out glyphs.
 139    */
 140   virtual Length GetNumberOfGlyphs() const = 0;
 141
 142   /**
 143    * @brief Retrieves the start index of laid-out glyphs.
 144    *
 145    * @return The start index of laid-out glyphs.
 146    */
 147   virtual GlyphIndex GetStartIndexOfElidedGlyphs() const = 0;
 148
 149   /**
 150    * @brief Retrieves the end index of laid-out glyphs.
 151    *
 152    * @return The end index of laid-out glyphs.
 153    */
 154   virtual GlyphIndex GetEndIndexOfElidedGlyphs() const = 0;
 155
 156   /**
 157    * @brief Retrieves the first middle index of elided glyphs, index before ellipsis of middle.
 158    *
 159    * @return The first middle index of elided glyphs, index before ellipsis of middle.
 160    */
 161   virtual GlyphIndex GetFirstMiddleIndexOfElidedGlyphs() const = 0;
 162
 163   /**
 164    * @brief Retrieves the second middle index of elided glyphs, index of ellipsis of middle.
 165    *
 166    * @return The second middle index of elided glyphs, index of ellipsis of middle.
 167    */
 168   virtual GlyphIndex GetSecondMiddleIndexOfElidedGlyphs() const = 0;
 169
 170   /**
 171    * @brief Retrieves the laid-out glyphs.
 172    *
 173    * @return A pointer to the vector with the laid-out glyphs.
 174    */
 175   virtual const GlyphInfo* const GetGlyphs() const = 0;
 176
 177   /**
 178    * @brief Retrieves the text layout.
 179    *
 180    * @return A pointer to the vector with the positions for each glyph.
 181    */
 182   virtual const Vector2* const GetLayout() const = 0;
 183
 184   /**
 185    * @brief Retrieves the vector of colors.
 186    *
 187    * @return Pointer to the vector of colors.
 188    */
 189   virtual const Vector4* const GetColors() const = 0;
 190
 191   /**
 192    * @brief Retrieves the vector of indices to the vector of colors.
 193    *
 194    * @return Pointer to a vector which stores for each glyph the index to the vector of colors.
 195    */
 196   virtual const ColorIndex* const GetColorIndices() const = 0;
 197
 198   /**
 199    * @brief Retrieves the vector of background colors.
 200    *
 201    * @return Pointer to the vector of background colors.
 202    */
 203   virtual const Vector4* const GetBackgroundColors() const = 0;
 204
 205   /**
 206    * @brief Retrieves the vector of indices to the vector of background colors.
 207    *
 208    * @return Pointer to a vector which stores for each glyph the index to the vector of background colors.
 209    */
 210   virtual const ColorIndex* const GetBackgroundColorIndices() const = 0;
 211
 212   /**
 213    * @brief checks if there is background colors set using markup.
 214    *
 215    * @return boolean if there is background colors set using markup .
 216    */
 217   virtual bool const IsMarkupBackgroundColorSet() const = 0;
 218
 219   /**
 220    * @brief Retrieves the text's default color.
 221    *
 222    * @return The default color.
 223    */
 224   virtual const Vector4& GetDefaultColor() const = 0;
 225
 226   /**
 227    * @brief Retrieves the shadow offset, 0 indicates no shadow.
 228    *
 229    * @return The shadow offset.
 230    */
 231   virtual const Vector2& GetShadowOffset() const = 0;
 232
 233   /**
 234    * @brief Retrieves the shadow color.
 235    *
 236    * @return The shadow color.
 237    */
 238   virtual const Vector4& GetShadowColor() const = 0;
 239
 240   /**
 241    * @brief Retrieve the shadow blur radius.
 242    *
 243    * @return The shadow blur radius.
 244    */
 245   virtual const float& GetShadowBlurRadius() const = 0;
 246
 247   /**
 248    * @brief Retrieves the underline color.
 249    *
 250    * @return The underline color.
 251    */
 252   virtual const Vector4& GetUnderlineColor() const = 0;
 253
 254   /**
 255    * @brief Returns whether underline is enabled or not.
 256    *
 257    * @return The underline state.
 258    */
 259   virtual bool IsUnderlineEnabled() const = 0;
 260
 261   /**
 262    * @brief Retrieves the underline height override
 263    *
 264    * @return Returns the override height for an underline, 0 indicates that adaptor will determine the height
 265    */
 266   virtual float GetUnderlineHeight() const = 0;
 267
 268   /**
 269    * @brief Retrieves the underline type override.
 270    *
 271    * @return Returns the override type for an underline.
 272    */
 273   virtual Text::Underline::Type GetUnderlineType() const = 0;
 274
 275   /**
 276    * @brief Retrieves the dashed underline width override
 277    *
 278    * @return Returns the override width for the dashed underline.
 279    */
 280   virtual float GetDashedUnderlineWidth() const = 0;
 281
 282   /**
 283    * @brief Retrieves the dashed underline gap override
 284    *
 285    * @return Returns the override gap for the dashed underline.
 286    */
 287   virtual float GetDashedUnderlineGap() const = 0;
 288
 289   /**
 290    * @brief Retrieves the number of underline runs.
 291    *
 292    * @return The number of underline runs.
 293    */
 294   virtual Length GetNumberOfUnderlineRuns() const = 0;
 295
 296   /**
 297    * @brief Retrieves the underline runs.
 298    *
 299    * @param[out] underlineRuns Pointer to a buffer where the underline runs are copied.
 300    * @param[in] index Index of the first underline run to be copied.
 301    * @param[in] numberOfRuns Number of underline runs to be copied.
 302    */
 303   virtual void GetUnderlineRuns(GlyphRun* underlineRuns, UnderlineRunIndex index, Length numberOfRuns) const = 0;
 304
 305   /**
 306    * @brief Retrieve the outline color.
 307    *
 308    * @return The outline color.
 309    */
 310   virtual const Vector4& GetOutlineColor() const = 0;
 311
 312   /**
 313    * @brief Retrieves the width of an outline
 314    *
 315    * @return The width of the outline.
 316    */
 317   virtual uint16_t GetOutlineWidth() const = 0;
 318
 319   /**
 320    * @brief Retrieves the background color.
 321    *
 322    * @return The background color.
 323    */
 324   virtual const Vector4& GetBackgroundColor() const = 0;
 325
 326   /**
 327    * @brief Returns whether background is enabled or not.
 328    *
 329    * @return The background state.
 330    */
 331   virtual bool IsBackgroundEnabled() const = 0;
 332
 333   /**
 334    * @brief Returns whether markup-processor is enabled or not.
 335    *
 336    * @return The markup-processor state.
 337    */
 338   virtual bool IsMarkupProcessorEnabled() const = 0;
 339
 340   /**
 341    * @brief Returns the hyphens glyph info.
 342    *
 343    * @return hyphens glyph info.
 344    */
 345   virtual const GlyphInfo* GetHyphens() const = 0;
 346
 347   /**
 348    * @brief Returns the indices of the hyphen in the text.
 349    *
 350    * @return the hyphen indices.
 351    */
 352   virtual const Length* GetHyphenIndices() const = 0;
 353
 354   /**
 355    * @brief Returns number of hyphens to add in text.
 356    *
 357    * @return number of hyphens.
 358    */
 359   virtual Length GetHyphensCount() const = 0;
 360
 361   /**
 362    * @brief Retrieves the strikethrough color.
 363    *
 364    * @return The strikethrough color.
 365    */
 366   virtual const Vector4& GetStrikethroughColor() const = 0;
 367
 368   /**
 369    * @brief Returns whether strikethrough is enabled or not.
 370    *
 371    * @return The strikethrough state.
 372    */
 373   virtual bool IsStrikethroughEnabled() const = 0;
 374
 375   /**
 376    * @brief Retrieves the strikethrough height override
 377    *
 378    * @return Returns the override height for a strikethrough, 0 indicates that adaptor will determine the height
 379    */
 380   virtual float GetStrikethroughHeight() const = 0;
 381
 382   /**
 383    * @brief Retrieves the number of strikethrough runs.
 384    *
 385    * @return The number of strikethrough runs.
 386    */
 387   virtual Length GetNumberOfStrikethroughRuns() const = 0;
 388
 389   /**
 390    * @brief Retrieves the strikethrough runs.
 391    *
 392    * @param[out] strikethroughRuns Pointer to a buffer where the strikethrough runs are copied.
 393    * @param[in] index Index of the first strikethrough run to be copied.
 394    * @param[in] numberOfRuns Number of strikethrough runs to be copied.
 395    */
 396   virtual void GetStrikethroughRuns(StrikethroughGlyphRun* strikethroughRuns, StrikethroughRunIndex index, Length numberOfRuns) const = 0;
 397
 398   /**
 399    * @brief Retrieves the character spacing.
 400    *
 401    * @note A positive value will make the characters far apart (expanded) and a negative value will bring them closer (condensed).
 402    *
 403    * @return The character spacing.
 404    */
 405   virtual const float GetCharacterSpacing() const = 0;
 406
 407   /**
 408    * @brief Retrieves the text buffer.
 409    *
 410    * @return The text buffer.
 411    */
 412   virtual const Character* GetTextBuffer() const = 0;
 413
 414   /**
 415    * @brief Retrieves the Glyphs to Characters Array.
 416    *
 417    * @return The GlyphsToCharacters.
 418    */
 419   virtual const Vector<CharacterIndex>& GetGlyphsToCharacters() const = 0;
 420 };
 421
 422 } // namespace Text
 423
 424 } // namespace Toolkit
 425
 426 } // namespace Dali
 427
 428 #endif // DALI_TOOLKIT_TEXT_MODEL_INTERFACE_H