1 #ifndef DALI_TOOLKIT_TEXT_EDITOR_H
2 #define DALI_TOOLKIT_TEXT_EDITOR_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/control.h>
30 namespace Internal DALI_INTERNAL
35 * @addtogroup dali_toolkit_controls_text_controls
40 * @brief A control which provides a multi-line editable text editor.
43 * | %Signal Name | Method | |
44 * |----------------------|--------------------------------|--------------------|
45 * | textChanged | @ref TextChangedSignal() | @SINCE_1_1.37 |
46 * | inputStyleChanged | @ref InputStyleChangedSignal() | @SINCE_1_2_2 |
49 class DALI_TOOLKIT_API TextEditor : public Control
54 * @brief Enumeration for the start and end property ranges for this control.
59 PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1,
60 PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000 ///< Reserve property indices
64 * @brief Enumeration for the instance of properties belonging to the TextEditor class.
70 * @brief Enumeration for the instance of properties belonging to the TextEditor class.
76 * @brief The text to display in UTF-8 format.
77 * @details Name "text", type Property::STRING.
80 TEXT = PROPERTY_START_INDEX,
83 * @brief The text color.
84 * @details Name "textColor", type Property::VECTOR4.
90 * @brief The requested font family.
91 * @details Name "fontFamily", type Property::STRING.
97 * @brief The requested font style.
98 * @details Name "fontStyle", type Property::STRING or Property::MAP.
104 * @brief The size of font in points.
105 * @details Name "pointSize", type Property::FLOAT.
106 * Conversion from Pixel size to Point size : Point size = Pixel size * 72 / DPI.
112 * @brief The text horizontal alignment.
113 * @details Name "horizontalAlignment", type Property::STRING or type HorizontalAlignment::Type (Property::INTEGER)
114 * Values "BEGIN" "CENTER" "END".
115 * @note Return type is Property::STRING
118 HORIZONTAL_ALIGNMENT,
121 * @brief Vertical scrolling will occur if the cursor is this close to the control border.
122 * @details Name "scrollThreshold", type Property::FLOAT.
128 * @brief The scroll speed in pixels per second.
129 * @details Name "scrollSpeed", type Property::FLOAT.
135 * @brief The color to apply to the primary cursor.
136 * @details Name "primaryCursorColor", type Property::VECTOR4.
139 PRIMARY_CURSOR_COLOR,
142 * @brief The color to apply to the secondary cursor.
143 * @details Name "secondaryCursorColor", type Property::VECTOR4.
146 SECONDARY_CURSOR_COLOR,
149 * @brief Whether the cursor should blink or not.
150 * @details Name "enableCursorBlink", type Property::BOOLEAN.
156 * @brief The time interval in seconds between cursor on/off states.
157 * @details Name "cursorBlinkInterval", type Property::FLOAT.
160 CURSOR_BLINK_INTERVAL,
163 * @brief The cursor will stop blinking after this number of seconds (if non-zero).
164 * @details Name "cursorBlinkDuration", type Property::FLOAT.
167 CURSOR_BLINK_DURATION,
170 * @brief The cursor width.
171 * @details Name "cursorWidth", type Property::INTEGER.
177 * @brief The image to display for the grab handle.
178 * @details Name "grabHandleImage", type Property::STRING.
184 * @brief The image to display when the grab handle is pressed.
185 * @details Name "grabHandlePressedImage", type Property::STRING.
188 GRAB_HANDLE_PRESSED_IMAGE,
191 * @brief The image to display for the left selection handle.
192 * @details Name "selectionHandleImageLeft", type Property::MAP.
195 SELECTION_HANDLE_IMAGE_LEFT,
198 * @brief The image to display for the right selection handle.
199 * @details Name "selectionHandleImageRight", type Property::MAP.
202 SELECTION_HANDLE_IMAGE_RIGHT,
205 * @brief The image to display when the left selection handle is pressed.
206 * @details Name "selectionHandlePressedImageLeft", type Property::MAP.
209 SELECTION_HANDLE_PRESSED_IMAGE_LEFT,
212 * @brief The image to display when the right selection handle is pressed.
213 * @details Name "selectionHandlePressedImageRight", type Property::MAP.
216 SELECTION_HANDLE_PRESSED_IMAGE_RIGHT,
219 * @brief The image to display for the left selection handle marker.
220 * @details Name "selectionHandleMarkerImageLeft", type Property::MAP.
223 SELECTION_HANDLE_MARKER_IMAGE_LEFT,
226 * @brief The image to display for the right selection handle marker.
227 * @details Name "selectionHandleMarkerImageRight", type Property::MAP.
230 SELECTION_HANDLE_MARKER_IMAGE_RIGHT,
233 * @brief The color of the selection highlight.
234 * @details Name "selectionHighlightColor", type Property::VECTOR4.
237 SELECTION_HIGHLIGHT_COLOR,
240 * @brief The decorations (handles etc) will positioned within this area on-screen.
241 * @details Name "decorationBoundingBox", type Property::RECTANGLE.
244 DECORATION_BOUNDING_BOX,
247 * @brief Whether the mark-up processing is enabled.
248 * @details Name "enableMarkup", type Property::BOOLEAN.
254 * @brief The color of the new input text.
255 * @details Name "inputColor", type Property::VECTOR4.
261 * @brief The font's family of the new input text.
262 * @details Name "inputFontFamily", type Property::STRING.
268 * @brief The font's style of the new input text.
269 * @details Name "inputFontStyle", type Property::MAP.
275 * @brief The font's size of the new input text in points.
276 * @details Name "inputPointSize", type Property::FLOAT.
282 * @brief The default extra space between lines in points.
283 * @details Name "lineSpacing", type Property::FLOAT.
289 * @brief The extra space between lines in points.
290 * @details Name "inputLineSpacing", type Property::FLOAT.
292 * @note This affects the whole paragraph where the new input text is inserted.
297 * @copydoc Dali::Toolkit::TextLabel::Property::UNDERLINE
302 * @brief The underline parameters of the new input text.
303 * @details Name "inputUnderline", type Property::MAP.
309 * @copydoc Dali::Toolkit::TextLabel::Property::SHADOW
314 * @brief The shadow parameters of the new input text.
315 * @details Name "inputShadow", type Property::MAP.
321 * @brief The default emboss parameters.
322 * @details Name "emboss", type Property::MAP.
328 * @brief The emboss parameters of the new input text.
329 * @details Name "inputEmboss", type Property::MAP.
335 * @copydoc Dali::Toolkit::TextLabel::Property::OUTLINE
340 * @brief The outline parameters of the new input text.
341 * @details Name "inputOutline", type Property::MAP.
347 * @brief Enable or disable the smooth scroll animation.
348 * @details Name "smoothScroll", type Property::BOOLEAN.
354 * @brief Sets the duration of smooth scroll animation.
355 * @details Name "smoothScrollDuration", type Property::FLOAT.
358 SMOOTH_SCROLL_DURATION,
361 * @brief Enable or disable the scroll bar.
362 * @details Name "enableScrollBar", type Property::BOOLEAN.
368 * @brief Sets the duration of scroll bar to show.
369 * @details Name "scrollBarShowDuration", type Property::FLOAT.
372 SCROLL_BAR_SHOW_DURATION,
375 * @brief Sets the duration of scroll bar to fade out.
376 * @details Name "scrollBarFadeDuration", type Property::FLOAT.
379 SCROLL_BAR_FADE_DURATION,
382 * @brief The size of font in pixels.
383 * @details Name "pixelSize", type Property::FLOAT.
384 * Conversion from Point size to Pixel size:
385 * Pixel size = Point size * DPI / 72
391 * @brief The line count of text.
392 * @details Name "lineCount", type Property::INTEGER.
394 * @note This property is read-only.
399 * @brief Enables Text selection, such as the cursor, handle, clipboard, and highlight color.
400 * @details Name "enableSelection", type Property::BOOLEAN.
406 * @brief Sets the placeholder : text, color, font family, font style, point size, and pixel size.
407 * @details Name "placeholder", type Property::MAP.
410 * Property::Map propertyMap;
411 * propertyMap["placeholderText"] = "Setting Placeholder Text";
412 * propertyMap["placeholderTextFocused"] = "Setting Placeholder Text Focused";
413 * propertyMap["placeholderColor"] = Color::RED;
414 * propertyMap["placeholderFontFamily"] = "Arial";
415 * propertyMap["placeholderPointSize"] = 12.0f;
417 * Property::Map fontStyleMap;
418 * fontStyleMap.Insert( "weight", "bold" );
419 * fontStyleMap.Insert( "width", "condensed" );
420 * fontStyleMap.Insert( "slant", "italic" );
421 * propertyMap["placeholderFontStyle"] = fontStyleMap;
423 * editor.SetProperty( TextEditor::Property::PLACEHOLDER, propertyMap );
431 * @brief Line wrap mode when text lines are greater than the layout width.
432 * @details Name "lineWrapMode", type Text::LineWrap::Mode (Text::Property::INTEGER) or Property::STRING.
434 * @note Default is Text::LineWrap::WORD.
435 * @note Return type is Text::LineWrap::Mode (Text::Property::INTEGER).
436 * @see Text::LineWrap
443 * @brief Mask used by the signal InputStyleChangedSignal(). Notifies which parameters of the input style have changed.
450 * @brief Enumeration for mask used by the signal InputStyleChangedSignal().
455 NONE = 0x0000, ///< @SINCE_1_2_2
456 COLOR = 0x0001, ///< @SINCE_1_2_2
457 FONT_FAMILY = 0x0002, ///< @SINCE_1_2_2
458 POINT_SIZE = 0x0004, ///< @SINCE_1_2_2
459 FONT_STYLE = 0x0008, ///< @SINCE_1_2_2
460 LINE_SPACING = 0x0010, ///< @SINCE_1_2_2
461 UNDERLINE = 0x0020, ///< @SINCE_1_2_2
462 SHADOW = 0x0040, ///< @SINCE_1_2_2
463 EMBOSS = 0x0080, ///< @SINCE_1_2_2
464 OUTLINE = 0x0100 ///< @SINCE_1_2_2
469 * @brief Enumerations for the type of scrolling.
471 * @see ScrollStateChangedSignal()
476 * @brief Enumerations for the type of scrolling.
478 * @see ScrollStateChangedSignal()
482 STARTED, ///< Scrolling has started. @SINCE_1_2.60
483 FINISHED ///< Scrolling has finished. @SINCE_1_2.60
490 * @brief Text changed signal type.
494 ( TextEditor ) > TextChangedSignalType;
497 * @brief Input Style changed signal type.
501 ( TextEditor, InputStyle::Mask ) > InputStyleChangedSignalType;
504 * @brief Scroll state changed signal type.
508 ( TextEditor, Scroll::Type ) > ScrollStateChangedSignalType;
511 * @brief Creates the TextEditor control.
514 * @return A handle to the TextEditor control
520 * @brief Creates an empty handle.
527 * @brief Copy constructor.
530 * @param[in] handle The handle to copy from
532 TextEditor( const TextEditor &handle );
535 * @brief Assignment operator.
538 * @param[in] handle The handle to copy from
539 * @return A reference to this
542 operator=( const TextEditor &handle );
547 * This is non-virtual since derived Handle types must not contain data or virtual methods.
553 * @brief Downcasts a handle to TextEditor.
555 * If the BaseHandle points is a TextEditor, the downcast returns a valid handle.
556 * If not, the returned handle is left empty.
559 * @param[in] handle Handle to an object
560 * @return Handle to a TextEditor or an empty handle
563 DownCast( BaseHandle handle );
568 * @brief This signal is emitted when the text changes.
570 * A callback of the following type may be connected:
572 * void YourCallbackName( TextEditor textEditor );
576 * @return The signal to connect to
578 TextChangedSignalType&
582 * @brief This signal is emitted when the input style is updated as a consequence of a change in the cursor position.
583 * i.e. The signal is not emitted when the input style is updated through the property system.
585 * A callback of the following type may be connected. The @p mask parameter notifies which parts of the style have changed.
587 * void YourCallbackName( TextEditor textEditor, TextEditor::InputStyle::Mask mask );
591 * @return The signal to connect to
593 InputStyleChangedSignalType&
594 InputStyleChangedSignal();
597 * @brief This signal is emitted when TextEditor scrolling is started or finished.
599 * A callback of the following type may be connected:
601 * void YourCallbackName( Scroll::Type type );
603 * type: Whether the scrolling is started or finished.
606 * @return The signal to connect to
608 ScrollStateChangedSignalType&
609 ScrollStateChangedSignal();
611 public: // Not intended for application developers
615 * @brief Creates a handle using the Toolkit::Internal implementation.
618 * @param[in] implementation The Control implementation
621 TextEditor( Internal::TextEditor &implementation );
624 * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
627 * @param[in] internal A pointer to the internal CustomActor
629 explicit DALI_INTERNAL
630 TextEditor( Dali::Internal::CustomActor *internal );
637 } // namespace Toolkit
641 #endif // DALI_TOOLKIT_TEXT_EDITOR_H