1 #ifndef __DALI_TOOLKIT_TEXT_EDITOR_H__
2 #define __DALI_TOOLKIT_TEXT_EDITOR_H__
5 * Copyright (c) 2016 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_IMPORT_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.
75 RENDERING_BACKEND = PROPERTY_START_INDEX, ///< name "renderingBackend", The type or rendering e.g. bitmap-based, type INT @SINCE_1_1.37
76 TEXT, ///< name "text", The text to display in UTF-8 format, type STRING @SINCE_1_1.37
77 TEXT_COLOR, ///< name "textColor", The text color, type VECTOR4 @SINCE_1_1.37
78 FONT_FAMILY, ///< name "fontFamily", The requested font family, type STRING @SINCE_1_1.37
79 FONT_STYLE, ///< name "fontStyle", The requested font style, type STRING or MAP @SINCE_1_2.13
80 POINT_SIZE, ///< name "pointSize", The size of font in points, type FLOAT @SINCE_1_1.37
81 HORIZONTAL_ALIGNMENT, ///< name "horizontalAlignment", The text horizontal alignment, type STRING, values "BEGIN", "CENTER", "END" @SINCE_1_1.37
82 SCROLL_THRESHOLD, ///< name "scrollThreshold" Vertical scrolling will occur if the cursor is this close to the control border, type FLOAT @SINCE_1_1.37
83 SCROLL_SPEED, ///< name "scrollSpeed" The scroll speed in pixels per second, type FLOAT @SINCE_1_1.37
84 PRIMARY_CURSOR_COLOR, ///< name "primaryCursorColor", The color to apply to the primary cursor, type VECTOR4 @SINCE_1_1.37
85 SECONDARY_CURSOR_COLOR, ///< name "secondaryCursorColor", The color to apply to the secondary cursor, type VECTOR4 @SINCE_1_1.37
86 ENABLE_CURSOR_BLINK, ///< name "enableCursorBlink", Whether the cursor should blink or not, type BOOLEAN @SINCE_1_1.37
87 CURSOR_BLINK_INTERVAL, ///< name "cursorBlinkInterval", The time interval in seconds between cursor on/off states, type FLOAT @SINCE_1_1.37
88 CURSOR_BLINK_DURATION, ///< name "cursorBlinkDuration", The cursor will stop blinking after this number of seconds (if non-zero), type FLOAT @SINCE_1_1.37
89 CURSOR_WIDTH, ///< name "cursorWidth", The cursor width, type INTEGER @SINCE_1_1.37
90 GRAB_HANDLE_IMAGE, ///< name "grabHandleImage", The image to display for the grab handle, type STRING @SINCE_1_1.37
91 GRAB_HANDLE_PRESSED_IMAGE, ///< name "grabHandlePressedImage", The image to display when the grab handle is pressed, type STRING @SINCE_1_1.37
92 SELECTION_HANDLE_IMAGE_LEFT, ///< name "selectionHandleImageLeft", The image to display for the left selection handle, type MAP @SINCE_1_1.37
93 SELECTION_HANDLE_IMAGE_RIGHT, ///< name "selectionHandleImageRight", The image to display for the right selection handle, type MAP @SINCE_1_1.37
94 SELECTION_HANDLE_PRESSED_IMAGE_LEFT, ///< name "selectionHandlePressedImageLeft", The image to display when the left selection handle is pressed, type MAP @SINCE_1_1.37
95 SELECTION_HANDLE_PRESSED_IMAGE_RIGHT, ///< name "selectionHandlePressedImageRight", The image to display when the right selection handle is pressed, type MAP @SINCE_1_1.37
96 SELECTION_HANDLE_MARKER_IMAGE_LEFT, ///< name "selectionHandleMarkerImageLeft", The image to display for the left selection handle marker, type MAP @SINCE_1_1.37
97 SELECTION_HANDLE_MARKER_IMAGE_RIGHT, ///< name "selectionHandleMarkerImageRight", The image to display for the right selection handle marker, type MAP @SINCE_1_1.37
98 SELECTION_HIGHLIGHT_COLOR, ///< name "selectionHighlightColor", The color of the selection highlight, type VECTOR4 @SINCE_1_1.37
99 DECORATION_BOUNDING_BOX, ///< name "decorationBoundingBox", The decorations (handles etc) will positioned within this area on-screen, type RECTANGLE @SINCE_1_1.37
100 ENABLE_MARKUP, ///< name "enableMarkup", Whether the mark-up processing is enabled. type BOOLEAN @SINCE_1_1.37
101 INPUT_COLOR, ///< name "inputColor", The color of the new input text, type VECTOR4 @SINCE_1_1.37
102 INPUT_FONT_FAMILY, ///< name "inputFontFamily", The font's family of the new input text, type STRING @SINCE_1_1.37
103 INPUT_FONT_STYLE, ///< name "inputFontStyle", The font's style of the new input text, type STRING or MAP @SINCE_1_2.13
104 INPUT_POINT_SIZE, ///< name "inputPointSize", The font's size of the new input text in points, type FLOAT @SINCE_1_1.37
105 LINE_SPACING, ///< name "lineSpacing", The default extra space between lines in points, type FLOAT @SINCE_1_1.37
106 INPUT_LINE_SPACING, ///< name "inputLineSpacing" The extra space between lines in points. It affects the whole paragraph where the new input text is inserted, type FLOAT @SINCE_1_1.37
107 UNDERLINE, ///< name "underline" The default underline parameters, type STRING or MAP @SINCE_1_2.13
108 INPUT_UNDERLINE, ///< name "inputUnderline" The underline parameters of the new input text, type STRING or MAP @SINCE_1_2.13
109 SHADOW, ///< name "shadow" The default shadow parameters, type STRING or MAP @SINCE_1_2.13
110 INPUT_SHADOW, ///< name "inputShadow" The shadow parameters of the new input text, type STRING or MAP @SINCE_1_2.13
111 EMBOSS, ///< name "emboss" The default emboss parameters, type STRING or MAP @SINCE_1_2.13
112 INPUT_EMBOSS, ///< name "inputEmboss" The emboss parameters of the new input text, type STRING or MAP @SINCE_1_2.13
113 OUTLINE, ///< name "outline" The default outline parameters, type STRING or MAP @SINCE_1_2.13
114 INPUT_OUTLINE, ///< name "inputOutline" The outline parameters of the new input text, type STRING or MAP @SINCE_1_2.13
119 * @brief Mask used by the signal InputStyleChangedSignal(). Notifies which parameters of the input style have changed.
126 * @brief Enumeration for mask used by the signal InputStyleChangedSignal().
131 NONE = 0x0000, ///< @SINCE_1_2_2
132 COLOR = 0x0001, ///< @SINCE_1_2_2
133 FONT_FAMILY = 0x0002, ///< @SINCE_1_2_2
134 POINT_SIZE = 0x0004, ///< @SINCE_1_2_2
135 FONT_STYLE = 0x0008, ///< @SINCE_1_2_2
136 LINE_SPACING = 0x0010, ///< @SINCE_1_2_2
137 UNDERLINE = 0x0020, ///< @SINCE_1_2_2
138 SHADOW = 0x0040, ///< @SINCE_1_2_2
139 EMBOSS = 0x0080, ///< @SINCE_1_2_2
140 OUTLINE = 0x0100 ///< @SINCE_1_2_2
147 * @brief Text changed signal type.
150 typedef Signal<void ( TextEditor ) > TextChangedSignalType;
153 * @brief Input Style changed signal type.
156 typedef Signal<void ( TextEditor, InputStyle::Mask ) > InputStyleChangedSignalType;
159 * @brief Creates the TextEditor control.
162 * @return A handle to the TextEditor control
164 static TextEditor New();
167 * @brief Creates an empty handle.
174 * @brief Copy constructor.
177 * @param[in] handle The handle to copy from
179 TextEditor( const TextEditor& handle );
182 * @brief Assignment operator.
185 * @param[in] handle The handle to copy from
186 * @return A reference to this
188 TextEditor& operator=( const TextEditor& handle );
193 * This is non-virtual since derived Handle types must not contain data or virtual methods.
199 * @brief Downcasts a handle to TextEditor.
201 * If the BaseHandle points is a TextEditor, the downcast returns a valid handle.
202 * If not, the returned handle is left empty.
205 * @param[in] handle Handle to an object
206 * @return Handle to a TextEditor or an empty handle
208 static TextEditor DownCast( BaseHandle handle );
213 * @brief This signal is emitted when the text changes.
215 * A callback of the following type may be connected:
217 * void YourCallbackName( TextEditor textEditor );
221 * @return The signal to connect to
223 TextChangedSignalType& TextChangedSignal();
226 * @brief This signal is emitted when the input style is updated as a consequence of a change in the cursor position.
227 * i.e. The signal is not emitted when the input style is updated through the property system.
229 * A callback of the following type may be connected. The @p mask parameter notifies which parts of the style have changed.
231 * void YourCallbackName( TextEditor textEditor, TextEditor::InputStyle::Mask mask );
235 * @return The signal to connect to
237 InputStyleChangedSignalType& InputStyleChangedSignal();
239 public: // Not intended for application developers
243 * @brief Creates a handle using the Toolkit::Internal implementation.
246 * @param[in] implementation The Control implementation
248 DALI_INTERNAL TextEditor( Internal::TextEditor& implementation );
251 * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
254 * @param[in] internal A pointer to the internal CustomActor
256 explicit DALI_INTERNAL TextEditor( Dali::Internal::CustomActor* internal );
263 } // namespace Toolkit
267 #endif // __DALI_TOOLKIT_TEXT_EDITOR_H__