1 #ifndef DALI_TOOLKIT_TEXT_EDITOR_DEVEL_H
2 #define DALI_TOOLKIT_TEXT_EDITOR_DEVEL_H
5 * Copyright (c) 2021 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 The position for primary cursor.
182 * @details Name "primaryCursorPosition", type Property::INTEGER.
184 PRIMARY_CURSOR_POSITION,
187 * @brief The color of the grab color.
188 * @details Name "grabHandleColor", type Property::VECTOR4.
193 * @brief Enables the grab handle popup for text selection.
194 * @details Name "enableGrabHandlePopup", type Property::BOOLEAN.
195 * @note The default value is true, which means the grab handle popup is enabled by default.
197 ENABLE_GRAB_HANDLE_POPUP,
200 * @brief The settings to relating to the System's Input Method, Key and Value.
201 * @details Name "inputMethodSettings", type Property::MAP.
203 * @note VARIATION key can be changed depending on PANEL_LAYOUT.
204 * For example, when PANEL_LAYOUT key is InputMethod::PanelLayout::NORMAL,
205 * then VARIATION would be among NORMAL, WITH_FILENAME, and WITH_PERSON_NAME in Dali::InputMethod::NormalLayout.
206 * For more information, see Dali::InputMethod::Category.
210 * Property::Map propertyMap;
211 * InputMethod::PanelLayout::Type panelLayout = InputMethod::PanelLayout::NUMBER;
212 * InputMethod::AutoCapital::Type autoCapital = InputMethod::AutoCapital::WORD;
213 * InputMethod::ButtonAction::Type buttonAction = InputMethod::ButtonAction::GO;
214 * int inputVariation = 1;
215 * propertyMap["PANEL_LAYOUT"] = panelLayout;
216 * propertyMap["AUTO_CAPITALIZE"] = autoCapital;
217 * propertyMap["BUTTON_ACTION"] = buttonAction;
218 * propertyMap["VARIATION"] = inputVariation;
220 * editor.SetProperty(DevelTextEditor::Property::INPUT_METHOD_SETTINGS, propertyMap);
223 INPUT_METHOD_SETTINGS,
226 * @brief The input filter
227 * @details Name "inputFilter", type Property::MAP.
229 * The inputFilter map contains the following keys:
231 * | %Property Name | Type | Required | Description |
232 * |----------------------|----------|----------|---------------------------------------------------------------------------------------------------------------------|
233 * | accepted | STRING | No | A regular expression in the set of characters to be accepted by the inputFilter (the default value is empty string) |
234 * | rejected | STRING | No | A regular expression in the set of characters to be rejected by the inputFilter (the default value is empty string) |
237 * The character set must follow the regular expression rules.
238 * Behaviour can not be guaranteed for incorrect grammars.
239 * Refer the link below for detailed rules.
240 * The functions in std::regex library use the ECMAScript grammar:
241 * http://cplusplus.com/reference/regex/ECMAScript/
243 * You can use enums instead of "accepted" and "rejected" strings.
244 * @see Dali::Toolkit::InputFilter::Property::Type
248 * Property::Map filter;
249 * filter[InputFilter::Property::ACCEPTED] = "[\\d]"; // accept whole digits
250 * filter[InputFilter::Property::REJECTED] = "[0-5]"; // reject 0, 1, 2, 3, 4, 5
252 * editor.SetProperty(DevelTextEditor::Property::INPUT_FILTER, filter); // acceptable inputs are 6, 7, 8, 9
258 * @brief Whether we should show the ellipsis if required.
259 * @details Name "ellipsis", type Property::BOOLEAN.
264 * @brief The enumerations used to specify whether to position the ellipsis at the END, START or MIDDLE of the text.
265 * @details Name "EllipsisPosition", type [Type](@ref Dali::Toolkit::DevelText::EllipsisPosition::Type) (Property::INTEGER), or Property::STRING. Read/Write
266 * @note Default is EllipsisPosition::END.
267 * @see DevelText::EllipsisPosition
272 * @brief Sets the height of the line in points.
273 * @details Name "minLineSize", type Property::FLOAT.
274 * @note If the font size is larger than the line size, it works with the font size.
279 } // namespace Property
282 * @brief Return the input method context of TextEditor.
284 * @param[in] textEditor The instance of TextEditor.
285 * @return InputMethodContext instance.
287 DALI_TOOLKIT_API InputMethodContext GetInputMethodContext(TextEditor textEditor);
290 * @brief Max Characters Exceed signal type.
292 using MaxLengthReachedSignalType = Signal<void(TextEditor)>;
295 * @brief This signal is emitted when inserted text exceeds the maximum character limit.
297 * A callback of the following type may be connected:
299 * void YourCallbackName( TextEditor textEditor );
301 * @param[in] textEditor The instance of TextEditor.
302 * @return The signal to connect to
304 DALI_TOOLKIT_API MaxLengthReachedSignalType& MaxLengthReachedSignal(TextEditor textEditor);
307 * @brief Anchor clicked signal type.
310 * - const char* : href of clicked anchor.
311 * - uint32_t : length of href.
313 using AnchorClickedSignalType = Signal<void(TextEditor, const char*, uint32_t)>;
316 * @brief This signal is emitted when the anchor is clicked.
318 * A callback of the following type may be connected:
320 * void YourCallbackName(TextEditor textEditor, const char* href, uint32_t hrefLength);
322 * @param[in] textEditor The instance of TextEditor.
323 * @return The signal to connect to.
325 DALI_TOOLKIT_API AnchorClickedSignalType& AnchorClickedSignal(TextEditor textEditor);
328 * @brief cursor position changed signal type.
331 * - uint32_t : old position.
333 using CursorPositionChangedSignalType = Signal<void(TextEditor, uint32_t)>;
336 * @brief This signal is emitted when the cursor position has been changed.
338 * A callback of the following type may be connected:
340 * void YourCallbackName(TextEditor textEditor, uint32_t oldPosition);
342 * @param[in] textEditor The instance of TextEditor.
343 * @return The signal to connect to.
345 DALI_TOOLKIT_API CursorPositionChangedSignalType& CursorPositionChangedSignal(TextEditor textEditor);
348 * @brief Input filtered signal type.
350 using InputFilteredSignalType = Signal<void(TextEditor, Toolkit::InputFilter::Property::Type)>;
353 * @brief This signal is emitted when the character to be inserted is filtered by the input filter.
355 * A callback of the following type may be connected:
357 * void YourCallbackName(TextEditor textEditor, Toolkit::InputFilter::Property::Type type);
359 * DevelTextEditor::InputFilteredSignal(textEditor).Connect(this, &OnInputFiltered);
361 * void OnInputFiltered(TextEditor textEditor, InputFilter::Property::Type type)
363 * if (type == InputFilter::Property::ACCEPTED)
365 * // If the input has been filtered with an accepted filter, the type is ACCEPTED.
367 * else if (type == InputFilter::Property::REJECTED)
369 * // If the input has been filtered with an rejected filter, the type is REJECTED.
373 * @param[in] textEditor The instance of TextEditor.
374 * @return The signal to connect to.
376 DALI_TOOLKIT_API InputFilteredSignalType& InputFilteredSignal(TextEditor textEditor);
379 * @brief selection changed signal type.
382 * - uint32_t : selection start before the change.
383 * - uint32_t : selection end before the change.
385 using SelectionChangedSignalType = Signal<void(TextEditor, uint32_t, uint32_t)>;
388 * @brief This signal is emitted when the selection has been changed.
390 * A callback of the following type may be connected:
392 * void YourCallbackName( TextEditor textEditor, uint32_t oldStart, uint32_t oldEnd);
394 * @param[in] textEditor The instance of TextEditor.
395 * @return The signal to connect to
397 DALI_TOOLKIT_API SelectionChangedSignalType& SelectionChangedSignal(TextEditor textEditor);
400 * @brief selection cleared signal type.
402 using SelectionClearedSignalType = Signal<void(TextEditor)>;
405 * @brief This signal is emitted when the selection has been cleared.
407 * A callback of the following type may be connected:
409 * void YourCallbackName( TextEditor textEditor);
411 * @param[in] textEditor The instance of TextEditor.
412 * @return The signal to connect to
414 DALI_TOOLKIT_API SelectionClearedSignalType& SelectionClearedSignal(TextEditor textEditor);
417 * @brief Select the whole text of TextEditor.
419 * @param[in] textEditor The instance of TextEditor.
421 DALI_TOOLKIT_API void SelectWholeText(TextEditor textEditor);
424 * @brief Unselect the whole text of TextEditor.
426 * @param[in] textEditor The instance of TextEditor.
428 DALI_TOOLKIT_API void SelectNone(TextEditor textEditor);
431 * @brief Select the text from start index to end index of TextEditor.
433 * The selection index is based on the cursor index.
437 * if textEditor.SelectText(1, 4); is executed, "ell" is selected.
439 * @param[in] textEditor The instance of TextEditor.
440 * @param[in] start The start index of the text to select. (The starting point of start index is 0.)
441 * @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.)
443 DALI_TOOLKIT_API void SelectText(TextEditor textEditor, const uint32_t start, const uint32_t end);
446 * @brief Scroll the TextEditor by specific amount.
448 * @param[in] textEditor The instance of TextEditor.
449 * @param[in] scroll amount (in pixels) of scrolling in horizontal & vectical directions.
451 DALI_TOOLKIT_API void ScrollBy(TextEditor textEditor, Vector2 scroll);
454 * @brief Get the rendered size of a specific text range.
455 * if the requested text is at multilines, multiple sizes will be returned for each text located in a separate line.
456 * if a line contains characters with different directions, multiple sizes will be returned for each block of contiguous characters with the same direction.
458 * @param[in] textEditor The instance of TextEditor.
459 * @param[in] startIndex start index of the text requested to calculate size for.
460 * @param[in] endIndex end index(included) of the text requested to calculate size for.
461 * @return list of sizes of the reuested text.
463 DALI_TOOLKIT_API Vector<Vector2> GetTextSize(TextEditor textEditor, const uint32_t startIndex, const uint32_t endIndex);
466 * @brief Get the top/left rendered position of a specific text range.
467 * if the requested text is at multilines, multiple positions will be returned for each text located in a separate line.
468 * if a line contains characters with different directions, multiple positions will be returned for each block of contiguous characters with the same direction.
470 * @param[in] textEditor The instance of TextEditor.
471 * @param[in] startIndex start index of the text requested to get position to.
472 * @param[in] endIndex end index(included) of the text requested to get position to.
473 * @return list of positions of the requested text.
475 DALI_TOOLKIT_API Vector<Vector2> GetTextPosition(TextEditor textEditor, const uint32_t startIndex, const uint32_t endIndex);
478 * @brief Copy and return the selected text of TextEditor.
480 * @param[in] textEditor The instance of TextEditor.
481 * @return The copied text.
483 DALI_TOOLKIT_API std::string CopyText(TextEditor textEditor);
486 * @brief Cut and return the selected text of TextEditor.
488 * @param[in] textEditor The instance of TextEditor.
489 * @return The cut text.
491 DALI_TOOLKIT_API std::string CutText(TextEditor textEditor);
494 * @brief Paste the most recent clipboard text item into the TextEditor.
496 * @param[in] textEditor The instance of TextEditor.
498 DALI_TOOLKIT_API void PasteText(TextEditor textEditor);
500 } // namespace DevelTextEditor
502 } // namespace Toolkit
506 #endif // DALI_TOOLKIT_TEXT_EDITOR_DEVEL_H