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
36 * @brief A control which renders a short text string.
38 * Text labels are lightweight, non-editable and do not respond to user input.
40 class DALI_IMPORT_API TextLabel : public Control
45 * @brief The start and end property ranges for this control.
49 PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1,
50 PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000 ///< Reserve property indices
54 * @brief An enumeration of properties belonging to the TextLabel class.
60 RENDERING_BACKEND = PROPERTY_START_INDEX, ///< name "rendering-backend", The type or rendering e.g. bitmap-based, type INT
61 TEXT, ///< name "text", The text to display in UTF-8 format, type STRING
62 FONT_FAMILY, ///< name "font-family", The requested font family, type STRING
63 FONT_STYLE, ///< name "font-style", The requested font style e.g. Regular/Italic, type STRING
64 POINT_SIZE, ///< name "point-size", The size of font in points, type FLOAT
65 MULTI_LINE, ///< name "multi-line", The single-line or multi-line layout option, type BOOLEAN
66 HORIZONTAL_ALIGNMENT, ///< name "horizontal-alignment", The line horizontal alignment, type STRING, values "BEGIN", "CENTER", "END"
67 VERTICAL_ALIGNMENT, ///< name "vertical-alignment", The line vertical alignment, type STRING, values "TOP", "CENTER", "BOTTOM"
68 TEXT_COLOR, ///< name "text-color", The text color, type VECTOR4
69 SHADOW_OFFSET, ///< name "shadow-offset", The drop shadow offset 0 indicates no shadow, type VECTOR2
70 SHADOW_COLOR, ///< name "shadow-color", The color of a drop shadow, type VECTOR4
71 UNDERLINE_ENABLED, ///< name "underline-enabled", The underline enabled flag type BOOLEAN
72 UNDERLINE_COLOR, ///< name "underline-color", The color of the underline type VECTOR4
77 * @brief Create the TextLabel control.
79 * @return A handle to the TextLabel control.
81 static TextLabel New();
84 * @brief Create the TextLabel control.
86 * @param[in] text The text to display.
87 * @return A handle to the TextLabel control.
89 static TextLabel New( const std::string& text );
92 * @brief Creates an empty handle.
97 * @brief Copy constructor.
99 * @param[in] handle The handle to copy from.
101 TextLabel( const TextLabel& handle );
104 * @brief Assignment operator.
106 * @param[in] handle The handle to copy from.
107 * @return A reference to this.
109 TextLabel& operator=( const TextLabel& handle );
114 * This is non-virtual since derived Handle types must not contain data or virtual methods.
119 * @brief Downcast a handle to TextLabel.
121 * If the BaseHandle points is a TextLabel the downcast returns a valid handle.
122 * If not the returned handle is left empty.
124 * @param[in] handle Handle to an object
125 * @return handle to a TextLabel or an empty handle
127 static TextLabel DownCast( BaseHandle handle );
129 public: // Not intended for application developers
132 * @brief Creates a handle using the Toolkit::Internal implementation.
134 * @param[in] implementation The Control implementation.
136 DALI_INTERNAL TextLabel( Internal::TextLabel& implementation );
139 * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
141 * @param[in] internal A pointer to the internal CustomActor.
143 explicit DALI_INTERNAL TextLabel( Dali::Internal::CustomActor* internal );
146 } // namespace Toolkit
150 #endif // __DALI_TOOLKIT_TEXT_LABEL_H__