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.
45 class DALI_IMPORT_API TextLabel : public Control
50 * @brief The start and end property ranges for this control.
55 PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1, ///< @SINCE_1_0.0
56 PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000 ///< Reserve property indices @SINCE_1_0.0
60 * @brief An enumeration of properties belonging to the TextLabel class.
67 RENDERING_BACKEND = PROPERTY_START_INDEX, ///< name "renderingBackend", The type or rendering e.g. bitmap-based, type INT @SINCE_1_0.0
68 TEXT, ///< name "text", The text to display in UTF-8 format, type STRING @SINCE_1_0.0
69 FONT_FAMILY, ///< name "fontFamily", The requested font family, type STRING @SINCE_1_0.0
70 FONT_STYLE, ///< name "fontStyle", The requested font style, type STRING @SINCE_1_0.0
71 POINT_SIZE, ///< name "pointSize", The size of font in points, type FLOAT @SINCE_1_0.0
72 MULTI_LINE, ///< name "multiLine", The single-line or multi-line layout option, type BOOLEAN @SINCE_1_0.0
73 HORIZONTAL_ALIGNMENT, ///< name "horizontalAlignment", The line horizontal alignment, type STRING, values "BEGIN", "CENTER", "END" @SINCE_1_0.0
74 VERTICAL_ALIGNMENT, ///< name "verticalAlignment", The line vertical alignment, type STRING, values "TOP", "CENTER", "BOTTOM" @SINCE_1_0.0
75 TEXT_COLOR, ///< name "textColor", The text color, type VECTOR4 @SINCE_1_0.0
76 SHADOW_OFFSET, ///< name "shadowOffset", The drop shadow offset 0 indicates no shadow, type VECTOR2 @SINCE_1_0.0
77 SHADOW_COLOR, ///< name "shadowColor", The color of a drop shadow, type VECTOR4 @SINCE_1_0.0
78 UNDERLINE_ENABLED, ///< name "underlineEnabled", The underline enabled flag, type BOOLEAN @SINCE_1_0.0
79 UNDERLINE_COLOR, ///< name "underlineColor", The color of the underline, type VECTOR4 @SINCE_1_0.0
80 UNDERLINE_HEIGHT, ///< name "underlineHeight", Overrides the underline height from font metrics, type FLOAT @SINCE_1_0.0
81 ENABLE_MARKUP ///< name "enableMarkup", Whether the mark-up processing is enabled. type BOOLEAN @SINCE_1_0.0
86 * @brief Create the TextLabel control.
89 * @return A handle to the TextLabel control.
91 static TextLabel New();
94 * @brief Create the TextLabel control.
97 * @param[in] text The text to display.
98 * @return A handle to the TextLabel control.
100 static TextLabel New( const std::string& text );
103 * @brief Creates an empty handle.
109 * @brief Copy constructor.
112 * @param[in] handle The handle to copy from.
114 TextLabel( const TextLabel& handle );
117 * @brief Assignment operator.
120 * @param[in] handle The handle to copy from.
121 * @return A reference to this.
123 TextLabel& operator=( const TextLabel& handle );
128 * This is non-virtual since derived Handle types must not contain data or virtual methods.
134 * @brief Downcast a handle to TextLabel.
136 * If the BaseHandle points is a TextLabel the downcast returns a valid handle.
137 * If not the returned handle is left empty.
140 * @param[in] handle Handle to an object
141 * @return handle to a TextLabel or an empty handle
143 static TextLabel DownCast( BaseHandle handle );
145 public: // Not intended for application developers
148 * @brief Creates a handle using the Toolkit::Internal implementation.
151 * @param[in] implementation The Control implementation.
153 DALI_INTERNAL TextLabel( Internal::TextLabel& implementation );
156 * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
159 * @param[in] internal A pointer to the internal CustomActor.
161 explicit DALI_INTERNAL TextLabel( Dali::Internal::CustomActor* internal );
167 } // namespace Toolkit
171 #endif // __DALI_TOOLKIT_TEXT_LABEL_H__