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
36 * @brief A control which provides a single-line editable text field.
38 class DALI_IMPORT_API TextField : public Control
43 * @brief The start and end property ranges for this control.
47 PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1,
48 PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000 ///< Reserve property indices
52 * @brief An enumeration of properties belonging to the TextLabel class.
58 RENDERING_BACKEND = PROPERTY_START_INDEX, ///< name "rendering-backend", The type or rendering e.g. bitmap-based, type INT
59 PLACEHOLDER_TEXT, ///< name "placeholder-text", The text to display when the TextField is empty, type STRING
60 TEXT, ///< name "text", The text to display in UTF-8 format, type STRING
61 FONT_FAMILY, ///< name "font-family", The requested font family, type STRING
62 FONT_STYLE, ///< name "font-style", The requested font style e.g. Regular/Italic, type STRING
63 POINT_SIZE, ///< name "point-size", The size of font in points, type FLOAT
64 EXCEED_POLICY, ///< name "exceed-policy" Specifies how the text is truncated when it does not fit, type INT
65 HORIZONTAL_ALIGNMENT, ///< name "horizontal-alignment", The line horizontal alignment, type STRING, values "BEGIN", "CENTER", "END"
66 VERTICAL_ALIGNMENT, ///< name "vertical-alignment", The line vertical alignment, type STRING, values "TOP", "CENTER", "BOTTOM"
67 TEXT_COLOR, ///< name "text-color", The text color, type VECTOR4
68 SHADOW_OFFSET, ///< name "shadow-offset", The drop shadow offset 0 indicates no shadow, type VECTOR2
69 SHADOW_COLOR, ///< name "shadow-color", The color of a drop shadow, type VECTOR4
70 PRIMARY_CURSOR_COLOR, ///< name "primary-cursor-color", The color to apply to the primary cursor, type VECTOR4
71 SECONDARY_CURSOR_COLOR, ///< name "secondary-cursor-color", The color to apply to the secondary cursor, type VECTOR4
72 ENABLE_CURSOR_BLINK, ///< name "enable-cursor-blink", Whether the cursor should blink or not, type BOOLEAN
73 CURSOR_BLINK_INTERVAL, ///< name "cursor-blink-interval", The time interval in seconds between cursor on/off states, type FLOAT
74 CURSOR_BLINK_DURATION, ///< name "cursor-blink-duration", The cursor will stop blinking after this number of seconds (if non-zero), type FLOAT
75 GRAB_HANDLE_IMAGE, ///< name "grab-handle-image", The image to display for the grab handle, type STRING
76 GRAB_HANDLE_PRESSED_IMAGE, ///< name "grab-handle-pressed-image", The image to display when the grab handle is pressed, type STRING
77 SCROLL_THRESHOLD, ///< name "scroll-threshold" Scrolling will occur if the cursor is this close to the control border, type FLOAT
78 SCROLL_SPEED, ///< name "scroll-speed" The scroll speed in pixels per second, type FLOAT
79 SELECTION_HANDLE_IMAGE_LEFT, ///< name "selection-handle-image-left", The image to display for the left selection handle, type STRING
80 SELECTION_HANDLE_IMAGE_RIGHT, ///< name "selection-handle-image-right", The image to display for the right selection handle, type STRING
81 SELECTION_HANDLE_PRESSED_IMAGE_LEFT, ///< name "selection-handle-pressed-image-left" The image to display when the left selection handle is pressed, type STRING
82 SELECTION_HANDLE_PRESSED_IMAGE_RIGHT, ///< name "selection-handle-pressed-image-right" The image to display when the right selection handle is pressed, type STRING
83 SELECTION_HIGHLIGHT_COLOR, ///< name "selection-highlight-color" The color of the selection highlight, type VECTOR4
84 DECORATION_BOUNDING_BOX ///< name "decoration-bounding-box", The decorations (handles etc) will positioned within this area on-screen, type RECTANGLE
89 * @brief Specifies how the text is truncated when it does not fit
91 * The default value is \e EXCEED_POLICY_CLIP.
95 EXCEED_POLICY_ORIGINAL, ///< The text will be display at original size, and may exceed the TextField boundary.
96 EXCEED_POLICY_CLIP ///< The end of text will be clipped to fit within the TextField.
100 * Create the TextField control.
101 * @return A handle to the TextField control.
103 static TextField New();
106 * @brief Creates an empty handle.
111 * @brief Copy constructor.
113 * @param[in] handle The handle to copy from.
115 TextField( const TextField& handle );
118 * @brief Assignment operator.
120 * @param[in] handle The handle to copy from.
121 * @return A reference to this.
123 TextField& operator=( const TextField& handle );
128 * This is non-virtual since derived Handle types must not contain data or virtual methods.
133 * @brief Downcast a handle to TextField.
135 * If the BaseHandle points is a TextField the downcast returns a valid handle.
136 * If not the returned handle is left empty.
138 * @param[in] handle Handle to an object
139 * @return handle to a TextField or an empty handle
141 static TextField DownCast( BaseHandle handle );
143 public: // Not intended for application developers
146 * @brief Creates a handle using the Toolkit::Internal implementation.
148 * @param[in] implementation The Control implementation.
150 DALI_INTERNAL TextField( Internal::TextField& implementation );
153 * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
155 * @param[in] internal A pointer to the internal CustomActor.
157 explicit DALI_INTERNAL TextField( Dali::Internal::CustomActor* internal );
160 } // namespace Toolkit
164 #endif // __DALI_TOOLKIT_TEXT_FIELD_H__