1 #ifndef __DALI_TOOLKIT_TEXT_LABEL_H__
2 #define __DALI_TOOLKIT_TEXT_LABEL_H__
5 * Copyright (c) 2015 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 | 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 | O | X |
62 * | Property::UNDERLINE | underline | STRING | O | X |
66 class DALI_IMPORT_API TextLabel : public Control
71 * @brief 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 An enumeration of properties belonging to the TextLabel class.
89 * @brief The type of rendering e.g. bitmap-based
90 * @details name "renderingBackend", type INT, default RENDERING_SHARED_ATLAS
93 RENDERING_BACKEND = PROPERTY_START_INDEX,
96 * @brief The text to display in UTF-8 format,
97 * @details name "text", type STRING
103 * @brief The requested font family to use,
104 * @details name "fontFamily", type STRING
110 * @brief The requested font style to use,
111 * @details name "fontStyle", type STRING
117 * @brief The size of font in points
118 * @details name "pointSize", type FLOAT
124 * @brief The single-line or multi-line layout option
125 * @details name "multiLine", type FLOAT, default SINGLE_LINE_BOX
131 * @brief The line horizontal alignment
132 * @details name "horizontalAlignment", type STRING, values "BEGIN", "CENTER", "END", default BEGIN
135 HORIZONTAL_ALIGNMENT,
138 * @brief The line vertical alignment
139 * @details name "verticalAlignment", type STRING, values "TOP", "CENTER", "BOTTOM" @SINCE_1_0.0, default TOP
145 * @brief The color of the text
146 * @details name "textColor", type VECTOR4
152 * @brief The drop shadow offset 0 indicates no shadow
153 * @details name "shadowOffset", type VECTOR4
154 * @DEPRECATED_1_1.37 Use SHADOW instead
159 * @brief The color of a drop shadow
160 * @details name "shadowColor", type VECTOR4
161 * @DEPRECATED_1_1.37 Use SHADOW instead
166 * @brief The underline enabled flag
167 * @details name "underlineEnabled", type BOOLEAN
168 * @DEPRECATED_1_1.37 Use UNDERLINE instead
173 * @brief The color of the underline
174 * @details name "underlineColor", type VECTOR4
175 * @DEPRECATED_1_1.37 Use UNDERLINE instead
180 * @brief Overrides the underline height from font metrics
181 * @details name "underlineHeight", type FLOAT
182 * @DEPRECATED_1_1.37 Use UNDERLINE instead
187 * @brief Whether the mark-up processing is enabled
188 * @details name "enableMarkup", type BOOLEAN
194 * @brief Start or stop auto scrolling,
195 * @details name "enableMarkup", type BOOLEAN, default is false
201 * @brief Start or stop auto scrolling,
202 * @details name "autoScrollSpeed", type INT, default in style sheet
208 * @brief Number of complete loops when scrolling enabled
209 * @details name "autoScrollLoopCount", type INT, default in style sheet
212 AUTO_SCROLL_LOOP_COUNT,
215 * @brief Gap before before scrolling wraps
216 * @details name "autoScrollGap", type INT, default in style sheet but can be overridden to prevent same text being show at start and end.
222 * @brief The default extra space between lines in points.
223 * @details name "lineSpacing", type FLOAT.
229 * @brief The default underline parameters.
230 * @details name "underline", type STRING.
236 * @brief The default shadow parameters.
237 * @details name "shadow", type STRING.
243 * @brief The default emboss parameters.
244 * @details name "emboss", type STRING.
250 * @brief The default outline parameters.
251 * @details name "outline", type STRING.
259 * @brief Create the TextLabel control.
262 * @return A handle to the TextLabel control.
264 static TextLabel New();
267 * @brief Create the TextLabel control.
270 * @param[in] text The text to display.
271 * @return A handle to the TextLabel control.
273 static TextLabel New( const std::string& text );
276 * @brief Creates an empty handle.
282 * @brief Copy constructor.
285 * @param[in] handle The handle to copy from.
287 TextLabel( const TextLabel& handle );
290 * @brief Assignment operator.
293 * @param[in] handle The handle to copy from.
294 * @return A reference to this.
296 TextLabel& operator=( const TextLabel& handle );
301 * This is non-virtual since derived Handle types must not contain data or virtual methods.
307 * @brief Downcast a handle to TextLabel.
309 * If the BaseHandle points is a TextLabel the downcast returns a valid handle.
310 * If not the returned handle is left empty.
313 * @param[in] handle Handle to an object
314 * @return handle to a TextLabel or an empty handle
316 static TextLabel DownCast( BaseHandle handle );
318 public: // Not intended for application developers
321 * @brief Creates a handle using the Toolkit::Internal implementation.
324 * @param[in] implementation The Control implementation.
326 DALI_INTERNAL TextLabel( Internal::TextLabel& implementation );
329 * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
332 * @param[in] internal A pointer to the internal CustomActor.
334 explicit DALI_INTERNAL TextLabel( Dali::Internal::CustomActor* internal );
340 } // namespace Toolkit
344 #endif // __DALI_TOOLKIT_TEXT_LABEL_H__