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

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