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