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