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