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 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 An enumeration of properties belonging to the TextEditor class.
71 RENDERING_BACKEND = PROPERTY_START_INDEX, ///< name "renderingBackend", The type or rendering e.g. bitmap-based, type INT @SINCE_1_1.37
72 TEXT, ///< name "text", The text to display in UTF-8 format, type STRING @SINCE_1_1.37
73 TEXT_COLOR, ///< name "textColor", The text color, type VECTOR4 @SINCE_1_1.37
74 FONT_FAMILY, ///< name "fontFamily", The requested font family, type STRING @SINCE_1_1.37
75 FONT_STYLE, ///< name "fontStyle", The requested font style, type STRING @SINCE_1_1.37
76 POINT_SIZE, ///< name "pointSize", The size of font in points, type FLOAT @SINCE_1_1.37
77 HORIZONTAL_ALIGNMENT, ///< name "horizontalAlignment", The text horizontal alignment, type STRING, values "BEGIN", "CENTER", "END" @SINCE_1_1.37
78 SCROLL_THRESHOLD, ///< name "scrollThreshold" Vertical scrolling will occur if the cursor is this close to the control border, type FLOAT @SINCE_1_1.37
79 SCROLL_SPEED, ///< name "scrollSpeed" The scroll speed in pixels per second, type FLOAT @SINCE_1_1.37
80 PRIMARY_CURSOR_COLOR, ///< name "primaryCursorColor", The color to apply to the primary cursor, type VECTOR4 @SINCE_1_1.37
81 SECONDARY_CURSOR_COLOR, ///< name "secondaryCursorColor", The color to apply to the secondary cursor, type VECTOR4 @SINCE_1_1.37
82 ENABLE_CURSOR_BLINK, ///< name "enableCursorBlink", Whether the cursor should blink or not, type BOOLEAN @SINCE_1_1.37
83 CURSOR_BLINK_INTERVAL, ///< name "cursorBlinkInterval", The time interval in seconds between cursor on/off states, type FLOAT @SINCE_1_1.37
84 CURSOR_BLINK_DURATION, ///< name "cursorBlinkDuration", The cursor will stop blinking after this number of seconds (if non-zero), type FLOAT @SINCE_1_1.37
85 CURSOR_WIDTH, ///< name "cursorWidth", The cursor width, type INTEGER @SINCE_1_1.37
86 GRAB_HANDLE_IMAGE, ///< name "grabHandleImage", The image to display for the grab handle, type STRING @SINCE_1_1.37
87 GRAB_HANDLE_PRESSED_IMAGE, ///< name "grabHandlePressedImage", The image to display when the grab handle is pressed, type STRING @SINCE_1_1.37
88 SELECTION_HANDLE_IMAGE_LEFT, ///< name "selectionHandleImageLeft", The image to display for the left selection handle, type MAP @SINCE_1_1.37
89 SELECTION_HANDLE_IMAGE_RIGHT, ///< name "selectionHandleImageRight", The image to display for the right selection handle, type MAP @SINCE_1_1.37
90 SELECTION_HANDLE_PRESSED_IMAGE_LEFT, ///< name "selectionHandlePressedImageLeft", The image to display when the left selection handle is pressed, type MAP @SINCE_1_1.37
91 SELECTION_HANDLE_PRESSED_IMAGE_RIGHT, ///< name "selectionHandlePressedImageRight", The image to display when the right selection handle is pressed, type MAP @SINCE_1_1.37
92 SELECTION_HANDLE_MARKER_IMAGE_LEFT, ///< name "selectionHandleMarkerImageLeft", The image to display for the left selection handle marker, type MAP @SINCE_1_1.37
93 SELECTION_HANDLE_MARKER_IMAGE_RIGHT, ///< name "selectionHandleMarkerImageRight", The image to display for the right selection handle marker, type MAP @SINCE_1_1.37
94 SELECTION_HIGHLIGHT_COLOR, ///< name "selectionHighlightColor", The color of the selection highlight, type VECTOR4 @SINCE_1_1.37
95 DECORATION_BOUNDING_BOX, ///< name "decorationBoundingBox", The decorations (handles etc) will positioned within this area on-screen, type RECTANGLE @SINCE_1_1.37
96 ENABLE_MARKUP, ///< name "enableMarkup", Whether the mark-up processing is enabled. type BOOLEAN @SINCE_1_1.37
97 INPUT_COLOR, ///< name "inputColor", The color of the new input text, type VECTOR4 @SINCE_1_1.37
98 INPUT_FONT_FAMILY, ///< name "inputFontFamily", The font's family of the new input text, type STRING @SINCE_1_1.37
99 INPUT_FONT_STYLE, ///< name "inputFontStyle", The font's style of the new input text, type STRING @SINCE_1_1.37
100 INPUT_POINT_SIZE, ///< name "inputPointSize", The font's size of the new input text in points, type FLOAT @SINCE_1_1.37
101 LINE_SPACING, ///< name "lineSpacing", The default extra space between lines in points, type FLOAT @SINCE_1_1.37
102 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
103 UNDERLINE, ///< name "underline" The default underline parameters, type STRING @SINCE_1_1.37
104 INPUT_UNDERLINE, ///< name "inputUnderline" The underline parameters of the new input text, type STRING @SINCE_1_1.37
105 SHADOW, ///< name "shadow" The default shadow parameters, type STRING @SINCE_1_1.37
106 INPUT_SHADOW, ///< name "inputShadow" The shadow parameters of the new input text, type STRING @SINCE_1_1.37
107 EMBOSS, ///< name "emboss" The default emboss parameters, type STRING @SINCE_1_1.37
108 INPUT_EMBOSS, ///< name "inputEmboss" The emboss parameters of the new input text, type STRING @SINCE_1_1.37
109 OUTLINE, ///< name "outline" The default outline parameters, type STRING @SINCE_1_1.37
110 INPUT_OUTLINE, ///< name "inputOutline" The outline parameters of the new input text, type STRING @SINCE_1_1.37
115 * @brief Mask used by the signal InputStyleChangedSignal(). Notifies which parameters of the input style have changed.
123 NONE = 0x0000, ///< @SINCE_1_2.2
124 COLOR = 0x0001, ///< @SINCE_1_2.2
125 FONT_FAMILY = 0x0002, ///< @SINCE_1_2.2
126 POINT_SIZE = 0x0004, ///< @SINCE_1_2.2
127 FONT_STYLE = 0x0008, ///< @SINCE_1_2.2
128 LINE_SPACING = 0x0010, ///< @SINCE_1_2.2
129 UNDERLINE = 0x0020, ///< @SINCE_1_2.2
130 SHADOW = 0x0040, ///< @SINCE_1_2.2
131 EMBOSS = 0x0080, ///< @SINCE_1_2.2
132 OUTLINE = 0x0100 ///< @SINCE_1_2.2
139 * @brief Text changed signal type.
142 typedef Signal<void ( TextEditor ) > TextChangedSignalType;
145 * @brief Input Style changed signal type.
148 typedef Signal<void ( TextEditor, InputStyle::Mask ) > InputStyleChangedSignalType;
151 * @brief Create the TextEditor control.
154 * @return A handle to the TextEditor control.
156 static TextEditor New();
159 * @brief Creates an empty handle.
166 * @brief Copy constructor.
169 * @param[in] handle The handle to copy from.
171 TextEditor( const TextEditor& handle );
174 * @brief Assignment operator.
177 * @param[in] handle The handle to copy from.
178 * @return A reference to this.
180 TextEditor& operator=( const TextEditor& handle );
185 * This is non-virtual since derived Handle types must not contain data or virtual methods.
191 * @brief Downcast a handle to TextEditor.
193 * If the BaseHandle points is a TextEditor the downcast returns a valid handle.
194 * If not the returned handle is left empty.
197 * @param[in] handle Handle to an object.
198 * @return handle to a TextEditor or an empty handle.
200 static TextEditor DownCast( BaseHandle handle );
205 * @brief This signal is emitted when the text changes.
207 * A callback of the following type may be connected:
209 * void YourCallbackName( TextEditor textEditor );
213 * @return The signal to connect to.
215 TextChangedSignalType& TextChangedSignal();
218 * @brief This signal is emitted when the input style is updated as a consequence of a change in the cursor position.
219 * i.e. The signal is not emitted when the input style is updated through the property system.
221 * A callback of the following type may be connected. The @p mask parameter notifies which parts of the style have changed.
223 * void YourCallbackName( TextEditor textEditor, TextEditor::InputStyle::Mask mask );
227 * @return The signal to connect to.
229 InputStyleChangedSignalType& InputStyleChangedSignal();
231 public: // Not intended for application developers
235 * @brief Creates a handle using the Toolkit::Internal implementation.
238 * @param[in] implementation The Control implementation.
240 DALI_INTERNAL TextEditor( Internal::TextEditor& implementation );
243 * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
246 * @param[in] internal A pointer to the internal CustomActor.
248 explicit DALI_INTERNAL TextEditor( Dali::Internal::CustomActor* internal );
255 } // namespace Toolkit
259 #endif // __DALI_TOOLKIT_TEXT_EDITOR_H__