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 Sets input type to password
 410    *
 411    * @note The string is displayed hidden character
 412    *
 413    * @param[in] passwordInput True if password input is enabled.
 414    */
 415   void SetInputModePassword( bool passwordInput );
 416
 417   /**
 418    * @brief Returns whether the input mode type is set as password.
 419    *
 420    * @return True if input mode type is password
 421    */
 422   bool IsInputModePassword();
 423
 424   /**
 425    * @brief Sets the action when there is a double tap event on top of a text area with no text.
 426    *
 427    * @param[in] action The action to do.
 428    */
 429   void SetNoTextDoubleTapAction( NoTextTap::Action action );
 430
 431   /**
 432    * @brief Retrieves the action when there is a double tap event on top of a text area with no text.
 433    *
 434    * @return The action to do.
 435    */
 436   NoTextTap::Action GetNoTextDoubleTapAction() const;
 437
 438   /**
 439    * @briefSets the action when there is a long press event on top of a text area with no text.
 440    *
 441    * @param[in] action The action to do.
 442    */
 443   void SetNoTextLongPressAction( NoTextTap::Action action );
 444
 445   /**
 446    * @brief Retrieves the action when there is a long press event on top of a text area with no text.
 447    *
 448    * @return The action to do.
 449    */
 450   NoTextTap::Action GetNoTextLongPressAction() const;
 451
 452   /**
 453    * @brief Query if Underline settings were provided by string or map
 454    * @return bool true if set by string
 455    */
 456   bool IsUnderlineSetByString();
 457
 458   /**
 459    * Set method underline setting were set by
 460    * @param[in] bool, true if set by string
 461    */
 462   void UnderlineSetByString( bool setByString );
 463
 464   /**
 465    * @brief Query if shadow settings were provided by string or map
 466    * @return bool true if set by string
 467    */
 468   bool IsShadowSetByString();
 469
 470   /**
 471    * Set method shadow setting were set by
 472    * @param[in] bool, true if set by string
 473    */
 474   void ShadowSetByString( bool setByString );
 475
 476   /**
 477    * @brief Query if outline settings were provided by string or map
 478    * @return bool true if set by string
 479    */
 480   bool IsOutlineSetByString();
 481
 482   /**
 483    * Set method outline setting were set by
 484    * @param[in] bool, true if set by string
 485    */
 486   void OutlineSetByString( bool setByString );
 487
 488   /**
 489    * @brief Query if font style settings were provided by string or map
 490    * @return bool true if set by string
 491    */
 492   bool IsFontStyleSetByString();
 493
 494   /**
 495    * Set method font style setting were set by
 496    * @param[in] bool, true if set by string
 497    */
 498   void FontStyleSetByString( bool setByString );
 499
 500 public: // Update.
 501
 502   /**
 503    * @brief Replaces any text previously set.
 504    *
 505    * @note This will be converted into UTF-32 when stored in the text model.
 506    * @param[in] text A string of UTF-8 characters.
 507    */
 508   void SetText( const std::string& text );
 509
 510   /**
 511    * @brief Retrieve any text previously set.
 512    *
 513    * @param[out] text A string of UTF-8 characters.
 514    */
 515   void GetText( std::string& text ) const;
 516
 517   /**
 518    * @brief Replaces any placeholder text previously set.
 519    *
 520    * @param[in] type Different placeholder-text can be shown when the control is active/inactive.
 521    * @param[in] text A string of UTF-8 characters.
 522    */
 523   void SetPlaceholderText( PlaceholderType type, const std::string& text );
 524
 525   /**
 526    * @brief Retrieve any placeholder text previously set.
 527    *
 528    * @param[in] type Different placeholder-text can be shown when the control is active/inactive.
 529    * @param[out] A string of UTF-8 characters.
 530    */
 531   void GetPlaceholderText( PlaceholderType type, std::string& text ) const;
 532
 533   /**
 534    * @ brief Update the text after a font change
 535    * @param[in] newDefaultFont The new font to change to
 536    */
 537   void UpdateAfterFontChange( const std::string& newDefaultFont );
 538
 539 public: // Default style & Input style
 540
 541   /**
 542    * @brief Set the default font family.
 543    *
 544    * @param[in] defaultFontFamily The default font family.
 545    */
 546   void SetDefaultFontFamily( const std::string& defaultFontFamily );
 547
 548   /**
 549    * @brief Retrieve the default font family.
 550    *
 551    * @return The default font family.
 552    */
 553   const std::string& GetDefaultFontFamily() const;
 554
 555   /**
 556    * @brief Sets the placeholder text font family.
 557    * @param[in] placeholderTextFontFamily The placeholder text font family.
 558    */
 559   void SetPlaceholderFontFamily( const std::string& placeholderTextFontFamily );
 560
 561   /**
 562    * @brief Retrieves the placeholder text font family.
 563    *
 564    * @return The placeholder text font family
 565    */
 566   const std::string& GetPlaceholderFontFamily() const;
 567
 568   /**
 569    * @brief Sets the default font weight.
 570    *
 571    * @param[in] weight The font weight.
 572    */
 573   void SetDefaultFontWeight( FontWeight weight );
 574
 575   /**
 576    * @brief Whether the font's weight has been defined.
 577    */
 578   bool IsDefaultFontWeightDefined() const;
 579
 580   /**
 581    * @brief Retrieves the default font weight.
 582    *
 583    * @return The default font weight.
 584    */
 585   FontWeight GetDefaultFontWeight() const;
 586
 587   /**
 588    * @brief Sets the placeholder text font weight.
 589    *
 590    * @param[in] weight The font weight
 591    */
 592   void SetPlaceholderTextFontWeight( FontWeight weight );
 593
 594   /**
 595    * @brief Whether the font's weight has been defined.
 596    *
 597    * @return True if the placeholder text font weight is defined
 598    */
 599   bool IsPlaceholderTextFontWeightDefined() const;
 600
 601   /**
 602    * @brief Retrieves the placeholder text font weight.
 603    *
 604    * @return The placeholder text font weight
 605    */
 606   FontWeight GetPlaceholderTextFontWeight() const;
 607
 608   /**
 609    * @brief Sets the default font width.
 610    *
 611    * @param[in] width The font width.
 612    */
 613   void SetDefaultFontWidth( FontWidth width );
 614
 615   /**
 616    * @brief Whether the font's width has been defined.
 617    */
 618   bool IsDefaultFontWidthDefined() const;
 619
 620   /**
 621    * @brief Retrieves the default font width.
 622    *
 623    * @return The default font width.
 624    */
 625   FontWidth GetDefaultFontWidth() const;
 626
 627   /**
 628    * @brief Sets the placeholder text font width.
 629    *
 630    * @param[in] width The font width
 631    */
 632   void SetPlaceholderTextFontWidth( FontWidth width );
 633
 634   /**
 635    * @brief Whether the font's width has been defined.
 636    *
 637    * @return True if the placeholder text font width is defined
 638    */
 639   bool IsPlaceholderTextFontWidthDefined() const;
 640
 641   /**
 642    * @brief Retrieves the placeholder text font width.
 643    *
 644    * @return The placeholder text font width
 645    */
 646   FontWidth GetPlaceholderTextFontWidth() const;
 647
 648   /**
 649    * @brief Sets the default font slant.
 650    *
 651    * @param[in] slant The font slant.
 652    */
 653   void SetDefaultFontSlant( FontSlant slant );
 654
 655   /**
 656    * @brief Whether the font's slant has been defined.
 657    */
 658   bool IsDefaultFontSlantDefined() const;
 659
 660   /**
 661    * @brief Retrieves the default font slant.
 662    *
 663    * @return The default font slant.
 664    */
 665   FontSlant GetDefaultFontSlant() const;
 666
 667   /**
 668    * @brief Sets the placeholder text font slant.
 669    *
 670    * @param[in] slant The font slant
 671    */
 672   void SetPlaceholderTextFontSlant( FontSlant slant );
 673
 674   /**
 675    * @brief Whether the font's slant has been defined.
 676    *
 677    * @return True if the placeholder text font slant is defined
 678    */
 679   bool IsPlaceholderTextFontSlantDefined() const;
 680
 681   /**
 682    * @brief Retrieves the placeholder text font slant.
 683    *
 684    * @return The placeholder text font slant
 685    */
 686   FontSlant GetPlaceholderTextFontSlant() const;
 687
 688   /**
 689    * @brief Set the default font size.
 690    *
 691    * @param[in] fontSize The default font size
 692    * @param[in] type The font size type is point size or pixel size
 693    */
 694   void SetDefaultFontSize( float fontSize, FontSizeType type );
 695
 696   /**
 697    * @brief Retrieve the default point size.
 698    *
 699    * @param[in] type The font size type
 700    * @return The default point size.
 701    */
 702   float GetDefaultFontSize( FontSizeType type ) const;
 703
 704   /**
 705    * @brief Sets the Placeholder text font size.
 706    * @param[in] fontSize The placeholder text font size
 707    * @param[in] type The font size type is point size or pixel size
 708    */
 709   void SetPlaceholderTextFontSize( float fontSize, FontSizeType type );
 710
 711   /**
 712    * @brief Retrieves the Placeholder text font size.
 713    * @param[in] type The font size type
 714    * @return The placeholder font size
 715    */
 716   float GetPlaceholderTextFontSize( FontSizeType type ) const;
 717
 718   /**
 719    * @brief Sets the text's default color.
 720    *
 721    * @param color The default color.
 722    */
 723   void SetDefaultColor( const Vector4& color );
 724
 725   /**
 726    * @brief Retrieves the text's default color.
 727    *
 728    * @return The default color.
 729    */
 730   const Vector4& GetDefaultColor() const;
 731
 732   /**
 733    * @brief Set the text color
 734    *
 735    * @param textColor The text color
 736    */
 737   void SetPlaceholderTextColor( const Vector4& textColor );
 738
 739   /**
 740    * @brief Retrieve the text color
 741    *
 742    * @return The text color
 743    */
 744   const Vector4& GetPlaceholderTextColor() const;
 745
 746   /**
 747    * @brief Set the shadow offset.
 748    *
 749    * @param[in] shadowOffset The shadow offset, 0,0 indicates no shadow.
 750    */
 751   void SetShadowOffset( const Vector2& shadowOffset );
 752
 753   /**
 754    * @brief Retrieve the shadow offset.
 755    *
 756    * @return The shadow offset.
 757    */
 758   const Vector2& GetShadowOffset() const;
 759
 760   /**
 761    * @brief Set the shadow color.
 762    *
 763    * @param[in] shadowColor The shadow color.
 764    */
 765   void SetShadowColor( const Vector4& shadowColor );
 766
 767   /**
 768    * @brief Retrieve the shadow color.
 769    *
 770    * @return The shadow color.
 771    */
 772   const Vector4& GetShadowColor() const;
 773
 774   /**
 775    * @brief Set the shadow blur radius.
 776    *
 777    * @param[in] shadowBlurRadius The shadow blur radius, 0,0 indicates no blur.
 778    */
 779   void SetShadowBlurRadius( const float& shadowBlurRadius );
 780
 781   /**
 782    * @brief Retrieve the shadow blur radius.
 783    *
 784    * @return The shadow blur radius.
 785    */
 786   const float& GetShadowBlurRadius() const;
 787
 788   /**
 789    * @brief Set the underline color.
 790    *
 791    * @param[in] color color of underline.
 792    */
 793   void SetUnderlineColor( const Vector4& color );
 794
 795   /**
 796    * @brief Retrieve the underline color.
 797    *
 798    * @return The underline color.
 799    */
 800   const Vector4& GetUnderlineColor() const;
 801
 802   /**
 803    * @brief Set the underline enabled flag.
 804    *
 805    * @param[in] enabled The underline enabled flag.
 806    */
 807   void SetUnderlineEnabled( bool enabled );
 808
 809   /**
 810    * @brief Returns whether the text is underlined or not.
 811    *
 812    * @return The underline state.
 813    */
 814   bool IsUnderlineEnabled() const;
 815
 816   /**
 817    * @brief Set the override used for underline height, 0 indicates height will be supplied by font metrics
 818    *
 819    * @param[in] height The height in pixels of the underline
 820    */
 821   void SetUnderlineHeight( float height );
 822
 823   /**
 824    * @brief Retrieves the override height of an underline, 0 indicates height is supplied by font metrics
 825    *
 826    * @return The height of the underline, or 0 if height is not overrided.
 827    */
 828   float GetUnderlineHeight() const;
 829
 830   /**
 831    * @brief Set the outline color.
 832    *
 833    * @param[in] color color of outline.
 834    */
 835   void SetOutlineColor( const Vector4& color );
 836
 837   /**
 838    * @brief Retrieve the outline color.
 839    *
 840    * @return The outline color.
 841    */
 842   const Vector4& GetOutlineColor() const;
 843
 844   /**
 845    * @brief Set the outline width
 846    *
 847    * @param[in] width The width in pixels of the outline, 0 indicates no outline
 848    */
 849   void SetOutlineWidth( unsigned int width );
 850
 851   /**
 852    * @brief Retrieves the width of an outline
 853    *
 854    * @return The width of the outline.
 855    */
 856   unsigned int GetOutlineWidth() const;
 857
 858   /**
 859    * @brief Sets the emboss's properties string.
 860    *
 861    * @note The string is stored to be recovered.
 862    *
 863    * @param[in] embossProperties The emboss's properties string.
 864    */
 865   void SetDefaultEmbossProperties( const std::string& embossProperties );
 866
 867   /**
 868    * @brief Retrieves the emboss's properties string.
 869    *
 870    * @return The emboss's properties string.
 871    */
 872   const std::string& GetDefaultEmbossProperties() const;
 873
 874   /**
 875    * @brief Sets the outline's properties string.
 876    *
 877    * @note The string is stored to be recovered.
 878    *
 879    * @param[in] outlineProperties The outline's properties string.
 880    */
 881   void SetDefaultOutlineProperties( const std::string& outlineProperties );
 882
 883   /**
 884    * @brief Retrieves the outline's properties string.
 885    *
 886    * @return The outline's properties string.
 887    */
 888   const std::string& GetDefaultOutlineProperties() const;
 889
 890   /**
 891    * @brief Sets the default line spacing.
 892    *
 893    * @param[in] lineSpacing The line spacing.
 894    *
 895    * @return True if lineSpacing has been updated, false otherwise
 896    */
 897   bool SetDefaultLineSpacing( float lineSpacing );
 898
 899   /**
 900    * @brief Retrieves the default line spacing.
 901    *
 902    * @return The line spacing.
 903    */
 904   float GetDefaultLineSpacing() const;
 905
 906   /**
 907    * @brief Sets the input text's color.
 908    *
 909    * @param[in] color The input text's color.
 910    */
 911   void SetInputColor( const Vector4& color );
 912
 913   /**
 914    * @brief Retrieves the input text's color.
 915    *
 916    * @return The input text's color.
 917    */
 918   const Vector4& GetInputColor() const;
 919
 920   /**
 921    * @brief Sets the input text's font family name.
 922    *
 923    * @param[in] fontFamily The text's font family name.
 924    */
 925   void SetInputFontFamily( const std::string& fontFamily );
 926
 927   /**
 928    * @brief Retrieves the input text's font family name.
 929    *
 930    * @return The input text's font family name.
 931    */
 932   const std::string& GetInputFontFamily() const;
 933
 934   /**
 935    * @brief Sets the input font's weight.
 936    *
 937    * @param[in] weight The input font's weight.
 938    */
 939   void SetInputFontWeight( FontWeight weight );
 940
 941   /**
 942    * @return Whether the font's weight has been defined.
 943    */
 944   bool IsInputFontWeightDefined() const;
 945
 946   /**
 947    * @brief Retrieves the input font's weight.
 948    *
 949    * @return The input font's weight.
 950    */
 951   FontWeight GetInputFontWeight() const;
 952
 953   /**
 954    * @brief Sets the input font's width.
 955    *
 956    * @param[in] width The input font's width.
 957    */
 958   void SetInputFontWidth( FontWidth width );
 959
 960   /**
 961    * @return Whether the font's width has been defined.
 962    */
 963   bool IsInputFontWidthDefined() const;
 964
 965   /**
 966    * @brief Retrieves the input font's width.
 967    *
 968    * @return The input font's width.
 969    */
 970   FontWidth GetInputFontWidth() const;
 971
 972   /**
 973    * @brief Sets the input font's slant.
 974    *
 975    * @param[in] slant The input font's slant.
 976    */
 977   void SetInputFontSlant( FontSlant slant );
 978
 979   /**
 980    * @return Whether the font's slant has been defined.
 981    */
 982   bool IsInputFontSlantDefined() const;
 983
 984   /**
 985    * @brief Retrieves the input font's slant.
 986    *
 987    * @return The input font's slant.
 988    */
 989   FontSlant GetInputFontSlant() const;
 990
 991   /**
 992    * @brief Sets the input font's point size.
 993    *
 994    * @param[in] size The input font's point size.
 995    */
 996   void SetInputFontPointSize( float size );
 997
 998   /**
 999    * @brief Retrieves the input font's point size.
1000    *
1001    * @return The input font's point size.
1002    */
1003   float GetInputFontPointSize() const;
1004
1005   /**
1006    * @brief Sets the input line spacing.
1007    *
1008    * @param[in] lineSpacing The line spacing.
1009    */
1010   void SetInputLineSpacing( float lineSpacing );
1011
1012   /**
1013    * @brief Retrieves the input line spacing.
1014    *
1015    * @return The line spacing.
1016    */
1017   float GetInputLineSpacing() const;
1018
1019   /**
1020    * @brief Sets the input shadow's properties string.
1021    *
1022    * @note The string is stored to be recovered.
1023    *
1024    * @param[in] shadowProperties The shadow's properties string.
1025    */
1026   void SetInputShadowProperties( const std::string& shadowProperties );
1027
1028   /**
1029    * @brief Retrieves the input shadow's properties string.
1030    *
1031    * @return The shadow's properties string.
1032    */
1033   const std::string& GetInputShadowProperties() const;
1034
1035   /**
1036    * @brief Sets the input underline's properties string.
1037    *
1038    * @note The string is stored to be recovered.
1039    *
1040    * @param[in] underlineProperties The underline's properties string.
1041    */
1042   void SetInputUnderlineProperties( const std::string& underlineProperties );
1043
1044   /**
1045    * @brief Retrieves the input underline's properties string.
1046    *
1047    * @return The underline's properties string.
1048    */
1049   const std::string& GetInputUnderlineProperties() const;
1050
1051   /**
1052    * @brief Sets the input emboss's properties string.
1053    *
1054    * @note The string is stored to be recovered.
1055    *
1056    * @param[in] embossProperties The emboss's properties string.
1057    */
1058   void SetInputEmbossProperties( const std::string& embossProperties );
1059
1060   /**
1061    * @brief Retrieves the input emboss's properties string.
1062    *
1063    * @return The emboss's properties string.
1064    */
1065   const std::string& GetInputEmbossProperties() const;
1066
1067   /**
1068    * @brief Sets input the outline's properties string.
1069    *
1070    * @note The string is stored to be recovered.
1071    *
1072    * @param[in] outlineProperties The outline's properties string.
1073    */
1074   void SetInputOutlineProperties( const std::string& outlineProperties );
1075
1076   /**
1077    * @brief Retrieves the input outline's properties string.
1078    *
1079    * @return The outline's properties string.
1080    */
1081   const std::string& GetInputOutlineProperties() const;
1082
1083   /**
1084    * @brief Set the control's interface.
1085    *
1086    * @param[in] controlInterface The control's interface.
1087    */
1088   void SetControlInterface( ControlInterface* controlInterface );
1089
1090 public: // Queries & retrieves.
1091
1092   /**
1093    * @brief Return the layout engine.
1094    *
1095    * @return A reference to the layout engine.
1096    */
1097   Layout::Engine& GetLayoutEngine();
1098
1099   /**
1100    * @brief Return a view of the text.
1101    *
1102    * @return A reference to the view.
1103    */
1104   View& GetView();
1105
1106   /**
1107    * @copydoc Control::GetNaturalSize()
1108    */
1109   Vector3 GetNaturalSize();
1110
1111   /**
1112    * @copydoc Control::GetHeightForWidth()
1113    */
1114   float GetHeightForWidth( float width );
1115
1116   /**
1117    * @brief Retrieves the text's number of lines for a given width.
1118    * @param[in] width The width of the text's area.
1119    * @ return The number of lines.
1120    */
1121   int GetLineCount( float width );
1122
1123   /**
1124    * @brief Retrieves the text's model.
1125    *
1126    * @return A pointer to the text's model.
1127    */
1128   const ModelInterface* const GetTextModel() const;
1129
1130   /**
1131    * @brief Used to get scrolled distance by user input
1132    *
1133    * @return Distance from last scroll offset to new scroll offset
1134    */
1135   float GetScrollAmountByUserInput();
1136
1137   /**
1138    * @brief Get latest scroll amount, control size and layout size
1139    *
1140    * This method is used to get information of control's scroll
1141    * @param[out] scrollPosition The current scrolled position
1142    * @param[out] controlHeight The size of a UI control
1143    * @param[out] layoutHeight The size of a bounding box to layout text within.
1144    *
1145    * @return Whether the text scroll position is changed or not after last update.
1146    */
1147   bool GetTextScrollInfo( float& scrollPosition, float& controlHeight, float& layoutHeight );
1148
1149   /**
1150    * @brief Used to set the hidden input option
1151    */
1152   void SetHiddenInputOption( const Property::Map& options );
1153
1154   /**
1155    * @brief Used to get the hidden input option
1156    */
1157   void GetHiddenInputOption( Property::Map& options );
1158
1159   /**
1160    * @brief Sets the Placeholder Properties.
1161    *
1162    * @param[in] map The placeholder property map
1163    */
1164   void SetPlaceholderProperty( const Property::Map& map );
1165
1166   /**
1167    * @brief Retrieves the Placeholder Property map.
1168    *
1169    * @param[out] map The property map
1170    */
1171   void GetPlaceholderProperty( Property::Map& map );
1172
1173   /**
1174    * @brief Checks text direction.
1175    * @return The text direction.
1176    */
1177   Toolkit::DevelText::TextDirection::Type GetTextDirection();
1178
1179   /**
1180    * @brief Retrieves vertical line alignment
1181    * @return The vertical line alignment
1182    */
1183   Toolkit::DevelText::VerticalLineAlignment::Type GetVerticalLineAlignment() const;
1184
1185   /**
1186    * @brief Sets vertical line alignment
1187    * @param[in] alignment The vertical line alignment for the text
1188    */
1189   void SetVerticalLineAlignment( Toolkit::DevelText::VerticalLineAlignment::Type alignment );
1190
1191 public: // Relayout.
1192
1193   /**
1194    * @brief Triggers a relayout which updates View (if necessary).
1195    *
1196    * @note UI Controls are expected to minimize calls to this method e.g. call once after size negotiation.
1197    * @param[in] size A the size of a bounding box to layout text within.
1198    *
1199    * @return Whether the text model or decorations were updated.
1200    */
1201   UpdateTextType Relayout( const Size& size );
1202
1203   /**
1204    * @brief Request a relayout using the ControlInterface.
1205    */
1206   void RequestRelayout();
1207
1208 public: // Input style change signals.
1209
1210   /**
1211    * @return Whether the queue of input style changed signals is empty.
1212    */
1213   bool IsInputStyleChangedSignalsQueueEmpty();
1214
1215   /**
1216    * @brief Process all pending input style changed signals.
1217    *
1218    * Calls the Text::ControlInterface::InputStyleChanged() method which is overriden by the
1219    * text controls. Text controls may send signals to state the input style has changed.
1220    */
1221   void ProcessInputStyleChangedSignals();
1222
1223 public: // Text-input Event Queuing.
1224
1225   /**
1226    * @brief Called by editable UI controls when keyboard focus is gained.
1227    */
1228   void KeyboardFocusGainEvent();
1229
1230   /**
1231    * @brief Called by editable UI controls when focus is lost.
1232    */
1233   void KeyboardFocusLostEvent();
1234
1235   /**
1236    * @brief Called by editable UI controls when key events are received.
1237    *
1238    * @param[in] event The key event.
1239    * @param[in] type Used to distinguish between regular key events and IMF events.
1240    */
1241   bool KeyEvent( const Dali::KeyEvent& event );
1242
1243   /**
1244    * @brief Called by editable UI controls when a tap gesture occurs.
1245    * @param[in] tapCount The number of taps.
1246    * @param[in] x The x position relative to the top-left of the parent control.
1247    * @param[in] y The y position relative to the top-left of the parent control.
1248    */
1249   void TapEvent( unsigned int tapCount, float x, float y );
1250
1251   /**
1252    * @brief Called by editable UI controls when a pan gesture occurs.
1253    *
1254    * @param[in] state The state of the gesture.
1255    * @param[in] displacement This distance panned since the last pan gesture.
1256    */
1257   void PanEvent( Gesture::State state, const Vector2& displacement );
1258
1259   /**
1260    * @brief Called by editable UI controls when a long press gesture occurs.
1261    *
1262    * @param[in] state The state of the gesture.
1263    * @param[in] x The x position relative to the top-left of the parent control.
1264    * @param[in] y The y position relative to the top-left of the parent control.
1265    */
1266   void LongPressEvent( Gesture::State state, float x, float y );
1267
1268   /**
1269    * @brief Event received from IMF manager
1270    *
1271    * @param[in] imfManager The IMF manager.
1272    * @param[in] imfEvent The event received.
1273    * @return A data struture indicating if update is needed, cursor position and current text.
1274    */
1275   ImfManager::ImfCallbackData OnImfEvent( ImfManager& imfManager, const ImfManager::ImfEventData& imfEvent );
1276
1277   /**
1278    * @brief Event from Clipboard notifying an Item has been selected for pasting
1279    */
1280   void PasteClipboardItemEvent();
1281
1282   /**
1283    * @brief Return true when text control should clear key input focus when escape key is pressed.
1284    *
1285    * @return Whether text control should clear key input focus or not when escape key is pressed.
1286    */
1287   bool ShouldClearFocusOnEscape() const;
1288
1289 protected: // Inherit from Text::Decorator::ControllerInterface.
1290
1291   /**
1292    * @copydoc Dali::Toolkit::Text::Decorator::ControllerInterface::GetTargetSize()
1293    */
1294   virtual void GetTargetSize( Vector2& targetSize );
1295
1296   /**
1297    * @copydoc Dali::Toolkit::Text::Decorator::ControllerInterface::AddDecoration()
1298    */
1299   virtual void AddDecoration( Actor& actor, bool needsClipping );
1300
1301   /**
1302    * @copydoc Dali::Toolkit::Text::Decorator::ControllerInterface::DecorationEvent()
1303    */
1304   virtual void DecorationEvent( HandleType handle, HandleState state, float x, float y );
1305
1306 protected: // Inherit from TextSelectionPopup::TextPopupButtonCallbackInterface.
1307
1308   /**
1309    * @copydoc Dali::Toolkit::TextSelectionPopup::TextPopupButtonCallbackInterface::TextPopupButtonTouched()
1310    */
1311   virtual void TextPopupButtonTouched( Dali::Toolkit::TextSelectionPopup::Buttons button );
1312
1313 protected: // Inherit from HiddenText.
1314
1315   /**
1316    * @brief Invoked from HiddenText when showing time of the last character was expired
1317    */
1318   virtual void DisplayTimeExpired();
1319
1320 private: // Update.
1321
1322   /**
1323    * @brief Called by editable UI controls when key events are received.
1324    *
1325    * @param[in] text The text to insert.
1326    * @param[in] type Used to distinguish between regular key events and IMF events.
1327    */
1328   void InsertText( const std::string& text, InsertType type );
1329
1330   /**
1331    * @brief Paste given string into Text model
1332    * @param[in] stringToPaste this string will be inserted into the text model
1333    */
1334   void PasteText( const std::string& stringToPaste );
1335
1336   /**
1337    * @brief Remove a given number of characters
1338    *
1339    * When predictve text is used the pre-edit text is removed and inserted again with the new characters.
1340    * The UpdateInputStyleType @type parameter if set to DONT_UPDATE_INPUT_STYLE avoids to update the input
1341    * style when pre-edit text is removed.
1342    *
1343    * @param[in] cursorOffset Start position from the current cursor position to start deleting characters.
1344    * @param[in] numberOfCharacters The number of characters to delete from the cursorOffset.
1345    * @param[in] type Whether to update the input style.
1346    * @return True if the remove was successful.
1347    */
1348   bool RemoveText( int cursorOffset,
1349                    int numberOfCharacters,
1350                    UpdateInputStyleType type  );
1351
1352   /**
1353    * @brief Checks if text is selected and if so removes it.
1354    * @return true if text was removed
1355    */
1356   bool RemoveSelectedText();
1357
1358 private: // Relayout.
1359
1360   /**
1361    * @brief Lays-out the text.
1362    *
1363    * GetNaturalSize(), GetHeightForWidth() and Relayout() calls this method.
1364    *
1365    * @param[in] size A the size of a bounding box to layout text within.
1366    * @param[in] operations The layout operations which need to be done.
1367    * @param[out] layoutSize The size of the laid-out text.
1368    */
1369   bool DoRelayout( const Size& size,
1370                    OperationsMask operations,
1371                    Size& layoutSize );
1372
1373   /**
1374    * @brief Calulates the vertical offset to align the text inside the bounding box.
1375    *
1376    * @param[in] size The size of the bounding box.
1377    */
1378   void CalculateVerticalOffset( const Size& size );
1379
1380 private: // Events.
1381
1382   /**
1383    * @brief Process queued events which modify the model.
1384    */
1385   void ProcessModifyEvents();
1386
1387   /**
1388    * @brief Used to process an event queued from SetText()
1389    */
1390   void TextReplacedEvent();
1391
1392   /**
1393    * @brief Used to process an event queued from key events etc.
1394    */
1395   void TextInsertedEvent();
1396
1397   /**
1398    * @brief Used to process an event queued from backspace key etc.
1399    */
1400   void TextDeletedEvent();
1401
1402   /**
1403    * @brief Creates a selection event.
1404    *
1405    * It could be called from the TapEvent (double tap) or when the text selection popup's sellect all button is pressed.
1406    *
1407    * @param[in] x The x position relative to the top-left of the parent control.
1408    * @param[in] y The y position relative to the top-left of the parent control.
1409    * @param[in] selectAll Whether the whole text is selected.
1410    */
1411   void SelectEvent( float x, float y, bool selectAll );
1412
1413   /**
1414    * @brief Helper to KeyEvent() to handle the backspace or delete key case.
1415    *
1416    * @param[in] keyCode The keycode for the key pressed
1417    * @return True if a character was deleted.
1418    */
1419   bool DeleteEvent( int keyCode );
1420
1421 private: // Helpers.
1422
1423   /**
1424    * @brief Used to remove the text included the placeholder text.
1425    */
1426   void ResetText();
1427
1428   /**
1429    * @brief Helper to show the place holder text..
1430    */
1431   void ShowPlaceholderText();
1432
1433   /**
1434    * @brief Helper to clear font-specific data (only).
1435    */
1436   void ClearFontData();
1437
1438   /**
1439    * @brief Helper to clear text's style data.
1440    */
1441   void ClearStyleData();
1442
1443   /**
1444    * @brief Used to reset the cursor position after setting a new text.
1445    *
1446    * @param[in] cursorIndex Where to place the cursor.
1447    */
1448   void ResetCursorPosition( CharacterIndex cursorIndex );
1449
1450   /**
1451    * @brief Used to reset the scroll position after setting a new text.
1452    */
1453   void ResetScrollPosition();
1454
1455 private: // Private contructors & copy operator.
1456
1457   /**
1458    * @brief Private constructor.
1459    */
1460   Controller();
1461
1462   /**
1463    * @brief Private constructor.
1464    */
1465   Controller( ControlInterface* controlInterface );
1466
1467   /**
1468    * @brief Private constructor.
1469    */
1470   Controller( ControlInterface* controlInterface,
1471               EditableControlInterface* editableControlInterface );
1472
1473   // Undefined
1474   Controller( const Controller& handle );
1475
1476   // Undefined
1477   Controller& operator=( const Controller& handle );
1478
1479 protected: // Destructor.
1480
1481   /**
1482    * @brief A reference counted object may only be deleted by calling Unreference().
1483    */
1484   virtual ~Controller();
1485
1486 private:
1487
1488   struct Impl;
1489   Impl* mImpl;
1490 };
1491
1492 } // namespace Text
1493
1494 } // namespace Toolkit
1495
1496 } // namespace Dali
1497
1498 #endif // DALI_TOOLKIT_TEXT_CONTROLLER_H