dali-toolkit/devel-api/controls/text-controls/text-field-devel.h

   1 #ifndef DALI_TOOLKIT_TEXT_FIELD_DEVEL_H
   2 #define DALI_TOOLKIT_TEXT_FIELD_DEVEL_H
   3
   4 /*
   5  * Copyright (c) 2022 Samsung Electronics Co., Ltd.
   6  *
   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
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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.
  18  *
  19  */
  20 // EXTERNAL INCLUDES
  21 #include <dali/devel-api/adaptor-framework/input-method-context.h>
  22
  23 // INTERNAL INCLUDES
  24 #include <dali-toolkit/public-api/controls/text-controls/input-filter-properties.h>
  25 #include <dali-toolkit/public-api/controls/text-controls/text-field.h>
  26
  27 namespace Dali
  28 {
  29 namespace Toolkit
  30 {
  31 namespace DevelTextField
  32 {
  33 namespace Property
  34 {
  35 enum
  36 {
  37   TEXT                                 = Dali::Toolkit::TextField::Property::TEXT,
  38   PLACEHOLDER_TEXT                     = Dali::Toolkit::TextField::Property::PLACEHOLDER_TEXT,
  39   PLACEHOLDER_TEXT_FOCUSED             = Dali::Toolkit::TextField::Property::PLACEHOLDER_TEXT_FOCUSED,
  40   FONT_FAMILY                          = Dali::Toolkit::TextField::Property::FONT_FAMILY,
  41   FONT_STYLE                           = Dali::Toolkit::TextField::Property::FONT_STYLE,
  42   POINT_SIZE                           = Dali::Toolkit::TextField::Property::POINT_SIZE,
  43   MAX_LENGTH                           = Dali::Toolkit::TextField::Property::MAX_LENGTH,
  44   EXCEED_POLICY                        = Dali::Toolkit::TextField::Property::EXCEED_POLICY,
  45   HORIZONTAL_ALIGNMENT                 = Dali::Toolkit::TextField::Property::HORIZONTAL_ALIGNMENT,
  46   VERTICAL_ALIGNMENT                   = Dali::Toolkit::TextField::Property::VERTICAL_ALIGNMENT,
  47   TEXT_COLOR                           = Dali::Toolkit::TextField::Property::TEXT_COLOR,
  48   PLACEHOLDER_TEXT_COLOR               = Dali::Toolkit::TextField::Property::PLACEHOLDER_TEXT_COLOR,
  49   PRIMARY_CURSOR_COLOR                 = Dali::Toolkit::TextField::Property::PRIMARY_CURSOR_COLOR,
  50   SECONDARY_CURSOR_COLOR               = Dali::Toolkit::TextField::Property::SECONDARY_CURSOR_COLOR,
  51   ENABLE_CURSOR_BLINK                  = Dali::Toolkit::TextField::Property::ENABLE_CURSOR_BLINK,
  52   CURSOR_BLINK_INTERVAL                = Dali::Toolkit::TextField::Property::CURSOR_BLINK_INTERVAL,
  53   CURSOR_BLINK_DURATION                = Dali::Toolkit::TextField::Property::CURSOR_BLINK_DURATION,
  54   CURSOR_WIDTH                         = Dali::Toolkit::TextField::Property::CURSOR_WIDTH,
  55   GRAB_HANDLE_IMAGE                    = Dali::Toolkit::TextField::Property::GRAB_HANDLE_IMAGE,
  56   GRAB_HANDLE_PRESSED_IMAGE            = Dali::Toolkit::TextField::Property::GRAB_HANDLE_PRESSED_IMAGE,
  57   SCROLL_THRESHOLD                     = Dali::Toolkit::TextField::Property::SCROLL_THRESHOLD,
  58   SCROLL_SPEED                         = Dali::Toolkit::TextField::Property::SCROLL_SPEED,
  59   SELECTION_HANDLE_IMAGE_LEFT          = Dali::Toolkit::TextField::Property::SELECTION_HANDLE_IMAGE_LEFT,
  60   SELECTION_HANDLE_IMAGE_RIGHT         = Dali::Toolkit::TextField::Property::SELECTION_HANDLE_IMAGE_RIGHT,
  61   SELECTION_HANDLE_PRESSED_IMAGE_LEFT  = Dali::Toolkit::TextField::Property::SELECTION_HANDLE_PRESSED_IMAGE_LEFT,
  62   SELECTION_HANDLE_PRESSED_IMAGE_RIGHT = Dali::Toolkit::TextField::Property::SELECTION_HANDLE_PRESSED_IMAGE_RIGHT,
  63   SELECTION_HANDLE_MARKER_IMAGE_LEFT   = Dali::Toolkit::TextField::Property::SELECTION_HANDLE_MARKER_IMAGE_LEFT,
  64   SELECTION_HANDLE_MARKER_IMAGE_RIGHT  = Dali::Toolkit::TextField::Property::SELECTION_HANDLE_MARKER_IMAGE_RIGHT,
  65   SELECTION_HIGHLIGHT_COLOR            = Dali::Toolkit::TextField::Property::SELECTION_HIGHLIGHT_COLOR,
  66   DECORATION_BOUNDING_BOX              = Dali::Toolkit::TextField::Property::DECORATION_BOUNDING_BOX,
  67   INPUT_METHOD_SETTINGS                = Dali::Toolkit::TextField::Property::INPUT_METHOD_SETTINGS,
  68   INPUT_COLOR                          = Dali::Toolkit::TextField::Property::INPUT_COLOR,
  69   ENABLE_MARKUP                        = Dali::Toolkit::TextField::Property::ENABLE_MARKUP,
  70   INPUT_FONT_FAMILY                    = Dali::Toolkit::TextField::Property::INPUT_FONT_FAMILY,
  71   INPUT_FONT_STYLE                     = Dali::Toolkit::TextField::Property::INPUT_FONT_STYLE,
  72   INPUT_POINT_SIZE                     = Dali::Toolkit::TextField::Property::INPUT_POINT_SIZE,
  73   UNDERLINE                            = Dali::Toolkit::TextField::Property::UNDERLINE,
  74   INPUT_UNDERLINE                      = Dali::Toolkit::TextField::Property::INPUT_UNDERLINE,
  75   SHADOW                               = Dali::Toolkit::TextField::Property::SHADOW,
  76   INPUT_SHADOW                         = Dali::Toolkit::TextField::Property::INPUT_SHADOW,
  77   EMBOSS                               = Dali::Toolkit::TextField::Property::EMBOSS,
  78   INPUT_EMBOSS                         = Dali::Toolkit::TextField::Property::INPUT_EMBOSS,
  79   OUTLINE                              = Dali::Toolkit::TextField::Property::OUTLINE,
  80   INPUT_OUTLINE                        = Dali::Toolkit::TextField::Property::INPUT_OUTLINE,
  81   HIDDEN_INPUT_SETTINGS                = Dali::Toolkit::TextField::Property::HIDDEN_INPUT_SETTINGS,
  82   PIXEL_SIZE                           = Dali::Toolkit::TextField::Property::PIXEL_SIZE,
  83   ENABLE_SELECTION                     = Dali::Toolkit::TextField::Property::ENABLE_SELECTION,
  84   PLACEHOLDER                          = Dali::Toolkit::TextField::Property::PLACEHOLDER,
  85   ELLIPSIS                             = Dali::Toolkit::TextField::Property::ELLIPSIS,
  86
  87   /**
  88    * @brief Enables Text selection using Shift key.
  89    * @details Name "enableShiftSelection", type Property::BOOLEAN.
  90    */
  91   ENABLE_SHIFT_SELECTION = ELLIPSIS + 1,
  92
  93   /**
  94    * @brief Enables the grab handles for text selection.
  95    * @details Name "enableGrabHandle", type Property::BOOLEAN.
  96    * @note The default value is true, which means the grab handles are enabled by default.
  97    */
  98   ENABLE_GRAB_HANDLE = ELLIPSIS + 2,
  99
 100   /**
 101    * @brief Modifies the default text alignment to match the direction of the system language.
 102    * @details Name "matchSystemLanguageDirection", type (Property::BOOLEAN), Read/Write
 103    * @note The default value is true
 104    */
 105   MATCH_SYSTEM_LANGUAGE_DIRECTION = ELLIPSIS + 3,
 106
 107   /**
 108    * @brief Enables the grab handle popup for text selection.
 109    * @details Name "enableGrabHandlePopup", type Property::BOOLEAN.
 110    * @note The default value is true, which means the grab handle popup is enabled by default.
 111    */
 112   ENABLE_GRAB_HANDLE_POPUP = ELLIPSIS + 4,
 113
 114   /**
 115    * @brief The default text background parameters.
 116    * @details Name "textBackground", type Property::VECTOR4.
 117    * @note Use "textBackground" as property name to avoid conflict with Control's "background" property.
 118    * @note The default value is Color::TRANSPARENT.
 119    */
 120   BACKGROUND = ELLIPSIS + 5,
 121
 122   /**
 123    * @brief The selected text in UTF-8 format.
 124    * @details Name "selectedText", type Property::STRING.
 125    * @note This property is read-only.
 126    */
 127   SELECTED_TEXT = ELLIPSIS + 6,
 128
 129   /**
 130    * @brief The type or rendering e.g. bitmap-based.
 131    * @details Name "renderingBackend", type Property::INTEGER.
 132    */
 133   RENDERING_BACKEND = ELLIPSIS + 7,
 134
 135   /**
 136    * @brief The selected text start position.
 137    * @details Name "selectedTextStart", type Property::INTEGER.
 138    */
 139   SELECTED_TEXT_START,
 140
 141   /**
 142    * @brief The selected text range end position.
 143    * @details Name "selectedTextEnd", type Property::INTEGER.
 144    */
 145   SELECTED_TEXT_END,
 146
 147   /**
 148    * @brief The Editable state of control.
 149    * @details Name "enableEditing", type Property::BOOLEAN.
 150    */
 151   ENABLE_EDITING,
 152
 153   /**
 154    * @brief The font size scale.
 155    * @details name "fontSizeScale", type Property::FLOAT.
 156    * @note The default value is 1.0 which does nothing.
 157    * The given font size scale value is used for multiplying the specified font size before querying fonts.
 158    *
 159    * e.g. The rendering results of both cases are same.
 160    *  - fontSize: 15pt, fontSizeScale: 1.0
 161    *  - fontSize: 10pt, fontSizeScale: 1.5
 162    */
 163   FONT_SIZE_SCALE,
 164
 165   /**
 166    * @brief True to enable the font size scale or false to disable.
 167    * @details Name "enableFontSizeScale", type Property::BOOLEAN.
 168    * @note The default value is true.
 169    * If false, font size scale is not apppied.
 170    */
 171   ENABLE_FONT_SIZE_SCALE,
 172
 173   /**
 174    * @brief The position for primary cursor.
 175    * @details Name "primaryCursorPosition", type Property::INTEGER.
 176    */
 177   PRIMARY_CURSOR_POSITION,
 178
 179   /**
 180    * @brief The color of the grab color.
 181    * @details Name "grabHandleColor", type Property::VECTOR4.
 182    */
 183   GRAB_HANDLE_COLOR,
 184
 185   /**
 186    * @brief The input filter
 187    * @details Name "inputFilter", type Property::MAP.
 188    *
 189    * The inputFilter map contains the following keys:
 190    *
 191    * | %Property Name       | Type     | Required | Description                                                                                                         |
 192    * |----------------------|----------|----------|---------------------------------------------------------------------------------------------------------------------|
 193    * | accepted             | STRING   | No       | A regular expression in the set of characters to be accepted by the inputFilter (the default value is empty string) |
 194    * | rejected             | STRING   | No       | A regular expression in the set of characters to be rejected by the inputFilter (the default value is empty string) |
 195    *
 196    * @note Optional.
 197    * The character set must follow the regular expression rules.
 198    * Behaviour can not be guaranteed for incorrect grammars.
 199    * Refer the link below for detailed rules.
 200    * The functions in std::regex library use the ECMAScript grammar:
 201    * http://cplusplus.com/reference/regex/ECMAScript/
 202    *
 203    * You can use enums instead of "accepted" and "rejected" strings.
 204    * @see Dali::Toolkit::InputFilter::Property::Type
 205    *
 206    * Example Usage:
 207    * @code
 208    *   Property::Map filter;
 209    *   filter[InputFilter::Property::ACCEPTED] = "[\\d]"; // accept whole digits
 210    *   filter[InputFilter::Property::REJECTED] = "[0-5]"; // reject 0, 1, 2, 3, 4, 5
 211    *
 212    *   field.SetProperty(DevelTextField::Property::INPUT_FILTER, filter); // acceptable inputs are 6, 7, 8, 9
 213    * @endcode
 214    */
 215   INPUT_FILTER,
 216
 217   /**
 218   * @brief The enumerations used to specify whether to position the ellipsis at the END, START or MIDDLE of the text.
 219   * @details Name "EllipsisPosition", type [Type](@ref Dali::Toolkit::DevelText::EllipsisPosition::Type) (Property::INTEGER), or Property::STRING. Read/Write
 220   * @note Default is EllipsisPosition::END.
 221   * @see DevelText::EllipsisPosition
 222   */
 223   ELLIPSIS_POSITION,
 224
 225   /**
 226    * @brief A horizontal line through the text center.
 227    * @details Name "strikethrough", type Property::MAP.
 228    */
 229   STRIKETHROUGH,
 230
 231   /**
 232    * @brief The strikethrough parameters of the new input text.
 233    * @details Name "inputStrikethrough", type Property::MAP.
 234    */
 235   INPUT_STRIKETHROUGH,
 236 };
 237
 238 } // namespace Property
 239
 240 /**
 241  * @brief Return the input method context of TextField.
 242  *
 243  * @param[in] textField The instance of TextField.
 244  * @return InputMethodContext instance.
 245  */
 246 DALI_TOOLKIT_API InputMethodContext GetInputMethodContext(TextField textField);
 247
 248 /**
 249  * @brief Anchor clicked signal type.
 250  *
 251  * @note Signal
 252  *  - const char* : href of clicked anchor.
 253  *  - uint32_t    : length of href.
 254  */
 255 using AnchorClickedSignalType = Signal<void(TextField, const char*, uint32_t)>;
 256
 257 /**
 258  * @brief This signal is emitted when the anchor is clicked.
 259  *
 260  * A callback of the following type may be connected:
 261  * @code
 262  *   void YourCallbackName(TextField textField, const char* href, uint32_t hrefLength);
 263  * @endcode
 264  * @param[in] textField The instance of TextField.
 265  * @return The signal to connect to.
 266  */
 267 DALI_TOOLKIT_API AnchorClickedSignalType& AnchorClickedSignal(TextField textField);
 268
 269 /**
 270  * @brief cursor position changed signal type.
 271  *
 272  * @note Signal
 273  *  - uint32_t    : old position.
 274  */
 275 using CursorPositionChangedSignalType = Signal<void(TextField, uint32_t)>;
 276
 277 /**
 278  * @brief This signal is emitted when the cursor position has been changed.
 279  *
 280  * A callback of the following type may be connected:
 281  * @code
 282  *   void YourCallbackName(TextField textField, uint32_t oldPosition);
 283  * @endcode
 284  * @param[in] textField The instance of TextField.
 285  * @return The signal to connect to.
 286  */
 287 DALI_TOOLKIT_API CursorPositionChangedSignalType& CursorPositionChangedSignal(TextField textField);
 288
 289 /**
 290  * @brief Input filtered signal type.
 291  */
 292 using InputFilteredSignalType = Signal<void(TextField, Toolkit::InputFilter::Property::Type)>;
 293
 294 /**
 295  * @brief This signal is emitted when the character to be inserted is filtered by the input filter.
 296  *
 297  * A callback of the following type may be connected:
 298  * @code
 299  *   void YourCallbackName(TextField textField, Toolkit::InputFilter::Property::Type type);
 300  *
 301  *   DevelTextField::InputFilteredSignal(textField).Connect(this, &OnInputFiltered);
 302  *
 303  *   void OnInputFiltered(TextField textField, InputFilter::Property::Type type)
 304  *   {
 305  *     if (type == InputFilter::Property::ACCEPTED)
 306  *     {
 307  *       // If the input has been filtered with an accepted filter, the type is ACCEPTED.
 308  *     }
 309  *     else if (type == InputFilter::Property::REJECTED)
 310  *     {
 311  *       // If the input has been filtered with an rejected filter, the type is REJECTED.
 312  *     }
 313  *   }
 314  * @endcode
 315  * @param[in] textField The instance of TextField.
 316  * @return The signal to connect to.
 317  */
 318 DALI_TOOLKIT_API InputFilteredSignalType& InputFilteredSignal(TextField textField);
 319
 320 /**
 321  * @brief selection changed signal type.
 322  *
 323  * @note Signal
 324  *  - uint32_t  : selection start before the change.
 325  *  - uint32_t  : selection end before the change.
 326  */
 327 using SelectionChangedSignalType = Signal<void(TextField, uint32_t, uint32_t)>;
 328
 329 /**
 330  * @brief This signal is emitted when the selection has been changed.
 331  *
 332  * A callback of the following type may be connected:
 333  * @code
 334  *   void YourCallbackName( TextField textField, uint32_t oldStart, uint32_t oldEnd);
 335  * @endcode
 336  * @param[in] textField The instance of TextField.
 337  * @return The signal to connect to
 338  */
 339 DALI_TOOLKIT_API SelectionChangedSignalType& SelectionChangedSignal(TextField textField);
 340
 341 /**
 342  * @brief selection cleared signal type.
 343  */
 344 using SelectionClearedSignalType = Signal<void(TextField)>;
 345
 346 /**
 347  * @brief This signal is emitted when the selection has been cleared.
 348  *
 349  * A callback of the following type may be connected:
 350  * @code
 351  *   void YourCallbackName( TextField textField);
 352  * @endcode
 353  * @param[in] textField The instance of TextField.
 354  * @return The signal to connect to
 355  */
 356 DALI_TOOLKIT_API SelectionClearedSignalType& SelectionClearedSignal(TextField textField);
 357
 358 /**
 359  * @brief Get the rendered size of a specific text range.
 360  * if the requested text is at multilines, multiple sizes will be returned for each text located in a separate line.
 361  * if a line contains characters with different directions, multiple sizes will be returned for each block of contiguous characters with the same direction.
 362  *
 363  * @param[in] textField The instance of TextField.
 364  * @param[in] startIndex start index of the text requested to calculate size for.
 365  * @param[in] endIndex end index(included) of the text requested to calculate size for.
 366  * @return list of sizes of the reuested text.
 367  */
 368 DALI_TOOLKIT_API Vector<Vector2> GetTextSize(TextField textField, const uint32_t startIndex, const uint32_t endIndex);
 369
 370 /**
 371  * @brief Get the top/left rendered position of a specific text range.
 372  * if the requested text is at multilines, multiple positions will be returned for each text located in a separate line.
 373  * if a line contains characters with different directions, multiple positions will be returned for each block of contiguous characters with the same direction.
 374  *
 375  * @param[in] textField The instance of TextField.
 376  * @param[in] startIndex start index of the text requested to get position to.
 377  * @param[in] endIndex end index(included) of the text requested to get position to.
 378  * @return list of positions of the requested text.
 379  */
 380 DALI_TOOLKIT_API Vector<Vector2> GetTextPosition(TextField textField, const uint32_t startIndex, const uint32_t endIndex);
 381
 382 /**
 383  * @brief Select the whole text of TextField.
 384  *
 385  * @param[in] textField The instance of TextField.
 386  */
 387 DALI_TOOLKIT_API void SelectWholeText(TextField textField);
 388
 389 /**
 390  * @brief Unselect the whole text of TextField.
 391  *
 392  * @param[in] textField The instance of TextField.
 393  */
 394 DALI_TOOLKIT_API void SelectNone(TextField textField);
 395
 396 /**
 397  * @brief Select the text from start index to end index of TextField.
 398  * @note
 399  * The selection index is based on the cursor index.
 400  *
 401  * text   H e l l o
 402  * index 0 1 2 3 4 5
 403  * if textField.SelectText(1, 4); is executed, "ell" is selected.
 404  *
 405  * @param[in] textField The instance of TextField.
 406  * @param[in] start The start index of the text to select. (The starting point of start index is 0.)
 407  * @param[in] end The end index of the text to select. (If end index > text's length, the end index is set to the length of the text.)
 408  */
 409 DALI_TOOLKIT_API void SelectText(TextField textField, const uint32_t start, const uint32_t end);
 410
 411 /**
 412  * @brief Copy and return the selected text of TextField.
 413  *
 414  * @param[in] textField The instance of TextField.
 415  * @return The copied text.
 416  */
 417 DALI_TOOLKIT_API std::string CopyText(TextField textField);
 418
 419 /**
 420  * @brief Cut and return the selected text of TextField.
 421  *
 422  * @param[in] textField The instance of TextField.
 423  * @return The cut text.
 424  */
 425 DALI_TOOLKIT_API std::string CutText(TextField textField);
 426
 427 /**
 428  * @brief Paste the most recent clipboard text item into the TextField.
 429  *
 430  * @param[in] textField The instance of TextField.
 431  */
 432 DALI_TOOLKIT_API void PasteText(TextField textField);
 433
 434 } // namespace DevelTextField
 435
 436 } // namespace Toolkit
 437
 438 } // namespace Dali
 439
 440 #endif // DALI_TOOLKIT_TEXT_FIELD_DEVEL_H