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) 2017 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/imf-manager.h>
  23 #include <dali/public-api/events/gesture.h>
  24
  25 // INTERNAL INCLUDES
  26 #include <dali-toolkit/devel-api/controls/text-controls/text-selection-popup-callback-interface.h>
  27 #include <dali-toolkit/internal/text/decorator/text-decorator.h>
  28 #include <dali-toolkit/internal/text/layouts/layout-engine.h>
  29 #include <dali-toolkit/internal/text/hidden-text.h>
  30 #include <dali-toolkit/internal/text/text-model-interface.h>
  31
  32 namespace Dali
  33 {
  34
  35 namespace Toolkit
  36 {
  37
  38 namespace Text
  39 {
  40
  41 class Controller;
  42 class ControlInterface;
  43 class EditableControlInterface;
  44 class View;
  45 class RenderingController;
  46
  47 typedef IntrusivePtr<Controller> ControllerPtr;
  48
  49 /**
  50  * @brief A Text Controller is used by UI Controls which display text.
  51  *
  52  * It manipulates the Logical & Visual text models on behalf of the UI Controls.
  53  * It provides a view of the text that can be used by rendering back-ends.
  54  *
  55  * For selectable/editable UI controls, the controller handles input events from the UI control
  56  * and decorations (grab handles etc) via the Decorator::ControllerInterface interface.
  57  *
  58  * The text selection popup button callbacks are as well handled via the TextSelectionPopupCallbackInterface interface.
  59  */
  60 class Controller : public RefObject, public Decorator::ControllerInterface, public TextSelectionPopupCallbackInterface, public HiddenText::Observer
  61 {
  62 public: // Enumerated types.
  63
  64   /**
  65    * @brief Text related operations to be done in the relayout process.
  66    */
  67   enum OperationsMask
  68   {
  69     NO_OPERATION       = 0x0000,
  70     CONVERT_TO_UTF32   = 0x0001,
  71     GET_SCRIPTS        = 0x0002,
  72     VALIDATE_FONTS     = 0x0004,
  73     GET_LINE_BREAKS    = 0x0008,
  74     GET_WORD_BREAKS    = 0x0010,
  75     BIDI_INFO          = 0x0020,
  76     SHAPE_TEXT         = 0x0040,
  77     GET_GLYPH_METRICS  = 0x0080,
  78     LAYOUT             = 0x0100,
  79     UPDATE_LAYOUT_SIZE = 0x0200,
  80     REORDER            = 0x0400,
  81     ALIGN              = 0x0800,
  82     COLOR              = 0x1000,
  83     UPDATE_DIRECTION   = 0x2000,
  84     ALL_OPERATIONS     = 0xFFFF
  85   };
  86
  87   /**
  88    * @brief Used to distinguish between regular key events and IMF events
  89    */
  90   enum InsertType
  91   {
  92     COMMIT,
  93     PRE_EDIT
  94   };
  95
  96   /**
  97    * @brief Used to specify whether to update the input style.
  98    */
  99   enum UpdateInputStyleType
 100   {
 101     UPDATE_INPUT_STYLE,
 102     DONT_UPDATE_INPUT_STYLE
 103   };
 104
 105   /**
 106    * @brief Used to specify what has been updated after the Relayout() method has been called.
 107    */
 108   enum UpdateTextType
 109   {
 110     NONE_UPDATED      = 0x0, ///< Nothing has been updated.
 111     MODEL_UPDATED     = 0x1, ///< The text's model has been updated.
 112     DECORATOR_UPDATED = 0x2  ///< The decoration has been updated.
 113   };
 114
 115   /**
 116    * @brief Different placeholder-text can be shown when the control is active/inactive.
 117    */
 118   enum PlaceholderType
 119   {
 120     PLACEHOLDER_TYPE_ACTIVE,
 121     PLACEHOLDER_TYPE_INACTIVE,
 122   };
 123
 124   /**
 125    * @brief Enumeration for Font Size Type.
 126    */
 127   enum FontSizeType
 128   {
 129     POINT_SIZE,   // The size of font in points.
 130     PIXEL_SIZE    // The size of font in pixels.
 131   };
 132
 133   struct NoTextTap
 134   {
 135     enum Action
 136     {
 137       NO_ACTION,           ///< Does no action if there is a tap on top of an area with no text.
 138       HIGHLIGHT,           ///< Highlights the nearest text (at the beginning or end of the text) and shows the text's selection popup.
 139       SHOW_SELECTION_POPUP ///< Shows the text's selection popup.
 140     };
 141   };
 142
 143 public: // Constructor.
 144
 145   /**
 146    * @brief Create a new instance of a Controller.
 147    *
 148    * @return A pointer to a new Controller.
 149    */
 150   static ControllerPtr New();
 151
 152   /**
 153    * @brief Create a new instance of a Controller.
 154    *
 155    * @param[in] controlInterface The control's interface.
 156    *
 157    * @return A pointer to a new Controller.
 158    */
 159   static ControllerPtr New( ControlInterface* controlInterface );
 160
 161   /**
 162    * @brief Create a new instance of a Controller.
 163    *
 164    * @param[in] controlInterface The control's interface.
 165    * @param[in] editableControlInterface The editable control's interface.
 166    *
 167    * @return A pointer to a new Controller.
 168    */
 169   static ControllerPtr New( ControlInterface* controlInterface,
 170                             EditableControlInterface* editableControlInterface );
 171
 172 public: // Configure the text controller.
 173
 174   /**
 175    * @brief Called to enable text input.
 176    *
 177    * @note Selectable or editable controls should call this once after Controller::New().
 178    * @param[in] decorator Used to create cursor, selection handle decorations etc.
 179    */
 180   void EnableTextInput( DecoratorPtr decorator );
 181
 182   /**
 183    * @brief Used to switch between bitmap & vector based glyphs
 184    *
 185    * @param[in] glyphType The type of glyph; note that metrics for bitmap & vector based glyphs are different.
 186    */
 187   void SetGlyphType( TextAbstraction::GlyphType glyphType );
 188
 189   /**
 190    * @brief Enables/disables the mark-up processor.
 191    *
 192    * By default is disabled.
 193    *
 194    * @param[in] enable Whether to enable the mark-up processor.
 195    */
 196   void SetMarkupProcessorEnabled( bool enable );
 197
 198   /**
 199    * @brief Retrieves whether the mark-up processor is enabled.
 200    *
 201    * By default is disabled.
 202    *
 203    * @return @e true if the mark-up processor is enabled, otherwise returns @e false.
 204    */
 205   bool IsMarkupProcessorEnabled() const;
 206
 207   /**
 208    * @brief Enables/disables the auto text scrolling
 209    *
 210    * By default is disabled.
 211    *
 212    * @param[in] enable Whether to enable the auto scrolling
 213    */
 214   void SetAutoScrollEnabled( bool enable );
 215
 216   /**
 217    * @brief Retrieves whether auto text scrolling is enabled.
 218    *
 219    * By default is disabled.
 220    *
 221    * @return @e true if auto scrolling is enabled, otherwise returns @e false.
 222    */
 223   bool IsAutoScrollEnabled() const;
 224
 225   /**
 226    * @brief Get direction of the text from the first line of text,
 227    * @return bool rtl (right to left) is true
 228    */
 229   CharacterDirection GetAutoScrollDirection() const;
 230
 231   /**
 232    * @brief Get the alignment offset of the first line of text.
 233    *
 234    * @return The alignment offset.
 235    */
 236   float GetAutoScrollLineAlignment() const;
 237
 238   /**
 239    * @brief Enables the horizontal scrolling.
 240    *
 241    * @param[in] enable Whether to enable the horizontal scrolling.
 242    */
 243   void SetHorizontalScrollEnabled( bool enable );
 244
 245   /**
 246    * @brief Retrieves whether the horizontal scrolling is enabled.
 247    *
 248    * @return @e true if the horizontal scrolling is enabled, otherwise it returns @e false.
 249    */
 250   bool IsHorizontalScrollEnabled() const;
 251
 252   /**
 253    * @brief Enables the vertical scrolling.
 254    *
 255    * @param[in] enable Whether to enable the vertical scrolling.
 256    */
 257   void SetVerticalScrollEnabled( bool enable );
 258
 259   /**
 260    * @brief Retrieves whether the verticall scrolling is enabled.
 261    *
 262    * @return @e true if the vertical scrolling is enabled, otherwise it returns @e false.
 263    */
 264   bool IsVerticalScrollEnabled() const;
 265
 266   /**
 267    * @brief Enables the smooth handle panning.
 268    *
 269    * @param[in] enable Whether to enable the smooth handle panning.
 270    */
 271   void SetSmoothHandlePanEnabled( bool enable );
 272
 273   /**
 274    * @brief Retrieves whether the smooth handle panning is enabled.
 275    *
 276    * @return @e true if the smooth handle panning is enabled.
 277    */
 278   bool IsSmoothHandlePanEnabled() const;
 279
 280   /**
 281    * @brief Sets the maximum number of characters that can be inserted into the TextModel
 282    *
 283    * @param[in] maxCharacters maximum number of characters to be accepted
 284    */
 285   void SetMaximumNumberOfCharacters( Length maxCharacters );
 286
 287   /**
 288    * @brief Sets the maximum number of characters that can be inserted into the TextModel
 289    *
 290    * @param[in] maxCharacters maximum number of characters to be accepted
 291    */
 292   int GetMaximumNumberOfCharacters();
 293
 294   /**
 295    * @brief Called to enable/disable cursor blink.
 296    *
 297    * @note Only editable controls should calls this.
 298    * @param[in] enabled Whether the cursor should blink or not.
 299    */
 300   void SetEnableCursorBlink( bool enable );
 301
 302   /**
 303    * @brief Query whether cursor blink is enabled.
 304    *
 305    * @return Whether the cursor should blink or not.
 306    */
 307   bool GetEnableCursorBlink() const;
 308
 309   /**
 310    * @brief Whether to enable the multi-line layout.
 311    *
 312    * @param[in] enable \e true enables the multi-line (by default)
 313    */
 314   void SetMultiLineEnabled( bool enable );
 315
 316   /**
 317    * @return Whether the multi-line layout is enabled.
 318    */
 319   bool IsMultiLineEnabled() const;
 320
 321   /**
 322    * @brief Sets the text's horizontal alignment.
 323    *
 324    * @param[in] alignment The horizontal alignment.
 325    */
 326   void SetHorizontalAlignment( Layout::HorizontalAlignment alignment );
 327
 328   /**
 329    * @copydoc ModelInterface::GetHorizontalAlignment()
 330    */
 331   Layout::HorizontalAlignment GetHorizontalAlignment() const;
 332
 333   /**
 334    * @brief Sets the text's vertical alignment.
 335    *
 336    * @param[in] alignment The vertical alignment.
 337    */
 338   void SetVerticalAlignment( Layout::VerticalAlignment alignment );
 339
 340   /**
 341    * @copydoc ModelInterface::GetVerticalAlignment()
 342    */
 343   Layout::VerticalAlignment GetVerticalAlignment() const;
 344
 345   /**
 346    * @brief Enable or disable the text elide.
 347    *
 348    * @param[in] enabled Whether to enable the text elide.
 349    */
 350   void SetTextElideEnabled( bool enabled );
 351
 352   /**
 353    * @copydoc ModelInterface::IsTextElideEnabled()
 354    */
 355   bool IsTextElideEnabled() const;
 356
 357   /**
 358    * @brief Sets input type to password
 359    *
 360    * @note The string is displayed hidden character
 361    *
 362    * @param[in] passwordInput True if password input is enabled.
 363    */
 364   void SetInputModePassword( bool passwordInput );
 365
 366   /**
 367    * @brief Returns whether the input mode type is set as password.
 368    *
 369    * @return True if input mode type is password
 370    */
 371   bool IsInputModePassword();
 372
 373   /**
 374    * @brief Sets the action when there is a double tap event on top of a text area with no text.
 375    *
 376    * @param[in] action The action to do.
 377    */
 378   void SetNoTextDoubleTapAction( NoTextTap::Action action );
 379
 380   /**
 381    * @brief Retrieves the action when there is a double tap event on top of a text area with no text.
 382    *
 383    * @return The action to do.
 384    */
 385   NoTextTap::Action GetNoTextDoubleTapAction() const;
 386
 387   /**
 388    * @briefSets the action when there is a long press event on top of a text area with no text.
 389    *
 390    * @param[in] action The action to do.
 391    */
 392   void SetNoTextLongPressAction( NoTextTap::Action action );
 393
 394   /**
 395    * @brief Retrieves the action when there is a long press event on top of a text area with no text.
 396    *
 397    * @return The action to do.
 398    */
 399   NoTextTap::Action GetNoTextLongPressAction() const;
 400
 401 public: // Update.
 402
 403   /**
 404    * @brief Replaces any text previously set.
 405    *
 406    * @note This will be converted into UTF-32 when stored in the text model.
 407    * @param[in] text A string of UTF-8 characters.
 408    */
 409   void SetText( const std::string& text );
 410
 411   /**
 412    * @brief Retrieve any text previously set.
 413    *
 414    * @param[out] text A string of UTF-8 characters.
 415    */
 416   void GetText( std::string& text ) const;
 417
 418   /**
 419    * @brief Replaces any placeholder text previously set.
 420    *
 421    * @param[in] type Different placeholder-text can be shown when the control is active/inactive.
 422    * @param[in] text A string of UTF-8 characters.
 423    */
 424   void SetPlaceholderText( PlaceholderType type, const std::string& text );
 425
 426   /**
 427    * @brief Retrieve any placeholder text previously set.
 428    *
 429    * @param[in] type Different placeholder-text can be shown when the control is active/inactive.
 430    * @param[out] A string of UTF-8 characters.
 431    */
 432   void GetPlaceholderText( PlaceholderType type, std::string& text ) const;
 433
 434   /**
 435    * @ brief Update the text after a font change
 436    * @param[in] newDefaultFont The new font to change to
 437    */
 438   void UpdateAfterFontChange( const std::string& newDefaultFont );
 439
 440 public: // Default style & Input style
 441
 442   /**
 443    * @brief Set the default font family.
 444    *
 445    * @param[in] defaultFontFamily The default font family.
 446    */
 447   void SetDefaultFontFamily( const std::string& defaultFontFamily );
 448
 449   /**
 450    * @brief Retrieve the default font family.
 451    *
 452    * @return The default font family.
 453    */
 454   const std::string& GetDefaultFontFamily() const;
 455
 456   /**
 457    * @brief Sets the default font weight.
 458    *
 459    * @param[in] weight The font weight.
 460    */
 461   void SetDefaultFontWeight( FontWeight weight );
 462
 463   /**
 464    * @brief Whether the font's weight has been defined.
 465    */
 466   bool IsDefaultFontWeightDefined() const;
 467
 468   /**
 469    * @brief Retrieves the default font weight.
 470    *
 471    * @return The default font weight.
 472    */
 473   FontWeight GetDefaultFontWeight() const;
 474
 475   /**
 476    * @brief Sets the default font width.
 477    *
 478    * @param[in] width The font width.
 479    */
 480   void SetDefaultFontWidth( FontWidth width );
 481
 482   /**
 483    * @brief Whether the font's width has been defined.
 484    */
 485   bool IsDefaultFontWidthDefined() const;
 486
 487   /**
 488    * @brief Retrieves the default font width.
 489    *
 490    * @return The default font width.
 491    */
 492   FontWidth GetDefaultFontWidth() const;
 493
 494   /**
 495    * @brief Sets the default font slant.
 496    *
 497    * @param[in] slant The font slant.
 498    */
 499   void SetDefaultFontSlant( FontSlant slant );
 500
 501   /**
 502    * @brief Whether the font's slant has been defined.
 503    */
 504   bool IsDefaultFontSlantDefined() const;
 505
 506   /**
 507    * @brief Retrieves the default font slant.
 508    *
 509    * @return The default font slant.
 510    */
 511   FontSlant GetDefaultFontSlant() const;
 512
 513   /**
 514    * @brief Set the default font size.
 515    *
 516    * @param[in] size The default font size.
 517    * @param[in] type The font size type is point size or pixel size
 518    */
 519   void SetDefaultFontSize( float fontSize, FontSizeType type );
 520
 521   /**
 522    * @brief Retrieve the default point size.
 523    *
 524    * @param[in] type The font size type
 525    * @return The default point size.
 526    */
 527   float GetDefaultFontSize( FontSizeType type ) const;
 528
 529   /**
 530    * @brief Sets the text's default color.
 531    *
 532    * @param color The default color.
 533    */
 534   void SetDefaultColor( const Vector4& color );
 535
 536   /**
 537    * @brief Retrieves the text's default color.
 538    *
 539    * @return The default color.
 540    */
 541   const Vector4& GetDefaultColor() const;
 542
 543   /**
 544    * @brief Set the text color
 545    *
 546    * @param textColor The text color
 547    */
 548   void SetPlaceholderTextColor( const Vector4& textColor );
 549
 550   /**
 551    * @brief Retrieve the text color
 552    *
 553    * @return The text color
 554    */
 555   const Vector4& GetPlaceholderTextColor() const;
 556
 557   /**
 558    * @brief Set the shadow offset.
 559    *
 560    * @param[in] shadowOffset The shadow offset, 0,0 indicates no shadow.
 561    */
 562   void SetShadowOffset( const Vector2& shadowOffset );
 563
 564   /**
 565    * @brief Retrieve the shadow offset.
 566    *
 567    * @return The shadow offset.
 568    */
 569   const Vector2& GetShadowOffset() const;
 570
 571   /**
 572    * @brief Set the shadow color.
 573    *
 574    * @param[in] shadowColor The shadow color.
 575    */
 576   void SetShadowColor( const Vector4& shadowColor );
 577
 578   /**
 579    * @brief Retrieve the shadow color.
 580    *
 581    * @return The shadow color.
 582    */
 583   const Vector4& GetShadowColor() const;
 584
 585   /**
 586    * @brief Set the underline color.
 587    *
 588    * @param[in] color color of underline.
 589    */
 590   void SetUnderlineColor( const Vector4& color );
 591
 592   /**
 593    * @brief Retrieve the underline color.
 594    *
 595    * @return The underline color.
 596    */
 597   const Vector4& GetUnderlineColor() const;
 598
 599   /**
 600    * @brief Set the underline enabled flag.
 601    *
 602    * @param[in] enabled The underline enabled flag.
 603    */
 604   void SetUnderlineEnabled( bool enabled );
 605
 606   /**
 607    * @brief Returns whether the text is underlined or not.
 608    *
 609    * @return The underline state.
 610    */
 611   bool IsUnderlineEnabled() const;
 612
 613   /**
 614    * @brief Set the override used for underline height, 0 indicates height will be supplied by font metrics
 615    *
 616    * @param[in] height The height in pixels of the underline
 617    */
 618   void SetUnderlineHeight( float height );
 619
 620   /**
 621    * @brief Retrieves the override height of an underline, 0 indicates height is supplied by font metrics
 622    *
 623    * @return The height of the underline, or 0 if height is not overrided.
 624    */
 625   float GetUnderlineHeight() const;
 626
 627   /**
 628    * @brief Sets the emboss's properties string.
 629    *
 630    * @note The string is stored to be recovered.
 631    *
 632    * @param[in] embossProperties The emboss's properties string.
 633    */
 634   void SetDefaultEmbossProperties( const std::string& embossProperties );
 635
 636   /**
 637    * @brief Retrieves the emboss's properties string.
 638    *
 639    * @return The emboss's properties string.
 640    */
 641   const std::string& GetDefaultEmbossProperties() const;
 642
 643   /**
 644    * @brief Sets the outline's properties string.
 645    *
 646    * @note The string is stored to be recovered.
 647    *
 648    * @param[in] outlineProperties The outline's properties string.
 649    */
 650   void SetDefaultOutlineProperties( const std::string& outlineProperties );
 651
 652   /**
 653    * @brief Retrieves the outline's properties string.
 654    *
 655    * @return The outline's properties string.
 656    */
 657   const std::string& GetDefaultOutlineProperties() const;
 658
 659   /**
 660    * @brief Sets the default line spacing.
 661    *
 662    * @param[in] lineSpacing The line spacing.
 663    */
 664   void SetDefaultLineSpacing( float lineSpacing );
 665
 666   /**
 667    * @brief Retrieves the default line spacing.
 668    *
 669    * @return The line spacing.
 670    */
 671   float GetDefaultLineSpacing() const;
 672
 673   /**
 674    * @brief Sets the input text's color.
 675    *
 676    * @param[in] color The input text's color.
 677    */
 678   void SetInputColor( const Vector4& color );
 679
 680   /**
 681    * @brief Retrieves the input text's color.
 682    *
 683    * @return The input text's color.
 684    */
 685   const Vector4& GetInputColor() const;
 686
 687   /**
 688    * @brief Sets the input text's font family name.
 689    *
 690    * @param[in] fontFamily The text's font family name.
 691    */
 692   void SetInputFontFamily( const std::string& fontFamily );
 693
 694   /**
 695    * @brief Retrieves the input text's font family name.
 696    *
 697    * @return The input text's font family name.
 698    */
 699   const std::string& GetInputFontFamily() const;
 700
 701   /**
 702    * @brief Sets the input font's weight.
 703    *
 704    * @param[in] weight The input font's weight.
 705    */
 706   void SetInputFontWeight( FontWeight weight );
 707
 708   /**
 709    * @return Whether the font's weight has been defined.
 710    */
 711   bool IsInputFontWeightDefined() const;
 712
 713   /**
 714    * @brief Retrieves the input font's weight.
 715    *
 716    * @return The input font's weight.
 717    */
 718   FontWeight GetInputFontWeight() const;
 719
 720   /**
 721    * @brief Sets the input font's width.
 722    *
 723    * @param[in] width The input font's width.
 724    */
 725   void SetInputFontWidth( FontWidth width );
 726
 727   /**
 728    * @return Whether the font's width has been defined.
 729    */
 730   bool IsInputFontWidthDefined() const;
 731
 732   /**
 733    * @brief Retrieves the input font's width.
 734    *
 735    * @return The input font's width.
 736    */
 737   FontWidth GetInputFontWidth() const;
 738
 739   /**
 740    * @brief Sets the input font's slant.
 741    *
 742    * @param[in] slant The input font's slant.
 743    */
 744   void SetInputFontSlant( FontSlant slant );
 745
 746   /**
 747    * @return Whether the font's slant has been defined.
 748    */
 749   bool IsInputFontSlantDefined() const;
 750
 751   /**
 752    * @brief Retrieves the input font's slant.
 753    *
 754    * @return The input font's slant.
 755    */
 756   FontSlant GetInputFontSlant() const;
 757
 758   /**
 759    * @brief Sets the input font's point size.
 760    *
 761    * @param[in] size The input font's point size.
 762    */
 763   void SetInputFontPointSize( float size );
 764
 765   /**
 766    * @brief Retrieves the input font's point size.
 767    *
 768    * @return The input font's point size.
 769    */
 770   float GetInputFontPointSize() const;
 771
 772   /**
 773    * @brief Sets the input line spacing.
 774    *
 775    * @param[in] lineSpacing The line spacing.
 776    */
 777   void SetInputLineSpacing( float lineSpacing );
 778
 779   /**
 780    * @brief Retrieves the input line spacing.
 781    *
 782    * @return The line spacing.
 783    */
 784   float GetInputLineSpacing() const;
 785
 786   /**
 787    * @brief Sets the input shadow's properties string.
 788    *
 789    * @note The string is stored to be recovered.
 790    *
 791    * @param[in] shadowProperties The shadow's properties string.
 792    */
 793   void SetInputShadowProperties( const std::string& shadowProperties );
 794
 795   /**
 796    * @brief Retrieves the input shadow's properties string.
 797    *
 798    * @return The shadow's properties string.
 799    */
 800   const std::string& GetInputShadowProperties() const;
 801
 802   /**
 803    * @brief Sets the input underline's properties string.
 804    *
 805    * @note The string is stored to be recovered.
 806    *
 807    * @param[in] underlineProperties The underline's properties string.
 808    */
 809   void SetInputUnderlineProperties( const std::string& underlineProperties );
 810
 811   /**
 812    * @brief Retrieves the input underline's properties string.
 813    *
 814    * @return The underline's properties string.
 815    */
 816   const std::string& GetInputUnderlineProperties() const;
 817
 818   /**
 819    * @brief Sets the input emboss's properties string.
 820    *
 821    * @note The string is stored to be recovered.
 822    *
 823    * @param[in] embossProperties The emboss's properties string.
 824    */
 825   void SetInputEmbossProperties( const std::string& embossProperties );
 826
 827   /**
 828    * @brief Retrieves the input emboss's properties string.
 829    *
 830    * @return The emboss's properties string.
 831    */
 832   const std::string& GetInputEmbossProperties() const;
 833
 834   /**
 835    * @brief Sets input the outline's properties string.
 836    *
 837    * @note The string is stored to be recovered.
 838    *
 839    * @param[in] outlineProperties The outline's properties string.
 840    */
 841   void SetInputOutlineProperties( const std::string& outlineProperties );
 842
 843   /**
 844    * @brief Retrieves the input outline's properties string.
 845    *
 846    * @return The outline's properties string.
 847    */
 848   const std::string& GetInputOutlineProperties() const;
 849
 850 public: // Queries & retrieves.
 851
 852   /**
 853    * @brief Return the layout engine.
 854    *
 855    * @return A reference to the layout engine.
 856    */
 857   Layout::Engine& GetLayoutEngine();
 858
 859   /**
 860    * @brief Return a view of the text.
 861    *
 862    * @return A reference to the view.
 863    */
 864   View& GetView();
 865
 866   /**
 867    * @copydoc Control::GetNaturalSize()
 868    */
 869   Vector3 GetNaturalSize();
 870
 871   /**
 872    * @copydoc Control::GetHeightForWidth()
 873    */
 874   float GetHeightForWidth( float width );
 875
 876   /**
 877    * @brief Retrieves the text's model.
 878    *
 879    * @return A pointer to the text's model.
 880    */
 881   const ModelInterface* const GetTextModel() const;
 882
 883   /**
 884    * @brief Used to get scrolled distance by user input
 885    *
 886    * @return Distance from last scroll offset to new scroll offset
 887    */
 888   float GetScrollAmountByUserInput();
 889
 890   /**
 891    * @brief Get latest scroll amount, control size and layout size
 892    *
 893    * This method is used to get information of control's scroll
 894    * @param[out] scrollPosition The current scrolled position
 895    * @param[out] controlHeight The size of a UI control
 896    * @param[out] layoutHeight The size of a bounding box to layout text within.
 897    *
 898    * @return Whether the text scroll position is changed or not after last update.
 899    */
 900   bool GetTextScrollInfo( float& scrollPosition, float& controlHeight, float& layoutHeight );
 901
 902   /**
 903    * @brief Used to set the hidden input option
 904    */
 905   void SetHiddenInputOption( const Property::Map& options );
 906
 907   /**
 908    * @brief Used to get the hidden input option
 909    */
 910   void GetHiddenInputOption( Property::Map& options );
 911
 912 public: // Relayout.
 913
 914   /**
 915    * @brief Triggers a relayout which updates View (if necessary).
 916    *
 917    * @note UI Controls are expected to minimize calls to this method e.g. call once after size negotiation.
 918    * @param[in] size A the size of a bounding box to layout text within.
 919    *
 920    * @return Whether the text model or decorations were updated.
 921    */
 922   UpdateTextType Relayout( const Size& size );
 923
 924   /**
 925    * @brief Request a relayout using the ControlInterface.
 926    */
 927   void RequestRelayout();
 928
 929 public: // Input style change signals.
 930
 931   /**
 932    * @return Whether the queue of input style changed signals is empty.
 933    */
 934   bool IsInputStyleChangedSignalsQueueEmpty();
 935
 936   /**
 937    * @brief Process all pending input style changed signals.
 938    *
 939    * Calls the Text::ControlInterface::InputStyleChanged() method which is overriden by the
 940    * text controls. Text controls may send signals to state the input style has changed.
 941    */
 942   void ProcessInputStyleChangedSignals();
 943
 944 public: // Text-input Event Queuing.
 945
 946   /**
 947    * @brief Called by editable UI controls when keyboard focus is gained.
 948    */
 949   void KeyboardFocusGainEvent();
 950
 951   /**
 952    * @brief Called by editable UI controls when focus is lost.
 953    */
 954   void KeyboardFocusLostEvent();
 955
 956   /**
 957    * @brief Called by editable UI controls when key events are received.
 958    *
 959    * @param[in] event The key event.
 960    * @param[in] type Used to distinguish between regular key events and IMF events.
 961    */
 962   bool KeyEvent( const Dali::KeyEvent& event );
 963
 964   /**
 965    * @brief Called by editable UI controls when a tap gesture occurs.
 966    * @param[in] tapCount The number of taps.
 967    * @param[in] x The x position relative to the top-left of the parent control.
 968    * @param[in] y The y position relative to the top-left of the parent control.
 969    */
 970   void TapEvent( unsigned int tapCount, float x, float y );
 971
 972   /**
 973    * @brief Called by editable UI controls when a pan gesture occurs.
 974    *
 975    * @param[in] state The state of the gesture.
 976    * @param[in] displacement This distance panned since the last pan gesture.
 977    */
 978   void PanEvent( Gesture::State state, const Vector2& displacement );
 979
 980   /**
 981    * @brief Called by editable UI controls when a long press gesture occurs.
 982    *
 983    * @param[in] state The state of the gesture.
 984    * @param[in] x The x position relative to the top-left of the parent control.
 985    * @param[in] y The y position relative to the top-left of the parent control.
 986    */
 987   void LongPressEvent( Gesture::State state, float x, float y );
 988
 989   /**
 990    * @brief Event received from IMF manager
 991    *
 992    * @param[in] imfManager The IMF manager.
 993    * @param[in] imfEvent The event received.
 994    * @return A data struture indicating if update is needed, cursor position and current text.
 995    */
 996   ImfManager::ImfCallbackData OnImfEvent( ImfManager& imfManager, const ImfManager::ImfEventData& imfEvent );
 997
 998   /**
 999    * @brief Event from Clipboard notifying an Item has been selected for pasting
1000    */
1001   void PasteClipboardItemEvent();
1002
1003 protected: // Inherit from Text::Decorator::ControllerInterface.
1004
1005   /**
1006    * @copydoc Dali::Toolkit::Text::Decorator::ControllerInterface::GetTargetSize()
1007    */
1008   virtual void GetTargetSize( Vector2& targetSize );
1009
1010   /**
1011    * @copydoc Dali::Toolkit::Text::Decorator::ControllerInterface::AddDecoration()
1012    */
1013   virtual void AddDecoration( Actor& actor, bool needsClipping );
1014
1015   /**
1016    * @copydoc Dali::Toolkit::Text::Decorator::ControllerInterface::DecorationEvent()
1017    */
1018   virtual void DecorationEvent( HandleType handle, HandleState state, float x, float y );
1019
1020 protected: // Inherit from TextSelectionPopup::TextPopupButtonCallbackInterface.
1021
1022   /**
1023    * @copydoc Dali::Toolkit::TextSelectionPopup::TextPopupButtonCallbackInterface::TextPopupButtonTouched()
1024    */
1025   virtual void TextPopupButtonTouched( Dali::Toolkit::TextSelectionPopup::Buttons button );
1026
1027 protected: // Inherit from HiddenText.
1028
1029   /**
1030    * @brief Invoked from HiddenText when showing time of the last character was expired
1031    */
1032   virtual void DisplayTimeExpired();
1033
1034 private: // Update.
1035
1036   /**
1037    * @brief Called by editable UI controls when key events are received.
1038    *
1039    * @param[in] text The text to insert.
1040    * @param[in] type Used to distinguish between regular key events and IMF events.
1041    */
1042   void InsertText( const std::string& text, InsertType type );
1043
1044   /**
1045    * @brief Paste given string into Text model
1046    * @param[in] stringToPaste this string will be inserted into the text model
1047    */
1048   void PasteText( const std::string& stringToPaste );
1049
1050   /**
1051    * @brief Remove a given number of characters
1052    *
1053    * When predictve text is used the pre-edit text is removed and inserted again with the new characters.
1054    * The UpdateInputStyleType @type parameter if set to DONT_UPDATE_INPUT_STYLE avoids to update the input
1055    * style when pre-edit text is removed.
1056    *
1057    * @param[in] cursorOffset Start position from the current cursor position to start deleting characters.
1058    * @param[in] numberOfCharacters The number of characters to delete from the cursorOffset.
1059    * @param[in] type Whether to update the input style.
1060    * @return True if the remove was successful.
1061    */
1062   bool RemoveText( int cursorOffset,
1063                    int numberOfCharacters,
1064                    UpdateInputStyleType type  );
1065
1066   /**
1067    * @brief Checks if text is selected and if so removes it.
1068    * @return true if text was removed
1069    */
1070   bool RemoveSelectedText();
1071
1072 private: // Relayout.
1073
1074   /**
1075    * @brief Lays-out the text.
1076    *
1077    * GetNaturalSize(), GetHeightForWidth() and Relayout() calls this method.
1078    *
1079    * @param[in] size A the size of a bounding box to layout text within.
1080    * @param[in] operations The layout operations which need to be done.
1081    * @param[out] layoutSize The size of the laid-out text.
1082    */
1083   bool DoRelayout( const Size& size,
1084                    OperationsMask operations,
1085                    Size& layoutSize );
1086
1087   /**
1088    * @brief Calulates the vertical offset to align the text inside the bounding box.
1089    *
1090    * @param[in] size The size of the bounding box.
1091    */
1092   void CalculateVerticalOffset( const Size& size );
1093
1094 private: // Events.
1095
1096   /**
1097    * @brief Process queued events which modify the model.
1098    */
1099   void ProcessModifyEvents();
1100
1101   /**
1102    * @brief Used to process an event queued from SetText()
1103    */
1104   void TextReplacedEvent();
1105
1106   /**
1107    * @brief Used to process an event queued from key events etc.
1108    */
1109   void TextInsertedEvent();
1110
1111   /**
1112    * @brief Used to process an event queued from backspace key etc.
1113    */
1114   void TextDeletedEvent();
1115
1116   /**
1117    * @brief Creates a selection event.
1118    *
1119    * It could be called from the TapEvent (double tap) or when the text selection popup's sellect all button is pressed.
1120    *
1121    * @param[in] x The x position relative to the top-left of the parent control.
1122    * @param[in] y The y position relative to the top-left of the parent control.
1123    * @param[in] selectAll Whether the whole text is selected.
1124    */
1125   void SelectEvent( float x, float y, bool selectAll );
1126
1127   /**
1128    * @brief Helper to KeyEvent() to handle the backspace case.
1129    *
1130    * @return True if a character was deleted.
1131    */
1132   bool BackspaceKeyEvent();
1133
1134 private: // Helpers.
1135
1136   /**
1137    * @brief Used to remove the text included the placeholder text.
1138    */
1139   void ResetText();
1140
1141   /**
1142    * @brief Helper to show the place holder text..
1143    */
1144   void ShowPlaceholderText();
1145
1146   /**
1147    * @brief Helper to clear font-specific data (only).
1148    */
1149   void ClearFontData();
1150
1151   /**
1152    * @brief Helper to clear text's style data.
1153    */
1154   void ClearStyleData();
1155
1156   /**
1157    * @brief Used to reset the cursor position after setting a new text.
1158    *
1159    * @param[in] cursorIndex Where to place the cursor.
1160    */
1161   void ResetCursorPosition( CharacterIndex cursorIndex );
1162
1163   /**
1164    * @brief Used to reset the scroll position after setting a new text.
1165    */
1166   void ResetScrollPosition();
1167
1168 private: // Private contructors & copy operator.
1169
1170   /**
1171    * @brief Private constructor.
1172    */
1173   Controller();
1174
1175   /**
1176    * @brief Private constructor.
1177    */
1178   Controller( ControlInterface* controlInterface );
1179
1180   /**
1181    * @brief Private constructor.
1182    */
1183   Controller( ControlInterface* controlInterface,
1184               EditableControlInterface* editableControlInterface );
1185
1186   // Undefined
1187   Controller( const Controller& handle );
1188
1189   // Undefined
1190   Controller& operator=( const Controller& handle );
1191
1192 protected: // Destructor.
1193
1194   /**
1195    * @brief A reference counted object may only be deleted by calling Unreference().
1196    */
1197   virtual ~Controller();
1198
1199 private:
1200
1201   struct Impl;
1202   Impl* mImpl;
1203 };
1204
1205 } // namespace Text
1206
1207 } // namespace Toolkit
1208
1209 } // namespace Dali
1210
1211 #endif // DALI_TOOLKIT_TEXT_CONTROLLER_H