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 |
63 * | batchingEnabled | BOOLEAN |
66 class TextVisual : public Visual::Base
71 * @brief Create a new text visual.
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.
77 static TextVisualPtr New( VisualFactoryCache& factoryCache, const Property::Map& properties );
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.
83 static void ConvertStringKeysToIndexKeys( Property::Map& propertyMap );
85 public: // from Visual::Base
88 * @copydoc Visual::Base::GetHeightForWidth()
90 virtual float GetHeightForWidth( float width );
93 * @copydoc Visual::Base::GetNaturalSize()
95 virtual void GetNaturalSize( Vector2& naturalSize );
98 * @copydoc Visual::Base::CreatePropertyMap()
100 virtual void DoCreatePropertyMap( Property::Map& map ) const;
105 * @brief Constructor.
107 * @param[in] factoryCache The VisualFactoryCache object
109 TextVisual( VisualFactoryCache& factoryCache );
112 * @brief A reference counted object may only be deleted by calling Unreference().
114 virtual ~TextVisual();
119 * @copydoc Visual::Base::DoSetProperties()
121 virtual void DoSetProperties( const Property::Map& propertyMap );
124 * @copydoc Visual::Base::DoSetOnStage()
126 virtual void DoSetOnStage( Actor& actor );
129 * @copydoc Visual::Base::DoSetOffStage()
131 virtual void DoSetOffStage( Actor& actor );
134 * @copydoc Visual::Base::OnSetTransform
136 virtual void OnSetTransform();
140 * @brief Set the individual property to the given value.
142 * @param[in] index The index key used to reference this value within the initial property map.
144 * @param[in] propertyValue The value to set.
146 void DoSetProperty( Dali::Property::Index index, const Dali::Property::Value& propertyValue );
149 * @brief Updates the text's renderer.
150 * @param[in] initializeRendererAndTexture Set flag to true to initialize textures and add renderer to control.
152 void UpdateRenderer( bool initializeRendererAndTexture );
155 * @brief Removes the texture set from the renderer.
157 void RemoveTextureSet();
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.
165 } // namespace Internal
167 } // namespace Toolkit
171 #endif /* DALI_TOOLKIT_INTERNAL_TEXT_VISUAL_H */