1 #ifndef __DALI_TOOLKIT_TEXT_LABEL_H__
2 #define __DALI_TOOLKIT_TEXT_LABEL_H__
5 * Copyright (c) 2017 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::RENDERING_BACKEND | renderingBackend | INTEGER | O | X |
48 * | Property::TEXT | text | STRING | O | X |
49 * | Property::FONT_FAMILY | fontFamily | STRING | O | X |
50 * | Property::FONT_STYLE | fontStyle | STRING or MAP | O | X |
51 * | Property::POINT_SIZE | pointSize | FLOAT | O | X |
52 * | Property::MULTI_LINE | multiLine | BOOLEAN | O | X |
53 * | Property::HORIZONTAL_ALIGNMENT | horizontalAlignment | STRING | O | X |
54 * | Property::VERTICAL_ALIGNMENT | verticalAlignment | STRING | O | X |
55 * | Property::TEXT_COLOR | textColor | VECTOR4 | O | X |
56 * | Property::ENABLE_MARKUP | enableMarkup | BOOLEAN | O | X |
57 * | Property::ENABLE_AUTO_SCROLL | enableAutoScroll | BOOLEAN | O | X |
58 * | Property::AUTO_SCROLL_SPEED | autoScrollSpeed | INTEGER | O | X |
59 * | Property::AUTO_SCROLL_LOOP_COUNT | autoScrollLoopCount | INTEGER | O | X |
60 * | Property::AUTO_SCROLL_GAP | autoScrollGap | INTEGER | O | X |
61 * | Property::SHADOW | shadow | STRING or MAP | O | X |
62 * | Property::UNDERLINE | underline | STRING or MAP | O | X |
66 class DALI_IMPORT_API TextLabel : public Control
71 * @brief Enumeration for the start and end property ranges for this control.
76 PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1, ///< @SINCE_1_0.0
77 PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000 ///< Reserve property indices @SINCE_1_0.0
81 * @brief Enumeration for the instance of properties belonging to the TextLabel class.
87 * @brief Enumeration for the instance of properties belonging to the TextLabel class.
93 * DEPRECATED_1_2.53 No longer be supported and will be ignored.
94 * @brief The type of rendering e.g. bitmap-based.
95 * @details name "renderingBackend", type INT, default RENDERING_SHARED_ATLAS.
98 RENDERING_BACKEND = PROPERTY_START_INDEX,
101 * @brief The text to display in UTF-8 format.
102 * @details name "text", type STRING.
108 * @brief The requested font family to use.
109 * @details name "fontFamily", type STRING.
115 * @brief The requested font style to use.
116 * @details name "fontStyle", type STRING or MAP.
122 * @brief The size of font in points.
124 * Conversion from Pixel size to Point size :
125 * Point size = Pixel size * 72 / DPI
126 * @details name "pointSize", type FLOAT.
132 * @brief The single-line or multi-line layout option.
133 * @details name "multiLine", type BOOLEAN, default false.
139 * @brief The line horizontal alignment.
140 * @details name "horizontalAlignment", type STRING, values "BEGIN", "CENTER", "END", default BEGIN.
143 HORIZONTAL_ALIGNMENT,
146 * @brief The line vertical alignment.
147 * @details name "verticalAlignment", type STRING, values "TOP", "CENTER", "BOTTOM" @SINCE_1_0.0, default TOP.
153 * @brief The color of the text.
154 * @details name "textColor", type VECTOR4.
160 * @DEPRECATED_1_1.37 Use SHADOW instead
161 * @brief The drop shadow offset 0 indicates no shadow.
162 * @details name "shadowOffset", type VECTOR2.
167 * @DEPRECATED_1_1.37 Use SHADOW instead
168 * @brief The color of a drop shadow.
169 * @details name "shadowColor", type VECTOR4
174 * @DEPRECATED_1_1.37 Use UNDERLINE instead
175 * @brief The underline enabled flag.
176 * @details name "underlineEnabled", type BOOLEAN.
181 * @DEPRECATED_1_1.37 Use UNDERLINE instead
182 * @brief The color of the underline.
183 * @details name "underlineColor", type VECTOR4.
188 * @DEPRECATED_1_1.37 Use UNDERLINE instead
189 * @brief Overrides the underline height from font metrics.
190 * @details name "underlineHeight", type FLOAT.
195 * @brief Whether the mark-up processing is enabled.
196 * @details name "enableMarkup", type BOOLEAN.
202 * @brief Starts or stops auto scrolling.
203 * @details name "enableAutoScroll", type BOOLEAN, default is false.
209 * @brief Sets the speed of scrolling in pixels per second.
210 * @details name "autoScrollSpeed", type INT, default in style sheet.
216 * @brief Number of complete loops when scrolling enabled.
217 * @details name "autoScrollLoopCount", type INT, default in style sheet.
220 AUTO_SCROLL_LOOP_COUNT,
223 * @brief Gap before scrolling wraps.
224 * @details name "autoScrollGap", type INT, default in style sheet but can be overridden to prevent same text being shown at start and end.
230 * @brief The default extra space between lines in points.
231 * @details name "lineSpacing", type FLOAT.
237 * @brief The default underline parameters.
238 * @details name "underline", type MAP.
244 * @brief The default shadow parameters.
245 * @details name "shadow", type MAP.
251 * @brief The default emboss parameters.
252 * @details name "emboss", type MAP.
258 * @brief The default outline parameters.
259 * @details name "outline", type MAP.
267 * @brief Creates the TextLabel control.
270 * @return A handle to the TextLabel control
272 static TextLabel New();
275 * @brief Creates the TextLabel control.
278 * @param[in] text The text to display
279 * @return A handle to the TextLabel control
281 static TextLabel New( const std::string& text );
284 * @brief Creates an empty handle.
290 * @brief Copy constructor.
293 * @param[in] handle The handle to copy from
295 TextLabel( const TextLabel& handle );
298 * @brief Assignment operator.
301 * @param[in] handle The handle to copy from
302 * @return A reference to this
304 TextLabel& operator=( const TextLabel& handle );
309 * This is non-virtual since derived Handle types must not contain data or virtual methods.
315 * @brief Downcasts a handle to TextLabel.
317 * If the BaseHandle points is a TextLabel, the downcast returns a valid handle.
318 * If not, the returned handle is left empty.
321 * @param[in] handle Handle to an object
322 * @return Handle to a TextLabel or an empty handle
324 static TextLabel DownCast( BaseHandle handle );
326 public: // Not intended for application developers
330 * @brief Creates a handle using the Toolkit::Internal implementation.
333 * @param[in] implementation The Control implementation
335 DALI_INTERNAL TextLabel( Internal::TextLabel& implementation );
338 * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
341 * @param[in] internal A pointer to the internal CustomActor
343 explicit DALI_INTERNAL TextLabel( Dali::Internal::CustomActor* internal );
350 } // namespace Toolkit
354 #endif // __DALI_TOOLKIT_TEXT_LABEL_H__