1 #ifndef __DALI_TOOLKIT_TEXT_FIELD_H__
2 #define __DALI_TOOLKIT_TEXT_FIELD_H__
5 * Copyright (c) 2015 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 single-line editable text field.
43 * | %Signal Name | Method |
44 * |----------------------|-----------------------------------------------------|
45 * | textChanged | @ref TextChangedSignal() |
46 * | maxLengthReached | @ref MaxLengthReachedSignal() |
50 class DALI_IMPORT_API TextField : public Control
55 * @brief The start and end property ranges for this control.
60 PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1, ///< @SINCE_1_0.0
61 PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000 ///< Reserve property indices @SINCE_1_0.0
65 * @brief An enumeration of properties belonging to the TextField class.
72 RENDERING_BACKEND = PROPERTY_START_INDEX, ///< name "renderingBackend", The type or rendering e.g. bitmap-based, type INT @SINCE_1_0.0
73 TEXT, ///< name "text", The text to display in UTF-8 format, type STRING @SINCE_1_0.0
74 PLACEHOLDER_TEXT, ///< name "placeholderText", The text to display when the TextField is empty and inactive, type STRING @SINCE_1_0.0
75 PLACEHOLDER_TEXT_FOCUSED, ///< name "placeholderTextFocused", The text to display when the TextField is empty with key-input focus, type STRING @SINCE_1_0.0
76 FONT_FAMILY, ///< name "fontFamily", The requested font family, type STRING @SINCE_1_0.0
77 FONT_STYLE, ///< name "fontStyle", The requested font style, type STRING @SINCE_1_0.0
78 POINT_SIZE, ///< name "pointSize", The size of font in points, type FLOAT @SINCE_1_0.0
79 MAX_LENGTH, ///< name "maxLength" The maximum number of characters that can be inserted, type INTEGER @SINCE_1_0.0
80 EXCEED_POLICY, ///< name "exceedPolicy" Specifies how the text is truncated when it does not fit, type INTEGER @SINCE_1_0.0
81 HORIZONTAL_ALIGNMENT, ///< name "horizontalAlignment", The line horizontal alignment, type STRING, values "BEGIN", "CENTER", "END" @SINCE_1_0.0
82 VERTICAL_ALIGNMENT, ///< name "verticalAlignment", The line vertical alignment, type STRING, values "TOP", "CENTER", "BOTTOM" @SINCE_1_0.0
83 TEXT_COLOR, ///< name "textColor", The text color, type VECTOR4 @SINCE_1_0.0
84 PLACEHOLDER_TEXT_COLOR, ///< name "placeholderTextColor", The placeholder-text color, type VECTOR4 @SINCE_1_0.0
85 SHADOW_OFFSET, ///< name "shadowOffset", The drop shadow offset 0 indicates no shadow, type VECTOR2 @SINCE_1_0.0
86 SHADOW_COLOR, ///< name "shadowColor", The color of a drop shadow, type VECTOR4 @SINCE_1_0.0
87 PRIMARY_CURSOR_COLOR, ///< name "primaryCursorColor", The color to apply to the primary cursor, type VECTOR4 @SINCE_1_0.0
88 SECONDARY_CURSOR_COLOR, ///< name "secondaryCursorColor", The color to apply to the secondary cursor, type VECTOR4 @SINCE_1_0.0
89 ENABLE_CURSOR_BLINK, ///< name "enableCursorBlink", Whether the cursor should blink or not, type BOOLEAN @SINCE_1_0.0
90 CURSOR_BLINK_INTERVAL, ///< name "cursorBlinkInterval", The time interval in seconds between cursor on/off states, type FLOAT @SINCE_1_0.0
91 CURSOR_BLINK_DURATION, ///< name "cursorBlinkDuration", The cursor will stop blinking after this number of seconds (if non-zero), type FLOAT @SINCE_1_0.0
92 CURSOR_WIDTH, ///< name "cursorWidth", The cursor width, type INTEGER @SINCE_1_0.0
93 GRAB_HANDLE_IMAGE, ///< name "grabHandleImage", The image to display for the grab handle, type STRING @SINCE_1_0.0
94 GRAB_HANDLE_PRESSED_IMAGE, ///< name "grabHandlePressedImage", The image to display when the grab handle is pressed, type STRING @SINCE_1_0.0
95 SCROLL_THRESHOLD, ///< name "scrollThreshold" Horizontal scrolling will occur if the cursor is this close to the control border, type FLOAT @SINCE_1_0.0
96 SCROLL_SPEED, ///< name "scrollSpeed" The scroll speed in pixels per second, type FLOAT @SINCE_1_0.0
97 SELECTION_HANDLE_IMAGE_LEFT, ///< name "selectionHandleImageLeft", The image to display for the left selection handle, type MAP @SINCE_1_0.0
98 SELECTION_HANDLE_IMAGE_RIGHT, ///< name "selectionHandleImageRight", The image to display for the right selection handle, type MAP @SINCE_1_0.0
99 SELECTION_HANDLE_PRESSED_IMAGE_LEFT, ///< name "selectionHandlePressedImageLeft", The image to display when the left selection handle is pressed, type MAP @SINCE_1_0.0
100 SELECTION_HANDLE_PRESSED_IMAGE_RIGHT, ///< name "selectionHandlePressedImageRight", The image to display when the right selection handle is pressed, type MAP @SINCE_1_0.0
101 SELECTION_HANDLE_MARKER_IMAGE_LEFT, ///< name "selectionHandleMarkerImageLeft", The image to display for the left selection handle marker, type MAP @SINCE_1_0.0
102 SELECTION_HANDLE_MARKER_IMAGE_RIGHT, ///< name "selectionHandleMarkerImageRight", The image to display for the right selection handle marker, type MAP @SINCE_1_0.0
103 SELECTION_HIGHLIGHT_COLOR, ///< name "selectionHighlightColor", The color of the selection highlight, type VECTOR4 @SINCE_1_0.0
104 DECORATION_BOUNDING_BOX, ///< name "decorationBoundingBox", The decorations (handles etc) will positioned within this area on-screen, type RECTANGLE @SINCE_1_0.0
105 INPUT_METHOD_SETTINGS, ///< name "inputMethodSettings", The settings to relating to the System's Input Method, Key and Value type MAP @SINCE_1_0.0
106 INPUT_COLOR, ///< name "inputColor", The color of the new input text, type VECTOR4 @SINCE_1_0.0
107 ENABLE_MARKUP, ///< name "enableMarkup", Whether the mark-up processing is enabled. type BOOLEAN @SINCE_1_0.0
108 INPUT_FONT_FAMILY, ///< name "inputFontFamily", The font's family of the new input text, type STRING @SINCE_1_0.0
109 INPUT_FONT_STYLE, ///< name "inputFontStyle", The font's style of the new input text, type STRING @SINCE_1_0.0
110 INPUT_POINT_SIZE ///< name "inputPointSize", The font's size of the new input text in points, type FLOAT @SINCE_1_0.0
115 * @brief Specifies how the text is truncated when it does not fit
117 * The default value is \e EXCEED_POLICY_CLIP.
122 EXCEED_POLICY_ORIGINAL, ///< The text will be display at original size, and may exceed the TextField boundary. @SINCE_1_0.0
123 EXCEED_POLICY_CLIP ///< The end of text will be clipped to fit within the TextField. @SINCE_1_0.0
128 /// @brief Text changed signal type.
129 typedef Signal<void ( TextField ) > TextChangedSignalType;
130 /// @brief Max Characters Exceed signal type.
131 typedef Signal<void ( TextField ) > MaxLengthReachedSignalType;
134 * @brief Create the TextField control.
136 * @return A handle to the TextField control.
138 static TextField New();
141 * @brief Creates an empty handle.
147 * @brief Copy constructor.
150 * @param[in] handle The handle to copy from.
152 TextField( const TextField& handle );
155 * @brief Assignment operator.
158 * @param[in] handle The handle to copy from.
159 * @return A reference to this.
161 TextField& operator=( const TextField& handle );
166 * This is non-virtual since derived Handle types must not contain data or virtual methods.
172 * @brief Downcast a handle to TextField.
174 * If the BaseHandle points is a TextField the downcast returns a valid handle.
175 * If not the returned handle is left empty.
178 * @param[in] handle Handle to an object.
179 * @return handle to a TextField or an empty handle.
181 static TextField DownCast( BaseHandle handle );
186 * @brief This signal is emitted when the text changes.
188 * A callback of the following type may be connected:
190 * void YourCallbackName( TextField textField );
193 * @return The signal to connect to.
195 TextChangedSignalType& TextChangedSignal();
198 * @brief This signal is emitted when inserted text exceeds the maximum character limit.
200 * A callback of the following type may be connected:
202 * void YourCallbackName( TextField textField );
205 * @return The signal to connect to.
207 MaxLengthReachedSignalType& MaxLengthReachedSignal();
209 public: // Not intended for application developers
212 * @brief Creates a handle using the Toolkit::Internal implementation.
215 * @param[in] implementation The Control implementation.
217 DALI_INTERNAL TextField( Internal::TextField& implementation );
220 * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
223 * @param[in] internal A pointer to the internal CustomActor.
225 explicit DALI_INTERNAL TextField( Dali::Internal::CustomActor* internal );
231 } // namespace Toolkit
235 #endif // __DALI_TOOLKIT_TEXT_FIELD_H__