1 #ifndef DALI_TOOLKIT_TEXT_FIELD_DEVEL_H
2 #define DALI_TOOLKIT_TEXT_FIELD_DEVEL_H
5 * Copyright (c) 2022 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.
21 #include <dali/devel-api/adaptor-framework/input-method-context.h>
24 #include <dali-toolkit/public-api/controls/text-controls/input-filter-properties.h>
25 #include <dali-toolkit/public-api/controls/text-controls/text-field.h>
31 namespace DevelTextField
37 TEXT = Dali::Toolkit::TextField::Property::TEXT,
38 PLACEHOLDER_TEXT = Dali::Toolkit::TextField::Property::PLACEHOLDER_TEXT,
39 PLACEHOLDER_TEXT_FOCUSED = Dali::Toolkit::TextField::Property::PLACEHOLDER_TEXT_FOCUSED,
40 FONT_FAMILY = Dali::Toolkit::TextField::Property::FONT_FAMILY,
41 FONT_STYLE = Dali::Toolkit::TextField::Property::FONT_STYLE,
42 POINT_SIZE = Dali::Toolkit::TextField::Property::POINT_SIZE,
43 MAX_LENGTH = Dali::Toolkit::TextField::Property::MAX_LENGTH,
44 EXCEED_POLICY = Dali::Toolkit::TextField::Property::EXCEED_POLICY,
45 HORIZONTAL_ALIGNMENT = Dali::Toolkit::TextField::Property::HORIZONTAL_ALIGNMENT,
46 VERTICAL_ALIGNMENT = Dali::Toolkit::TextField::Property::VERTICAL_ALIGNMENT,
47 TEXT_COLOR = Dali::Toolkit::TextField::Property::TEXT_COLOR,
48 PLACEHOLDER_TEXT_COLOR = Dali::Toolkit::TextField::Property::PLACEHOLDER_TEXT_COLOR,
49 PRIMARY_CURSOR_COLOR = Dali::Toolkit::TextField::Property::PRIMARY_CURSOR_COLOR,
50 SECONDARY_CURSOR_COLOR = Dali::Toolkit::TextField::Property::SECONDARY_CURSOR_COLOR,
51 ENABLE_CURSOR_BLINK = Dali::Toolkit::TextField::Property::ENABLE_CURSOR_BLINK,
52 CURSOR_BLINK_INTERVAL = Dali::Toolkit::TextField::Property::CURSOR_BLINK_INTERVAL,
53 CURSOR_BLINK_DURATION = Dali::Toolkit::TextField::Property::CURSOR_BLINK_DURATION,
54 CURSOR_WIDTH = Dali::Toolkit::TextField::Property::CURSOR_WIDTH,
55 GRAB_HANDLE_IMAGE = Dali::Toolkit::TextField::Property::GRAB_HANDLE_IMAGE,
56 GRAB_HANDLE_PRESSED_IMAGE = Dali::Toolkit::TextField::Property::GRAB_HANDLE_PRESSED_IMAGE,
57 SCROLL_THRESHOLD = Dali::Toolkit::TextField::Property::SCROLL_THRESHOLD,
58 SCROLL_SPEED = Dali::Toolkit::TextField::Property::SCROLL_SPEED,
59 SELECTION_HANDLE_IMAGE_LEFT = Dali::Toolkit::TextField::Property::SELECTION_HANDLE_IMAGE_LEFT,
60 SELECTION_HANDLE_IMAGE_RIGHT = Dali::Toolkit::TextField::Property::SELECTION_HANDLE_IMAGE_RIGHT,
61 SELECTION_HANDLE_PRESSED_IMAGE_LEFT = Dali::Toolkit::TextField::Property::SELECTION_HANDLE_PRESSED_IMAGE_LEFT,
62 SELECTION_HANDLE_PRESSED_IMAGE_RIGHT = Dali::Toolkit::TextField::Property::SELECTION_HANDLE_PRESSED_IMAGE_RIGHT,
63 SELECTION_HANDLE_MARKER_IMAGE_LEFT = Dali::Toolkit::TextField::Property::SELECTION_HANDLE_MARKER_IMAGE_LEFT,
64 SELECTION_HANDLE_MARKER_IMAGE_RIGHT = Dali::Toolkit::TextField::Property::SELECTION_HANDLE_MARKER_IMAGE_RIGHT,
65 SELECTION_HIGHLIGHT_COLOR = Dali::Toolkit::TextField::Property::SELECTION_HIGHLIGHT_COLOR,
66 DECORATION_BOUNDING_BOX = Dali::Toolkit::TextField::Property::DECORATION_BOUNDING_BOX,
67 INPUT_METHOD_SETTINGS = Dali::Toolkit::TextField::Property::INPUT_METHOD_SETTINGS,
68 INPUT_COLOR = Dali::Toolkit::TextField::Property::INPUT_COLOR,
69 ENABLE_MARKUP = Dali::Toolkit::TextField::Property::ENABLE_MARKUP,
70 INPUT_FONT_FAMILY = Dali::Toolkit::TextField::Property::INPUT_FONT_FAMILY,
71 INPUT_FONT_STYLE = Dali::Toolkit::TextField::Property::INPUT_FONT_STYLE,
72 INPUT_POINT_SIZE = Dali::Toolkit::TextField::Property::INPUT_POINT_SIZE,
73 UNDERLINE = Dali::Toolkit::TextField::Property::UNDERLINE,
74 INPUT_UNDERLINE = Dali::Toolkit::TextField::Property::INPUT_UNDERLINE,
75 SHADOW = Dali::Toolkit::TextField::Property::SHADOW,
76 INPUT_SHADOW = Dali::Toolkit::TextField::Property::INPUT_SHADOW,
77 EMBOSS = Dali::Toolkit::TextField::Property::EMBOSS,
78 INPUT_EMBOSS = Dali::Toolkit::TextField::Property::INPUT_EMBOSS,
79 OUTLINE = Dali::Toolkit::TextField::Property::OUTLINE,
80 INPUT_OUTLINE = Dali::Toolkit::TextField::Property::INPUT_OUTLINE,
81 HIDDEN_INPUT_SETTINGS = Dali::Toolkit::TextField::Property::HIDDEN_INPUT_SETTINGS,
82 PIXEL_SIZE = Dali::Toolkit::TextField::Property::PIXEL_SIZE,
83 ENABLE_SELECTION = Dali::Toolkit::TextField::Property::ENABLE_SELECTION,
84 PLACEHOLDER = Dali::Toolkit::TextField::Property::PLACEHOLDER,
85 ELLIPSIS = Dali::Toolkit::TextField::Property::ELLIPSIS,
88 * @brief Enables Text selection using Shift key.
89 * @details Name "enableShiftSelection", type Property::BOOLEAN.
91 ENABLE_SHIFT_SELECTION = ELLIPSIS + 1,
94 * @brief Enables the grab handles for text selection.
95 * @details Name "enableGrabHandle", type Property::BOOLEAN.
96 * @note The default value is true, which means the grab handles are enabled by default.
98 ENABLE_GRAB_HANDLE = ELLIPSIS + 2,
101 * @brief Modifies the default text alignment to match the direction of the system language.
102 * @details Name "matchSystemLanguageDirection", type (Property::BOOLEAN), Read/Write
103 * @note The default value is true
105 MATCH_SYSTEM_LANGUAGE_DIRECTION = ELLIPSIS + 3,
108 * @brief Enables the grab handle popup for text selection.
109 * @details Name "enableGrabHandlePopup", type Property::BOOLEAN.
110 * @note The default value is true, which means the grab handle popup is enabled by default.
112 ENABLE_GRAB_HANDLE_POPUP = ELLIPSIS + 4,
115 * @brief The default text background parameters.
116 * @details Name "textBackground", type Property::VECTOR4.
117 * @note Use "textBackground" as property name to avoid conflict with Control's "background" property.
118 * @note The default value is Color::TRANSPARENT.
120 BACKGROUND = ELLIPSIS + 5,
123 * @brief The selected text in UTF-8 format.
124 * @details Name "selectedText", type Property::STRING.
125 * @note This property is read-only.
127 SELECTED_TEXT = ELLIPSIS + 6,
130 * @brief The type or rendering e.g. bitmap-based.
131 * @details Name "renderingBackend", type Property::INTEGER.
133 RENDERING_BACKEND = ELLIPSIS + 7,
136 * @brief The selected text start position.
137 * @details Name "selectedTextStart", type Property::INTEGER.
142 * @brief The selected text range end position.
143 * @details Name "selectedTextEnd", type Property::INTEGER.
148 * @brief The Editable state of control.
149 * @details Name "enableEditing", type Property::BOOLEAN.
154 * @brief The font size scale.
155 * @details name "fontSizeScale", type Property::FLOAT.
156 * @note The default value is 1.0 which does nothing.
157 * The given font size scale value is used for multiplying the specified font size before querying fonts.
159 * e.g. The rendering results of both cases are same.
160 * - fontSize: 15pt, fontSizeScale: 1.0
161 * - fontSize: 10pt, fontSizeScale: 1.5
166 * @brief True to enable the font size scale or false to disable.
167 * @details Name "enableFontSizeScale", type Property::BOOLEAN.
168 * @note The default value is true.
169 * If false, font size scale is not apppied.
171 ENABLE_FONT_SIZE_SCALE,
174 * @brief The position for primary cursor.
175 * @details Name "primaryCursorPosition", type Property::INTEGER.
177 PRIMARY_CURSOR_POSITION,
180 * @brief The color of the grab color.
181 * @details Name "grabHandleColor", type Property::VECTOR4.
186 * @brief The input filter
187 * @details Name "inputFilter", type Property::MAP.
189 * The inputFilter map contains the following keys:
191 * | %Property Name | Type | Required | Description |
192 * |----------------------|----------|----------|---------------------------------------------------------------------------------------------------------------------|
193 * | accepted | STRING | No | A regular expression in the set of characters to be accepted by the inputFilter (the default value is empty string) |
194 * | rejected | STRING | No | A regular expression in the set of characters to be rejected by the inputFilter (the default value is empty string) |
197 * The character set must follow the regular expression rules.
198 * Behaviour can not be guaranteed for incorrect grammars.
199 * Refer the link below for detailed rules.
200 * The functions in std::regex library use the ECMAScript grammar:
201 * http://cplusplus.com/reference/regex/ECMAScript/
203 * You can use enums instead of "accepted" and "rejected" strings.
204 * @see Dali::Toolkit::InputFilter::Property::Type
208 * Property::Map filter;
209 * filter[InputFilter::Property::ACCEPTED] = "[\\d]"; // accept whole digits
210 * filter[InputFilter::Property::REJECTED] = "[0-5]"; // reject 0, 1, 2, 3, 4, 5
212 * field.SetProperty(DevelTextField::Property::INPUT_FILTER, filter); // acceptable inputs are 6, 7, 8, 9
218 * @brief The enumerations used to specify whether to position the ellipsis at the END, START or MIDDLE of the text.
219 * @details Name "EllipsisPosition", type [Type](@ref Dali::Toolkit::DevelText::EllipsisPosition::Type) (Property::INTEGER), or Property::STRING. Read/Write
220 * @note Default is EllipsisPosition::END.
221 * @see DevelText::EllipsisPosition
226 * @brief A horizontal line through the text center.
227 * @details Name "strikethrough", type Property::MAP.
232 * @brief The strikethrough parameters of the new input text.
233 * @details Name "inputStrikethrough", type Property::MAP.
238 * @brief The spaces between characters in Pixels.
239 * @details Name "characterSpacing", type Property::FLOAT.
241 * A positive value will make the characters far apart (expanded) and a negative value will bring them closer (condensed).
242 * The default value is 0.f which does nothing.
247 * @brief Sets the selection popup style
248 * @details Name "selectionPopupStyle", type Property::MAP.
249 * @see Dali::Toolkit::TextSelectionPopup::Property
251 SELECTION_POPUP_STYLE,
254 } // namespace Property
257 * @brief Return the input method context of TextField.
259 * @param[in] textField The instance of TextField.
260 * @return InputMethodContext instance.
262 DALI_TOOLKIT_API InputMethodContext GetInputMethodContext(TextField textField);
265 * @brief Anchor clicked signal type.
268 * - const char* : href of clicked anchor.
269 * - uint32_t : length of href.
271 using AnchorClickedSignalType = Signal<void(TextField, const char*, uint32_t)>;
274 * @brief This signal is emitted when the anchor is clicked.
276 * A callback of the following type may be connected:
278 * void YourCallbackName(TextField textField, const char* href, uint32_t hrefLength);
280 * @param[in] textField The instance of TextField.
281 * @return The signal to connect to.
283 DALI_TOOLKIT_API AnchorClickedSignalType& AnchorClickedSignal(TextField textField);
286 * @brief cursor position changed signal type.
289 * - uint32_t : old position.
291 using CursorPositionChangedSignalType = Signal<void(TextField, uint32_t)>;
294 * @brief This signal is emitted when the cursor position has been changed.
296 * A callback of the following type may be connected:
298 * void YourCallbackName(TextField textField, uint32_t oldPosition);
300 * @param[in] textField The instance of TextField.
301 * @return The signal to connect to.
303 DALI_TOOLKIT_API CursorPositionChangedSignalType& CursorPositionChangedSignal(TextField textField);
306 * @brief Input filtered signal type.
308 using InputFilteredSignalType = Signal<void(TextField, Toolkit::InputFilter::Property::Type)>;
311 * @brief This signal is emitted when the character to be inserted is filtered by the input filter.
313 * A callback of the following type may be connected:
315 * void YourCallbackName(TextField textField, Toolkit::InputFilter::Property::Type type);
317 * DevelTextField::InputFilteredSignal(textField).Connect(this, &OnInputFiltered);
319 * void OnInputFiltered(TextField textField, InputFilter::Property::Type type)
321 * if (type == InputFilter::Property::ACCEPTED)
323 * // If the input has been filtered with an accepted filter, the type is ACCEPTED.
325 * else if (type == InputFilter::Property::REJECTED)
327 * // If the input has been filtered with an rejected filter, the type is REJECTED.
331 * @param[in] textField The instance of TextField.
332 * @return The signal to connect to.
334 DALI_TOOLKIT_API InputFilteredSignalType& InputFilteredSignal(TextField textField);
337 * @brief selection changed signal type.
340 * - uint32_t : selection start before the change.
341 * - uint32_t : selection end before the change.
343 using SelectionChangedSignalType = Signal<void(TextField, uint32_t, uint32_t)>;
346 * @brief This signal is emitted when the selection has been changed.
348 * A callback of the following type may be connected:
350 * void YourCallbackName( TextField textField, uint32_t oldStart, uint32_t oldEnd);
352 * @param[in] textField The instance of TextField.
353 * @return The signal to connect to
355 DALI_TOOLKIT_API SelectionChangedSignalType& SelectionChangedSignal(TextField textField);
358 * @brief selection cleared signal type.
360 using SelectionClearedSignalType = Signal<void(TextField)>;
363 * @brief This signal is emitted when the selection has been cleared.
365 * A callback of the following type may be connected:
367 * void YourCallbackName( TextField textField);
369 * @param[in] textField The instance of TextField.
370 * @return The signal to connect to
372 DALI_TOOLKIT_API SelectionClearedSignalType& SelectionClearedSignal(TextField textField);
375 * @brief selection start signal type.
377 using SelectionStartedSignalType = Signal<void(TextField)>;
380 * @brief This signal is emitted when the selection start.
382 * A callback of the following type may be connected:
384 * void YourCallbackName( TextField textField);
386 * @param[in] textField The instance of TextField.
387 * @return The signal to connect to
389 DALI_TOOLKIT_API SelectionStartedSignalType& SelectionStartedSignal(TextField textField);
392 * @brief Get the rendered size of a specific text range.
393 * if the requested text is at multilines, multiple sizes will be returned for each text located in a separate line.
394 * if a line contains characters with different directions, multiple sizes will be returned for each block of contiguous characters with the same direction.
396 * @param[in] textField The instance of TextField.
397 * @param[in] startIndex start index of the text requested to calculate size for.
398 * @param[in] endIndex end index(included) of the text requested to calculate size for.
399 * @return list of sizes of the reuested text.
401 DALI_TOOLKIT_API Vector<Vector2> GetTextSize(TextField textField, const uint32_t startIndex, const uint32_t endIndex);
404 * @brief Get the top/left rendered position of a specific text range.
405 * if the requested text is at multilines, multiple positions will be returned for each text located in a separate line.
406 * if a line contains characters with different directions, multiple positions will be returned for each block of contiguous characters with the same direction.
408 * @param[in] textField The instance of TextField.
409 * @param[in] startIndex start index of the text requested to get position to.
410 * @param[in] endIndex end index(included) of the text requested to get position to.
411 * @return list of positions of the requested text.
413 DALI_TOOLKIT_API Vector<Vector2> GetTextPosition(TextField textField, const uint32_t startIndex, const uint32_t endIndex);
416 * @brief Gets the bounding box of a specific text range.
418 * @param[in] textField The instance of textField.
419 * @param[in] startIndex start index of the text requested to get bounding box to.
420 * @param[in] endIndex end index(included) of the text requested to get bounding box to.
421 * @return bounding box of the requested text.
423 DALI_TOOLKIT_API Rect<> GetTextBoundingRectangle(TextField textField, uint32_t startIndex, uint32_t endIndex);
426 * @brief Select the whole text of TextField.
428 * @param[in] textField The instance of TextField.
430 DALI_TOOLKIT_API void SelectWholeText(TextField textField);
433 * @brief Unselect the whole text of TextField.
435 * @param[in] textField The instance of TextField.
437 DALI_TOOLKIT_API void SelectNone(TextField textField);
440 * @brief Select the text from start index to end index of TextField.
442 * The selection index is based on the cursor index.
446 * if textField.SelectText(1, 4); is executed, "ell" is selected.
448 * @param[in] textField The instance of TextField.
449 * @param[in] start The start index of the text to select. (The starting point of start index is 0.)
450 * @param[in] end The end index of the text to select. (If end index > text's length, the end index is set to the length of the text.)
452 DALI_TOOLKIT_API void SelectText(TextField textField, const uint32_t start, const uint32_t end);
455 * @brief Copy and return the selected text of TextField.
457 * @param[in] textField The instance of TextField.
458 * @return The copied text.
460 DALI_TOOLKIT_API std::string CopyText(TextField textField);
463 * @brief Cut and return the selected text of TextField.
465 * @param[in] textField The instance of TextField.
466 * @return The cut text.
468 DALI_TOOLKIT_API std::string CutText(TextField textField);
471 * @brief Paste the most recent clipboard text item into the TextField.
473 * @param[in] textField The instance of TextField.
475 DALI_TOOLKIT_API void PasteText(TextField textField);
477 } // namespace DevelTextField
479 } // namespace Toolkit
483 #endif // DALI_TOOLKIT_TEXT_FIELD_DEVEL_H