1 #ifndef DALI_TOOLKIT_INTERNAL_TEXT_VISUAL_H
2 #define DALI_TOOLKIT_INTERNAL_TEXT_VISUAL_H
5 * Copyright (c) 2016 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
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>
36 typedef IntrusivePtr< TextVisual > TextVisualPtr;
39 * The visual which renders text
41 * The following properties are optional:
43 * | %Property Name | Type |
44 * |---------------------|---------|
45 * | renderingBackend | INTEGER |
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 |
62 * | outline | STRING |
65 class TextVisual : public Visual::Base
70 * @brief Create a new text visual.
72 * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
73 * @param[in] properties A Property::Map containing settings for this visual
74 * @return A smart-pointer to the newly allocated visual.
76 static TextVisualPtr New( VisualFactoryCache& factoryCache, const Property::Map& properties );
79 * @brief Converts all strings keys in property map to index keys. Property Map can then be merged correctly.
80 * @param[in,out] propertyMap containing string keys or a mix of strings and indexes. Will be changed to index keys.
82 static void ConvertStringKeysToIndexKeys( Property::Map& propertyMap );
84 public: // from Visual::Base
87 * @copydoc Visual::Base::GetHeightForWidth()
89 virtual float GetHeightForWidth( float width );
92 * @copydoc Visual::Base::GetNaturalSize()
94 virtual void GetNaturalSize( Vector2& naturalSize );
97 * @copydoc Visual::Base::CreatePropertyMap()
99 virtual void DoCreatePropertyMap( Property::Map& map ) const;
102 * @copydoc Visual::Base::CreateInstancePropertyMap
104 virtual void DoCreateInstancePropertyMap( Property::Map& map ) const;
109 * @brief Constructor.
111 * @param[in] factoryCache The VisualFactoryCache object
113 TextVisual( VisualFactoryCache& factoryCache );
116 * @brief A reference counted object may only be deleted by calling Unreference().
118 virtual ~TextVisual();
123 * @copydoc Visual::Base::DoSetProperties()
125 virtual void DoSetProperties( const Property::Map& propertyMap );
128 * @copydoc Visual::Base::DoSetOnStage()
130 virtual void DoSetOnStage( Actor& actor );
133 * @copydoc Visual::Base::DoSetOffStage()
135 virtual void DoSetOffStage( Actor& actor );
138 * @copydoc Visual::Base::OnSetTransform
140 virtual void OnSetTransform();
144 * @brief Set the individual property to the given value.
146 * @param[in] index The index key used to reference this value within the initial property map.
148 * @param[in] propertyValue The value to set.
150 void DoSetProperty( Dali::Property::Index index, const Dali::Property::Value& propertyValue );
153 * @brief Updates the text's renderer.
154 * @param[in] initializeRendererAndTexture Set flag to true to initialize textures and add renderer to control.
156 void UpdateRenderer( bool initializeRendererAndTexture );
159 * @brief Removes the texture set from the renderer.
161 void RemoveTextureSet();
164 Text::ControllerPtr mController; ///< The text's controller.
165 Text::TypesetterPtr mTypesetter; ///< The text's typesetter.
166 WeakHandle<Actor> mControl; ///< The control where the renderer is added.
169 } // namespace Internal
171 } // namespace Toolkit
175 #endif /* DALI_TOOLKIT_INTERNAL_TEXT_VISUAL_H */