dali-toolkit/internal/text/controller/text-controller.h

   1 #ifndef DALI_TOOLKIT_TEXT_CONTROLLER_H
   2 #define DALI_TOOLKIT_TEXT_CONTROLLER_H
   3
   4 /*
   5  * Copyright (c) 2023 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 // EXTERNAL INCLUDES
  22 #include <dali-toolkit/devel-api/text/spanned.h>
  23 #include <dali/devel-api/adaptor-framework/clipboard.h>
  24 #include <dali/devel-api/adaptor-framework/input-method-context.h>
  25 #include <dali/public-api/events/gesture.h>
  26
  27 // INTERNAL INCLUDES
  28 #include <dali-toolkit/devel-api/controls/text-controls/text-anchor-devel.h>
  29 #include <dali-toolkit/devel-api/controls/text-controls/text-label-devel.h>
  30 #include <dali-toolkit/devel-api/controls/text-controls/text-selection-popup-callback-interface.h>
  31 #include <dali-toolkit/devel-api/text/text-enumerations-devel.h>
  32 #include <dali-toolkit/internal/text/decorator/text-decorator.h>
  33 #include <dali-toolkit/internal/text/hidden-text.h>
  34 #include <dali-toolkit/internal/text/input-filter.h>
  35 #include <dali-toolkit/internal/text/layouts/layout-engine.h>
  36 #include <dali-toolkit/internal/text/text-anchor-control-interface.h>
  37 #include <dali-toolkit/internal/text/text-model-interface.h>
  38 #include <dali-toolkit/internal/text/text-selectable-control-interface.h>
  39 #include <dali-toolkit/public-api/text/text-enumerations.h>
  40
  41 namespace Dali::Toolkit::Text
  42 {
  43 class Controller;
  44 class ControlInterface;
  45 class EditableControlInterface;
  46 class View;
  47 class RenderingController;
  48
  49 /**
  50    * @brief Text selection operations .
  51    */
  52 enum SelectionType
  53 {
  54   INTERACTIVE = 0x0000, ///< Select the word where the cursor is located.
  55   ALL         = 0x0001, ///< Select the whole text.
  56   NONE        = 0x0002, ///< Unselect the whole text.
  57   RANGE       = 0x0003  ///< Select the range text.
  58 };
  59
  60 typedef IntrusivePtr<Controller> ControllerPtr;
  61
  62 /**
  63  * @brief A Text Controller is used by UI Controls which display text.
  64  *
  65  * It manipulates the Logical & Visual text models on behalf of the UI Controls.
  66  * It provides a view of the text that can be used by rendering back-ends.
  67  *
  68  * For selectable/editable UI controls, the controller handles input events from the UI control
  69  * and decorations (grab handles etc) via the Decorator::ControllerInterface interface.
  70  *
  71  * The text selection popup button callbacks are as well handled via the TextSelectionPopupCallbackInterface interface.
  72  */
  73 class Controller : public RefObject, public Decorator::ControllerInterface, public TextSelectionPopupCallbackInterface, public HiddenText::Observer, public ConnectionTracker
  74 {
  75 public: // Enumerated types.
  76   /**
  77    * @brief Text related operations to be done in the relayout process.
  78    */
  79   enum OperationsMask
  80   {
  81     NO_OPERATION       = 0x0000,
  82     CONVERT_TO_UTF32   = 0x0001,
  83     GET_SCRIPTS        = 0x0002,
  84     VALIDATE_FONTS     = 0x0004,
  85     GET_LINE_BREAKS    = 0x0008,
  86     BIDI_INFO          = 0x0010,
  87     SHAPE_TEXT         = 0x0020,
  88     GET_GLYPH_METRICS  = 0x0040,
  89     LAYOUT             = 0x0080,
  90     UPDATE_LAYOUT_SIZE = 0x0100,
  91     REORDER            = 0x0200,
  92     ALIGN              = 0x0400,
  93     COLOR              = 0x0800,
  94     UPDATE_DIRECTION   = 0x1000,
  95     ALL_OPERATIONS     = 0xFFFF
  96   };
  97
  98   /**
  99    * @brief Used to distinguish between regular key events and InputMethodContext events
 100    */
 101   enum InsertType
 102   {
 103     COMMIT,
 104     PRE_EDIT
 105   };
 106
 107   /**
 108    * @brief Used to specify whether to update the input style.
 109    */
 110   enum UpdateInputStyleType
 111   {
 112     UPDATE_INPUT_STYLE,
 113     DONT_UPDATE_INPUT_STYLE
 114   };
 115
 116   /**
 117    * @brief Used to specify what has been updated after the Relayout() method has been called.
 118    */
 119   enum UpdateTextType
 120   {
 121     NONE_UPDATED      = 0x0, ///< Nothing has been updated.
 122     MODEL_UPDATED     = 0x1, ///< The text's model has been updated.
 123     DECORATOR_UPDATED = 0x2  ///< The decoration has been updated.
 124   };
 125
 126   /**
 127    * @brief Different placeholder-text can be shown when the control is active/inactive.
 128    */
 129   enum PlaceholderType
 130   {
 131     PLACEHOLDER_TYPE_ACTIVE,
 132     PLACEHOLDER_TYPE_INACTIVE,
 133   };
 134
 135   /**
 136    * @brief Enumeration for Font Size Type.
 137    */
 138   enum FontSizeType
 139   {
 140     POINT_SIZE, // The size of font in points.
 141     PIXEL_SIZE  // The size of font in pixels.
 142   };
 143
 144   struct NoTextTap
 145   {
 146     enum Action
 147     {
 148       NO_ACTION,           ///< Does no action if there is a tap on top of an area with no text.
 149       HIGHLIGHT,           ///< Highlights the nearest text (at the beginning or end of the text) and shows the text's selection popup.
 150       SHOW_SELECTION_POPUP ///< Shows the text's selection popup.
 151     };
 152   };
 153
 154   struct TextFitInfo
 155   {
 156     enum Property
 157     {
 158       TEXT_FIT_ENABLE,
 159       TEXT_FIT_MIN_SIZE,
 160       TEXT_FIT_MAX_SIZE,
 161       TEXT_FIT_STEP_SIZE,
 162       TEXT_FIT_FONT_SIZE_TYPE
 163     };
 164   };
 165
 166 public: // Constructor.
 167   /**
 168    * @brief Create a new instance of a Controller.
 169    *
 170    * @return A pointer to a new Controller.
 171    */
 172   static ControllerPtr New()
 173   {
 174     return ControllerPtr(new Controller());
 175   }
 176
 177   /**
 178    * @brief Create a new instance of a Controller.
 179    *
 180    * @param[in] controlInterface The control's interface.
 181    *
 182    * @return A pointer to a new Controller.
 183    */
 184   static ControllerPtr New(ControlInterface* controlInterface)
 185   {
 186     return ControllerPtr(new Controller(controlInterface));
 187   }
 188
 189   /**
 190    * @brief Create a new instance of a Controller.
 191    *
 192    * @param[in] controlInterface The control's interface.
 193    * @param[in] editableControlInterface The editable control's interface.
 194    * @param[in] selectableControlInterface The selectable control's interface.
 195    * @param[in] anchorControlInterface The anchor control's interface.
 196    *
 197    * @return A pointer to a new Controller.
 198    */
 199   static ControllerPtr New(ControlInterface*           controlInterface,
 200                            EditableControlInterface*   editableControlInterface,
 201                            SelectableControlInterface* selectableControlInterface,
 202                            AnchorControlInterface*     anchorControlInterface)
 203   {
 204     return ControllerPtr(new Controller(controlInterface,
 205                                         editableControlInterface,
 206                                         selectableControlInterface,
 207                                         anchorControlInterface));
 208   }
 209
 210 public: // Configure the text controller.
 211   /**
 212    * @brief Called to enable text input.
 213    *
 214    * @note Selectable or editable controls should call this once after Controller::New().
 215    * @param[in] decorator Used to create cursor, selection handle decorations etc.
 216    * @param[in] inputMethodContext Used to manager ime.
 217    */
 218   void EnableTextInput(DecoratorPtr decorator, InputMethodContext& inputMethodContext);
 219
 220   /**
 221    * @brief Used to switch between bitmap & vector based glyphs
 222    *
 223    * @param[in] glyphType The type of glyph; note that metrics for bitmap & vector based glyphs are different.
 224    */
 225   void SetGlyphType(TextAbstraction::GlyphType glyphType);
 226
 227   /**
 228    * @brief Enables/disables the mark-up processor.
 229    *
 230    * By default is disabled.
 231    *
 232    * @param[in] enable Whether to enable the mark-up processor.
 233    */
 234   void SetMarkupProcessorEnabled(bool enable);
 235
 236   /**
 237    * @brief Retrieves whether the mark-up processor is enabled.
 238    *
 239    * By default is disabled.
 240    *
 241    * @return @e true if the mark-up processor is enabled, otherwise returns @e false.
 242    */
 243   bool IsMarkupProcessorEnabled() const;
 244
 245   /**
 246    * @brief Retrieves whether the current text contains anchors.
 247    *
 248    * @return @e true if the current text contains anchors. @e false.
 249    */
 250   bool HasAnchors() const;
 251
 252   /**
 253    * @brief Enables/disables the auto text scrolling
 254    *
 255    * By default is disabled.
 256    *
 257    * @param[in] enable Whether to enable the auto scrolling
 258    */
 259   void SetAutoScrollEnabled(bool enable);
 260
 261   /**
 262    * @brief Whether the auto scrolling texture exceed max texture.
 263    *
 264    * By default is false.
 265    *
 266    * @param[in] exceed Whether the auto scrolling texture exceed max texture.
 267    */
 268   void SetAutoScrollMaxTextureExceeded(bool exceed);
 269
 270   /**
 271    * @brief Retrieves whether auto text scrolling is enabled.
 272    *
 273    * By default is disabled.
 274    *
 275    * @return @e true if auto scrolling is enabled, otherwise returns @e false.
 276    */
 277   bool IsAutoScrollEnabled() const;
 278
 279   /**
 280    * @brief Get direction of the text from the first line of text,
 281    * @return bool rtl (right to left) is true
 282    */
 283   CharacterDirection GetAutoScrollDirection() const;
 284
 285   /**
 286    * @brief Get the alignment offset of the first line of text.
 287    *
 288    * @return The alignment offset.
 289    */
 290   float GetAutoScrollLineAlignment() const;
 291
 292   /**
 293    * @brief Enables the horizontal scrolling.
 294    *
 295    * @param[in] enable Whether to enable the horizontal scrolling.
 296    */
 297   void SetHorizontalScrollEnabled(bool enable);
 298
 299   /**
 300    * @brief Retrieves whether the horizontal scrolling is enabled.
 301    *
 302    * @return @e true if the horizontal scrolling is enabled, otherwise it returns @e false.
 303    */
 304   bool IsHorizontalScrollEnabled() const;
 305
 306   /**
 307    * @brief Enables the vertical scrolling.
 308    *
 309    * @param[in] enable Whether to enable the vertical scrolling.
 310    */
 311   void SetVerticalScrollEnabled(bool enable);
 312
 313   /**
 314    * @brief Retrieves whether the verticall scrolling is enabled.
 315    *
 316    * @return @e true if the vertical scrolling is enabled, otherwise it returns @e false.
 317    */
 318   bool IsVerticalScrollEnabled() const;
 319
 320   /**
 321    * @brief Enables the smooth handle panning.
 322    *
 323    * @param[in] enable Whether to enable the smooth handle panning.
 324    */
 325   void SetSmoothHandlePanEnabled(bool enable);
 326
 327   /**
 328    * @brief Retrieves whether the smooth handle panning is enabled.
 329    *
 330    * @return @e true if the smooth handle panning is enabled.
 331    */
 332   bool IsSmoothHandlePanEnabled() const;
 333
 334   /**
 335    * @brief Sets the maximum number of characters that can be inserted into the TextModel
 336    *
 337    * @param[in] maxCharacters maximum number of characters to be accepted
 338    */
 339   void SetMaximumNumberOfCharacters(Length maxCharacters);
 340
 341   /**
 342    * @brief Sets the maximum number of characters that can be inserted into the TextModel
 343    *
 344    * @param[in] maxCharacters maximum number of characters to be accepted
 345    */
 346   int GetMaximumNumberOfCharacters();
 347
 348   /**
 349    * @brief Called to enable/disable cursor blink.
 350    *
 351    * @note Only editable controls should calls this.
 352    * @param[in] enabled Whether the cursor should blink or not.
 353    */
 354   void SetEnableCursorBlink(bool enable);
 355
 356   /**
 357    * @brief Query whether cursor blink is enabled.
 358    *
 359    * @return Whether the cursor should blink or not.
 360    */
 361   bool GetEnableCursorBlink() const;
 362
 363   /**
 364    * @brief Whether to enable the multi-line layout.
 365    *
 366    * @param[in] enable \e true enables the multi-line (by default)
 367    */
 368   void SetMultiLineEnabled(bool enable);
 369
 370   /**
 371    * @return Whether the multi-line layout is enabled.
 372    */
 373   bool IsMultiLineEnabled() const;
 374
 375   /**
 376    * @brief Sets the text's horizontal alignment.
 377    *
 378    * @param[in] alignment The horizontal alignment.
 379    */
 380   void SetHorizontalAlignment(HorizontalAlignment::Type alignment);
 381
 382   /**
 383    * @copydoc ModelInterface::GetHorizontalAlignment()
 384    */
 385   HorizontalAlignment::Type GetHorizontalAlignment() const;
 386
 387   /**
 388    * @brief Sets the text's vertical alignment.
 389    *
 390    * @param[in] alignment The vertical alignment.
 391    */
 392   void SetVerticalAlignment(VerticalAlignment::Type alignment);
 393
 394   /**
 395    * @copydoc ModelInterface::GetVerticalAlignment()
 396    */
 397   VerticalAlignment::Type GetVerticalAlignment() const;
 398
 399   /**
 400    * @brief Sets the text's wrap mode
 401    * @param[in] text wrap mode The unit of wrapping
 402    */
 403   void SetLineWrapMode(Text::LineWrap::Mode textWarpMode);
 404
 405   /**
 406    * @brief Retrieve text wrap mode previously set.
 407    * @return text wrap mode
 408    */
 409   Text::LineWrap::Mode GetLineWrapMode() const;
 410
 411   /**
 412    * @brief Enable or disable the text elide.
 413    *
 414    * @param[in] enabled Whether to enable the text elide.
 415    */
 416   void SetTextElideEnabled(bool enabled);
 417
 418   /**
 419    * @copydoc ModelInterface::IsTextElideEnabled()
 420    */
 421   bool IsTextElideEnabled() const;
 422
 423   /**
 424    * @brief Enable or disable the text fit.
 425    *
 426    * @param[in] enabled Whether to enable the text fit.
 427    */
 428   void SetTextFitEnabled(bool enabled);
 429
 430   /**
 431    * @brief Whether the text fit is enabled or not.
 432    *
 433    * @return True if the text fit is enabled
 434    */
 435   bool IsTextFitEnabled() const;
 436
 437   /**
 438    * @brief Sets minimum size valid for text fit.
 439    *
 440    * @param[in] minimum size value.
 441    * @param[in] type The font size type is point size or pixel size
 442    */
 443   void SetTextFitMinSize(float pointSize, FontSizeType type);
 444
 445   /**
 446    * @brief Retrieves the minimum point size valid for text fit.
 447    *
 448    * @return The minimum point size valid for text fit
 449    */
 450   float GetTextFitMinSize() const;
 451
 452   /**
 453    * @brief Sets maximum size valid for text fit.
 454    *
 455    * @param[in] maximum size value.
 456    * @param[in] type The font size type is point size or pixel size
 457    */
 458   void SetTextFitMaxSize(float pointSize, FontSizeType type);
 459
 460   /**
 461    * @brief Retrieves the maximum point size valid for text fit.
 462    *
 463    * @return The maximum point size valid for text fit
 464    */
 465   float GetTextFitMaxSize() const;
 466
 467   /**
 468    * @brief Sets step size for font increase valid for text fit.
 469    *
 470    * @param[in] step size value.
 471    * @param[in] type The font size type is point size or pixel size
 472    */
 473   void SetTextFitStepSize(float step, FontSizeType type);
 474
 475   /**
 476    * @brief Retrieves the step point size valid for text fit.
 477    *
 478    * @return The step point size valid for text fit
 479    */
 480   float GetTextFitStepSize() const;
 481
 482   /**
 483    * @brief Sets content size valid for text fit.
 484    *
 485    * @param[in] Content size value.
 486    */
 487   void SetTextFitContentSize(Vector2 size);
 488
 489   /**
 490    * @brief Retrieves the content size valid for text fit.
 491    *
 492    * @return The content size valid for text fit
 493    */
 494   Vector2 GetTextFitContentSize() const;
 495
 496   /**
 497    * @brief Retrieve the fited point size.
 498    *
 499    * @return The fited point size.
 500    */
 501   float GetTextFitPointSize() const;
 502
 503   /**
 504    * @brief Sets whether the text fit properties have changed.
 505    *
 506    * @param[in] changed Whether to changed the text fit.
 507    */
 508   void SetTextFitChanged(bool changed);
 509
 510   /**
 511    * @brief Whether the text fit properties are changed or not.
 512    *
 513    * @return True if the text fit properties are changed
 514    */
 515   bool IsTextFitChanged() const;
 516
 517   /**
 518    * @brief Sets line size valid for text fit.
 519    *
 520    * @param[in] lineSize line size value
 521    */
 522   void SetTextFitLineSize(float lineSize);
 523
 524   /**
 525    * @brief Sets disabled color opacity.
 526    *
 527    * @param[in] opacity The color opacity value in disabled state.
 528    */
 529   void SetDisabledColorOpacity(float opacity);
 530
 531   /**
 532    * @brief Retrieves the disabled color opacity.
 533    *
 534    * @return The disabled color opacity value for disabled state.
 535    */
 536   float GetDisabledColorOpacity() const;
 537
 538   /**
 539    * @brief Enable or disable the placeholder text elide.
 540    * @param enabled Whether to enable the placeholder text elide.
 541    */
 542   void SetPlaceholderTextElideEnabled(bool enabled);
 543
 544   /**
 545    * @brief Whether the placeholder text elide property is enabled.
 546    * @return True if the placeholder text elide property is enabled, false otherwise.
 547    */
 548   bool IsPlaceholderTextElideEnabled() const;
 549
 550   /**
 551    * @brief Enable or disable the text selection.
 552    * @param[in] enabled Whether to enable the text selection.
 553    */
 554   void SetSelectionEnabled(bool enabled);
 555
 556   /**
 557    * @brief Whether the text selection is enabled or not.
 558    * @return True if the text selection is enabled
 559    */
 560   bool IsSelectionEnabled() const;
 561
 562   /**
 563    * @brief Enable or disable the text selection using Shift key.
 564    * @param enabled Whether to enable the text selection using Shift key
 565    */
 566   void SetShiftSelectionEnabled(bool enabled);
 567
 568   /**
 569    * @brief Whether the text selection using Shift key is enabled or not.
 570    * @return True if the text selection using Shift key is enabled
 571    */
 572   bool IsShiftSelectionEnabled() const;
 573
 574   /**
 575    * @brief Enable or disable the grab handles for text selection.
 576    *
 577    * @param[in] enabled Whether to enable the grab handles
 578    */
 579   void SetGrabHandleEnabled(bool enabled);
 580
 581   /**
 582    * @brief Returns whether the grab handles are enabled.
 583    *
 584    * @return True if the grab handles are enabled
 585    */
 586   bool IsGrabHandleEnabled() const;
 587
 588   /**
 589    * @brief Enable or disable the grab handles for text selection.
 590    *
 591    * @param[in] enabled Whether to enable the grab handles
 592    */
 593   void SetGrabHandlePopupEnabled(bool enabled);
 594
 595   /**
 596    * @brief Returns whether the grab handles are enabled.
 597    *
 598    * @return True if the grab handles are enabled
 599    */
 600   bool IsGrabHandlePopupEnabled() const;
 601
 602   /**
 603    * @brief Sets input type to password
 604    *
 605    * @note The string is displayed hidden character
 606    *
 607    * @param[in] passwordInput True if password input is enabled.
 608    */
 609   void SetInputModePassword(bool passwordInput);
 610
 611   /**
 612    * @brief Returns whether the input mode type is set as password.
 613    *
 614    * @return True if input mode type is password
 615    */
 616   bool IsInputModePassword();
 617
 618   /**
 619    * @brief Sets the action when there is a double tap event on top of a text area with no text.
 620    *
 621    * @param[in] action The action to do.
 622    */
 623   void SetNoTextDoubleTapAction(NoTextTap::Action action);
 624
 625   /**
 626    * @brief Retrieves the action when there is a double tap event on top of a text area with no text.
 627    *
 628    * @return The action to do.
 629    */
 630   NoTextTap::Action GetNoTextDoubleTapAction() const;
 631
 632   /**
 633    * @briefSets the action when there is a long press event on top of a text area with no text.
 634    *
 635    * @param[in] action The action to do.
 636    */
 637   void SetNoTextLongPressAction(NoTextTap::Action action);
 638
 639   /**
 640    * @brief Retrieves the action when there is a long press event on top of a text area with no text.
 641    *
 642    * @return The action to do.
 643    */
 644   NoTextTap::Action GetNoTextLongPressAction() const;
 645
 646   /**
 647    * @brief Query if Underline settings were provided by string or map
 648    * @return bool true if set by string
 649    */
 650   bool IsUnderlineSetByString();
 651
 652   /**
 653    * Set method underline setting were set by
 654    * @param[in] bool, true if set by string
 655    */
 656   void UnderlineSetByString(bool setByString);
 657
 658   /**
 659    * @brief Query if shadow settings were provided by string or map
 660    * @return bool true if set by string
 661    */
 662   bool IsShadowSetByString();
 663
 664   /**
 665    * Set method shadow setting were set by
 666    * @param[in] bool, true if set by string
 667    */
 668   void ShadowSetByString(bool setByString);
 669
 670   /**
 671    * @brief Query if outline settings were provided by string or map
 672    * @return bool true if set by string
 673    */
 674   bool IsOutlineSetByString();
 675
 676   /**
 677    * Set method outline setting were set by
 678    * @param[in] bool, true if set by string
 679    */
 680   void OutlineSetByString(bool setByString);
 681
 682   /**
 683    * @brief Query if font style settings were provided by string or map
 684    * @return bool true if set by string
 685    */
 686   bool IsFontStyleSetByString();
 687
 688   /**
 689    * Set method font style setting were set by
 690    * @param[in] bool, true if set by string
 691    */
 692   void FontStyleSetByString(bool setByString);
 693
 694   /**
 695    * @brief Query if Strikethrough settings were provided by string or map
 696    * @return bool true if set by string
 697    */
 698   bool IsStrikethroughSetByString();
 699
 700   /**
 701    * Set method Strikethrough setting were set by
 702    * @param[in] bool, true if set by string
 703    */
 704   void StrikethroughSetByString(bool setByString);
 705
 706   /**
 707    * @brief Set the override used for strikethrough height, 0 indicates height will be supplied by font metrics
 708    *
 709    * @param[in] height The height in pixels of the strikethrough
 710    */
 711   void SetStrikethroughHeight(float height);
 712
 713   /**
 714    * @brief Retrieves the override height of an strikethrough, 0 indicates height is supplied by font metrics
 715    *
 716    * @return The height of the strikethrough, or 0 if height is not overrided.
 717    */
 718   float GetStrikethroughHeight() const;
 719
 720   /**
 721    * @brief Set the strikethrough color.
 722    *
 723    * @param[in] color color of strikethrough.
 724    */
 725   void SetStrikethroughColor(const Vector4& color);
 726
 727   /**
 728    * @brief Retrieve the strikethrough color.
 729    *
 730    * @return The strikethrough color.
 731    */
 732   const Vector4& GetStrikethroughColor() const;
 733
 734   /**
 735    * @brief Set the strikethrough enabled flag.
 736    *
 737    * @param[in] enabled The strikethrough enabled flag.
 738    */
 739   void SetStrikethroughEnabled(bool enabled);
 740
 741   /**
 742    * @brief Returns whether the text has a strikethrough or not.
 743    *
 744    * @return The strikethrough state.
 745    */
 746   bool IsStrikethroughEnabled() const;
 747
 748 public: // Update.
 749   /**
 750    * @brief Replaces any text previously set.
 751    *
 752    * @note This will be converted into UTF-32 when stored in the text model.
 753    * @param[in] text A string of UTF-8 characters.
 754    */
 755   void SetText(const std::string& text);
 756
 757   /**
 758    * @brief Retrieve any text previously set.
 759    *
 760    * @param[out] text A string of UTF-8 characters.
 761    */
 762   void GetText(std::string& text) const;
 763
 764   /**
 765    * @brief Retrieves number of characters previously set.
 766    *
 767    * @return A length of string of UTF-32 characters.
 768    */
 769   Length GetNumberOfCharacters() const;
 770
 771   /**
 772  * @brief Set the @p spannedText
 773  * the spanned text contains content (text) and  format (spans with ranges)
 774  * the text is copied into text-controller and the spans are applied on ranges
 775  *
 776  * @param[in] spannedText the text with spans.
 777  */
 778   void SetSpannedText(const Text::Spanned& spannedText);
 779
 780   /**
 781    * @brief Replaces any placeholder text previously set.
 782    *
 783    * @param[in] type Different placeholder-text can be shown when the control is active/inactive.
 784    * @param[in] text A string of UTF-8 characters.
 785    */
 786   void SetPlaceholderText(PlaceholderType type, const std::string& text);
 787
 788   /**
 789    * @brief Retrieve any placeholder text previously set.
 790    *
 791    * @param[in] type Different placeholder-text can be shown when the control is active/inactive.
 792    * @param[out] A string of UTF-8 characters.
 793    */
 794   void GetPlaceholderText(PlaceholderType type, std::string& text) const;
 795
 796   /**
 797    * @ brief Update the text after a font change
 798    * @param[in] newDefaultFont The new font to change to
 799    */
 800   void UpdateAfterFontChange(const std::string& newDefaultFont);
 801
 802   /**
 803    * @brief The method acquires currently selected text
 804    * @param selectedText variable to place selected text in
 805    */
 806   void RetrieveSelection(std::string& selectedText) const;
 807
 808   /**
 809    * @brief The method sets selection in given range
 810    * @param start index of first character
 811    * @param end   index of first character after selection
 812    */
 813   void SetSelection(int start, int end);
 814
 815   /**
 816    * @brief This method retrieve indexes of current selection
 817    *
 818    * @return a pair, where first element is left index of selection and second is the right one
 819    */
 820   std::pair<int, int> GetSelectionIndexes() const;
 821
 822   /**
 823    * Place string in system clipboard
 824    * @param source std::string
 825    */
 826   void CopyStringToClipboard(const std::string& source);
 827
 828   /**
 829    * Place currently selected text in system clipboard
 830    * @param deleteAfterSending flag pointing if text should be deleted after sending to clipboard
 831    */
 832   void SendSelectionToClipboard(bool deleteAfterSending);
 833
 834 public: // Default style & Input style
 835   /**
 836    * @brief Set the default font family.
 837    *
 838    * @param[in] defaultFontFamily The default font family.
 839    */
 840   void SetDefaultFontFamily(const std::string& defaultFontFamily);
 841
 842   /**
 843    * @brief Retrieve the default font family.
 844    *
 845    * @return The default font family.
 846    */
 847   std::string GetDefaultFontFamily() const;
 848
 849   /**
 850    * @brief Sets the placeholder text font family.
 851    * @param[in] placeholderTextFontFamily The placeholder text font family.
 852    */
 853   void SetPlaceholderFontFamily(const std::string& placeholderTextFontFamily);
 854
 855   /**
 856    * @brief Retrieves the placeholder text font family.
 857    *
 858    * @return The placeholder text font family
 859    */
 860   std::string GetPlaceholderFontFamily() const;
 861
 862   /**
 863    * @brief Sets the default font weight.
 864    *
 865    * @param[in] weight The font weight.
 866    */
 867   void SetDefaultFontWeight(FontWeight weight);
 868
 869   /**
 870    * @brief Whether the font's weight has been defined.
 871    */
 872   bool IsDefaultFontWeightDefined() const;
 873
 874   /**
 875    * @brief Retrieves the default font weight.
 876    *
 877    * @return The default font weight.
 878    */
 879   FontWeight GetDefaultFontWeight() const;
 880
 881   /**
 882    * @brief Sets the placeholder text font weight.
 883    *
 884    * @param[in] weight The font weight
 885    */
 886   void SetPlaceholderTextFontWeight(FontWeight weight);
 887
 888   /**
 889    * @brief Whether the font's weight has been defined.
 890    *
 891    * @return True if the placeholder text font weight is defined
 892    */
 893   bool IsPlaceholderTextFontWeightDefined() const;
 894
 895   /**
 896    * @brief Retrieves the placeholder text font weight.
 897    *
 898    * @return The placeholder text font weight
 899    */
 900   FontWeight GetPlaceholderTextFontWeight() const;
 901
 902   /**
 903    * @brief Sets the default font width.
 904    *
 905    * @param[in] width The font width.
 906    */
 907   void SetDefaultFontWidth(FontWidth width);
 908
 909   /**
 910    * @brief Whether the font's width has been defined.
 911    */
 912   bool IsDefaultFontWidthDefined() const;
 913
 914   /**
 915    * @brief Retrieves the default font width.
 916    *
 917    * @return The default font width.
 918    */
 919   FontWidth GetDefaultFontWidth() const;
 920
 921   /**
 922    * @brief Sets the placeholder text font width.
 923    *
 924    * @param[in] width The font width
 925    */
 926   void SetPlaceholderTextFontWidth(FontWidth width);
 927
 928   /**
 929    * @brief Whether the font's width has been defined.
 930    *
 931    * @return True if the placeholder text font width is defined
 932    */
 933   bool IsPlaceholderTextFontWidthDefined() const;
 934
 935   /**
 936    * @brief Retrieves the placeholder text font width.
 937    *
 938    * @return The placeholder text font width
 939    */
 940   FontWidth GetPlaceholderTextFontWidth() const;
 941
 942   /**
 943    * @brief Sets the default font slant.
 944    *
 945    * @param[in] slant The font slant.
 946    */
 947   void SetDefaultFontSlant(FontSlant slant);
 948
 949   /**
 950    * @brief Whether the font's slant has been defined.
 951    */
 952   bool IsDefaultFontSlantDefined() const;
 953
 954   /**
 955    * @brief Retrieves the default font slant.
 956    *
 957    * @return The default font slant.
 958    */
 959   FontSlant GetDefaultFontSlant() const;
 960
 961   /**
 962    * @brief Sets the placeholder text font slant.
 963    *
 964    * @param[in] slant The font slant
 965    */
 966   void SetPlaceholderTextFontSlant(FontSlant slant);
 967
 968   /**
 969    * @brief Whether the font's slant has been defined.
 970    *
 971    * @return True if the placeholder text font slant is defined
 972    */
 973   bool IsPlaceholderTextFontSlantDefined() const;
 974
 975   /**
 976    * @brief Retrieves the placeholder text font slant.
 977    *
 978    * @return The placeholder text font slant
 979    */
 980   FontSlant GetPlaceholderTextFontSlant() const;
 981
 982   /**
 983    * @brief Set the default font size.
 984    *
 985    * @param[in] fontSize The default font size
 986    * @param[in] type The font size type is point size or pixel size
 987    */
 988   void SetDefaultFontSize(float fontSize, FontSizeType type);
 989
 990   /**
 991    * @brief Retrieve the default point size.
 992    *
 993    * @param[in] type The font size type
 994    * @return The default point size.
 995    */
 996   float GetDefaultFontSize(FontSizeType type) const;
 997
 998   /**
 999    * @brief Set the font size scale.
1000    *
1001    * @param[in] scale The font size scale
1002    */
1003   void SetFontSizeScale(float scale);
1004
1005   /**
1006    * @brief Get the font size scale.
1007    *
1008    * @return The font size scale.
1009    */
1010   float GetFontSizeScale() const;
1011
1012   /**
1013    * @brief Set the font size scale enabled flag.
1014    *
1015    * @param[in] enabled whether to enable the font size scale.
1016    */
1017   void SetFontSizeScaleEnabled(bool enabled);
1018
1019   /**
1020    * @brief Returns whether the font size scale is enabled or not.
1021    *
1022    * @return @e true if the font size scale is enabled, otherwise returns @e false.
1023    */
1024   bool IsFontSizeScaleEnabled() const;
1025
1026   /**
1027    * @brief Sets the Placeholder text font size.
1028    * @param[in] fontSize The placeholder text font size
1029    * @param[in] type The font size type is point size or pixel size
1030    */
1031   void SetPlaceholderTextFontSize(float fontSize, FontSizeType type);
1032
1033   /**
1034    * @brief Retrieves the Placeholder text font size.
1035    * @param[in] type The font size type
1036    * @return The placeholder font size
1037    */
1038   float GetPlaceholderTextFontSize(FontSizeType type) const;
1039
1040   /**
1041    * @brief Sets the text's default color.
1042    *
1043    * @param color The default color.
1044    */
1045   void SetDefaultColor(const Vector4& color);
1046
1047   /**
1048    * @brief Retrieves the text's default color.
1049    *
1050    * @return The default color.
1051    */
1052   const Vector4& GetDefaultColor() const;
1053
1054   /**
1055    * @brief Sets the user interaction enabled.
1056    *
1057    * @param enabled whether to enable the user interaction.
1058    */
1059   void SetUserInteractionEnabled(bool enabled);
1060
1061   /**
1062    * @brief Whether the user interaction is enabled.
1063    *
1064    * @return true if the user interaction is enabled, false otherwise.
1065    */
1066   bool IsUserInteractionEnabled() const;
1067
1068   /**
1069    * @brief Set the text color
1070    *
1071    * @param textColor The text color
1072    */
1073   void SetPlaceholderTextColor(const Vector4& textColor);
1074
1075   /**
1076    * @brief Retrieve the text color
1077    *
1078    * @return The text color
1079    */
1080   const Vector4& GetPlaceholderTextColor() const;
1081
1082   /**
1083    * @brief Set the shadow offset.
1084    *
1085    * @param[in] shadowOffset The shadow offset, 0,0 indicates no shadow.
1086    */
1087   void SetShadowOffset(const Vector2& shadowOffset);
1088
1089   /**
1090    * @brief Retrieve the shadow offset.
1091    *
1092    * @return The shadow offset.
1093    */
1094   const Vector2& GetShadowOffset() const;
1095
1096   /**
1097    * @brief Set the shadow color.
1098    *
1099    * @param[in] shadowColor The shadow color.
1100    */
1101   void SetShadowColor(const Vector4& shadowColor);
1102
1103   /**
1104    * @brief Retrieve the shadow color.
1105    *
1106    * @return The shadow color.
1107    */
1108   const Vector4& GetShadowColor() const;
1109
1110   /**
1111    * @brief Set the shadow blur radius.
1112    *
1113    * @param[in] shadowBlurRadius The shadow blur radius, 0,0 indicates no blur.
1114    */
1115   void SetShadowBlurRadius(const float& shadowBlurRadius);
1116
1117   /**
1118    * @brief Retrieve the shadow blur radius.
1119    *
1120    * @return The shadow blur radius.
1121    */
1122   const float& GetShadowBlurRadius() const;
1123
1124   /**
1125    * @brief Set the underline color.
1126    *
1127    * @param[in] color color of underline.
1128    */
1129   void SetUnderlineColor(const Vector4& color);
1130
1131   /**
1132    * @brief Retrieve the underline color.
1133    *
1134    * @return The underline color.
1135    */
1136   const Vector4& GetUnderlineColor() const;
1137
1138   /**
1139    * @brief Set the underline enabled flag.
1140    *
1141    * @param[in] enabled The underline enabled flag.
1142    */
1143   void SetUnderlineEnabled(bool enabled);
1144
1145   /**
1146    * @brief Returns whether the text is underlined or not.
1147    *
1148    * @return The underline state.
1149    */
1150   bool IsUnderlineEnabled() const;
1151
1152   /**
1153    * @brief Set the override used for underline height, 0 indicates height will be supplied by font metrics
1154    *
1155    * @param[in] height The height in pixels of the underline
1156    */
1157   void SetUnderlineHeight(float height);
1158
1159   /**
1160    * @brief Retrieves the override height of an underline, 0 indicates height is supplied by font metrics
1161    *
1162    * @return The height of the underline, or 0 if height is not overrided.
1163    */
1164   float GetUnderlineHeight() const;
1165
1166   /**
1167    * @brief Sets the underline type.
1168    * @param[in] type The underline type.
1169    */
1170   void SetUnderlineType(Text::Underline::Type type);
1171
1172   /**
1173    * @brief Retrieve underline type.
1174    * @return The underline type.
1175    */
1176   Text::Underline::Type GetUnderlineType() const;
1177
1178   /**
1179    * @brief Set the width of the dashes of the dashed underline.
1180    *
1181    * @param[in] width The width in pixels of the dashes of the dashed underline.
1182    */
1183   void SetDashedUnderlineWidth(float width);
1184
1185   /**
1186    * @brief Retrieves the width of the dashes of the dashed underline.
1187    *
1188    * @return The width of the dashes of the dashed underline.
1189    */
1190   float GetDashedUnderlineWidth() const;
1191
1192   /**
1193    * @brief Set the gap between the dashes of the dashed underline.
1194    *
1195    * @param[in] gap The gap between the dashes of the dashed underline.
1196    */
1197   void SetDashedUnderlineGap(float gap);
1198
1199   /**
1200    * @brief Retrieves the gap between the dashes of the dashed underline.
1201    *
1202    * @return The The gap between the dashes of the dashed underline.
1203    */
1204   float GetDashedUnderlineGap() const;
1205
1206   /**
1207    * @brief Set the outline color.
1208    *
1209    * @param[in] color color of outline.
1210    */
1211   void SetOutlineColor(const Vector4& color);
1212
1213   /**
1214    * @brief Retrieve the outline color.
1215    *
1216    * @return The outline color.
1217    */
1218   const Vector4& GetOutlineColor() const;
1219
1220   /**
1221    * @brief Set the outline width
1222    *
1223    * @param[in] width The width in pixels of the outline, 0 indicates no outline
1224    */
1225   void SetOutlineWidth(uint16_t width);
1226
1227   /**
1228    * @brief Retrieves the width of an outline
1229    *
1230    * @return The width of the outline.
1231    */
1232   uint16_t GetOutlineWidth() const;
1233
1234   /**
1235    * @brief Set the background color.
1236    *
1237    * @param[in] color color of background.
1238    */
1239   void SetBackgroundColor(const Vector4& color);
1240
1241   /**
1242    * @brief Retrieve the background color.
1243    *
1244    * @return The background color.
1245    */
1246   const Vector4& GetBackgroundColor() const;
1247
1248   /**
1249    * @brief Set the background enabled flag.
1250    *
1251    * @param[in] enabled The background enabled flag.
1252    */
1253   void SetBackgroundEnabled(bool enabled);
1254
1255   /**
1256    * @brief Returns whether to enable text background or not.
1257    *
1258    * @return Whether text background is enabled.
1259    */
1260   bool IsBackgroundEnabled() const;
1261
1262   /**
1263    * @brief Sets the emboss's properties string.
1264    *
1265    * @note The string is stored to be recovered.
1266    *
1267    * @param[in] embossProperties The emboss's properties string.
1268    */
1269   void SetDefaultEmbossProperties(const std::string& embossProperties);
1270
1271   /**
1272    * @brief Retrieves the emboss's properties string.
1273    *
1274    * @return The emboss's properties string.
1275    */
1276   std::string GetDefaultEmbossProperties() const;
1277
1278   /**
1279    * @brief Sets the outline's properties string.
1280    *
1281    * @note The string is stored to be recovered.
1282    *
1283    * @param[in] outlineProperties The outline's properties string.
1284    */
1285   void SetDefaultOutlineProperties(const std::string& outlineProperties);
1286
1287   /**
1288    * @brief Retrieves the outline's properties string.
1289    *
1290    * @return The outline's properties string.
1291    */
1292   std::string GetDefaultOutlineProperties() const;
1293
1294   /**
1295    * @brief Sets the default line spacing.
1296    *
1297    * @param[in] lineSpacing The line spacing.
1298    *
1299    * @return True if lineSpacing has been updated, false otherwise
1300    */
1301   bool SetDefaultLineSpacing(float lineSpacing);
1302
1303   /**
1304    * @brief Retrieves the default line spacing.
1305    *
1306    * @return The line spacing.
1307    */
1308   float GetDefaultLineSpacing() const;
1309
1310   /**
1311    * @brief Sets the default line size.
1312    *
1313    * @param[in] lineSize The line size.
1314    *
1315    * @return True if lineSize has been updated, false otherwise
1316    */
1317   bool SetDefaultLineSize(float lineSize);
1318
1319   /**
1320    * @brief Retrieves the default line size.
1321    *
1322    * @return The line size.
1323    */
1324   float GetDefaultLineSize() const;
1325
1326   /**
1327    * @brief Sets the relative line size to the original line size.
1328    *
1329    * @param[in] relativeLineSize The relativeline size.
1330    *
1331    * @return True if relativeLineSize has been updated, false otherwise
1332    */
1333   bool SetRelativeLineSize(float lineSize);
1334
1335   /**
1336    * @brief Retrieves the relative line size.
1337    *
1338    * @return The relative line size.
1339    */
1340   float GetRelativeLineSize() const;
1341
1342   /**
1343    * @brief Sets the input text's color.
1344    *
1345    * @param[in] color The input text's color.
1346    */
1347   void SetInputColor(const Vector4& color);
1348
1349   /**
1350    * @brief Retrieves the input text's color.
1351    *
1352    * @return The input text's color.
1353    */
1354   const Vector4& GetInputColor() const;
1355
1356   /**
1357    * @brief Sets the input text's font family name.
1358    *
1359    * @param[in] fontFamily The text's font family name.
1360    */
1361   void SetInputFontFamily(const std::string& fontFamily);
1362
1363   /**
1364    * @brief Retrieves the input text's font family name.
1365    *
1366    * @return The input text's font family name.
1367    */
1368   std::string GetInputFontFamily() const;
1369
1370   /**
1371    * @brief Sets the input font's weight.
1372    *
1373    * @param[in] weight The input font's weight.
1374    */
1375   void SetInputFontWeight(FontWeight weight);
1376
1377   /**
1378    * @return Whether the font's weight has been defined.
1379    */
1380   bool IsInputFontWeightDefined() const;
1381
1382   /**
1383    * @brief Retrieves the input font's weight.
1384    *
1385    * @return The input font's weight.
1386    */
1387   FontWeight GetInputFontWeight() const;
1388
1389   /**
1390    * @brief Sets the input font's width.
1391    *
1392    * @param[in] width The input font's width.
1393    */
1394   void SetInputFontWidth(FontWidth width);
1395
1396   /**
1397    * @return Whether the font's width has been defined.
1398    */
1399   bool IsInputFontWidthDefined() const;
1400
1401   /**
1402    * @brief Retrieves the input font's width.
1403    *
1404    * @return The input font's width.
1405    */
1406   FontWidth GetInputFontWidth() const;
1407
1408   /**
1409    * @brief Sets the input font's slant.
1410    *
1411    * @param[in] slant The input font's slant.
1412    */
1413   void SetInputFontSlant(FontSlant slant);
1414
1415   /**
1416    * @return Whether the font's slant has been defined.
1417    */
1418   bool IsInputFontSlantDefined() const;
1419
1420   /**
1421    * @brief Retrieves the input font's slant.
1422    *
1423    * @return The input font's slant.
1424    */
1425   FontSlant GetInputFontSlant() const;
1426
1427   /**
1428    * @brief Sets the input font's point size.
1429    *
1430    * @param[in] size The input font's point size.
1431    */
1432   void SetInputFontPointSize(float size);
1433
1434   /**
1435    * @brief Retrieves the input font's point size.
1436    *
1437    * @return The input font's point size.
1438    */
1439   float GetInputFontPointSize() const;
1440
1441   /**
1442    * @brief Sets the input line spacing.
1443    *
1444    * @param[in] lineSpacing The line spacing.
1445    */
1446   void SetInputLineSpacing(float lineSpacing);
1447
1448   /**
1449    * @brief Retrieves the input line spacing.
1450    *
1451    * @return The line spacing.
1452    */
1453   float GetInputLineSpacing() const;
1454
1455   /**
1456    * @brief Sets the input shadow's properties string.
1457    *
1458    * @note The string is stored to be recovered.
1459    *
1460    * @param[in] shadowProperties The shadow's properties string.
1461    */
1462   void SetInputShadowProperties(const std::string& shadowProperties);
1463
1464   /**
1465    * @brief Retrieves the input shadow's properties string.
1466    *
1467    * @return The shadow's properties string.
1468    */
1469   std::string GetInputShadowProperties() const;
1470
1471   /**
1472    * @brief Sets the input underline's properties string.
1473    *
1474    * @note The string is stored to be recovered.
1475    *
1476    * @param[in] underlineProperties The underline's properties string.
1477    */
1478   void SetInputUnderlineProperties(const std::string& underlineProperties);
1479
1480   /**
1481    * @brief Retrieves the input underline's properties string.
1482    *
1483    * @return The underline's properties string.
1484    */
1485   std::string GetInputUnderlineProperties() const;
1486
1487   /**
1488    * @brief Sets the input emboss's properties string.
1489    *
1490    * @note The string is stored to be recovered.
1491    *
1492    * @param[in] embossProperties The emboss's properties string.
1493    */
1494   void SetInputEmbossProperties(const std::string& embossProperties);
1495
1496   /**
1497    * @brief Retrieves the input emboss's properties string.
1498    *
1499    * @return The emboss's properties string.
1500    */
1501   std::string GetInputEmbossProperties() const;
1502
1503   /**
1504    * @brief Sets input the outline's properties string.
1505    *
1506    * @note The string is stored to be recovered.
1507    *
1508    * @param[in] outlineProperties The outline's properties string.
1509    */
1510   void SetInputOutlineProperties(const std::string& outlineProperties);
1511
1512   /**
1513    * @brief Retrieves the input outline's properties string.
1514    *
1515    * @return The outline's properties string.
1516    */
1517   std::string GetInputOutlineProperties() const;
1518
1519   /**
1520    * @brief Sets the input strikethrough's properties string.
1521    *
1522    * @note The string is stored to be recovered.
1523    *
1524    * @param[in] strikethroughProperties The strikethrough's properties string.
1525    */
1526   void SetInputStrikethroughProperties(const std::string& strikethroughProperties);
1527
1528   /**
1529    * @brief Retrieves the input strikethrough's properties string.
1530    *
1531    * @return The strikethrough's properties string.
1532    */
1533   std::string GetInputStrikethroughProperties() const;
1534
1535   /**
1536    * @brief Set the control's interface.
1537    *
1538    * @param[in] controlInterface The control's interface.
1539    */
1540   void SetControlInterface(ControlInterface* controlInterface);
1541
1542   /**
1543    * @brief Set the anchor control's interface.
1544    *
1545    * @param[in] anchorControlInterface The control's interface.
1546    */
1547   void SetAnchorControlInterface(AnchorControlInterface* anchorControlInterface);
1548
1549   /**
1550    * @brief Sets the character spacing.
1551    *
1552    * @note A positive value will make the characters far apart (expanded) and a negative value will bring them closer (condensed).
1553    *
1554    * @param[in] characterSpacing The character spacing.
1555    */
1556   void SetCharacterSpacing(float characterSpacing);
1557
1558   /**
1559    * @brief Retrieves the character spacing.
1560    *
1561    * @note A positive value will make the characters far apart (expanded) and a negative value will bring them closer (condensed).
1562    *
1563    * @return The character spacing.
1564    */
1565   const float GetCharacterSpacing() const;
1566
1567 public: // Queries & retrieves.
1568   /**
1569    * @brief Return the layout engine.
1570    *
1571    * @return A reference to the layout engine.
1572    */
1573   Layout::Engine& GetLayoutEngine();
1574
1575   /**
1576    * @brief Return a view of the text.
1577    *
1578    * @return A reference to the view.
1579    */
1580   View& GetView();
1581
1582   /**
1583    * @copydoc Control::GetNaturalSize()
1584    */
1585   Vector3 GetNaturalSize();
1586
1587   /**
1588    * @copydoc Control::GetHeightForWidth()
1589    */
1590   float GetHeightForWidth(float width);
1591
1592   /**
1593    * @brief Calculates the point size for text for given layout()
1594    */
1595   void FitPointSizeforLayout(Size layoutSize);
1596
1597   /**
1598    * @brief Checks if the point size fits within the layout size.
1599    *
1600    * @return Whether the point size fits within the layout size.
1601    */
1602   bool CheckForTextFit(float pointSize, Size& layoutSize);
1603
1604   /**
1605    * @brief Retrieves the text's number of lines for a given width.
1606    * @param[in] width The width of the text's area.
1607    * @ return The number of lines.
1608    */
1609   int GetLineCount(float width);
1610
1611   /**
1612    * @brief Retrieves the text's model.
1613    *
1614    * @return A pointer to the text's model.
1615    */
1616   const ModelInterface* GetTextModel() const;
1617
1618   /**
1619    * @brief Used to get scrolled distance by user input
1620    *
1621    * @return Distance from last scroll offset to new scroll offset
1622    */
1623   float GetScrollAmountByUserInput();
1624
1625   /**
1626    * @brief Get latest scroll amount, control size and layout size
1627    *
1628    * This method is used to get information of control's scroll
1629    * @param[out] scrollPosition The current scrolled position
1630    * @param[out] controlHeight The size of a UI control
1631    * @param[out] layoutHeight The size of a bounding box to layout text within.
1632    *
1633    * @return Whether the text scroll position is changed or not after last update.
1634    */
1635   bool GetTextScrollInfo(float& scrollPosition, float& controlHeight, float& layoutHeight);
1636
1637   /**
1638    * @brief Used to set the hidden input option
1639    */
1640   void SetHiddenInputOption(const Property::Map& options);
1641
1642   /**
1643    * @brief Used to get the hidden input option
1644    */
1645   void GetHiddenInputOption(Property::Map& options);
1646
1647   /**
1648    * @brief Used to set the input filter option
1649    */
1650   void SetInputFilterOption(const Property::Map& options);
1651
1652   /**
1653    * @brief Used to get the input filter option
1654    */
1655   void GetInputFilterOption(Property::Map& options);
1656
1657   /**
1658    * @brief Sets the Placeholder Properties.
1659    *
1660    * @param[in] map The placeholder property map
1661    */
1662   void SetPlaceholderProperty(const Property::Map& map);
1663
1664   /**
1665    * @brief Retrieves the Placeholder Property map.
1666    *
1667    * @param[out] map The property map
1668    */
1669   void GetPlaceholderProperty(Property::Map& map);
1670
1671   /**
1672    * @brief Checks text direction.
1673    * @return The text direction.
1674    */
1675   Toolkit::DevelText::TextDirection::Type GetTextDirection();
1676
1677   /**
1678    * @brief Retrieves vertical line alignment
1679    * @return The vertical line alignment
1680    */
1681   Toolkit::DevelText::VerticalLineAlignment::Type GetVerticalLineAlignment() const;
1682
1683   /**
1684    * @brief Sets vertical line alignment
1685    * @param[in] alignment The vertical line alignment for the text
1686    */
1687   void SetVerticalLineAlignment(Toolkit::DevelText::VerticalLineAlignment::Type alignment);
1688
1689   /**
1690    * @brief Retrieves ellipsis position
1691    * @return The ellipsis position
1692    */
1693   Toolkit::DevelText::EllipsisPosition::Type GetEllipsisPosition() const;
1694
1695   /**
1696    * @brief Sets ellipsis position
1697    * @param[in] ellipsisPosition The ellipsis position for the text
1698    */
1699   void SetEllipsisPosition(Toolkit::DevelText::EllipsisPosition::Type ellipsisPosition);
1700
1701   /**
1702    * @brief Retrieves ignoreSpaceAfterText value from model
1703    * @return The value of ignoreSpaceAfterText
1704    */
1705   bool IsIgnoreSpacesAfterText() const;
1706
1707   /**
1708    * @brief Sets ignoreSpaceAfterText value to model
1709    * @param[in] ignore The value of ignoreSpacesAfterText for the text
1710    */
1711   void SetIgnoreSpacesAfterText(bool ignore);
1712
1713   /**
1714    * @brief Sets SetMatchLayoutDirection value to model
1715    * @param[in] match The value of matchLayoutDirection for the text
1716    */
1717   void SetMatchLayoutDirection(DevelText::MatchLayoutDirection type);
1718
1719   /**
1720    * @brief Retrieves matchLayoutDirection value from model
1721    * @return The value of matchLayoutDirection
1722    */
1723   DevelText::MatchLayoutDirection GetMatchLayoutDirection() const;
1724
1725   /**
1726    * @brief Sets layoutDirection type value.
1727    * @param[in] layoutDirection The value of the layout direction type.
1728    */
1729   void SetLayoutDirection(Dali::LayoutDirection::Type layoutDirection);
1730
1731   /**
1732    * @brief Gets layoutDirection type value.
1733    * @param[in] actor The actor which will get the layout direction type.
1734    * @return The value of the layout direction type.
1735    */
1736   Dali::LayoutDirection::Type GetLayoutDirection(Dali::Actor& actor) const;
1737
1738   /**
1739    * @brief Get the rendered size of a specific text range.
1740    * if the requested text is at multilines, multiple sizes will be returned for each text located in a separate line.
1741    * if a line contains characters with different directions, multiple sizes will be returned for each block of contiguous characters with the same direction.
1742    *
1743    * @param[in] startIndex start index of the text requested to calculate size for.
1744    * @param[in] endIndex end index(included) of the text requested to calculate size for.
1745    * @return list of sizes of the reuested text.
1746    */
1747   Vector<Vector2> GetTextSize(CharacterIndex startIndex, CharacterIndex endIndex);
1748
1749   /**
1750    * @brief Get the top/left rendered position of a specific text range.
1751    * if the requested text is at multilines, multiple positions will be returned for each text located in a separate line.
1752    * if a line contains characters with different directions, multiple positions will be returned for each block of contiguous characters with the same direction.
1753    *
1754    * @param[in] startIndex start index of the text requested to get position to.
1755    * @param[in] endIndex end index(included) of the text requested to get position to.
1756    * @return list of positions of the requested text.
1757    */
1758   Vector<Vector2> GetTextPosition(CharacterIndex startIndex, CharacterIndex endIndex);
1759
1760   /**
1761    * @brief Get the line bounding rectangle.
1762    * if the requested index is out of range or the line is not yet rendered, a rect of {0, 0, 0, 0} is returned.
1763    *
1764    * @param[in] lineIndex line index to which we want to calculate the geometry for.
1765    * @return bounding rectangle.
1766    */
1767   Rect<float> GetLineBoundingRectangle(const uint32_t lineIndex);
1768
1769   /**
1770    * @brief Get the char bounding rectangle.
1771    * If the text is not yet rendered or the index > text.Count(); a rect of {0, 0, 0, 0} is returned.
1772    *
1773    * @param[in] charIndex character index to which we want to calculate the geometry for.
1774    * @return bounding rectangle.
1775    */
1776   Rect<float> GetCharacterBoundingRectangle(const uint32_t charIndex);
1777
1778   /**
1779    * @brief Get the character index.
1780    * If the text is not yet rendered or the text is empty, -1 is returned.
1781    *
1782    * @param[in] visualX visual x position.
1783    * @param[in] visualY visual y position.
1784    * @return character index.
1785    */
1786   int GetCharacterIndexAtPosition(float visualX, float visualY);
1787
1788   /**
1789    * @brief Gets the bounding box of a specific text range.
1790    *
1791    * @param[in] startIndex start index of the text requested to get bounding box to.
1792    * @param[in] endIndex end index(included) of the text requested to get bounding box to.
1793    * @return bounding box of the requested text.
1794    */
1795   Rect<> GetTextBoundingRectangle(CharacterIndex startIndex, CharacterIndex endIndex);
1796
1797   /**
1798    * @brief Sets the layout direction changed.
1799    */
1800   void ChangedLayoutDirection();
1801
1802   /**
1803    * @brief Retrieves if showing real text or not.
1804    * @return The value of showing real text.
1805    */
1806   bool IsShowingRealText() const;
1807
1808 public: // Relayout.
1809   /**
1810    * @brief Triggers a relayout which updates View (if necessary).
1811    *
1812    * @note UI Controls are expected to minimize calls to this method e.g. call once after size negotiation.
1813    * @param[in] size A the size of a bounding box to layout text within.
1814    * @param[in] layoutDirection The direction of the system language.
1815    *
1816    * @return Whether the text model or decorations were updated.
1817    */
1818   UpdateTextType Relayout(const Size& size, Dali::LayoutDirection::Type layoutDirection = Dali::LayoutDirection::LEFT_TO_RIGHT);
1819
1820   /**
1821    * @brief Request a relayout using the ControlInterface.
1822    */
1823   void RequestRelayout();
1824
1825 public: // Input style change signals.
1826   /**
1827    * @return Whether the queue of input style changed signals is empty.
1828    */
1829   bool IsInputStyleChangedSignalsQueueEmpty();
1830
1831   /**
1832    * @brief Process all pending input style changed signals.
1833    *
1834    * Calls the Text::ControlInterface::InputStyleChanged() method which is overriden by the
1835    * text controls. Text controls may send signals to state the input style has changed.
1836    */
1837   void ProcessInputStyleChangedSignals();
1838
1839 public: // Text-input Event Queuing.
1840   /**
1841    * @brief Called by editable UI controls when keyboard focus is gained.
1842    */
1843   void KeyboardFocusGainEvent();
1844
1845   /**
1846    * @brief Called by editable UI controls when focus is lost.
1847    */
1848   void KeyboardFocusLostEvent();
1849
1850   /**
1851    * @brief Called by editable UI controls when key events are received.
1852    *
1853    * @param[in] event The key event.
1854    * @param[in] type Used to distinguish between regular key events and InputMethodContext events.
1855    */
1856   bool KeyEvent(const Dali::KeyEvent& event);
1857
1858   /**
1859    * @brief Called by anchor when a tap gesture occurs.
1860    * @param[in] x The x position relative to the top-left of the parent control.
1861    * @param[in] y The y position relative to the top-left of the parent control.
1862    */
1863   void AnchorEvent(float x, float y);
1864
1865   /**
1866    * @brief Called by editable UI controls when a tap gesture occurs.
1867    * @param[in] tapCount The number of taps.
1868    * @param[in] x The x position relative to the top-left of the parent control.
1869    * @param[in] y The y position relative to the top-left of the parent control.
1870    */
1871   void TapEvent(unsigned int tapCount, float x, float y);
1872
1873   /**
1874    * @brief Called by editable UI controls when a pan gesture occurs.
1875    *
1876    * @param[in] state The state of the gesture.
1877    * @param[in] displacement This distance panned since the last pan gesture.
1878    */
1879   void PanEvent(GestureState state, const Vector2& displacement);
1880
1881   /**
1882    * @brief Called by editable UI controls when a long press gesture occurs.
1883    *
1884    * @param[in] state The state of the gesture.
1885    * @param[in] x The x position relative to the top-left of the parent control.
1886    * @param[in] y The y position relative to the top-left of the parent control.
1887    */
1888   void LongPressEvent(GestureState state, float x, float y);
1889
1890   /**
1891    * @brief Used to get the Primary cursor position.
1892    *
1893    * @return Primary cursor position.
1894    */
1895   CharacterIndex GetPrimaryCursorPosition() const;
1896
1897   /**
1898    * @brief Used to set the Primary cursor position.
1899    *
1900    * @param[in] index for the Primary cursor position.
1901    * @param[in] focused true if UI control has gained focus to receive key event, false otherwise.
1902    * @return[in] true if cursor position changed, false otherwise.
1903    */
1904   bool SetPrimaryCursorPosition(CharacterIndex index, bool focused);
1905
1906   /**
1907    * @brief Creates a selection event.
1908    *
1909    * It could be called from the TapEvent (double tap) or when the text selection popup's sellect all button is pressed.
1910    *
1911    * @param[in] x The x position relative to the top-left of the parent control.
1912    * @param[in] y The y position relative to the top-left of the parent control.
1913    * @param[in] selection type like the whole text is selected or unselected.
1914    */
1915   void SelectEvent(float x, float y, SelectionType selection);
1916
1917   /**
1918    * @copydoc Text::SelectableControlInterface::SetTextSelectionRange()
1919    */
1920   void SetTextSelectionRange(const uint32_t* start, const uint32_t* end);
1921
1922   /**
1923    * @copydoc Text::SelectableControlInterface::GetTextSelectionRange()
1924    */
1925   Uint32Pair GetTextSelectionRange() const;
1926
1927   /**
1928    * @copydoc Text::SelectableControlInterface::SelectWholeText()
1929    */
1930   void SelectWholeText();
1931
1932   /**
1933    * @copydoc Text::EditableControlInterface::CopyText()
1934    */
1935   string CopyText();
1936
1937   /**
1938    * @copydoc Text::EditableControlInterface::CutText()
1939    */
1940   string CutText();
1941
1942   /**
1943    * @copydoc Text::EditableControlInterface::PasteText()
1944    */
1945   void PasteText();
1946
1947   /**
1948    * @copydoc Text::SelectableControlInterface::SelectNone()
1949    */
1950   void SelectNone();
1951
1952   /**
1953    * @copydoc Text::SelectableControlInterface::SelectText()
1954    */
1955   void SelectText(const uint32_t start, const uint32_t end);
1956
1957   /**
1958    * @copydoc Text::SelectableControlInterface::GetSelectedText()
1959    */
1960   string GetSelectedText() const;
1961
1962   /**
1963    * @copydoc Text::EditableControlInterface::IsEditable()
1964    */
1965   virtual bool IsEditable() const;
1966
1967   /**
1968    * @copydoc Text::EditableControlInterface::SetEditable()
1969    */
1970   virtual void SetEditable(bool editable);
1971
1972   /**
1973    * @copydoc Dali::Toolkit::Internal::TextEditor::ScrollBy()
1974    */
1975   virtual void ScrollBy(Vector2 scroll);
1976
1977   /**
1978    * @brief Whether the text is scrollable.
1979    * @return Returns true if the text is scrollable.
1980    */
1981   bool IsScrollable(const Vector2& displacement);
1982
1983   /**
1984    * @copydoc Dali::Toolkit::Internal::TextEditor::GetHorizontalScrollPosition()
1985    */
1986   float GetHorizontalScrollPosition();
1987
1988   /**
1989    * @copydoc Dali::Toolkit::Internal::TextEditor::GetVerticalScrollPosition()
1990    */
1991   float GetVerticalScrollPosition();
1992
1993   /**
1994    * @brief Event received from input method context
1995    *
1996    * @param[in] inputMethodContext The input method context.
1997    * @param[in] inputMethodContextEvent The event received.
1998    * @return A data struture indicating if update is needed, cursor position and current text.
1999    */
2000   InputMethodContext::CallbackData OnInputMethodContextEvent(InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent);
2001
2002   /**
2003    * @brief Event from Clipboard notifying an Item has been selected for pasting
2004    *
2005    * @param[in] id The id of the data request.
2006    * @param[in] mimeType The mime type of data received.
2007    * @param[in] data The data received.
2008    * @note
2009    * This event is executed by receiving the Clipboard's DataReceivedSignal.
2010    */
2011   void PasteClipboardItemEvent(uint32_t id, const char* mimeType, const char* data);
2012
2013   /**
2014    * @brief Return true when text control should clear key input focus when escape key is pressed.
2015    *
2016    * @return Whether text control should clear key input focus or not when escape key is pressed.
2017    */
2018   bool ShouldClearFocusOnEscape() const;
2019
2020   /**
2021    * @brief Create an actor that renders the text background color
2022    *
2023    * @return the created actor or an empty handle if no background color needs to be rendered.
2024    */
2025   Actor CreateBackgroundActor();
2026
2027   /**
2028    * @brief Used to reset the cursor position after setting a new text.
2029    *
2030    * @param[in] cursorIndex Where to place the cursor.
2031    */
2032   void ResetCursorPosition(CharacterIndex cursorIndex);
2033
2034   /**
2035    * @brief The method acquires current position of cursor
2036    * @return unsigned value with cursor position
2037    */
2038   CharacterIndex GetCursorPosition();
2039
2040   /**
2041    * @brief Resets a provided vector with actors that marks the position of anchors in markup enabled text
2042    *
2043    * @param[out] anchorActors the vector of actor (empty collection if no anchors available).
2044    */
2045   void GetAnchorActors(std::vector<Toolkit::TextAnchor>& anchorActors);
2046
2047   /**
2048    * @brief Return an index of first anchor in the anchor vector whose boundaries includes given character offset
2049    *
2050    * @param[in] characterOffset A position in text coords.
2051    *
2052    * @return the index in anchor vector (-1 if an anchor not found)
2053    */
2054   int GetAnchorIndex(size_t characterOffset);
2055
2056 protected: // Inherit from Text::Decorator::ControllerInterface.
2057   /**
2058    * @copydoc Dali::Toolkit::Text::Decorator::ControllerInterface::GetTargetSize()
2059    */
2060   void GetTargetSize(Vector2& targetSize) override;
2061
2062   /**
2063    * @copydoc Dali::Toolkit::Text::Decorator::ControllerInterface::AddDecoration()
2064    */
2065   void AddDecoration(Actor& actor, DecorationType type, bool needsClipping) override;
2066
2067   /**
2068    * @copydoc Dali::Toolkit::Text::Decorator::ControllerInterface::DecorationEvent()
2069    */
2070   void DecorationEvent(HandleType handle, HandleState state, float x, float y) override;
2071
2072 protected: // Inherit from TextSelectionPopup::TextPopupButtonCallbackInterface.
2073   /**
2074    * @copydoc Dali::Toolkit::TextSelectionPopup::TextPopupButtonCallbackInterface::TextPopupButtonTouched()
2075    */
2076   void TextPopupButtonTouched(Dali::Toolkit::TextSelectionPopup::Buttons button) override;
2077
2078 protected: // Inherit from HiddenText.
2079   /**
2080    * @brief Invoked from HiddenText when showing time of the last character was expired
2081    */
2082   void DisplayTimeExpired() override;
2083
2084 private: // Private contructors & copy operator.
2085   /**
2086    * @brief Private constructor.
2087    */
2088   Controller()
2089   : Controller(nullptr, nullptr, nullptr, nullptr)
2090   {
2091   }
2092
2093   /**
2094    * @brief Private constructor.
2095    */
2096   Controller(ControlInterface* controlInterface)
2097   : Controller(controlInterface, nullptr, nullptr, nullptr)
2098   {
2099   }
2100
2101   /**
2102    * @brief Private constructor.
2103    */
2104   Controller(ControlInterface*           controlInterface,
2105              EditableControlInterface*   editableControlInterface,
2106              SelectableControlInterface* selectableControlInterface,
2107              AnchorControlInterface*     anchorControlInterface);
2108
2109   Controller(const Controller& handle) = delete;
2110   Controller& operator=(const Controller& handle) = delete;
2111
2112 protected: // Destructor.
2113   /**
2114    * @brief A reference counted object may only be deleted by calling Unreference().
2115    */
2116   virtual ~Controller();
2117
2118 public:
2119   struct Impl; ///< Made public for testing purposes
2120
2121 private:
2122   struct EventHandler;
2123   struct InputFontHandler;
2124   struct InputProperties;
2125   struct PlaceholderHandler;
2126   struct Relayouter;
2127   struct TextUpdater;
2128   struct SpannableHandler;
2129
2130   std::unique_ptr<Impl> mImpl{nullptr};
2131 };
2132
2133 } // namespace Dali::Toolkit::Text
2134
2135 #endif // DALI_TOOLKIT_TEXT_CONTROLLER_H