text-view.h

   1 #ifndef __DALI_TOOLKIT_TEXT_VIEW_H__
   2 #define __DALI_TOOLKIT_TEXT_VIEW_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-view-interface.h>
  23 #include <dali-toolkit/internal/text/visual-model-impl.h>
  24
  25 namespace Dali
  26 {
  27
  28 struct Vector2;
  29
  30 namespace Toolkit
  31 {
  32
  33 namespace Text
  34 {
  35
  36 /**
  37  * @brief View provides an interface between the Text layout engine and rendering back-end.
  38  */
  39 class View : public ViewInterface
  40 {
  41 public:
  42
  43   /**
  44    * @brief Create a new instance of a View.
  45    */
  46   View();
  47
  48   /**
  49    * @brief Virtual destructor.
  50    */
  51   virtual ~View();
  52
  53   /**
  54    * @brief Set the visual model.
  55    *
  56    * @param[in] visualModel The visual model used by the View.
  57    */
  58   void SetVisualModel( VisualModelPtr visualModel );
  59
  60   /**
  61    * @copydoc Dali::Toolkit::Text::ViewInterface::GetNumberOfGlyphs()
  62    */
  63   virtual Length GetNumberOfGlyphs() const;
  64
  65   /**
  66    * @copydoc Dali::Toolkit::Text::ViewInterface::GetGlyphs()
  67    */
  68   virtual Length GetGlyphs( GlyphInfo* glyphs,
  69                             Vector2* glyphPositions,
  70                             GlyphIndex glyphIndex,
  71                             Length numberOfGlyphs ) const;
  72
  73   /**
  74    * @copydoc Dali::Toolkit::Text::ViewInterface::GetTextColor()
  75    */
  76   virtual const Vector4& GetTextColor() const;
  77
  78   /**
  79    * @copydoc Dali::Toolkit::Text::ViewInterface::GetShadowOffset()
  80    */
  81   virtual const Vector2& GetShadowOffset() const;
  82
  83   /**
  84    * @copydoc Dali::Toolkit::Text::ViewInterface::GetShadowColor()
  85    */
  86   virtual const Vector4& GetShadowColor() const;
  87
  88   /**
  89    * @copydoc Dali::Toolkit::Text::ViewInterface::GetUnderlineColor()
  90    */
  91   virtual const Vector4& GetUnderlineColor() const;
  92
  93   /**
  94    * @copydoc Dali::Toolkit::Text::ViewInterface::IsUnderlineEnabled()
  95    */
  96   virtual bool IsUnderlineEnabled() const;
  97
  98   /**
  99    * @copydoc Dali::Toolkit::Text::ViewInterface::GetUnderlineHeight()
 100    */
 101   virtual float GetUnderlineHeight() const;
 102
 103 private:
 104
 105   // Undefined
 106   View( const View& handle );
 107
 108   // Undefined
 109   View& operator=( const View& handle );
 110
 111 private:
 112
 113   struct Impl;
 114   Impl* mImpl;
 115 };
 116 } // namespace Text
 117
 118 } // namespace Toolkit
 119
 120 } // namespace Dali
 121
 122 #endif // __DALI_TOOLKIT_TEXT_VIEW_H__