1 #ifndef __DALI_TOOLKIT_TEXT_FIELD_H__
2 #define __DALI_TOOLKIT_TEXT_FIELD_H__
5 * Copyright (c) 2018 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_TOOLKIT_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 * @brief This property is removed because it's deprecated.
174 RESERVED_PROPERTY_01,
177 * @brief This property is removed because it's deprecated.
179 RESERVED_PROPERTY_02,
182 * @brief The color to apply to the primary cursor.
183 * @details Name "primaryCursorColor", type Property::VECTOR4.
186 PRIMARY_CURSOR_COLOR,
189 * @brief The color to apply to the secondary cursor.
190 * @details Name "secondaryCursorColor", type Property::VECTOR4.
193 SECONDARY_CURSOR_COLOR,
196 * @brief Whether the cursor should blink or not.
197 * @details Name "enableCursorBlink", type Property::BOOLEAN.
203 * @brief The time interval in seconds between cursor on/off states.
204 * @details Name "cursorBlinkInterval", type Property::FLOAT.
207 CURSOR_BLINK_INTERVAL,
210 * @brief The cursor will stop blinking after this number of seconds (if non-zero)
211 * @details Name "cursorBlinkDuration", type Property::FLOAT.
214 CURSOR_BLINK_DURATION,
217 * @brief The cursor width.
218 * @details Name "cursorWidth", type Property::INTEGER.
224 * @brief The image to display for the grab handle.
225 * @details Name "grabHandleImage", type Property::STRING.
231 * @brief The image to display when the grab handle is pressed
232 * @details Name "grabHandlePressedImage", type Property::STRING.
235 GRAB_HANDLE_PRESSED_IMAGE,
238 * @brief Horizontal scrolling will occur if the cursor is this close to the control border.
239 * @details Name "scrollThreshold", type Property::FLOAT.
245 * @brief The scroll speed in pixels per second.
246 * @details Name "scrollSpeed", type Property::FLOAT.
252 * @brief The image to display for the left selection handle.
253 * @details Name "selectionHandleImageLeft", type Property::MAP.
256 SELECTION_HANDLE_IMAGE_LEFT,
259 * @brief The image to display for the right selection handle.
260 * @details Name "selectionHandleImageRight", type Property::MAP.
263 SELECTION_HANDLE_IMAGE_RIGHT,
266 * @brief The image to display when the left selection handle is pressed.
267 * @details Name "selectionHandlePressedImageLeft", type Property::MAP.
270 SELECTION_HANDLE_PRESSED_IMAGE_LEFT,
273 * @brief The image to display when the right selection handle is pressed.
274 * @details Name "selectionHandlePressedImageRight", type Property::MAP.
277 SELECTION_HANDLE_PRESSED_IMAGE_RIGHT,
280 * @brief The image to display for the left selection handle marker.
281 * @details Name "selectionHandleMarkerImageLeft", type Property::MAP.
284 SELECTION_HANDLE_MARKER_IMAGE_LEFT,
287 * @brief The image to display for the right selection handle marker.
288 * @details Name "selectionHandleMarkerImageRight", type Property::MAP.
291 SELECTION_HANDLE_MARKER_IMAGE_RIGHT,
294 * @brief The color of the selection highlight.
295 * @details Name "selectionHighlightColor", type Property::VECTOR4.
298 SELECTION_HIGHLIGHT_COLOR,
301 * @brief The decorations (handles etc) will positioned within this area on-screen.
302 * @details Name "decorationBoundingBox", type Property::RECTANGLE.
305 DECORATION_BOUNDING_BOX,
308 * @brief The settings to relating to the System's Input Method, Key and Value.
309 * @details Name "inputMethodSettings", type Property::MAP.
311 * @note VARIATION key can be changed depending on PANEL_LAYOUT.
312 * For example, when PANEL_LAYOUT key is InputMethod::PanelLayout::NORMAL,
313 * then VARIATION would be among NORMAL, WITH_FILENAME, and WITH_PERSON_NAME in Dali::InputMethod::NormalLayout.
314 * For more information, see Dali::InputMethod::Category.
318 * Property::Map propertyMap;
319 * InputMethod::PanelLayout::Type panelLayout = InputMethod::PanelLayout::NUMBER;
320 * InputMethod::AutoCapital::Type autoCapital = InputMethod::AutoCapital::WORD;
321 * InputMethod::ButtonAction::Type buttonAction = InputMethod::ButtonAction::GO;
322 * int inputVariation = 1;
323 * propertyMap["PANEL_LAYOUT"] = panelLayout;
324 * propertyMap["AUTO_CAPITALIZE"] = autoCapital;
325 * propertyMap["BUTTON_ACTION"] = buttonAction;
326 * propertyMap["VARIATION"] = inputVariation;
328 * field.SetProperty( TextField::Property::INPUT_METHOD_SETTINGS, propertyMap );
332 INPUT_METHOD_SETTINGS,
335 * @brief The color of the new input text.
336 * @details Name "inputColor", type Property::VECTOR4.
342 * @brief Whether the mark-up processing is enabled.
343 * @details Name "enableMarkup", type Property::BOOLEAN.
349 * @brief The font's family of the new input text.
350 * @details Name "inputFontFamily", type Property::STRING.
356 * @brief The font's style of the new input text.
357 * @details Name "inputFontStyle", type Property::MAP.
363 * @brief The font's size of the new input text in points.
364 * @details Name "inputPointSize", type Property::FLOAT.
370 * @copydoc Dali::Toolkit::TextLabel::Property::UNDERLINE
375 * @brief The underline parameters of the new input text.
376 * @details Name "inputUnderline", type Property::MAP.
382 * @copydoc Dali::Toolkit::TextLabel::Property::SHADOW
387 * @brief The shadow parameters of the new input text.
388 * @details Name "inputShadow", type Property::MAP.
394 * @brief The default emboss parameters.
395 * @details Name "emboss", type Property::MAP.
401 * @brief The emboss parameters of the new input text.
402 * @details Name "inputEmboss", type Property::MAP.
408 * @copydoc Dali::Toolkit::TextLabel::Property::OUTLINE
413 * @brief The outline parameters of the new input text.
414 * @details Name "inputOutline", type Property::MAP.
420 * @brief Hides the input characters and instead shows a default character for password or pin entry.
421 * @details Name "hiddenInputSettings", type Property::MAP.
424 * @see HiddenInput::Property
426 HIDDEN_INPUT_SETTINGS,
429 * @brief The size of font in pixels.
430 * @details Name "pixelSize", type Property::FLOAT.
431 * Conversion from Point size to Pixel size:
432 * Pixel size = Point size * DPI / 72
438 * @brief Enables Text selection, such as the cursor, handle, clipboard, and highlight color.
439 * @details Name "enableSelection", type Property::BOOLEAN.
445 * @brief Sets the placeholder : text, color, font family, font style, point size, and pixel size.
446 * @details Name "placeholder", type Property::MAP.
449 * Property::Map propertyMap;
450 * propertyMap[ Text::PlaceHolder::Property::TEXT ] = "Setting Placeholder Text";
451 * propertyMap[ Text::PlaceHolder::Property::TEXT_FOCUSED] = "Setting Placeholder Text Focused";
452 * propertyMap[ Text::PlaceHolder::Property::COLOR] = Color::RED;
453 * propertyMap[ Text::PlaceHolder::Property::FONT_FAMILY ] = "Arial";
454 * propertyMap[ Text::PlaceHolder::Property::POINT_SIZE ] = 12.0f;
455 * propertyMap[ Text::PlaceHolder::Property::ELLIPSIS ] = true;
457 * Property::Map fontStyleMap;
458 * fontStyleMap.Insert( "weight", "bold" );
459 * fontStyleMap.Insert( "width", "condensed" );
460 * fontStyleMap.Insert( "slant", "italic" );
461 * propertyMap[ Text::PlaceHolder::Property::FONT_STYLE] = fontStyleMap;
463 * field.SetProperty( TextField::Property::PLACEHOLDER, propertyMap );
470 * @brief Whether we should show the ellipsis if it is required.
471 * @details Name "ellipsis", type Property::BOOLEAN.
473 * @note PLACEHOLDER map is used to add ellipsis to placeholder text.
480 * @brief Enumeration for specifying how the text is truncated when it does not fit.
482 * The default value is \e EXCEED_POLICY_CLIP.
487 EXCEED_POLICY_ORIGINAL, ///< The text will be display at original size, and may exceed the TextField boundary. @SINCE_1_0.0
488 EXCEED_POLICY_CLIP ///< The end of text will be clipped to fit within the TextField. @SINCE_1_0.0
492 * @brief Mask used by the signal InputStyleChangedSignal(). Notifies which parameters of the input style have changed.
499 * @brief Mask used by the signal InputStyleChangedSignal().
505 NONE = 0x0000, ///< @SINCE_1_2_2
506 COLOR = 0x0001, ///< @SINCE_1_2_2
507 FONT_FAMILY = 0x0002, ///< @SINCE_1_2_2
508 POINT_SIZE = 0x0004, ///< @SINCE_1_2_2
509 FONT_STYLE = 0x0008, ///< @SINCE_1_2_2
510 UNDERLINE = 0x0010, ///< @SINCE_1_2_2
511 SHADOW = 0x0020, ///< @SINCE_1_2_2
512 EMBOSS = 0x0040, ///< @SINCE_1_2_2
513 OUTLINE = 0x0080 ///< @SINCE_1_2_2
520 * @brief Text changed signal type.
523 typedef Signal<void ( TextField ) > TextChangedSignalType;
526 * @brief Max Characters Exceed signal type.
529 typedef Signal<void ( TextField ) > MaxLengthReachedSignalType;
532 * @brief Input Style changed signal type.
535 typedef Signal<void ( TextField, InputStyle::Mask ) > InputStyleChangedSignalType;
538 * @brief Creates the TextField control.
540 * @return A handle to the TextField control
542 static TextField New();
545 * @brief Creates an empty handle.
551 * @brief Copy constructor.
554 * @param[in] handle The handle to copy from
556 TextField( const TextField& handle );
559 * @brief Assignment operator.
562 * @param[in] handle The handle to copy from
563 * @return A reference to this
565 TextField& operator=( const TextField& handle );
570 * This is non-virtual since derived Handle types must not contain data or virtual methods.
576 * @brief Downcasts a handle to TextField.
578 * If the BaseHandle points is a TextField, the downcast returns a valid handle.
579 * If not, the returned handle is left empty.
582 * @param[in] handle Handle to an object
583 * @return Handle to a TextField or an empty handle
585 static TextField DownCast( BaseHandle handle );
590 * @brief This signal is emitted when the text changes.
592 * A callback of the following type may be connected:
594 * void YourCallbackName( TextField textField );
597 * @return The signal to connect to.
599 TextChangedSignalType& TextChangedSignal();
602 * @brief This signal is emitted when inserted text exceeds the maximum character limit.
604 * A callback of the following type may be connected:
606 * void YourCallbackName( TextField textField );
609 * @return The signal to connect to
611 MaxLengthReachedSignalType& MaxLengthReachedSignal();
614 * @brief This signal is emitted when the input style is updated as a consequence of a change in the cursor position.
615 * i.e. The signal is not emitted when the input style is updated through the property system.
617 * A callback of the following type may be connected. The @p mask parameter notifies which parts of the style have changed.
619 * void YourCallbackName( TextField textField, TextField::InputStyle::Mask mask );
623 * @return The signal to connect to
625 InputStyleChangedSignalType& InputStyleChangedSignal();
627 public: // Not intended for application developers
630 * @brief Creates a handle using the Toolkit::Internal implementation.
633 * @param[in] implementation The Control implementation
635 DALI_INTERNAL TextField( Internal::TextField& implementation );
638 * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
641 * @param[in] internal A pointer to the internal CustomActor
643 explicit DALI_INTERNAL TextField( Dali::Internal::CustomActor* internal );
649 } // namespace Toolkit
653 #endif // __DALI_TOOLKIT_TEXT_FIELD_H__