1 #ifndef DALI_TOOLKIT_TEXT_LABEL_H
2 #define DALI_TOOLKIT_TEXT_LABEL_H
5 * Copyright (c) 2020 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/public-api/controls/control.h>
30 namespace Internal DALI_INTERNAL
35 * @addtogroup dali_toolkit_controls_text_controls
40 * @brief A control which renders a short text string.
42 * Text labels are lightweight, non-editable and do not respond to user input.
44 * @section TextLabelProperties Properties
45 * |%Property enum |String name |Type |Writable|Animatable|
46 * |----------------------------------|---------------------|----------------|--------|----------|
47 * | Property::TEXT | text | STRING | O | X |
48 * | Property::FONT_FAMILY | fontFamily | STRING | O | X |
49 * | Property::FONT_STYLE | fontStyle | STRING or MAP | O | X |
50 * | Property::POINT_SIZE | pointSize | FLOAT | O | X |
51 * | Property::MULTI_LINE | multiLine | BOOLEAN | O | X |
52 * | Property::HORIZONTAL_ALIGNMENT | horizontalAlignment | STRING | O | X |
53 * | Property::VERTICAL_ALIGNMENT | verticalAlignment | STRING | O | X |
54 * | Property::TEXT_COLOR | textColor | VECTOR4 | O | X |
55 * | Property::ENABLE_MARKUP | enableMarkup | BOOLEAN | O | X |
56 * | Property::ENABLE_AUTO_SCROLL | enableAutoScroll | BOOLEAN | O | X |
57 * | Property::AUTO_SCROLL_SPEED | autoScrollSpeed | INTEGER | O | X |
58 * | Property::AUTO_SCROLL_LOOP_COUNT | autoScrollLoopCount | INTEGER | O | X |
59 * | Property::AUTO_SCROLL_GAP | autoScrollGap | INTEGER | O | X |
60 * | Property::SHADOW | shadow | STRING or MAP | O | X |
61 * | Property::UNDERLINE | underline | STRING or MAP | O | X |
65 class DALI_TOOLKIT_API TextLabel : public Control
70 * @brief Enumeration for the start and end property ranges for this control.
75 PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1, ///< @SINCE_1_0.0
76 PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000, ///< Reserve property indices @SINCE_1_0.0
78 ANIMATABLE_PROPERTY_START_INDEX = ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX, ///< @SINCE_1_2.60
79 ANIMATABLE_PROPERTY_END_INDEX = ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX + 1000 ///< Reserve animatable property indices @SINCE_1_2.60
83 * @brief Enumeration for the instance of properties belonging to the TextLabel class.
89 * @brief Enumeration for the instance of properties belonging to the TextLabel class.
94 ///////////////////////////////////////////////////////////////////////////////
95 // Event side (non-animatable) properties
96 ///////////////////////////////////////////////////////////////////////////////
99 * @brief The text to display in UTF-8 format.
100 * @details Name "text", type Property::STRING.
103 TEXT = PROPERTY_START_INDEX,
106 * @brief The requested font family to use.
107 * @details Name "fontFamily", type Property::STRING.
113 * @brief The requested font style to use.
114 * @details Name "fontStyle", type Property::STRING or Property::MAP.
120 * @brief The size of font in points.
121 * @details Name "pointSize", type Property::FLOAT.
122 * Conversion from Pixel size to Point size:
123 * Point size = Pixel size * 72 / DPI
129 * @brief The single-line or multi-line layout option.
130 * @details Name "multiLine", type Property::BOOLEAN.
132 * @note Default is false.
137 * @brief The line horizontal alignment.
138 * @details Name "horizontalAlignment", type Property::STRING or type HorizontalAlignment::Type (Property::INTEGER)
139 * Values "BEGIN", "CENTER", "END", default BEGIN.
140 * @note Return type is Property::STRING
143 HORIZONTAL_ALIGNMENT,
146 * @brief The line vertical alignment.
147 * @details Name "verticalAlignment", type Property::STRING or type VerticalAlignment::Type (Property::INTEGER).
148 * Values "TOP", "CENTER", "BOTTOM" @SINCE_1_0.0, default TOP.
149 * @note Return type is Property::STRING
155 * @brief Whether the mark-up processing is enabled.
156 * @details Name "enableMarkup", type Property::BOOLEAN.
158 * @note Default is false.
163 * @brief Starts or stops auto scrolling.
164 * @details Name "enableAutoScroll", type Property::BOOLEAN.
166 * @note Default is false.
171 * @brief Sets the speed of scrolling in pixels per second.
172 * @details Name "autoScrollSpeed", type Property::INT.
174 * @note Default in style sheet.
179 * @brief Number of complete loops when scrolling enabled.
180 * @details Name "autoScrollLoopCount", type Property::INT.
182 * @note Default in style sheet.
184 AUTO_SCROLL_LOOP_COUNT,
187 * @brief Gap before scrolling wraps.
188 * @details Name "autoScrollGap", type Property::INT.
190 * @note Default in style sheet but can be overridden to prevent same text being shown at start and end.
191 * @note Displayed gap size is not guaranteed if the text length plus gap exceeds the maximum texture size (i.e. GL_MAX_TEXTURE_SIZE).
196 * @brief The default extra space between lines in points.
197 * @details Name "lineSpacing", type Property::FLOAT.
203 * @brief The default underline parameters.
204 * @details Name "underline", type Property::MAP.
206 * The underline map contains the following keys:
208 * | %Property Name | Type | Required | Description |
209 * |----------------------|----------|----------|--------------------------------------------------------------------------------------------------------------------|
210 * | enable | BOOLEAN | No | True to enable the underline or false to disable (the default value is false) |
211 * | color | VECTOR4 | No | The color of the underline (the default value is Color::BLACK) |
212 * | height | FLOAT | No | The height of the underline (the default value is 0) |
219 * @brief The default shadow parameters.
220 * @details Name "shadow", type Property::MAP.
222 * The shadow map contains the following keys:
224 * | %Property Name | Type | Required | Description |
225 * |----------------------|----------|----------|--------------------------------------------------------------------------------------------------------------------|
226 * | color | VECTOR4 | No | The color of the shadow (the default value is Color::BLACK) |
227 * | offset | VECTOR2 | No | The offset from the text to draw the shadow in the X and Y axes (the default value is 0 which means no shadow) |
228 * | blurRadius | FLOAT | No | The radius of blur to be applied to the shadow (the default value is 0 which means no blur) |
235 * @brief The default emboss parameters.
236 * @details Name "emboss", type Property::MAP.
242 * @brief The default outline parameters.
243 * @details Name "outline", type Property::MAP.
245 * The outline map contains the following keys:
247 * | %Property Name | Type | Required | Description |
248 * |----------------------|----------|----------|--------------------------------------------------------------------------------------------------------------------|
249 * | color | VECTOR4 | No | The color of the outline (the default value is Color::WHITE) |
250 * | width | INTEGER | No | The width of the outline (the default value is 0 which means no outline) |
257 * @brief The size of font in pixels.
258 * @details Name "pixelSize", type Property::FLOAT.
259 * Conversion from Point size to Pixel size:
260 * Pixel size = Point size * DPI / 72
266 * @brief Whether we should show the ellipsis if required.
267 * @details Name "ellipsis", type Property::BOOLEAN.
273 * @brief The amount of time to delay the starting time of auto scrolling and further loops.
274 * @details Name "autoScrollLoopDelay", type Property::FLOAT.
277 AUTO_SCROLL_LOOP_DELAY,
280 * @brief The auto scrolling stop behaviour.
281 * @details Name "autoScrollStopMode", type AutoScrollStopMode::Type (Property::INTEGER) or Property::STRING.
283 * @note Default is AutoScrollStopMode::FINISH_LOOP.
284 * @see AutoScrollStopMode::Type
286 AUTO_SCROLL_STOP_MODE,
289 * @brief The line count of text.
290 * @details name "lineCount", type Property::INTEGER.
292 * @note This property is read-only.
297 * @brief Line wrap mode when text lines are greater than the layout width.
298 * @details Name "lineWrapMode", type Text::LineWrap::Mode (Text::Property::INTEGER) or Property::STRING.
300 * @note Default is Text::LineWrap::WORD.
301 * @note Return type is Text::LineWrap::Mode (Text::Property::INTEGER).
302 * @see Text::LineWrap
306 ///////////////////////////////////////////////////////////////////////////////
307 // Animatable Properties
308 ///////////////////////////////////////////////////////////////////////////////
311 * @brief The color of the text.
312 * @details Name "textColor", type Property::VECTOR4.
315 TEXT_COLOR = ANIMATABLE_PROPERTY_START_INDEX,
318 * @brief The red component of the text color.
319 * @details Name "textColorRed", type Property::FLOAT.
326 * @brief The green component of the text color.
327 * @details Name "textColorGreen", type Property::FLOAT.
334 * @brief The blue component of the text color.
335 * @details Name "textColorBlue", type Property::FLOAT.
342 * @brief The alpha component of the text color.
343 * @details Name "textColorAlpha", type Property::FLOAT.
352 * @brief The enumerations used for auto scroll stop mode.
354 * @see Property::AUTO_SCROLL_STOP_MODE.
356 struct AutoScrollStopMode
359 * @brief The enumerations used for auto scroll stop mode.
361 * @see Property::AUTO_SCROLL_STOP_MODE.
365 FINISH_LOOP = 0, ///< Stop animation after current loop finishes. @SINCE_1_2.60
366 IMMEDIATE ///< Stop animation immediately and reset position. @SINCE_1_2.60
371 * @brief Creates the TextLabel control.
374 * @return A handle to the TextLabel control
376 static TextLabel New();
379 * @brief Creates the TextLabel control.
382 * @param[in] text The text to display
383 * @return A handle to the TextLabel control
385 static TextLabel New( const std::string& text );
388 * @brief Creates an empty handle.
394 * @brief Copy constructor.
397 * @param[in] handle The handle to copy from
399 TextLabel( const TextLabel& handle );
402 * @brief Assignment operator.
405 * @param[in] handle The handle to copy from
406 * @return A reference to this
408 TextLabel& operator=( const TextLabel& handle );
413 * This is non-virtual since derived Handle types must not contain data or virtual methods.
419 * @brief Downcasts a handle to TextLabel.
421 * If the BaseHandle points is a TextLabel, the downcast returns a valid handle.
422 * If not, the returned handle is left empty.
425 * @param[in] handle Handle to an object
426 * @return Handle to a TextLabel or an empty handle
428 static TextLabel DownCast( BaseHandle handle );
430 public: // Not intended for application developers
434 * @brief Creates a handle using the Toolkit::Internal implementation.
437 * @param[in] implementation The Control implementation
439 DALI_INTERNAL TextLabel( Internal::TextLabel& implementation );
442 * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
445 * @param[in] internal A pointer to the internal CustomActor
447 explicit DALI_INTERNAL TextLabel( Dali::Internal::CustomActor* internal );
454 } // namespace Toolkit
458 #endif // DALI_TOOLKIT_TEXT_LABEL_H