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   /**
 402    * @brief Query if Underline settings were provided by string or map
 403    * @return bool true if set by string
 404    */
 405   bool IsUnderlineSetByString();
 406
 407   /**
 408    * Set method underline setting were set by
 409    * @param[in] bool, true if set by string
 410    */
 411   void UnderlineSetByString( bool setByString );
 412
 413   /**
 414    * @brief Query if shadow settings were provided by string or map
 415    * @return bool true if set by string
 416    */
 417   bool IsShadowSetByString();
 418
 419   /**
 420    * Set method shadow setting were set by
 421    * @param[in] bool, true if set by string
 422    */
 423   void ShadowSetByString( bool setByString );
 424
 425 public: // Update.
 426
 427   /**
 428    * @brief Replaces any text previously set.
 429    *
 430    * @note This will be converted into UTF-32 when stored in the text model.
 431    * @param[in] text A string of UTF-8 characters.
 432    */
 433   void SetText( const std::string& text );
 434
 435   /**
 436    * @brief Retrieve any text previously set.
 437    *
 438    * @param[out] text A string of UTF-8 characters.
 439    */
 440   void GetText( std::string& text ) const;
 441
 442   /**
 443    * @brief Replaces any placeholder text previously set.
 444    *
 445    * @param[in] type Different placeholder-text can be shown when the control is active/inactive.
 446    * @param[in] text A string of UTF-8 characters.
 447    */
 448   void SetPlaceholderText( PlaceholderType type, const std::string& text );
 449
 450   /**
 451    * @brief Retrieve any placeholder text previously set.
 452    *
 453    * @param[in] type Different placeholder-text can be shown when the control is active/inactive.
 454    * @param[out] A string of UTF-8 characters.
 455    */
 456   void GetPlaceholderText( PlaceholderType type, std::string& text ) const;
 457
 458   /**
 459    * @ brief Update the text after a font change
 460    * @param[in] newDefaultFont The new font to change to
 461    */
 462   void UpdateAfterFontChange( const std::string& newDefaultFont );
 463
 464 public: // Default style & Input style
 465
 466   /**
 467    * @brief Set the default font family.
 468    *
 469    * @param[in] defaultFontFamily The default font family.
 470    */
 471   void SetDefaultFontFamily( const std::string& defaultFontFamily );
 472
 473   /**
 474    * @brief Retrieve the default font family.
 475    *
 476    * @return The default font family.
 477    */
 478   const std::string& GetDefaultFontFamily() const;
 479
 480   /**
 481    * @brief Sets the default font weight.
 482    *
 483    * @param[in] weight The font weight.
 484    */
 485   void SetDefaultFontWeight( FontWeight weight );
 486
 487   /**
 488    * @brief Whether the font's weight has been defined.
 489    */
 490   bool IsDefaultFontWeightDefined() const;
 491
 492   /**
 493    * @brief Retrieves the default font weight.
 494    *
 495    * @return The default font weight.
 496    */
 497   FontWeight GetDefaultFontWeight() const;
 498
 499   /**
 500    * @brief Sets the default font width.
 501    *
 502    * @param[in] width The font width.
 503    */
 504   void SetDefaultFontWidth( FontWidth width );
 505
 506   /**
 507    * @brief Whether the font's width has been defined.
 508    */
 509   bool IsDefaultFontWidthDefined() const;
 510
 511   /**
 512    * @brief Retrieves the default font width.
 513    *
 514    * @return The default font width.
 515    */
 516   FontWidth GetDefaultFontWidth() const;
 517
 518   /**
 519    * @brief Sets the default font slant.
 520    *
 521    * @param[in] slant The font slant.
 522    */
 523   void SetDefaultFontSlant( FontSlant slant );
 524
 525   /**
 526    * @brief Whether the font's slant has been defined.
 527    */
 528   bool IsDefaultFontSlantDefined() const;
 529
 530   /**
 531    * @brief Retrieves the default font slant.
 532    *
 533    * @return The default font slant.
 534    */
 535   FontSlant GetDefaultFontSlant() const;
 536
 537   /**
 538    * @brief Set the default font size.
 539    *
 540    * @param[in] size The default font size.
 541    * @param[in] type The font size type is point size or pixel size
 542    */
 543   void SetDefaultFontSize( float fontSize, FontSizeType type );
 544
 545   /**
 546    * @brief Retrieve the default point size.
 547    *
 548    * @param[in] type The font size type
 549    * @return The default point size.
 550    */
 551   float GetDefaultFontSize( FontSizeType type ) const;
 552
 553   /**
 554    * @brief Sets the text's default color.
 555    *
 556    * @param color The default color.
 557    */
 558   void SetDefaultColor( const Vector4& color );
 559
 560   /**
 561    * @brief Retrieves the text's default color.
 562    *
 563    * @return The default color.
 564    */
 565   const Vector4& GetDefaultColor() const;
 566
 567   /**
 568    * @brief Set the text color
 569    *
 570    * @param textColor The text color
 571    */
 572   void SetPlaceholderTextColor( const Vector4& textColor );
 573
 574   /**
 575    * @brief Retrieve the text color
 576    *
 577    * @return The text color
 578    */
 579   const Vector4& GetPlaceholderTextColor() const;
 580
 581   /**
 582    * @brief Set the shadow offset.
 583    *
 584    * @param[in] shadowOffset The shadow offset, 0,0 indicates no shadow.
 585    */
 586   void SetShadowOffset( const Vector2& shadowOffset );
 587
 588   /**
 589    * @brief Retrieve the shadow offset.
 590    *
 591    * @return The shadow offset.
 592    */
 593   const Vector2& GetShadowOffset() const;
 594
 595   /**
 596    * @brief Set the shadow color.
 597    *
 598    * @param[in] shadowColor The shadow color.
 599    */
 600   void SetShadowColor( const Vector4& shadowColor );
 601
 602   /**
 603    * @brief Retrieve the shadow color.
 604    *
 605    * @return The shadow color.
 606    */
 607   const Vector4& GetShadowColor() const;
 608
 609   /**
 610    * @brief Set the underline color.
 611    *
 612    * @param[in] color color of underline.
 613    */
 614   void SetUnderlineColor( const Vector4& color );
 615
 616   /**
 617    * @brief Retrieve the underline color.
 618    *
 619    * @return The underline color.
 620    */
 621   const Vector4& GetUnderlineColor() const;
 622
 623   /**
 624    * @brief Set the underline enabled flag.
 625    *
 626    * @param[in] enabled The underline enabled flag.
 627    */
 628   void SetUnderlineEnabled( bool enabled );
 629
 630   /**
 631    * @brief Returns whether the text is underlined or not.
 632    *
 633    * @return The underline state.
 634    */
 635   bool IsUnderlineEnabled() const;
 636
 637   /**
 638    * @brief Set the override used for underline height, 0 indicates height will be supplied by font metrics
 639    *
 640    * @param[in] height The height in pixels of the underline
 641    */
 642   void SetUnderlineHeight( float height );
 643
 644   /**
 645    * @brief Retrieves the override height of an underline, 0 indicates height is supplied by font metrics
 646    *
 647    * @return The height of the underline, or 0 if height is not overrided.
 648    */
 649   float GetUnderlineHeight() const;
 650
 651   /**
 652    * @brief Sets the emboss's properties string.
 653    *
 654    * @note The string is stored to be recovered.
 655    *
 656    * @param[in] embossProperties The emboss's properties string.
 657    */
 658   void SetDefaultEmbossProperties( const std::string& embossProperties );
 659
 660   /**
 661    * @brief Retrieves the emboss's properties string.
 662    *
 663    * @return The emboss's properties string.
 664    */
 665   const std::string& GetDefaultEmbossProperties() const;
 666
 667   /**
 668    * @brief Sets the outline's properties string.
 669    *
 670    * @note The string is stored to be recovered.
 671    *
 672    * @param[in] outlineProperties The outline's properties string.
 673    */
 674   void SetDefaultOutlineProperties( const std::string& outlineProperties );
 675
 676   /**
 677    * @brief Retrieves the outline's properties string.
 678    *
 679    * @return The outline's properties string.
 680    */
 681   const std::string& GetDefaultOutlineProperties() const;
 682
 683   /**
 684    * @brief Sets the default line spacing.
 685    *
 686    * @param[in] lineSpacing The line spacing.
 687    */
 688   void SetDefaultLineSpacing( float lineSpacing );
 689
 690   /**
 691    * @brief Retrieves the default line spacing.
 692    *
 693    * @return The line spacing.
 694    */
 695   float GetDefaultLineSpacing() const;
 696
 697   /**
 698    * @brief Sets the input text's color.
 699    *
 700    * @param[in] color The input text's color.
 701    */
 702   void SetInputColor( const Vector4& color );
 703
 704   /**
 705    * @brief Retrieves the input text's color.
 706    *
 707    * @return The input text's color.
 708    */
 709   const Vector4& GetInputColor() const;
 710
 711   /**
 712    * @brief Sets the input text's font family name.
 713    *
 714    * @param[in] fontFamily The text's font family name.
 715    */
 716   void SetInputFontFamily( const std::string& fontFamily );
 717
 718   /**
 719    * @brief Retrieves the input text's font family name.
 720    *
 721    * @return The input text's font family name.
 722    */
 723   const std::string& GetInputFontFamily() const;
 724
 725   /**
 726    * @brief Sets the input font's weight.
 727    *
 728    * @param[in] weight The input font's weight.
 729    */
 730   void SetInputFontWeight( FontWeight weight );
 731
 732   /**
 733    * @return Whether the font's weight has been defined.
 734    */
 735   bool IsInputFontWeightDefined() const;
 736
 737   /**
 738    * @brief Retrieves the input font's weight.
 739    *
 740    * @return The input font's weight.
 741    */
 742   FontWeight GetInputFontWeight() const;
 743
 744   /**
 745    * @brief Sets the input font's width.
 746    *
 747    * @param[in] width The input font's width.
 748    */
 749   void SetInputFontWidth( FontWidth width );
 750
 751   /**
 752    * @return Whether the font's width has been defined.
 753    */
 754   bool IsInputFontWidthDefined() const;
 755
 756   /**
 757    * @brief Retrieves the input font's width.
 758    *
 759    * @return The input font's width.
 760    */
 761   FontWidth GetInputFontWidth() const;
 762
 763   /**
 764    * @brief Sets the input font's slant.
 765    *
 766    * @param[in] slant The input font's slant.
 767    */
 768   void SetInputFontSlant( FontSlant slant );
 769
 770   /**
 771    * @return Whether the font's slant has been defined.
 772    */
 773   bool IsInputFontSlantDefined() const;
 774
 775   /**
 776    * @brief Retrieves the input font's slant.
 777    *
 778    * @return The input font's slant.
 779    */
 780   FontSlant GetInputFontSlant() const;
 781
 782   /**
 783    * @brief Sets the input font's point size.
 784    *
 785    * @param[in] size The input font's point size.
 786    */
 787   void SetInputFontPointSize( float size );
 788
 789   /**
 790    * @brief Retrieves the input font's point size.
 791    *
 792    * @return The input font's point size.
 793    */
 794   float GetInputFontPointSize() const;
 795
 796   /**
 797    * @brief Sets the input line spacing.
 798    *
 799    * @param[in] lineSpacing The line spacing.
 800    */
 801   void SetInputLineSpacing( float lineSpacing );
 802
 803   /**
 804    * @brief Retrieves the input line spacing.
 805    *
 806    * @return The line spacing.
 807    */
 808   float GetInputLineSpacing() const;
 809
 810   /**
 811    * @brief Sets the input shadow's properties string.
 812    *
 813    * @note The string is stored to be recovered.
 814    *
 815    * @param[in] shadowProperties The shadow's properties string.
 816    */
 817   void SetInputShadowProperties( const std::string& shadowProperties );
 818
 819   /**
 820    * @brief Retrieves the input shadow's properties string.
 821    *
 822    * @return The shadow's properties string.
 823    */
 824   const std::string& GetInputShadowProperties() const;
 825
 826   /**
 827    * @brief Sets the input underline's properties string.
 828    *
 829    * @note The string is stored to be recovered.
 830    *
 831    * @param[in] underlineProperties The underline's properties string.
 832    */
 833   void SetInputUnderlineProperties( const std::string& underlineProperties );
 834
 835   /**
 836    * @brief Retrieves the input underline's properties string.
 837    *
 838    * @return The underline's properties string.
 839    */
 840   const std::string& GetInputUnderlineProperties() const;
 841
 842   /**
 843    * @brief Sets the input emboss's properties string.
 844    *
 845    * @note The string is stored to be recovered.
 846    *
 847    * @param[in] embossProperties The emboss's properties string.
 848    */
 849   void SetInputEmbossProperties( const std::string& embossProperties );
 850
 851   /**
 852    * @brief Retrieves the input emboss's properties string.
 853    *
 854    * @return The emboss's properties string.
 855    */
 856   const std::string& GetInputEmbossProperties() const;
 857
 858   /**
 859    * @brief Sets input the outline's properties string.
 860    *
 861    * @note The string is stored to be recovered.
 862    *
 863    * @param[in] outlineProperties The outline's properties string.
 864    */
 865   void SetInputOutlineProperties( const std::string& outlineProperties );
 866
 867   /**
 868    * @brief Retrieves the input outline's properties string.
 869    *
 870    * @return The outline's properties string.
 871    */
 872   const std::string& GetInputOutlineProperties() const;
 873
 874 public: // Queries & retrieves.
 875
 876   /**
 877    * @brief Return the layout engine.
 878    *
 879    * @return A reference to the layout engine.
 880    */
 881   Layout::Engine& GetLayoutEngine();
 882
 883   /**
 884    * @brief Return a view of the text.
 885    *
 886    * @return A reference to the view.
 887    */
 888   View& GetView();
 889
 890   /**
 891    * @copydoc Control::GetNaturalSize()
 892    */
 893   Vector3 GetNaturalSize();
 894
 895   /**
 896    * @copydoc Control::GetHeightForWidth()
 897    */
 898   float GetHeightForWidth( float width );
 899
 900   /**
 901    * @brief Retrieves the text's model.
 902    *
 903    * @return A pointer to the text's model.
 904    */
 905   const ModelInterface* const GetTextModel() const;
 906
 907   /**
 908    * @brief Used to get scrolled distance by user input
 909    *
 910    * @return Distance from last scroll offset to new scroll offset
 911    */
 912   float GetScrollAmountByUserInput();
 913
 914   /**
 915    * @brief Get latest scroll amount, control size and layout size
 916    *
 917    * This method is used to get information of control's scroll
 918    * @param[out] scrollPosition The current scrolled position
 919    * @param[out] controlHeight The size of a UI control
 920    * @param[out] layoutHeight The size of a bounding box to layout text within.
 921    *
 922    * @return Whether the text scroll position is changed or not after last update.
 923    */
 924   bool GetTextScrollInfo( float& scrollPosition, float& controlHeight, float& layoutHeight );
 925
 926   /**
 927    * @brief Used to set the hidden input option
 928    */
 929   void SetHiddenInputOption( const Property::Map& options );
 930
 931   /**
 932    * @brief Used to get the hidden input option
 933    */
 934   void GetHiddenInputOption( Property::Map& options );
 935
 936 public: // Relayout.
 937
 938   /**
 939    * @brief Triggers a relayout which updates View (if necessary).
 940    *
 941    * @note UI Controls are expected to minimize calls to this method e.g. call once after size negotiation.
 942    * @param[in] size A the size of a bounding box to layout text within.
 943    *
 944    * @return Whether the text model or decorations were updated.
 945    */
 946   UpdateTextType Relayout( const Size& size );
 947
 948   /**
 949    * @brief Request a relayout using the ControlInterface.
 950    */
 951   void RequestRelayout();
 952
 953 public: // Input style change signals.
 954
 955   /**
 956    * @return Whether the queue of input style changed signals is empty.
 957    */
 958   bool IsInputStyleChangedSignalsQueueEmpty();
 959
 960   /**
 961    * @brief Process all pending input style changed signals.
 962    *
 963    * Calls the Text::ControlInterface::InputStyleChanged() method which is overriden by the
 964    * text controls. Text controls may send signals to state the input style has changed.
 965    */
 966   void ProcessInputStyleChangedSignals();
 967
 968 public: // Text-input Event Queuing.
 969
 970   /**
 971    * @brief Called by editable UI controls when keyboard focus is gained.
 972    */
 973   void KeyboardFocusGainEvent();
 974
 975   /**
 976    * @brief Called by editable UI controls when focus is lost.
 977    */
 978   void KeyboardFocusLostEvent();
 979
 980   /**
 981    * @brief Called by editable UI controls when key events are received.
 982    *
 983    * @param[in] event The key event.
 984    * @param[in] type Used to distinguish between regular key events and IMF events.
 985    */
 986   bool KeyEvent( const Dali::KeyEvent& event );
 987
 988   /**
 989    * @brief Called by editable UI controls when a tap gesture occurs.
 990    * @param[in] tapCount The number of taps.
 991    * @param[in] x The x position relative to the top-left of the parent control.
 992    * @param[in] y The y position relative to the top-left of the parent control.
 993    */
 994   void TapEvent( unsigned int tapCount, float x, float y );
 995
 996   /**
 997    * @brief Called by editable UI controls when a pan gesture occurs.
 998    *
 999    * @param[in] state The state of the gesture.
1000    * @param[in] displacement This distance panned since the last pan gesture.
1001    */
1002   void PanEvent( Gesture::State state, const Vector2& displacement );
1003
1004   /**
1005    * @brief Called by editable UI controls when a long press gesture occurs.
1006    *
1007    * @param[in] state The state of the gesture.
1008    * @param[in] x The x position relative to the top-left of the parent control.
1009    * @param[in] y The y position relative to the top-left of the parent control.
1010    */
1011   void LongPressEvent( Gesture::State state, float x, float y );
1012
1013   /**
1014    * @brief Event received from IMF manager
1015    *
1016    * @param[in] imfManager The IMF manager.
1017    * @param[in] imfEvent The event received.
1018    * @return A data struture indicating if update is needed, cursor position and current text.
1019    */
1020   ImfManager::ImfCallbackData OnImfEvent( ImfManager& imfManager, const ImfManager::ImfEventData& imfEvent );
1021
1022   /**
1023    * @brief Event from Clipboard notifying an Item has been selected for pasting
1024    */
1025   void PasteClipboardItemEvent();
1026
1027 protected: // Inherit from Text::Decorator::ControllerInterface.
1028
1029   /**
1030    * @copydoc Dali::Toolkit::Text::Decorator::ControllerInterface::GetTargetSize()
1031    */
1032   virtual void GetTargetSize( Vector2& targetSize );
1033
1034   /**
1035    * @copydoc Dali::Toolkit::Text::Decorator::ControllerInterface::AddDecoration()
1036    */
1037   virtual void AddDecoration( Actor& actor, bool needsClipping );
1038
1039   /**
1040    * @copydoc Dali::Toolkit::Text::Decorator::ControllerInterface::DecorationEvent()
1041    */
1042   virtual void DecorationEvent( HandleType handle, HandleState state, float x, float y );
1043
1044 protected: // Inherit from TextSelectionPopup::TextPopupButtonCallbackInterface.
1045
1046   /**
1047    * @copydoc Dali::Toolkit::TextSelectionPopup::TextPopupButtonCallbackInterface::TextPopupButtonTouched()
1048    */
1049   virtual void TextPopupButtonTouched( Dali::Toolkit::TextSelectionPopup::Buttons button );
1050
1051 protected: // Inherit from HiddenText.
1052
1053   /**
1054    * @brief Invoked from HiddenText when showing time of the last character was expired
1055    */
1056   virtual void DisplayTimeExpired();
1057
1058 private: // Update.
1059
1060   /**
1061    * @brief Called by editable UI controls when key events are received.
1062    *
1063    * @param[in] text The text to insert.
1064    * @param[in] type Used to distinguish between regular key events and IMF events.
1065    */
1066   void InsertText( const std::string& text, InsertType type );
1067
1068   /**
1069    * @brief Paste given string into Text model
1070    * @param[in] stringToPaste this string will be inserted into the text model
1071    */
1072   void PasteText( const std::string& stringToPaste );
1073
1074   /**
1075    * @brief Remove a given number of characters
1076    *
1077    * When predictve text is used the pre-edit text is removed and inserted again with the new characters.
1078    * The UpdateInputStyleType @type parameter if set to DONT_UPDATE_INPUT_STYLE avoids to update the input
1079    * style when pre-edit text is removed.
1080    *
1081    * @param[in] cursorOffset Start position from the current cursor position to start deleting characters.
1082    * @param[in] numberOfCharacters The number of characters to delete from the cursorOffset.
1083    * @param[in] type Whether to update the input style.
1084    * @return True if the remove was successful.
1085    */
1086   bool RemoveText( int cursorOffset,
1087                    int numberOfCharacters,
1088                    UpdateInputStyleType type  );
1089
1090   /**
1091    * @brief Checks if text is selected and if so removes it.
1092    * @return true if text was removed
1093    */
1094   bool RemoveSelectedText();
1095
1096 private: // Relayout.
1097
1098   /**
1099    * @brief Lays-out the text.
1100    *
1101    * GetNaturalSize(), GetHeightForWidth() and Relayout() calls this method.
1102    *
1103    * @param[in] size A the size of a bounding box to layout text within.
1104    * @param[in] operations The layout operations which need to be done.
1105    * @param[out] layoutSize The size of the laid-out text.
1106    */
1107   bool DoRelayout( const Size& size,
1108                    OperationsMask operations,
1109                    Size& layoutSize );
1110
1111   /**
1112    * @brief Calulates the vertical offset to align the text inside the bounding box.
1113    *
1114    * @param[in] size The size of the bounding box.
1115    */
1116   void CalculateVerticalOffset( const Size& size );
1117
1118 private: // Events.
1119
1120   /**
1121    * @brief Process queued events which modify the model.
1122    */
1123   void ProcessModifyEvents();
1124
1125   /**
1126    * @brief Used to process an event queued from SetText()
1127    */
1128   void TextReplacedEvent();
1129
1130   /**
1131    * @brief Used to process an event queued from key events etc.
1132    */
1133   void TextInsertedEvent();
1134
1135   /**
1136    * @brief Used to process an event queued from backspace key etc.
1137    */
1138   void TextDeletedEvent();
1139
1140   /**
1141    * @brief Creates a selection event.
1142    *
1143    * It could be called from the TapEvent (double tap) or when the text selection popup's sellect all button is pressed.
1144    *
1145    * @param[in] x The x position relative to the top-left of the parent control.
1146    * @param[in] y The y position relative to the top-left of the parent control.
1147    * @param[in] selectAll Whether the whole text is selected.
1148    */
1149   void SelectEvent( float x, float y, bool selectAll );
1150
1151   /**
1152    * @brief Helper to KeyEvent() to handle the backspace case.
1153    *
1154    * @return True if a character was deleted.
1155    */
1156   bool BackspaceKeyEvent();
1157
1158 private: // Helpers.
1159
1160   /**
1161    * @brief Used to remove the text included the placeholder text.
1162    */
1163   void ResetText();
1164
1165   /**
1166    * @brief Helper to show the place holder text..
1167    */
1168   void ShowPlaceholderText();
1169
1170   /**
1171    * @brief Helper to clear font-specific data (only).
1172    */
1173   void ClearFontData();
1174
1175   /**
1176    * @brief Helper to clear text's style data.
1177    */
1178   void ClearStyleData();
1179
1180   /**
1181    * @brief Used to reset the cursor position after setting a new text.
1182    *
1183    * @param[in] cursorIndex Where to place the cursor.
1184    */
1185   void ResetCursorPosition( CharacterIndex cursorIndex );
1186
1187   /**
1188    * @brief Used to reset the scroll position after setting a new text.
1189    */
1190   void ResetScrollPosition();
1191
1192 private: // Private contructors & copy operator.
1193
1194   /**
1195    * @brief Private constructor.
1196    */
1197   Controller();
1198
1199   /**
1200    * @brief Private constructor.
1201    */
1202   Controller( ControlInterface* controlInterface );
1203
1204   /**
1205    * @brief Private constructor.
1206    */
1207   Controller( ControlInterface* controlInterface,
1208               EditableControlInterface* editableControlInterface );
1209
1210   // Undefined
1211   Controller( const Controller& handle );
1212
1213   // Undefined
1214   Controller& operator=( const Controller& handle );
1215
1216 protected: // Destructor.
1217
1218   /**
1219    * @brief A reference counted object may only be deleted by calling Unreference().
1220    */
1221   virtual ~Controller();
1222
1223 private:
1224
1225   struct Impl;
1226   Impl* mImpl;
1227 };
1228
1229 } // namespace Text
1230
1231 } // namespace Toolkit
1232
1233 } // namespace Dali
1234
1235 #endif // DALI_TOOLKIT_TEXT_CONTROLLER_H