1 #ifndef __DALI_TOOLKIT_TEXT_FIELD_H__
2 #define __DALI_TOOLKIT_TEXT_FIELD_H__
5 * Copyright (c) 2017 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() | @SINCE_1_0.0 |
46 * | maxLengthReached | @ref MaxLengthReachedSignal() | @SINCE_1_0.0 |
47 * | inputStyleChanged | @ref InputStyleChangedSignal() | @SINCE_1_2_2 |
49 class DALI_IMPORT_API TextField : public Control
54 * @brief The start and end property ranges for this control.
59 PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1, ///< @SINCE_1_0.0
60 PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000 ///< Reserve property indices @SINCE_1_0.0
64 * @brief Enumeration for the instance of properties belonging to the TextField class.
70 * @brief Enumeration for the instance of properties belonging to the TextField class.
76 * @brief The type or rendering e.g. bitmap-based.
77 * @details Name "renderingBackend", type Property::INTEGER.
80 RENDERING_BACKEND = PROPERTY_START_INDEX,
83 * @brief The text to display in UTF-8 format.
84 * @details Name "text", type Property::STRING.
90 * @brief The text to display when the TextField is empty and inactive.
91 * @details Name "placeholderText", type Property::STRING.
97 * @brief The text to display when the TextField is empty with key-input focus.
98 * @details Name "placeholderTextFocused", type Property::STRING.
101 PLACEHOLDER_TEXT_FOCUSED,
104 * @brief The requested font family.
105 * @details Name "fontFamily", type Property::STRING.
111 * @brief The requested font style
112 * @details Name "fontStyle", type Property::STRING or Property::MAP.
118 * @brief The size of font in points.
119 * @details Name "pointSize", type Property::FLOAT.
120 * (Conversion from Pixel size to Point size : Point size = Pixel size * 72 / DPI).
126 * @brief The maximum number of characters that can be inserted.
127 * @details Name "maxLength", type Property::INTEGER.
133 * @brief Specifies how the text is truncated when it does not fit.
134 * @details Name "exceedPolicy", type Property::INTEGER.
140 * @brief The line horizontal alignment.
141 * @details Name "horizontalAlignment", type Property::STRING or type HorizontalAlignment::Type (Property::INTEGER)
142 * Values "BEGIN", "CENTER", "END".
143 * @note Return type is Property::STRING
146 HORIZONTAL_ALIGNMENT,
149 * @brief The line vertical alignment.
150 * @details Name "verticalAlignment", type Property::STRING type VerticalAlignment::Type (Property::INTEGER)
151 * Values "TOP", "CENTER", "BOTTOM".
152 * @note Return type is Property::STRING
158 * @brief The text color.
159 * @details Name "textColor", type Property::VECTOR4.
165 * @brief The placeholder-text color.
166 * @details Name "placeholderTextColor", type Property::VECTOR4.
169 PLACEHOLDER_TEXT_COLOR,
172 * @DEPRECATED_1_1.37 Use SHADOW instead.
173 * @brief The drop shadow offset 0 indicates no shadow.
174 * @details Name "shadowOffset", type Property::VECTOR2.
180 * @DEPRECATED_1_1.37 Use SHADOW instead.
181 * @brief The color of a drop shadow.
182 * @details Name "shadowColor", type Property::VECTOR4.
188 * @brief The color to apply to the primary cursor.
189 * @details Name "primaryCursorColor", type Property::VECTOR4.
192 PRIMARY_CURSOR_COLOR,
195 * @brief The color to apply to the secondary cursor.
196 * @details Name "secondaryCursorColor", type Property::VECTOR4.
199 SECONDARY_CURSOR_COLOR,
202 * @brief Whether the cursor should blink or not.
203 * @details Name "enableCursorBlink", type Property::BOOLEAN.
209 * @brief The time interval in seconds between cursor on/off states.
210 * @details Name "cursorBlinkInterval", type Property::FLOAT.
213 CURSOR_BLINK_INTERVAL,
216 * @brief The cursor will stop blinking after this number of seconds (if non-zero)
217 * @details Name "cursorBlinkDuration", type Property::FLOAT.
220 CURSOR_BLINK_DURATION,
223 * @brief The cursor width.
224 * @details Name "cursorWidth", type Property::INTEGER.
230 * @brief The image to display for the grab handle.
231 * @details Name "grabHandleImage", type Property::STRING.
237 * @brief The image to display when the grab handle is pressed
238 * @details Name "grabHandlePressedImage", type Property::STRING.
241 GRAB_HANDLE_PRESSED_IMAGE,
244 * @brief Horizontal scrolling will occur if the cursor is this close to the control border.
245 * @details Name "scrollThreshold", type Property::FLOAT.
251 * @brief The scroll speed in pixels per second.
252 * @details Name "scrollSpeed", type Property::FLOAT.
258 * @brief The image to display for the left selection handle.
259 * @details Name "selectionHandleImageLeft", type Property::MAP.
262 SELECTION_HANDLE_IMAGE_LEFT,
265 * @brief The image to display for the right selection handle.
266 * @details Name "selectionHandleImageRight", type Property::MAP.
269 SELECTION_HANDLE_IMAGE_RIGHT,
272 * @brief The image to display when the left selection handle is pressed.
273 * @details Name "selectionHandlePressedImageLeft", type Property::MAP.
276 SELECTION_HANDLE_PRESSED_IMAGE_LEFT,
279 * @brief The image to display when the right selection handle is pressed.
280 * @details Name "selectionHandlePressedImageRight", type Property::MAP.
283 SELECTION_HANDLE_PRESSED_IMAGE_RIGHT,
286 * @brief The image to display for the left selection handle marker.
287 * @details Name "selectionHandleMarkerImageLeft", type Property::MAP.
290 SELECTION_HANDLE_MARKER_IMAGE_LEFT,
293 * @brief The image to display for the right selection handle marker.
294 * @details Name "selectionHandleMarkerImageRight", type Property::MAP.
297 SELECTION_HANDLE_MARKER_IMAGE_RIGHT,
300 * @brief The color of the selection highlight.
301 * @details Name "selectionHighlightColor", type Property::VECTOR4.
304 SELECTION_HIGHLIGHT_COLOR,
307 * @brief The decorations (handles etc) will positioned within this area on-screen.
308 * @details Name "decorationBoundingBox", type Property::RECTANGLE.
311 DECORATION_BOUNDING_BOX,
314 * @brief The settings to relating to the System's Input Method, Key and Value.
315 * @details Name "inputMethodSettings", type Property::MAP.
318 INPUT_METHOD_SETTINGS,
321 * @brief The color of the new input text.
322 * @details Name "inputColor", type Property::VECTOR4.
328 * @brief Whether the mark-up processing is enabled.
329 * @details Name "enableMarkup", type Property::BOOLEAN.
335 * @brief The font's family of the new input text.
336 * @details Name "inputFontFamily", type Property::STRING.
342 * @brief The font's style of the new input text.
343 * @details Name "inputFontStyle", type Property::MAP.
349 * @brief The font's size of the new input text in points.
350 * @details Name "inputPointSize", type Property::FLOAT.
356 * @brief The default underline parameters.
357 * @details Name "underline", type Property::MAP.
363 * @brief The underline parameters of the new input text.
364 * @details Name "inputUnderline", type Property::MAP.
370 * @brief The default shadow parameters.
371 * @details Name "shadow", type Property::MAP.
377 * @brief The shadow parameters of the new input text.
378 * @details Name "inputShadow", type Property::MAP.
384 * @brief The default emboss parameters.
385 * @details Name "emboss", type Property::MAP.
391 * @brief The emboss parameters of the new input text.
392 * @details Name "inputEmboss", type Property::MAP.
398 * @brief The default outline parameters.
399 * @details Name "outline", type Property::MAP.
405 * @brief The outline parameters of the new input text.
406 * @details Name "inputOutline", type Property::MAP.
412 * @brief Hides the input characters and instead shows a default character for password or pin entry.
413 * @details Name "hiddenInputSettings", type Property::MAP.
416 * @see HiddenInput::Property
418 HIDDEN_INPUT_SETTINGS,
421 * @brief The size of font in pixels.
422 * @details Name "pixelSize", type Property::FLOAT.
423 * Conversion from Point size to Pixel size:
424 * Pixel size = Point size * DPI / 72
430 * @brief Enables Text selection, such as the cursor, handle, clipboard, and highlight color.
431 * @details Name "enableSelection", type Property::BOOLEAN.
437 * @brief Sets the placeholder : text, color, font family, font style, point size, and pixel size.
438 * @details Name "placeholder", type Property::MAP.
441 * Property::Map propertyMap;
442 * propertyMap[ Text::PlaceHolder::Property::TEXT ] = "Setting Placeholder Text";
443 * propertyMap[ Text::PlaceHolder::Property::TEXT_FOCUSED] = "Setting Placeholder Text Focused";
444 * propertyMap[ Text::PlaceHolder::Property::COLOR] = Color::RED;
445 * propertyMap[ Text::PlaceHolder::Property::FONT_FAMILY ] = "Arial";
446 * propertyMap[ Text::PlaceHolder::Property::POINT_SIZE ] = 12.0f;
447 * propertyMap[ Text::PlaceHolder::Property::ELLIPSIS ] = true;
449 * Property::Map fontStyleMap;
450 * fontStyleMap.Insert( "weight", "bold" );
451 * fontStyleMap.Insert( "width", "condensed" );
452 * fontStyleMap.Insert( "slant", "italic" );
453 * propertyMap[ Text::PlaceHolder::Property::FONT_STYLE] = fontStyleMap;
455 * field.SetProperty( TextField::Property::PLACEHOLDER, propertyMap );
462 * @brief Whether we should show the ellipsis if it is required.
463 * @details Name "ellipsis", type Property::BOOLEAN.
465 * @note PLACEHOLDER map is used to add ellipsis to placeholder text.
472 * @brief Enumeration for specifying how the text is truncated when it does not fit.
474 * The default value is \e EXCEED_POLICY_CLIP.
479 EXCEED_POLICY_ORIGINAL, ///< The text will be display at original size, and may exceed the TextField boundary. @SINCE_1_0.0
480 EXCEED_POLICY_CLIP ///< The end of text will be clipped to fit within the TextField. @SINCE_1_0.0
484 * @brief Mask used by the signal InputStyleChangedSignal(). Notifies which parameters of the input style have changed.
491 * @brief Mask used by the signal InputStyleChangedSignal().
497 NONE = 0x0000, ///< @SINCE_1_2_2
498 COLOR = 0x0001, ///< @SINCE_1_2_2
499 FONT_FAMILY = 0x0002, ///< @SINCE_1_2_2
500 POINT_SIZE = 0x0004, ///< @SINCE_1_2_2
501 FONT_STYLE = 0x0008, ///< @SINCE_1_2_2
502 UNDERLINE = 0x0010, ///< @SINCE_1_2_2
503 SHADOW = 0x0020, ///< @SINCE_1_2_2
504 EMBOSS = 0x0040, ///< @SINCE_1_2_2
505 OUTLINE = 0x0080 ///< @SINCE_1_2_2
512 * @brief Text changed signal type.
515 typedef Signal<void ( TextField ) > TextChangedSignalType;
518 * @brief Max Characters Exceed signal type.
521 typedef Signal<void ( TextField ) > MaxLengthReachedSignalType;
524 * @brief Input Style changed signal type.
527 typedef Signal<void ( TextField, InputStyle::Mask ) > InputStyleChangedSignalType;
530 * @brief Creates the TextField control.
532 * @return A handle to the TextField control
534 static TextField New();
537 * @brief Creates an empty handle.
543 * @brief Copy constructor.
546 * @param[in] handle The handle to copy from
548 TextField( const TextField& handle );
551 * @brief Assignment operator.
554 * @param[in] handle The handle to copy from
555 * @return A reference to this
557 TextField& operator=( const TextField& handle );
562 * This is non-virtual since derived Handle types must not contain data or virtual methods.
568 * @brief Downcasts a handle to TextField.
570 * If the BaseHandle points is a TextField, the downcast returns a valid handle.
571 * If not, the returned handle is left empty.
574 * @param[in] handle Handle to an object
575 * @return Handle to a TextField or an empty handle
577 static TextField DownCast( BaseHandle handle );
582 * @brief This signal is emitted when the text changes.
584 * A callback of the following type may be connected:
586 * void YourCallbackName( TextField textField );
589 * @return The signal to connect to.
591 TextChangedSignalType& TextChangedSignal();
594 * @brief This signal is emitted when inserted text exceeds the maximum character limit.
596 * A callback of the following type may be connected:
598 * void YourCallbackName( TextField textField );
601 * @return The signal to connect to
603 MaxLengthReachedSignalType& MaxLengthReachedSignal();
606 * @brief This signal is emitted when the input style is updated as a consequence of a change in the cursor position.
607 * i.e. The signal is not emitted when the input style is updated through the property system.
609 * A callback of the following type may be connected. The @p mask parameter notifies which parts of the style have changed.
611 * void YourCallbackName( TextField textField, TextField::InputStyle::Mask mask );
615 * @return The signal to connect to
617 InputStyleChangedSignalType& InputStyleChangedSignal();
619 public: // Not intended for application developers
622 * @brief Creates a handle using the Toolkit::Internal implementation.
625 * @param[in] implementation The Control implementation
627 DALI_INTERNAL TextField( Internal::TextField& implementation );
630 * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
633 * @param[in] internal A pointer to the internal CustomActor
635 explicit DALI_INTERNAL TextField( Dali::Internal::CustomActor* internal );
641 } // namespace Toolkit
645 #endif // __DALI_TOOLKIT_TEXT_FIELD_H__