1 #ifndef DALI_TOOLKIT_TEXT_LABEL_DEVEL_H
2 #define DALI_TOOLKIT_TEXT_LABEL_DEVEL_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/text-controls/text-label.h>
30 namespace DevelTextLabel
37 TEXT = Dali::Toolkit::TextLabel::Property::TEXT,
38 FONT_FAMILY = Dali::Toolkit::TextLabel::Property::FONT_FAMILY,
39 FONT_STYLE = Dali::Toolkit::TextLabel::Property::FONT_STYLE,
40 POINT_SIZE = Dali::Toolkit::TextLabel::Property::POINT_SIZE,
41 MULTI_LINE = Dali::Toolkit::TextLabel::Property::MULTI_LINE,
42 HORIZONTAL_ALIGNMENT = Dali::Toolkit::TextLabel::Property::HORIZONTAL_ALIGNMENT,
43 VERTICAL_ALIGNMENT = Dali::Toolkit::TextLabel::Property::VERTICAL_ALIGNMENT,
44 ENABLE_MARKUP = Dali::Toolkit::TextLabel::Property::ENABLE_MARKUP,
45 ENABLE_AUTO_SCROLL = Dali::Toolkit::TextLabel::Property::ENABLE_AUTO_SCROLL,
46 AUTO_SCROLL_SPEED = Dali::Toolkit::TextLabel::Property::AUTO_SCROLL_SPEED,
47 AUTO_SCROLL_LOOP_COUNT = Dali::Toolkit::TextLabel::Property::AUTO_SCROLL_LOOP_COUNT,
48 AUTO_SCROLL_GAP = Dali::Toolkit::TextLabel::Property::AUTO_SCROLL_GAP,
49 LINE_SPACING = Dali::Toolkit::TextLabel::Property::LINE_SPACING,
50 UNDERLINE = Dali::Toolkit::TextLabel::Property::UNDERLINE,
51 SHADOW = Dali::Toolkit::TextLabel::Property::SHADOW,
52 EMBOSS = Dali::Toolkit::TextLabel::Property::EMBOSS,
53 OUTLINE = Dali::Toolkit::TextLabel::Property::OUTLINE,
54 PIXEL_SIZE = Dali::Toolkit::TextLabel::Property::PIXEL_SIZE,
55 ELLIPSIS = Dali::Toolkit::TextLabel::Property::ELLIPSIS,
56 AUTO_SCROLL_LOOP_DELAY = Dali::Toolkit::TextLabel::Property::AUTO_SCROLL_LOOP_DELAY,
57 AUTO_SCROLL_STOP_MODE = Dali::Toolkit::TextLabel::Property::AUTO_SCROLL_STOP_MODE,
58 LINE_COUNT = Dali::Toolkit::TextLabel::Property::LINE_COUNT,
59 LINE_WRAP_MODE = Dali::Toolkit::TextLabel::Property::LINE_WRAP_MODE,
62 * @brief The direction of the layout.
63 * @details Name "textDirection", type [Type](@ref Dali::Toolkit::DevelText::TextDirection::Type) (Property::INTEGER), Read/Write
64 * @note The text direction can be changed only by replacing the text itself.
65 * @see TextDirection::Type for supported values.
70 * @brief Alignment of text within area of single line
71 * @details Name "verticalLineAlignment", type [Type](@ref Dali::Toolkit::DevelText::VerticalLineAlignment::Type) (Property::INTEGER), Read/Write
72 * @note The default value is TOP
73 * @see VerticalLineAlignment::Type for supported values
75 VERTICAL_LINE_ALIGNMENT,
78 * @brief The default text background parameters.
79 * @details Name "textBackground", type Property::MAP.
80 * @note Use "textBackground" as property name to avoid conflict with Control's "background" property
82 * The background map contains the following keys:
84 * | %Property Name | Type | Required | Description |
85 * |----------------------|----------|----------|--------------------------------------------------------------------------------------------------------------------|
86 * | enable | BOOLEAN | No | True to enable the background or false to disable (the default value is false) |
87 * | color | VECTOR4 | No | The color of the background (the default value is Color::CYAN) |
92 * @brief Ignore spaces after text.
93 * @details Name "ignoreSpacesAfterText", type (Property::BOLEAN), Read/Write
94 * @note The default value is true
96 IGNORE_SPACES_AFTER_TEXT,
99 * @brief Modifies the default text alignment to match the direction of the system language.
100 * @details Name "matchSystemLanguageDirection", type (Property::BOLEAN), Read/Write
101 * @note The default value is false
103 * If MATCH_SYSTEM_LANGUAGE_DIRECTION property set true, the default text alignment to match the direction of the system language.
105 * ex) Current system language direction LTR.
106 * TextLabel::New("Hello world \n ﻡﺮﺤﺑﺍ. ");
107 * TextLabel::Property::HORIZONTAL_ALIGNMENT, "END"
109 * | TextLabel::Property::MATCH_SYSTEM_LANGUAGE_DIRECTION |
110 * |-----------------------------------------------------------------------
111 * | false (default) | true |
112 * |-----------------------------------|----------------------------------|
113 * | Hello world | Hello world |
114 * | ﻡﺮﺤﺑﺍ. | ﻡﺮﺤﺑﺍ. |
117 MATCH_SYSTEM_LANGUAGE_DIRECTION,
120 * @brief The text fit parameters.
121 * @details Name "textFit", type Property::MAP.
122 * @note The default value is false
124 * The textFit map contains the following keys:
126 * | %Property Name | Type | Required | Description |
127 * |----------------------|----------|----------|--------------------------------------------------------------------------------------------------------------------|
128 * | enable | BOOLEAN | No | True to enable the text fit or false to disable (the default value is false) |
129 * | minSize | FLOAT | No | Minimum Size for text fit (the default value is 10.f) |
130 * | maxSize | FLOAT | No | Maximum Size for text fit (the default value is 100.f) |
131 * | stepSize | FLOAT | No | Step Size for font increase (the default value is 1.f) |
132 * | fontSizeType | STRING | No | The size type of font, You can choose between "pointSize" or "pixelSize". (the default value is "pointSize") |
137 * @brief Sets the height of the line in points.
138 * @details Name "lineSize", type Property::FLOAT.
139 * @note If the font size is larger than the line size, it works with the font size.
144 * @brief The type of rendering e.g. bitmap-based.
145 * @details Name "renderingBackend", type Property::INT.
150 } // namespace Property
152 } // namespace DevelTextLabel
154 } // namespace Toolkit
158 #endif // DALI_TOOLKIT_TEXT_LABEL_DEVEL_H