dali-toolkit/public-api/controls/text-controls/text-editor.h

   1 #ifndef DALI_TOOLKIT_TEXT_EDITOR_H
   2 #define DALI_TOOLKIT_TEXT_EDITOR_H
   3
   4 /*
   5  * Copyright (c) 2019 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
  21 // INTERNAL INCLUDES
  22 #include <dali-toolkit/public-api/controls/control.h>
  23
  24 namespace Dali
  25 {
  26
  27 namespace Toolkit
  28 {
  29
  30 namespace Internal DALI_INTERNAL
  31 {
  32 class TextEditor;
  33 }
  34 /**
  35  * @addtogroup dali_toolkit_controls_text_controls
  36  * @{
  37  */
  38
  39 /**
  40  * @brief A control which provides a multi-line editable text editor.
  41  *
  42  * Signals
  43  * | %Signal Name         | Method                         |                    |
  44  * |----------------------|--------------------------------|--------------------|
  45  * | textChanged          | @ref TextChangedSignal()       | @SINCE_1_1.37      |
  46  * | inputStyleChanged    | @ref InputStyleChangedSignal() | @SINCE_1_2_2       |
  47  *
  48  */
  49 class DALI_TOOLKIT_API TextEditor : public Control
  50 {
  51 public:
  52
  53   /**
  54    * @brief Enumeration for the start and end property ranges for this control.
  55    * @SINCE_1_1.37
  56    */
  57   enum PropertyRange
  58   {
  59     PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1,
  60     PROPERTY_END_INDEX =   PROPERTY_START_INDEX + 1000              ///< Reserve property indices
  61   };
  62
  63   /**
  64    * @brief Enumeration for the instance of properties belonging to the TextEditor class.
  65    * @SINCE_1_1.37
  66    */
  67   struct Property
  68   {
  69     /**
  70      * @brief Enumeration for the instance of properties belonging to the TextEditor class.
  71      * @SINCE_1_1.37
  72      */
  73     enum
  74     {
  75       /**
  76        * @brief The type or rendering e.g. bitmap-based.
  77        * @details Name "renderingBackend", type Property::INTEGER.
  78        * @SINCE_1_1.37
  79        */
  80       RENDERING_BACKEND = PROPERTY_START_INDEX,
  81
  82       /**
  83        * @brief The text to display in UTF-8 format.
  84        * @details Name "text", type Property::STRING.
  85        * @SINCE_1_1.37
  86        */
  87       TEXT,
  88
  89       /**
  90        * @brief The text color.
  91        * @details Name "textColor", type Property::VECTOR4.
  92        * @SINCE_1_1.37
  93        */
  94       TEXT_COLOR,
  95
  96       /**
  97        * @brief The requested font family.
  98        * @details Name "fontFamily", type Property::STRING.
  99        * @SINCE_1_1.37
 100        */
 101       FONT_FAMILY,
 102
 103       /**
 104        * @brief The requested font style.
 105        * @details Name "fontStyle", type Property::STRING or Property::MAP.
 106        * @SINCE_1_2.13
 107        */
 108       FONT_STYLE,
 109
 110       /**
 111        * @brief The size of font in points.
 112        * @details Name "pointSize", type Property::FLOAT.
 113        *          Conversion from Pixel size to Point size : Point size = Pixel size * 72 / DPI.
 114        * @SINCE_1_1.37
 115        */
 116       POINT_SIZE,
 117
 118       /**
 119        * @brief The text horizontal alignment.
 120        * @details Name "horizontalAlignment", type Property::STRING or type HorizontalAlignment::Type (Property::INTEGER)
 121        *          Values "BEGIN" "CENTER" "END".
 122        * @note Return type is Property::STRING
 123        * @SINCE_1_1.37
 124        */
 125       HORIZONTAL_ALIGNMENT,
 126
 127       /**
 128        * @brief Vertical scrolling will occur if the cursor is this close to the control border.
 129        * @details Name "scrollThreshold", type Property::FLOAT.
 130        * @SINCE_1_1.37
 131        */
 132       SCROLL_THRESHOLD,
 133
 134       /**
 135        * @brief The scroll speed in pixels per second.
 136        * @details Name "scrollSpeed", type Property::FLOAT.
 137        * @SINCE_1_1.37
 138        */
 139       SCROLL_SPEED,
 140
 141       /**
 142        * @brief The color to apply to the primary cursor.
 143        * @details Name "primaryCursorColor", type Property::VECTOR4.
 144        * @SINCE_1_1.37
 145        */
 146       PRIMARY_CURSOR_COLOR,
 147
 148       /**
 149        * @brief The color to apply to the secondary cursor.
 150        * @details Name "secondaryCursorColor", type Property::VECTOR4.
 151        * @SINCE_1_1.37
 152        */
 153       SECONDARY_CURSOR_COLOR,
 154
 155       /**
 156        * @brief Whether the cursor should blink or not.
 157        * @details Name "enableCursorBlink", type Property::BOOLEAN.
 158        * @SINCE_1_1.37
 159        */
 160       ENABLE_CURSOR_BLINK,
 161
 162       /**
 163        * @brief The time interval in seconds between cursor on/off states.
 164        * @details Name "cursorBlinkInterval", type Property::FLOAT.
 165        * @SINCE_1_1.37
 166        */
 167       CURSOR_BLINK_INTERVAL,
 168
 169       /**
 170        * @brief The cursor will stop blinking after this number of seconds (if non-zero).
 171        * @details Name "cursorBlinkDuration", type Property::FLOAT.
 172        * @SINCE_1_1.37
 173        */
 174       CURSOR_BLINK_DURATION,
 175
 176       /**
 177        * @brief The cursor width.
 178        * @details Name "cursorWidth", type Property::INTEGER.
 179        * @SINCE_1_1.37
 180        */
 181       CURSOR_WIDTH,
 182
 183       /**
 184        * @brief The image to display for the grab handle.
 185        * @details Name "grabHandleImage", type Property::STRING.
 186        * @SINCE_1_1.37
 187        */
 188       GRAB_HANDLE_IMAGE,
 189
 190       /**
 191        * @brief The image to display when the grab handle is pressed.
 192        * @details Name "grabHandlePressedImage", type Property::STRING.
 193        * @SINCE_1_1.37
 194        */
 195       GRAB_HANDLE_PRESSED_IMAGE,
 196
 197       /**
 198        * @brief The image to display for the left selection handle.
 199        * @details Name "selectionHandleImageLeft", type Property::MAP.
 200        * @SINCE_1_1.37
 201        */
 202       SELECTION_HANDLE_IMAGE_LEFT,
 203
 204       /**
 205        * @brief The image to display for the right selection handle.
 206        * @details Name "selectionHandleImageRight", type Property::MAP.
 207        * @SINCE_1_1.37
 208        */
 209       SELECTION_HANDLE_IMAGE_RIGHT,
 210
 211       /**
 212        * @brief The image to display when the left selection handle is pressed.
 213        * @details Name "selectionHandlePressedImageLeft", type Property::MAP.
 214        * @SINCE_1_1.37
 215        */
 216       SELECTION_HANDLE_PRESSED_IMAGE_LEFT,
 217
 218       /**
 219        * @brief The image to display when the right selection handle is pressed.
 220        * @details Name "selectionHandlePressedImageRight", type Property::MAP.
 221        * @SINCE_1_1.37
 222        */
 223       SELECTION_HANDLE_PRESSED_IMAGE_RIGHT,
 224
 225       /**
 226        * @brief The image to display for the left selection handle marker.
 227        * @details Name "selectionHandleMarkerImageLeft", type Property::MAP.
 228        * @SINCE_1_1.37
 229        */
 230       SELECTION_HANDLE_MARKER_IMAGE_LEFT,
 231
 232       /**
 233        * @brief The image to display for the right selection handle marker.
 234        * @details Name "selectionHandleMarkerImageRight", type Property::MAP.
 235        * @SINCE_1_1.37
 236        */
 237       SELECTION_HANDLE_MARKER_IMAGE_RIGHT,
 238
 239       /**
 240        * @brief The color of the selection highlight.
 241        * @details Name "selectionHighlightColor", type Property::VECTOR4.
 242        * @SINCE_1_1.37
 243        */
 244       SELECTION_HIGHLIGHT_COLOR,
 245
 246       /**
 247        * @brief The decorations (handles etc) will positioned within this area on-screen.
 248        * @details Name "decorationBoundingBox", type Property::RECTANGLE.
 249        * @SINCE_1_1.37
 250        */
 251       DECORATION_BOUNDING_BOX,
 252
 253       /**
 254        * @brief Whether the mark-up processing is enabled.
 255        * @details Name "enableMarkup", type Property::BOOLEAN.
 256        * @SINCE_1_1.37
 257        */
 258       ENABLE_MARKUP,
 259
 260       /**
 261        * @brief The color of the new input text.
 262        * @details Name "inputColor", type Property::VECTOR4.
 263        * @SINCE_1_1.37
 264        */
 265       INPUT_COLOR,
 266
 267       /**
 268        * @brief The font's family of the new input text.
 269        * @details Name "inputFontFamily", type Property::STRING.
 270        * @SINCE_1_1.37
 271        */
 272       INPUT_FONT_FAMILY,
 273
 274       /**
 275        * @brief The font's style of the new input text.
 276        * @details Name "inputFontStyle", type Property::MAP.
 277        * @SINCE_1_2.13
 278        */
 279       INPUT_FONT_STYLE,
 280
 281       /**
 282        * @brief The font's size of the new input text in points.
 283        * @details Name "inputPointSize", type Property::FLOAT.
 284        * @SINCE_1_1.37
 285        */
 286       INPUT_POINT_SIZE,
 287
 288       /**
 289        * @brief The default extra space between lines in points.
 290        * @details Name "lineSpacing", type Property::FLOAT.
 291        * @SINCE_1_1.37
 292        */
 293       LINE_SPACING,
 294
 295       /**
 296        * @brief The extra space between lines in points.
 297        * @details Name "inputLineSpacing",  type Property::FLOAT.
 298        * @SINCE_1_1.37
 299        * @note This affects the whole paragraph where the new input text is inserted.
 300        */
 301       INPUT_LINE_SPACING,
 302
 303       /**
 304        * @copydoc Dali::Toolkit::TextLabel::Property::UNDERLINE
 305        */
 306       UNDERLINE,
 307
 308       /**
 309        * @brief The underline parameters of the new input text.
 310        * @details Name "inputUnderline", type Property::MAP.
 311        * @SINCE_1_2.13
 312        */
 313       INPUT_UNDERLINE,
 314
 315       /**
 316        * @copydoc Dali::Toolkit::TextLabel::Property::SHADOW
 317        */
 318       SHADOW,
 319
 320       /**
 321        * @brief The shadow parameters of the new input text.
 322        * @details Name "inputShadow", type Property::MAP.
 323        * @SINCE_1_2.13
 324        */
 325       INPUT_SHADOW,
 326
 327       /**
 328        * @brief The default emboss parameters.
 329        * @details Name "emboss", type Property::MAP.
 330        * @SINCE_1_2.13
 331        */
 332       EMBOSS,
 333
 334       /**
 335        * @brief The emboss parameters of the new input text.
 336        * @details Name "inputEmboss", type Property::MAP.
 337        * @SINCE_1_2.13
 338        */
 339       INPUT_EMBOSS,
 340
 341       /**
 342        * @copydoc Dali::Toolkit::TextLabel::Property::OUTLINE
 343        */
 344       OUTLINE,
 345
 346       /**
 347        * @brief The outline parameters of the new input text.
 348        * @details Name "inputOutline", type Property::MAP.
 349        * @SINCE_1_2.13
 350        */
 351       INPUT_OUTLINE,
 352
 353       /**
 354        * @brief Enable or disable the smooth scroll animation.
 355        * @details Name "smoothScroll", type Property::BOOLEAN.
 356        * @SINCE_1_2.60
 357        */
 358       SMOOTH_SCROLL,
 359
 360       /**
 361        * @brief Sets the duration of smooth scroll animation.
 362        * @details Name "smoothScrollDuration", type Property::FLOAT.
 363        * @SINCE_1_2.60
 364        */
 365       SMOOTH_SCROLL_DURATION,
 366
 367       /**
 368        * @brief Enable or disable the scroll bar.
 369        * @details Name "enableScrollBar", type Property::BOOLEAN.
 370        * @SINCE_1_2.60
 371        */
 372       ENABLE_SCROLL_BAR,
 373
 374       /**
 375        * @brief Sets the duration of scroll bar to show.
 376        * @details Name "scrollBarShowDuration", type Property::FLOAT.
 377        * @SINCE_1_2.60
 378        */
 379       SCROLL_BAR_SHOW_DURATION,
 380
 381       /**
 382        * @brief Sets the duration of scroll bar to fade out.
 383        * @details Name "scrollBarFadeDuration", type Property::FLOAT.
 384        * @SINCE_1_2.60
 385        */
 386       SCROLL_BAR_FADE_DURATION,
 387
 388       /**
 389        * @brief The size of font in pixels.
 390        * @details Name "pixelSize", type Property::FLOAT.
 391        *          Conversion from Point size to Pixel size:
 392        *           Pixel size = Point size * DPI / 72
 393        * @SINCE_1_2.60
 394        */
 395       PIXEL_SIZE,
 396
 397       /**
 398        * @brief The line count of text.
 399        * @details Name "lineCount", type Property::INTEGER.
 400        * @SINCE_1_2.60
 401        * @note This property is read-only.
 402        */
 403       LINE_COUNT,
 404
 405       /**
 406        * @brief Enables Text selection, such as the cursor, handle, clipboard, and highlight color.
 407        * @details Name "enableSelection", type Property::BOOLEAN.
 408        * @SINCE_1_2.60
 409        */
 410       ENABLE_SELECTION,
 411
 412       /**
 413        * @brief Sets the placeholder : text, color, font family, font style, point size, and pixel size.
 414        * @details Name "placeholder", type Property::MAP.
 415        * Example:
 416        * @code
 417        *   Property::Map propertyMap;
 418        *   propertyMap["placeholderText"] = "Setting Placeholder Text";
 419        *   propertyMap["placeholderTextFocused"] = "Setting Placeholder Text Focused";
 420        *   propertyMap["placeholderColor"] = Color::RED;
 421        *   propertyMap["placeholderFontFamily"] = "Arial";
 422        *   propertyMap["placeholderPointSize"] = 12.0f;
 423        *
 424        *   Property::Map fontStyleMap;
 425        *   fontStyleMap.Insert( "weight", "bold" );
 426        *   fontStyleMap.Insert( "width", "condensed" );
 427        *   fontStyleMap.Insert( "slant", "italic" );
 428        *   propertyMap["placeholderFontStyle"] = fontStyleMap;
 429        *
 430        *   editor.SetProperty( TextEditor::Property::PLACEHOLDER, propertyMap );
 431        * @endcode
 432        *
 433        * @SINCE_1_2.60
 434        */
 435       PLACEHOLDER,
 436
 437       /**
 438        * @brief Line wrap mode when text lines are greater than the layout width.
 439        * @details Name "lineWrapMode", type Text::LineWrap::Mode (Text::Property::INTEGER) or Property::STRING.
 440        * @SINCE_1_2.60
 441        * @note Default is Text::LineWrap::WORD.
 442        * @note Return type is Text::LineWrap::Mode (Text::Property::INTEGER).
 443        * @see Text::LineWrap
 444        */
 445       LINE_WRAP_MODE,
 446     };
 447   };
 448
 449   /**
 450    * @brief Mask used by the signal InputStyleChangedSignal(). Notifies which parameters of the input style have changed.
 451    *
 452    * @SINCE_1_2_2
 453    */
 454   struct InputStyle
 455   {
 456   /**
 457    * @brief Enumeration for mask used by the signal InputStyleChangedSignal().
 458    * @SINCE_1_2_2
 459    */
 460     enum Mask
 461     {
 462       NONE         = 0x0000, ///< @SINCE_1_2_2
 463       COLOR        = 0x0001, ///< @SINCE_1_2_2
 464       FONT_FAMILY  = 0x0002, ///< @SINCE_1_2_2
 465       POINT_SIZE   = 0x0004, ///< @SINCE_1_2_2
 466       FONT_STYLE   = 0x0008, ///< @SINCE_1_2_2
 467       LINE_SPACING = 0x0010, ///< @SINCE_1_2_2
 468       UNDERLINE    = 0x0020, ///< @SINCE_1_2_2
 469       SHADOW       = 0x0040, ///< @SINCE_1_2_2
 470       EMBOSS       = 0x0080, ///< @SINCE_1_2_2
 471       OUTLINE      = 0x0100  ///< @SINCE_1_2_2
 472     };
 473   };
 474
 475   /**
 476    * @brief Enumerations for the type of scrolling.
 477    * @SINCE_1_2.60
 478    * @see ScrollStateChangedSignal()
 479    */
 480   struct Scroll
 481   {
 482     /**
 483      * @brief Enumerations for the type of scrolling.
 484      * @SINCE_1_2.60
 485      * @see ScrollStateChangedSignal()
 486      */
 487     enum Type
 488     {
 489       STARTED,   ///< Scrolling has started. @SINCE_1_2.60
 490       FINISHED   ///< Scrolling has finished. @SINCE_1_2.60
 491     };
 492   };
 493
 494   // Type Defs
 495
 496   /**
 497    * @brief Text changed signal type.
 498    * @SINCE_1_1.37
 499    */
 500   typedef Signal<void ( TextEditor ) > TextChangedSignalType;
 501
 502   /**
 503    * @brief Input Style changed signal type.
 504    * @SINCE_1_2_2
 505    */
 506   typedef Signal<void ( TextEditor, InputStyle::Mask ) > InputStyleChangedSignalType;
 507
 508   /**
 509    * @brief Scroll state changed signal type.
 510    * @SINCE_1_2.60
 511    */
 512   typedef Signal< void ( TextEditor, Scroll::Type ) > ScrollStateChangedSignalType;
 513
 514   /**
 515    * @brief Creates the TextEditor control.
 516    *
 517    * @SINCE_1_1.37
 518    * @return A handle to the TextEditor control
 519    */
 520   static TextEditor New();
 521
 522   /**
 523    * @brief Creates an empty handle.
 524    *
 525    * @SINCE_1_1.37
 526    */
 527   TextEditor();
 528
 529   /**
 530    * @brief Copy constructor.
 531    *
 532    * @SINCE_1_1.37
 533    * @param[in] handle The handle to copy from
 534    */
 535   TextEditor( const TextEditor& handle );
 536
 537   /**
 538    * @brief Assignment operator.
 539    *
 540    * @SINCE_1_1.37
 541    * @param[in] handle The handle to copy from
 542    * @return A reference to this
 543    */
 544   TextEditor& operator=( const TextEditor& handle );
 545
 546   /**
 547    * @brief Destructor.
 548    *
 549    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 550    * @SINCE_1_1.37
 551    */
 552   ~TextEditor();
 553
 554   /**
 555    * @brief Downcasts a handle to TextEditor.
 556    *
 557    * If the BaseHandle points is a TextEditor, the downcast returns a valid handle.
 558    * If not, the returned handle is left empty.
 559    *
 560    * @SINCE_1_1.37
 561    * @param[in] handle Handle to an object
 562    * @return Handle to a TextEditor or an empty handle
 563    */
 564   static TextEditor DownCast( BaseHandle handle );
 565
 566   // Signals
 567
 568   /**
 569    * @brief This signal is emitted when the text changes.
 570    *
 571    * A callback of the following type may be connected:
 572    * @code
 573    *   void YourCallbackName( TextEditor textEditor );
 574    * @endcode
 575    *
 576    * @SINCE_1_1.37
 577    * @return The signal to connect to
 578    */
 579   TextChangedSignalType& TextChangedSignal();
 580
 581   /**
 582    * @brief This signal is emitted when the input style is updated as a consequence of a change in the cursor position.
 583    * i.e. The signal is not emitted when the input style is updated through the property system.
 584    *
 585    * A callback of the following type may be connected. The @p mask parameter notifies which parts of the style have changed.
 586    * @code
 587    *   void YourCallbackName( TextEditor textEditor, TextEditor::InputStyle::Mask mask );
 588    * @endcode
 589    *
 590    * @SINCE_1_2_2
 591    * @return The signal to connect to
 592    */
 593   InputStyleChangedSignalType& InputStyleChangedSignal();
 594
 595   /**
 596    * @brief This signal is emitted when TextEditor scrolling is started or finished.
 597    *
 598    * A callback of the following type may be connected:
 599    * @code
 600    *   void YourCallbackName( Scroll::Type type );
 601    * @endcode
 602    * type: Whether the scrolling is started or finished.
 603    *
 604    * @SINCE_1_2.60
 605    * @return The signal to connect to
 606    */
 607   ScrollStateChangedSignalType& ScrollStateChangedSignal();
 608
 609 public: // Not intended for application developers
 610
 611   /// @cond internal
 612   /**
 613    * @brief Creates a handle using the Toolkit::Internal implementation.
 614    *
 615    * @SINCE_1_1.37
 616    * @param[in] implementation The Control implementation
 617    */
 618   DALI_INTERNAL TextEditor( Internal::TextEditor& implementation );
 619
 620   /**
 621    * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
 622    *
 623    * @SINCE_1_1.37
 624    * @param[in] internal A pointer to the internal CustomActor
 625    */
 626   explicit DALI_INTERNAL TextEditor( Dali::Internal::CustomActor* internal );
 627   /// @endcond
 628 };
 629
 630 /**
 631  * @}
 632  */
 633 } // namespace Toolkit
 634
 635 } // namespace Dali
 636
 637 #endif // DALI_TOOLKIT_TEXT_EDITOR_H