dali-toolkit/internal/visuals/text/text-visual.h

   1 #ifndef DALI_TOOLKIT_INTERNAL_TEXT_VISUAL_H
   2 #define DALI_TOOLKIT_INTERNAL_TEXT_VISUAL_H
   3
   4 /*
   5  * Copyright (c) 2016 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/visuals/visual-base-impl.h>
  23 #include <dali-toolkit/internal/text/rendering/text-typesetter.h>
  24 #include <dali-toolkit/internal/text/text-controller.h>
  25
  26 namespace Dali
  27 {
  28
  29 namespace Toolkit
  30 {
  31
  32 namespace Internal
  33 {
  34
  35 class TextVisual;
  36 typedef IntrusivePtr< TextVisual > TextVisualPtr;
  37
  38 /**
  39  * The visual which renders text
  40  *
  41  * The following properties are optional:
  42  *
  43  * | %Property Name      | Type    |
  44  * |---------------------|---------|
  45  * | renderingBackend    | INTEGER |
  46  * | text                | STRING  |
  47  * | fontFamily          | STRING  |
  48  * | fontStyle           | STRING  |
  49  * | pointSize           | FLOAT   |
  50  * | multiLine           | BOOLEAN |
  51  * | horizontalAlignment | STRING  |
  52  * | verticalAlignment   | STRING  |
  53  * | textColor           | VECTOR4 |
  54  * | enableMarkup        | BOOLEAN |
  55  * | enableAutoScroll    | BOOLEAN |
  56  * | autoScrollSpeed     | INTEGER |
  57  * | autoScrollLoopCount | INTEGER |
  58  * | autoScrollGap       | INTEGER |
  59  * | lineSpacing         | FLOAT   |
  60  * | underline           | STRING  |
  61  * | shadow              | STRING  |
  62  * | outline             | STRING  |
  63  * | batchingEnabled     | BOOLEAN |
  64  *
  65  */
  66 class TextVisual : public Visual::Base
  67 {
  68 public:
  69
  70   /**
  71    * @brief Create a new text visual.
  72    *
  73    * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
  74    * @param[in] properties A Property::Map containing settings for this visual
  75    * @return A smart-pointer to the newly allocated visual.
  76    */
  77   static TextVisualPtr New( VisualFactoryCache& factoryCache, const Property::Map& properties );
  78
  79   /**
  80    * @brief Converts all strings keys in property map to index keys.  Property Map can then be merged correctly.
  81    * @param[in,out] propertyMap containing string keys or a mix of strings and indexes. Will be changed to index keys.
  82    */
  83   static void ConvertStringKeysToIndexKeys( Property::Map& propertyMap );
  84
  85 public: // from Visual::Base
  86
  87   /**
  88    * @copydoc Visual::Base::GetHeightForWidth()
  89    */
  90   virtual float GetHeightForWidth( float width );
  91
  92   /**
  93    * @copydoc Visual::Base::GetNaturalSize()
  94    */
  95   virtual void GetNaturalSize( Vector2& naturalSize );
  96
  97   /**
  98    * @copydoc Visual::Base::CreatePropertyMap()
  99    */
 100   virtual void DoCreatePropertyMap( Property::Map& map ) const;
 101
 102 protected:
 103
 104   /**
 105    * @brief Constructor.
 106    *
 107    * @param[in] factoryCache The VisualFactoryCache object
 108    */
 109   TextVisual( VisualFactoryCache& factoryCache );
 110
 111   /**
 112    * @brief A reference counted object may only be deleted by calling Unreference().
 113    */
 114   virtual ~TextVisual();
 115
 116   // from Visual::Base
 117
 118   /**
 119    * @copydoc Visual::Base::DoSetProperties()
 120    */
 121   virtual void DoSetProperties( const Property::Map& propertyMap );
 122
 123   /**
 124    * @copydoc Visual::Base::DoSetOnStage()
 125    */
 126   virtual void DoSetOnStage( Actor& actor );
 127
 128   /**
 129    * @copydoc Visual::Base::DoSetOffStage()
 130    */
 131   virtual void DoSetOffStage( Actor& actor );
 132
 133   /**
 134    * @copydoc Visual::Base::OnSetTransform
 135    */
 136   virtual void OnSetTransform();
 137
 138 private:
 139   /**
 140    * @brief Set the individual property to the given value.
 141    *
 142    * @param[in] index The index key used to reference this value within the initial property map.
 143    *
 144    * @param[in] propertyValue The value to set.
 145    */
 146   void DoSetProperty( Dali::Property::Index index, const Dali::Property::Value& propertyValue );
 147
 148   /**
 149    * @brief Updates the text's renderer.
 150    * @param[in] initializeRendererAndTexture Set flag to true to initialize textures and add renderer to control.
 151    */
 152   void UpdateRenderer( bool initializeRendererAndTexture );
 153
 154   /**
 155    * @brief Removes the texture set from the renderer.
 156    */
 157   void RemoveTextureSet();
 158
 159 private:
 160   Text::ControllerPtr mController; ///< The text's controller.
 161   Text::TypesetterPtr mTypesetter; ///< The text's typesetter.
 162   WeakHandle<Actor>   mControl;    ///< The control where the renderer is added.
 163 };
 164
 165 } // namespace Internal
 166
 167 } // namespace Toolkit
 168
 169 } // namespace Dali
 170
 171 #endif /* DALI_TOOLKIT_INTERNAL_TEXT_VISUAL_H */