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>
23 #include <dali-toolkit/public-api/text/rendering/text-renderer.h>
31 namespace Internal DALI_INTERNAL
37 * @brief A control which provides a single-line editable text field.
39 class DALI_IMPORT_API TextField : public Control
44 static const Property::Index PROPERTY_PLACEHOLDER_TEXT; ///< name "placeholder-text", type STRING
45 static const Property::Index PROPERTY_TEXT; ///< name "text", type STRING
46 static const Property::Index PROPERTY_CURSOR_IMAGE; ///< name "cursor-image", type STRING
47 static const Property::Index PROPERTY_PRIMARY_CURSOR_COLOR; ///< name "primary-cursor-color", type VECTOR4
48 static const Property::Index PROPERTY_SECONDARY_CURSOR_COLOR; ///< name "secondary-cursor-color", type VECTOR4
49 static const Property::Index PROPERTY_ENABLE_CURSOR_BLINK; ///< name "enable-cursor-blink", type BOOLEAN
50 static const Property::Index PROPERTY_CURSOR_BLINK_INTERVAL; ///< name "cursor-blink-interval", type FLOAT
51 static const Property::Index PROPERTY_CURSOR_BLINK_DURATION; ///< name "cursor-blink-duration", type FLOAT
54 static const std::string PLACEHOLDER_TEXT_PROPERTY_NAME; ///< Property, name "placeholder-text", type STRING
55 static const std::string TEXT_PROPERTY_NAME; ///< Property, name "text", type STRING
56 static const std::string CURSOR_IMAGE_PROPERTY_NAME; ///< Property, name "cursor-image", type STRING
57 static const std::string PRIMARY_CURSOR_COLOR_PROPERTY_NAME; ///< Property, name "primary-cursor-color", type VECTOR4
58 static const std::string SECONDARY_CURSOR_COLOR_PROPERTY_NAME; ///< Property, name "secondary-cursor-color", type VECTOR4
59 static const std::string ENABLE_CURSOR_BLINK_PROPERTY_NAME; ///< Property, name "enable-cursor-blink", type BOOLEAN
60 static const std::string CURSOR_BLINK_INTERVAL_PROPERTY_NAME; ///< Property, name "cursor-blink-interval", type FLOAT
61 static const std::string CURSOR_BLINK_DURATION_PROPERTY_NAME; ///< Property, name "cursor-blink-duration", type FLOAT
64 * Create the TextField control.
65 * @return A handle to the TextField control.
67 static TextField New();
70 * @brief Creates an empty handle.
75 * @brief Copy constructor.
77 * @param[in] handle The handle to copy from.
79 TextField( const TextField& handle );
82 * @brief Assignment operator.
84 * @param[in] handle The handle to copy from.
85 * @return A reference to this.
87 TextField& operator=( const TextField& handle );
92 * This is non-virtual since derived Handle types must not contain data or virtual methods.
97 * @brief Downcast a handle to TextField.
99 * If the BaseHandle points is a TextField the downcast returns a valid handle.
100 * If not the returned handle is left empty.
102 * @param[in] handle Handle to an object
103 * @return handle to a TextField or an empty handle
105 static TextField DownCast( BaseHandle handle );
108 * @brief Set the rendering back-end used by the TextField.
110 * @param[in] renderer The text renderer to use.
112 void SetRenderer( Text::RendererPtr renderer );
114 public: // Not intended for application developers
117 * @brief Creates a handle using the Toolkit::Internal implementation.
119 * @param[in] implementation The Control implementation.
121 DALI_INTERNAL TextField( Internal::TextField& implementation );
124 * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
126 * @param[in] internal A pointer to the internal CustomActor.
128 explicit DALI_INTERNAL TextField( Dali::Internal::CustomActor* internal );
131 } // namespace Toolkit
135 #endif // __DALI_TOOLKIT_TEXT_FIELD_H__