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

   1 #ifndef __DALI_TOOLKIT_TEXT_VIEW_INTERFACE_H__
   2 #define __DALI_TOOLKIT_TEXT_VIEW_INTERFACE_H__
   3
   4 /*
   5  * Copyright (c) 2015 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 // INTERNAL INCLUDES
  22 #include <dali-toolkit/internal/text/text-definitions.h>
  23
  24 namespace Dali
  25 {
  26
  27 struct Vector2;
  28 struct Vector4;
  29
  30 namespace Toolkit
  31 {
  32
  33 namespace Text
  34 {
  35
  36 struct GlyphRun;
  37
  38 /**
  39  * @brief Abstract interface to provide the information necessary displaying text.
  40  *
  41  * This includes:
  42  * - The font & glyph IDs needed to get bitmaps etc. from TextAbstraction
  43  * - The visual position of each glyph within the layout
  44  * - A window into the text layout e.g. which page of a document to view
  45  */
  46 class ViewInterface
  47 {
  48 public:
  49
  50   /**
  51    * @brief Constructor.
  52    */
  53   ViewInterface();
  54
  55   /**
  56    * @brief Virtual destructor
  57    */
  58   virtual ~ViewInterface();
  59
  60   /**
  61    * @brief Retrieves the target size of the UI control.
  62    *
  63    * @return The text's size.
  64    */
  65   virtual const Vector2& GetControlSize() const = 0;
  66
  67   /**
  68    * Retrieves the number of glyphs.
  69    *
  70    * @return The number of glyphs.
  71    */
  72   virtual Length GetNumberOfGlyphs() const = 0;
  73
  74   /**
  75    * @brief Retrieves glyphs and positions in the given buffers.
  76    *
  77    * @note The size of the @p glyphs and @p glyphPositions buffers need to be big enough to copy the @p numberOfGlyphs glyphs and positions.
  78    * @note The returned number of glyphs may be less than @p numberOfGlyphs if a line has ellipsis.
  79    *
  80    * @param[out] glyphs Pointer to a buffer where the glyphs are copied.
  81    * @param[out] glyphPositions Pointer to a buffer where the glyph positions are copied.
  82    * @param[in] glyphIndex Index to the first glyph.
  83    * @param[in] numberOfGlyphs Number of glyphs to be copied.
  84    *
  85    * @return The number of glyphs.
  86    */
  87   virtual Length GetGlyphs( GlyphInfo* glyphs,
  88                             Vector2* glyphPositions,
  89                             GlyphIndex glyphIndex,
  90                             Length numberOfGlyphs ) const = 0;
  91
  92   /**
  93    * @brief Retrieves the text color
  94    *
  95    * @return The text color
  96    */
  97   virtual const Vector4& GetTextColor() const = 0;
  98
  99   /**
 100    * @brief Retrieves the shadow offset, 0 indicates no shadow.
 101    *
 102    * @return The shadow offset.
 103    */
 104   virtual const Vector2& GetShadowOffset() const = 0;
 105
 106   /**
 107    * @brief Retrieves the shadow color.
 108    *
 109    * @return The shadow color.
 110    */
 111   virtual const Vector4& GetShadowColor() const = 0;
 112
 113   /**
 114    * @brief Retrieves the underline color.
 115    *
 116    * @return The underline color.
 117    */
 118   virtual const Vector4& GetUnderlineColor() const = 0;
 119
 120   /**
 121    * @brief Returns whether underline is enabled or not.
 122    *
 123    * @return The underline state.
 124    */
 125   virtual bool IsUnderlineEnabled() const = 0;
 126
 127   /**
 128    * @brief Retrieves the underline height override
 129    *
 130    * @return Returns the override height for an underline, 0 indicates that adaptor will determine the height
 131    */
 132   virtual float GetUnderlineHeight() const = 0;
 133
 134   /**
 135    * @brief Retrieves the number of underline runs.
 136    *
 137    * @return The number of underline runs.
 138    */
 139   virtual Length GetNumberOfUnderlineRuns() const = 0;
 140
 141   /**
 142    * @brief Retrieves the underline runs.
 143    *
 144    * @param[out] underlineRuns Pointer to a buffer where the underline runs are copied.
 145    * @param[in] index Index of the first underline run to be copied.
 146    * @param[in] numberOfRuns Number of underline runs to be copied.
 147    */
 148   virtual void GetUnderlineRuns( GlyphRun* underlineRuns,
 149                                  UnderlineRunIndex index,
 150                                  Length numberOfRuns ) const = 0;
 151 };
 152
 153 } // namespace Text
 154
 155 } // namespace Toolkit
 156
 157 } // namespace Dali
 158
 159 #endif // __DALI_TOOLKIT_TEXT_VIEW_INTERFACE_H__