dali-toolkit/internal/text/text-controller.h

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