X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=dali-toolkit%2Fdevel-api%2Fcontrols%2Ftext-controls%2Ftext-field-devel.h;h=e1c18f04fe9a6aed86947b9970ac15dcd22013e4;hp=8e2e00638d638e67ca51fb205fa9ae1e37956381;hb=0a6073b11b32d2153deb0e4a581a9314eef8ab10;hpb=1d82abb8a1a514ce0af63004706135fb7883f89b diff --git a/dali-toolkit/devel-api/controls/text-controls/text-field-devel.h b/dali-toolkit/devel-api/controls/text-controls/text-field-devel.h index 8e2e006..e1c18f0 100644 --- a/dali-toolkit/devel-api/controls/text-controls/text-field-devel.h +++ b/dali-toolkit/devel-api/controls/text-controls/text-field-devel.h @@ -2,7 +2,7 @@ #define DALI_TOOLKIT_TEXT_FIELD_DEVEL_H /* - * Copyright (c) 2020 Samsung Electronics Co., Ltd. + * Copyright (c) 2021 Samsung Electronics Co., Ltd. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -21,6 +21,7 @@ #include // INTERNAL INCLUDES +#include #include namespace Dali @@ -84,54 +85,128 @@ enum ELLIPSIS = Dali::Toolkit::TextField::Property::ELLIPSIS, /** - * @brief Enables Text selection using Shift key. - * @details Name "enableShiftSelection", type Property::BOOLEAN. - */ + * @brief Enables Text selection using Shift key. + * @details Name "enableShiftSelection", type Property::BOOLEAN. + */ ENABLE_SHIFT_SELECTION = ELLIPSIS + 1, /** - * @brief Enables the grab handles for text selection. - * @details Name "enableGrabHandle", type Property::BOOLEAN. - * @note The default value is true, which means the grab handles are enabled by default. - */ + * @brief Enables the grab handles for text selection. + * @details Name "enableGrabHandle", type Property::BOOLEAN. + * @note The default value is true, which means the grab handles are enabled by default. + */ ENABLE_GRAB_HANDLE = ELLIPSIS + 2, /** - * @brief Modifies the default text alignment to match the direction of the system language. - * @details Name "matchSystemLanguageDirection", type (Property::BOOLEAN), Read/Write - * @note The default value is false - */ + * @brief Modifies the default text alignment to match the direction of the system language. + * @details Name "matchSystemLanguageDirection", type (Property::BOOLEAN), Read/Write + * @note The default value is false + */ MATCH_SYSTEM_LANGUAGE_DIRECTION = ELLIPSIS + 3, /** - * @brief Enables the grab handle popup for text selection. - * @details Name "enableGrabHandlePopup", type Property::BOOLEAN. - * @note The default value is true, which means the grab handle popup is enabled by default. - */ + * @brief Enables the grab handle popup for text selection. + * @details Name "enableGrabHandlePopup", type Property::BOOLEAN. + * @note The default value is true, which means the grab handle popup is enabled by default. + */ ENABLE_GRAB_HANDLE_POPUP = ELLIPSIS + 4, /** - * @brief The default text background parameters. - * @details Name "textBackground", type Property::VECTOR4. - * @note Use "textBackground" as property name to avoid conflict with Control's "background" property. - * @note The default value is Color::TRANSPARENT. - */ + * @brief The default text background parameters. + * @details Name "textBackground", type Property::VECTOR4. + * @note Use "textBackground" as property name to avoid conflict with Control's "background" property. + * @note The default value is Color::TRANSPARENT. + */ BACKGROUND = ELLIPSIS + 5, /** - * @brief The selected text in UTF-8 format. - * @details Name "selectedText", type Property::STRING. - * @note This property is read-only. - */ + * @brief The selected text in UTF-8 format. + * @details Name "selectedText", type Property::STRING. + * @note This property is read-only. + */ SELECTED_TEXT = ELLIPSIS + 6, /** - * @brief The type or rendering e.g. bitmap-based. - * @details Name "renderingBackend", type Property::INTEGER. - */ + * @brief The type or rendering e.g. bitmap-based. + * @details Name "renderingBackend", type Property::INTEGER. + */ RENDERING_BACKEND = ELLIPSIS + 7, + /** + * @brief The selected text start position. + * @details Name "selectedTextStart", type Property::INTEGER. + */ + SELECTED_TEXT_START, + + /** + * @brief The selected text range end position. + * @details Name "selectedTextEnd", type Property::INTEGER. + */ + SELECTED_TEXT_END, + + /** + * @brief The Editable state of control. + * @details Name "enableEditing", type Property::BOOLEAN. + */ + ENABLE_EDITING, + + /** + * @brief The font size scale. + * @details name "fontSizeScale", type Property::FLOAT. + * @note The default value is 1.0 which does nothing. + * The given font size scale value is used for multiplying the specified font size before querying fonts. + * + * e.g. The rendering results of both cases are same. + * - fontSize: 15pt, fontSizeScale: 1.0 + * - fontSize: 10pt, fontSizeScale: 1.5 + */ + FONT_SIZE_SCALE, + + /** + * @brief The position for primary cursor. + * @details Name "primaryCursorPosition", type Property::INTEGER. + */ + PRIMARY_CURSOR_POSITION, + + /** + * @brief The color of the grab color. + * @details Name "grabHandleColor", type Property::VECTOR4. + */ + GRAB_HANDLE_COLOR, + + /** + * @brief The input filter + * @details Name "inputFilter", type Property::MAP. + * + * The inputFilter map contains the following keys: + * + * | %Property Name | Type | Required | Description | + * |----------------------|----------|----------|---------------------------------------------------------------------------------------------------------------------| + * | accepted | STRING | No | A regular expression in the set of characters to be accepted by the inputFilter (the default value is empty string) | + * | rejected | STRING | No | A regular expression in the set of characters to be rejected by the inputFilter (the default value is empty string) | + * + * @note Optional. + * The character set must follow the regular expression rules. + * Behaviour can not be guaranteed for incorrect grammars. + * Refer the link below for detailed rules. + * The functions in std::regex library use the ECMAScript grammar: + * http://cplusplus.com/reference/regex/ECMAScript/ + * + * You can use enums instead of "accepted" and "rejected" strings. + * @see Dali::Toolkit::InputFilter::Property::Type + * + * Example Usage: + * @code + * Property::Map filter; + * filter[InputFilter::Property::ACCEPTED] = "[\\d]"; // accept whole digits + * filter[InputFilter::Property::REJECTED] = "[0-5]"; // reject 0, 1, 2, 3, 4, 5 + * + * field.SetProperty(DevelTextField::Property::INPUT_FILTER, filter); // acceptable inputs are 6, 7, 8, 9 + * @endcode + */ + INPUT_FILTER, }; + } // namespace Property /** @@ -143,6 +218,58 @@ enum DALI_TOOLKIT_API InputMethodContext GetInputMethodContext(TextField textField); /** + * @brief Anchor clicked signal type. + * + * @note Signal + * - const char* : href of clicked anchor. + * - uint32_t : length of href. + */ +using AnchorClickedSignalType = Signal; + +/** + * @brief This signal is emitted when the anchor is clicked. + * + * A callback of the following type may be connected: + * @code + * void YourCallbackName(TextField textField, const char* href, uint32_t hrefLength); + * @endcode + * @param[in] textField The instance of TextField. + * @return The signal to connect to. + */ +DALI_TOOLKIT_API AnchorClickedSignalType& AnchorClickedSignal(TextField textField); + +/** + * @brief Input filtered signal type. + */ +using InputFilteredSignalType = Signal; + +/** + * @brief This signal is emitted when the character to be inserted is filtered by the input filter. + * + * A callback of the following type may be connected: + * @code + * void YourCallbackName(TextField textField, Toolkit::InputFilter::Property::Type type); + * + * DevelTextField::InputFilteredSignal(textField).Connect(this, &OnInputFiltered); + * + * void OnInputFiltered(TextField textField, InputFilter::Property::Type type) + * { + * if (type == InputFilter::Property::ACCEPTED) + * { + * // If the input has been filtered with an accepted filter, the type is ACCEPTED. + * } + * else if (type == InputFilter::Property::REJECTED) + * { + * // If the input has been filtered with an rejected filter, the type is REJECTED. + * } + * } + * @endcode + * @param[in] textField The instance of TextField. + * @return The signal to connect to. + */ +DALI_TOOLKIT_API InputFilteredSignalType& InputFilteredSignal(TextField textField); + +/** * @brief Select the whole text of TextField. * * @param[in] textField The instance of TextField.