1 #ifndef DALI_TOOLKIT_TEXT_EDITOR_DEVEL_H
2 #define DALI_TOOLKIT_TEXT_EDITOR_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-editor.h>
31 namespace DevelTextEditor
37 TEXT = Dali::Toolkit::TextEditor::Property::TEXT,
38 TEXT_COLOR = Dali::Toolkit::TextEditor::Property::TEXT_COLOR,
39 FONT_FAMILY = Dali::Toolkit::TextEditor::Property::FONT_FAMILY,
40 FONT_STYLE = Dali::Toolkit::TextEditor::Property::FONT_STYLE,
41 POINT_SIZE = Dali::Toolkit::TextEditor::Property::POINT_SIZE,
42 HORIZONTAL_ALIGNMENT = Dali::Toolkit::TextEditor::Property::HORIZONTAL_ALIGNMENT,
43 SCROLL_THRESHOLD = Dali::Toolkit::TextEditor::Property::SCROLL_THRESHOLD,
44 SCROLL_SPEED = Dali::Toolkit::TextEditor::Property::SCROLL_SPEED,
45 PRIMARY_CURSOR_COLOR = Dali::Toolkit::TextEditor::Property::PRIMARY_CURSOR_COLOR,
46 SECONDARY_CURSOR_COLOR = Dali::Toolkit::TextEditor::Property::SECONDARY_CURSOR_COLOR,
47 ENABLE_CURSOR_BLINK = Dali::Toolkit::TextEditor::Property::ENABLE_CURSOR_BLINK,
48 CURSOR_BLINK_INTERVAL = Dali::Toolkit::TextEditor::Property::CURSOR_BLINK_INTERVAL,
49 CURSOR_BLINK_DURATION = Dali::Toolkit::TextEditor::Property::CURSOR_BLINK_DURATION,
50 CURSOR_WIDTH = Dali::Toolkit::TextEditor::Property::CURSOR_WIDTH,
51 GRAB_HANDLE_IMAGE = Dali::Toolkit::TextEditor::Property::GRAB_HANDLE_IMAGE,
52 GRAB_HANDLE_PRESSED_IMAGE = Dali::Toolkit::TextEditor::Property::GRAB_HANDLE_PRESSED_IMAGE,
53 SELECTION_HANDLE_IMAGE_LEFT = Dali::Toolkit::TextEditor::Property::SELECTION_HANDLE_IMAGE_LEFT,
54 SELECTION_HANDLE_IMAGE_RIGHT = Dali::Toolkit::TextEditor::Property::SELECTION_HANDLE_IMAGE_RIGHT,
55 SELECTION_HANDLE_PRESSED_IMAGE_LEFT = Dali::Toolkit::TextEditor::Property::SELECTION_HANDLE_PRESSED_IMAGE_LEFT,
56 SELECTION_HANDLE_PRESSED_IMAGE_RIGHT = Dali::Toolkit::TextEditor::Property::SELECTION_HANDLE_PRESSED_IMAGE_RIGHT,
57 SELECTION_HANDLE_MARKER_IMAGE_LEFT = Dali::Toolkit::TextEditor::Property::SELECTION_HANDLE_MARKER_IMAGE_LEFT,
58 SELECTION_HANDLE_MARKER_IMAGE_RIGHT = Dali::Toolkit::TextEditor::Property::SELECTION_HANDLE_MARKER_IMAGE_RIGHT,
59 SELECTION_HIGHLIGHT_COLOR = Dali::Toolkit::TextEditor::Property::SELECTION_HIGHLIGHT_COLOR,
60 DECORATION_BOUNDING_BOX = Dali::Toolkit::TextEditor::Property::DECORATION_BOUNDING_BOX,
61 ENABLE_MARKUP = Dali::Toolkit::TextEditor::Property::ENABLE_MARKUP,
62 INPUT_COLOR = Dali::Toolkit::TextEditor::Property::INPUT_COLOR,
63 INPUT_FONT_FAMILY = Dali::Toolkit::TextEditor::Property::INPUT_FONT_FAMILY,
64 INPUT_FONT_STYLE = Dali::Toolkit::TextEditor::Property::INPUT_FONT_STYLE,
65 INPUT_POINT_SIZE = Dali::Toolkit::TextEditor::Property::INPUT_POINT_SIZE,
66 LINE_SPACING = Dali::Toolkit::TextEditor::Property::LINE_SPACING,
67 INPUT_LINE_SPACING = Dali::Toolkit::TextEditor::Property::INPUT_LINE_SPACING,
68 UNDERLINE = Dali::Toolkit::TextEditor::Property::UNDERLINE,
69 INPUT_UNDERLINE = Dali::Toolkit::TextEditor::Property::INPUT_UNDERLINE,
70 SHADOW = Dali::Toolkit::TextEditor::Property::SHADOW,
71 INPUT_SHADOW = Dali::Toolkit::TextEditor::Property::INPUT_SHADOW,
72 EMBOSS = Dali::Toolkit::TextEditor::Property::EMBOSS,
73 INPUT_EMBOSS = Dali::Toolkit::TextEditor::Property::INPUT_EMBOSS,
74 OUTLINE = Dali::Toolkit::TextEditor::Property::OUTLINE,
75 INPUT_OUTLINE = Dali::Toolkit::TextEditor::Property::INPUT_OUTLINE,
76 SMOOTH_SCROLL = Dali::Toolkit::TextEditor::Property::SMOOTH_SCROLL,
77 SMOOTH_SCROLL_DURATION = Dali::Toolkit::TextEditor::Property::SMOOTH_SCROLL_DURATION,
78 ENABLE_SCROLL_BAR = Dali::Toolkit::TextEditor::Property::ENABLE_SCROLL_BAR,
79 SCROLL_BAR_SHOW_DURATION = Dali::Toolkit::TextEditor::Property::SCROLL_BAR_SHOW_DURATION,
80 SCROLL_BAR_FADE_DURATION = Dali::Toolkit::TextEditor::Property::SCROLL_BAR_FADE_DURATION,
81 PIXEL_SIZE = Dali::Toolkit::TextEditor::Property::PIXEL_SIZE,
82 LINE_COUNT = Dali::Toolkit::TextEditor::Property::LINE_COUNT,
83 ENABLE_SELECTION = Dali::Toolkit::TextEditor::Property::ENABLE_SELECTION,
84 PLACEHOLDER = Dali::Toolkit::TextEditor::Property::PLACEHOLDER,
85 LINE_WRAP_MODE = Dali::Toolkit::TextEditor::Property::LINE_WRAP_MODE,
88 * @brief The text to display when the TextEditor is empty and inactive.
89 * @details Name "placeholderText", type Property::STRING.
94 * @brief The placeholder-text color.
95 * @details Name "placeholderTextColor", type Property::VECTOR4.
97 PLACEHOLDER_TEXT_COLOR,
100 * @brief Enables Text selection using Shift key.
101 * @details Name "enableShiftSelection", type Property::BOOLEAN.
103 ENABLE_SHIFT_SELECTION,
106 * @brief Enables the grab handles for text selection.
107 * @details Name "enableGrabHandle", type Property::BOOLEAN.
108 * @note The default value is true, which means the grab handles are enabled by default.
113 * @brief Modifies the default text alignment to match the direction of the system language.
114 * @details Name "matchSystemLanguageDirection", type (Property::BOOLEAN), Read/Write
115 * @note The default value is true
117 MATCH_SYSTEM_LANGUAGE_DIRECTION,
120 * @brief The type or rendering e.g. bitmap-based.
121 * @details Name "renderingBackend", type Property::INTEGER.
126 * @brief The maximum number of characters that can be inserted.
127 * @details Name "maxLength", type Property::INTEGER.
132 * @brief The selected text start position.
133 * @details Name "selectedTextStart", type Property::INTEGER.
138 * @brief The selected text range end position.
139 * @details Name "selectedTextEnd", type Property::INTEGER.
144 * @brief The horizontal scroll position in pixels.
145 * @details Name "horizontalScrollPosition", type Property::FLOAT.
147 HORIZONTAL_SCROLL_POSITION,
150 * @brief The vertical scroll position in pixels.
151 * @details Name "verticalScrollPosition", type Property::FLOAT.
153 VERTICAL_SCROLL_POSITION,
156 * @brief The Editable state of control.
157 * @details Name "enableEditing", type Property::BOOLEAN.
162 * @brief The selected text in UTF-8 format.
163 * @details Name "selectedText", type Property::STRING.
164 * @note This property is read-only.
169 * @brief The font size scale.
170 * @details name "fontSizeScale", type Property::FLOAT.
171 * @note The default value is 1.0 which does nothing.
172 * The given font size scale value is used for multiplying the specified font size before querying fonts.
174 * e.g. The rendering results of both cases are same.
175 * - fontSize: 15pt, fontSizeScale: 1.0
176 * - fontSize: 10pt, fontSizeScale: 1.5
181 * @brief True to enable the font size scale or false to disable.
182 * @details Name "enableFontSizeScale", type Property::BOOLEAN.
183 * @note The default value is true.
184 * If false, font size scale is not apppied.
186 ENABLE_FONT_SIZE_SCALE,
189 * @brief The position for primary cursor.
190 * @details Name "primaryCursorPosition", type Property::INTEGER.
192 PRIMARY_CURSOR_POSITION,
195 * @brief The color of the grab color.
196 * @details Name "grabHandleColor", type Property::VECTOR4.
201 * @brief Enables the grab handle popup for text selection.
202 * @details Name "enableGrabHandlePopup", type Property::BOOLEAN.
203 * @note The default value is true, which means the grab handle popup is enabled by default.
205 ENABLE_GRAB_HANDLE_POPUP,
208 * @brief The settings to relating to the System's Input Method, Key and Value.
209 * @details Name "inputMethodSettings", type Property::MAP.
211 * @note VARIATION key can be changed depending on PANEL_LAYOUT.
212 * For example, when PANEL_LAYOUT key is InputMethod::PanelLayout::NORMAL,
213 * then VARIATION would be among NORMAL, WITH_FILENAME, and WITH_PERSON_NAME in Dali::InputMethod::NormalLayout.
214 * For more information, see Dali::InputMethod::Category.
218 * Property::Map propertyMap;
219 * InputMethod::PanelLayout::Type panelLayout = InputMethod::PanelLayout::NUMBER;
220 * InputMethod::AutoCapital::Type autoCapital = InputMethod::AutoCapital::WORD;
221 * InputMethod::ButtonAction::Type buttonAction = InputMethod::ButtonAction::GO;
222 * int inputVariation = 1;
223 * propertyMap["PANEL_LAYOUT"] = panelLayout;
224 * propertyMap["AUTO_CAPITALIZE"] = autoCapital;
225 * propertyMap["BUTTON_ACTION"] = buttonAction;
226 * propertyMap["VARIATION"] = inputVariation;
228 * editor.SetProperty(DevelTextEditor::Property::INPUT_METHOD_SETTINGS, propertyMap);
231 INPUT_METHOD_SETTINGS,
234 * @brief The input filter
235 * @details Name "inputFilter", type Property::MAP.
237 * The inputFilter map contains the following keys:
239 * | %Property Name | Type | Required | Description |
240 * |----------------------|----------|----------|---------------------------------------------------------------------------------------------------------------------|
241 * | accepted | STRING | No | A regular expression in the set of characters to be accepted by the inputFilter (the default value is empty string) |
242 * | rejected | STRING | No | A regular expression in the set of characters to be rejected by the inputFilter (the default value is empty string) |
245 * The character set must follow the regular expression rules.
246 * Behaviour can not be guaranteed for incorrect grammars.
247 * Refer the link below for detailed rules.
248 * The functions in std::regex library use the ECMAScript grammar:
249 * http://cplusplus.com/reference/regex/ECMAScript/
251 * You can use enums instead of "accepted" and "rejected" strings.
252 * @see Dali::Toolkit::InputFilter::Property::Type
256 * Property::Map filter;
257 * filter[InputFilter::Property::ACCEPTED] = "[\\d]"; // accept whole digits
258 * filter[InputFilter::Property::REJECTED] = "[0-5]"; // reject 0, 1, 2, 3, 4, 5
260 * editor.SetProperty(DevelTextEditor::Property::INPUT_FILTER, filter); // acceptable inputs are 6, 7, 8, 9
266 * @brief Whether we should show the ellipsis if required.
267 * @details Name "ellipsis", type Property::BOOLEAN.
272 * @brief The enumerations used to specify whether to position the ellipsis at the END, START or MIDDLE of the text.
273 * @details Name "EllipsisPosition", type [Type](@ref Dali::Toolkit::DevelText::EllipsisPosition::Type) (Property::INTEGER), or Property::STRING. Read/Write
274 * @note Default is EllipsisPosition::END.
275 * @see DevelText::EllipsisPosition
280 * @brief Sets the height of the line in points.
281 * @details Name "minLineSize", type Property::FLOAT.
282 * @note If the font size is larger than the line size, it works with the font size.
287 * @brief A horizontal line through the text center.
288 * @details Name "strikethrough", type Property::MAP.
293 * @brief The strikethrough parameters of the new input text.
294 * @details Name "inputStrikethrough", type Property::MAP.
299 * @brief The spaces between characters in Pixels.
300 * @details Name "characterSpacing", type Property::FLOAT.
302 * A positive value will make the characters far apart (expanded) and a negative value will bring them closer (condensed).
303 * The default value is 0.f which does nothing.
308 * @brief the relative height of the line (a factor that will be multiplied by text height).
309 * @details Name "relativeLineSize", type Property::FLOAT.
310 * @note If the value is less than 1, the lines could to be overlapped.
315 * @brief The line vertical alignment.
316 * @details Name "verticalAlignment", type Property::STRING or type VerticalAlignment::Type (Property::INTEGER).
317 * Values "TOP", "CENTER", "BOTTOM", default TOP.
318 * @note Return type is Property::STRING
323 * @brief Sets the selection popup style
324 * @details Name "selectionPopupStyle", type Property::MAP.
325 * @see Dali::Toolkit::TextSelectionPopup::Property
327 SELECTION_POPUP_STYLE,
330 * @brief Whether to trim the xBearing of first glyph of the text.
331 * @details Name "removeFrontInset", type Property::BOOLEAN.
336 * @brief Whether to trim the advance of last glyph of the text.
337 * @details Name "removeBackInset", type Property::BOOLEAN.
342 } // namespace Property
345 * @brief Return the input method context of TextEditor.
347 * @param[in] textEditor The instance of TextEditor.
348 * @return InputMethodContext instance.
350 DALI_TOOLKIT_API InputMethodContext GetInputMethodContext(TextEditor textEditor);
353 * @brief Max Characters Exceed signal type.
355 using MaxLengthReachedSignalType = Signal<void(TextEditor)>;
358 * @brief This signal is emitted when inserted text exceeds the maximum character limit.
360 * A callback of the following type may be connected:
362 * void YourCallbackName( TextEditor textEditor );
364 * @param[in] textEditor The instance of TextEditor.
365 * @return The signal to connect to
367 DALI_TOOLKIT_API MaxLengthReachedSignalType& MaxLengthReachedSignal(TextEditor textEditor);
370 * @brief Anchor clicked signal type.
373 * - const char* : href of clicked anchor.
374 * - uint32_t : length of href.
376 using AnchorClickedSignalType = Signal<void(TextEditor, const char*, uint32_t)>;
379 * @brief This signal is emitted when the anchor is clicked.
381 * A callback of the following type may be connected:
383 * void YourCallbackName(TextEditor textEditor, const char* href, uint32_t hrefLength);
385 * @param[in] textEditor The instance of TextEditor.
386 * @return The signal to connect to.
388 DALI_TOOLKIT_API AnchorClickedSignalType& AnchorClickedSignal(TextEditor textEditor);
391 * @brief cursor position changed signal type.
394 * - uint32_t : old position.
396 using CursorPositionChangedSignalType = Signal<void(TextEditor, uint32_t)>;
399 * @brief This signal is emitted when the cursor position has been changed.
401 * A callback of the following type may be connected:
403 * void YourCallbackName(TextEditor textEditor, uint32_t oldPosition);
405 * @param[in] textEditor The instance of TextEditor.
406 * @return The signal to connect to.
408 DALI_TOOLKIT_API CursorPositionChangedSignalType& CursorPositionChangedSignal(TextEditor textEditor);
411 * @brief Input filtered signal type.
413 using InputFilteredSignalType = Signal<void(TextEditor, Toolkit::InputFilter::Property::Type)>;
416 * @brief This signal is emitted when the character to be inserted is filtered by the input filter.
418 * A callback of the following type may be connected:
420 * void YourCallbackName(TextEditor textEditor, Toolkit::InputFilter::Property::Type type);
422 * DevelTextEditor::InputFilteredSignal(textEditor).Connect(this, &OnInputFiltered);
424 * void OnInputFiltered(TextEditor textEditor, InputFilter::Property::Type type)
426 * if (type == InputFilter::Property::ACCEPTED)
428 * // If the input has been filtered with an accepted filter, the type is ACCEPTED.
430 * else if (type == InputFilter::Property::REJECTED)
432 * // If the input has been filtered with an rejected filter, the type is REJECTED.
436 * @param[in] textEditor The instance of TextEditor.
437 * @return The signal to connect to.
439 DALI_TOOLKIT_API InputFilteredSignalType& InputFilteredSignal(TextEditor textEditor);
442 * @brief selection changed signal type.
445 * - uint32_t : selection start before the change.
446 * - uint32_t : selection end before the change.
448 using SelectionChangedSignalType = Signal<void(TextEditor, uint32_t, uint32_t)>;
451 * @brief This signal is emitted when the selection has been changed.
453 * A callback of the following type may be connected:
455 * void YourCallbackName( TextEditor textEditor, uint32_t oldStart, uint32_t oldEnd);
457 * @param[in] textEditor The instance of TextEditor.
458 * @return The signal to connect to
460 DALI_TOOLKIT_API SelectionChangedSignalType& SelectionChangedSignal(TextEditor textEditor);
463 * @brief selection cleared signal type.
465 using SelectionClearedSignalType = Signal<void(TextEditor)>;
468 * @brief This signal is emitted when the selection has been cleared.
470 * A callback of the following type may be connected:
472 * void YourCallbackName( TextEditor textEditor);
474 * @param[in] textEditor The instance of TextEditor.
475 * @return The signal to connect to
477 DALI_TOOLKIT_API SelectionClearedSignalType& SelectionClearedSignal(TextEditor textEditor);
480 * @brief selection start signal type.
482 using SelectionStartedSignalType = Signal<void(TextEditor)>;
485 * @brief This signal is emitted when the selection start.
487 * A callback of the following type may be connected:
489 * void YourCallbackName( TextEditor textEditor);
491 * @param[in] textEditor The instance of TextEditor.
492 * @return The signal to connect to
494 DALI_TOOLKIT_API SelectionStartedSignalType& SelectionStartedSignal(TextEditor textEditor);
497 * @brief Select the whole text of TextEditor.
499 * @param[in] textEditor The instance of TextEditor.
501 DALI_TOOLKIT_API void SelectWholeText(TextEditor textEditor);
504 * @brief Unselect the whole text of TextEditor.
506 * @param[in] textEditor The instance of TextEditor.
508 DALI_TOOLKIT_API void SelectNone(TextEditor textEditor);
511 * @brief Select the text from start index to end index of TextEditor.
513 * The selection index is based on the cursor index.
517 * if textEditor.SelectText(1, 4); is executed, "ell" is selected.
519 * @param[in] textEditor The instance of TextEditor.
520 * @param[in] start The start index of the text to select. (The starting point of start index is 0.)
521 * @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.)
523 DALI_TOOLKIT_API void SelectText(TextEditor textEditor, const uint32_t start, const uint32_t end);
526 * @brief Scroll the TextEditor by specific amount.
528 * @param[in] textEditor The instance of TextEditor.
529 * @param[in] scroll amount (in pixels) of scrolling in horizontal & vectical directions.
531 DALI_TOOLKIT_API void ScrollBy(TextEditor textEditor, Vector2 scroll);
534 * @brief Get the rendered size of a specific text range.
535 * if the requested text is at multilines, multiple sizes will be returned for each text located in a separate line.
536 * if a line contains characters with different directions, multiple sizes will be returned for each block of contiguous characters with the same direction.
538 * @param[in] textEditor The instance of TextEditor.
539 * @param[in] startIndex start index of the text requested to calculate size for.
540 * @param[in] endIndex end index(included) of the text requested to calculate size for.
541 * @return list of sizes of the reuested text.
543 DALI_TOOLKIT_API Vector<Vector2> GetTextSize(TextEditor textEditor, const uint32_t startIndex, const uint32_t endIndex);
546 * @brief Get the top/left rendered position of a specific text range.
547 * if the requested text is at multilines, multiple positions will be returned for each text located in a separate line.
548 * if a line contains characters with different directions, multiple positions will be returned for each block of contiguous characters with the same direction.
550 * @param[in] textEditor The instance of TextEditor.
551 * @param[in] startIndex start index of the text requested to get position to.
552 * @param[in] endIndex end index(included) of the text requested to get position to.
553 * @return list of positions of the requested text.
555 DALI_TOOLKIT_API Vector<Vector2> GetTextPosition(TextEditor textEditor, const uint32_t startIndex, const uint32_t endIndex);
558 * @brief Gets the bounding box of a specific text range.
560 * @param[in] textEditor The instance of textEditor.
561 * @param[in] startIndex start index of the text requested to get bounding box to.
562 * @param[in] endIndex end index(included) of the text requested to get bounding box to.
563 * @return bounding box of the requested text.
565 DALI_TOOLKIT_API Rect<> GetTextBoundingRectangle(TextEditor textEditor, uint32_t startIndex, uint32_t endIndex);
568 * @brief Copy and return the selected text of TextEditor.
570 * @param[in] textEditor The instance of TextEditor.
571 * @return The copied text.
573 DALI_TOOLKIT_API std::string CopyText(TextEditor textEditor);
576 * @brief Cut and return the selected text of TextEditor.
578 * @param[in] textEditor The instance of TextEditor.
579 * @return The cut text.
581 DALI_TOOLKIT_API std::string CutText(TextEditor textEditor);
584 * @brief Paste the most recent clipboard text item into the TextEditor.
586 * @param[in] textEditor The instance of TextEditor.
588 DALI_TOOLKIT_API void PasteText(TextEditor textEditor);
591 * @brief Set removing front inset to text label.
593 * @param[in] textEditor The instance of TextLabel.
594 * @param[in] remove Whether front inset of text label has to be removed or not.
596 DALI_TOOLKIT_API void SetRemoveFrontInset(TextEditor textEditor, const bool remove);
599 * @brief Whether front inset of text label is removed or not.
601 * @param[in] textEditor The instance of TextLabel.
602 * @return True if the front inset of text label is removed.
604 DALI_TOOLKIT_API bool IsRemoveFrontInset(TextEditor textEditor);
607 * @brief Set removing back inset to text label.
609 * @param[in] textEditor The instance of TextLabel.
610 * @param[in] remove Whether back inset of text label has to be removed or not.
612 DALI_TOOLKIT_API void SetRemoveBackInset(TextEditor textEditor, const bool remove);
615 * @brief Whether back inset of text label is removed or not.
617 * @param[in] textEditor The instance of TextLabel.
618 * @return True if the back inset of text label is removed.
620 DALI_TOOLKIT_API bool IsRemoveBackInset(TextEditor textEditor);
623 } // namespace DevelTextEditor
625 } // namespace Toolkit
629 #endif // DALI_TOOLKIT_TEXT_EDITOR_DEVEL_H