capi/dali-toolkit/public-api/controls/text-view/text-view.h

   1 #ifndef __DALI_TOOLKIT_TEXT_VIEW_H__
   2 #define __DALI_TOOLKIT_TEXT_VIEW_H__
   3
   4 //
   5 // Copyright (c) 2014 Samsung Electronics Co., Ltd.
   6 //
   7 // Licensed under the Flora License, Version 1.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://floralicense.org/license/
  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  * @addtogroup CAPI_DALI_TOOLKIT_TEXT_VIEW_MODULE
  22  * @{
  23  */
  24
  25 // EXTERNAL INCLUDES
  26 #include <string>
  27
  28 // INTERNAL INCLUDES
  29 #include <dali-toolkit/public-api/controls/alignment/alignment.h>
  30 #include <dali-toolkit/public-api/markup-processor/markup-processor.h>
  31
  32 namespace Dali DALI_IMPORT_API
  33 {
  34
  35 namespace Toolkit
  36 {
  37
  38 namespace Internal DALI_INTERNAL
  39 {
  40 class TextView;
  41 }
  42
  43 /**
  44  * @brief TextView is a layout container for text with alignment, multi-line wrapping and formatting support.
  45  *
  46  * Different multi-line and exceed policies could be chosen to represent the given text.
  47  * \see Toolkit::TextView::SetMultilinePolicy \see Toolkit::TextView::SetExceedPolicy
  48  *
  49  * Multi-line policies:
  50  * <ul>
  51  *   <li>\e Split by new line character.
  52  *          Text will split when a '\\n' character is found.
  53  *
  54  *   <li>\e Split by word.
  55  *          Text will split when a '\\n' character is found or if the text doesn't fit in the text view width.
  56  *          In that case, some words will be moved to a new line.
  57  *
  58  *   <li>\e Split by character.
  59  *          Text will split when a '\\n' character is found or if the text doesn't fit in the text view width.
  60  *          In that case, words which doesn't fit will be split in two and the remaining text moved to a new line.
  61  * </ul>
  62  *
  63  * Exceed policies work in combination with multi-line policies:
  64  * <ul>
  65  *   <li>\e Original size.
  66  *          Text will be displayed with its original size.
  67  *
  68  *   <li>\e Truncate.
  69  *          Text will be truncated.
  70  *
  71  *   <li>\e Fade.
  72  *          Text will be faded out.
  73  *
  74  *   <li>\e Split.
  75  *          Text will be split and moved to a new line.
  76  *
  77  *   <li>\e Shrink to fit.
  78  *          Text will be shrink to fit in the text view's boundary.
  79  *
  80  *   <li>\e EllipsizeEnd.
  81  *          Text will be ellipsized at the end.
  82  *
  83  * </ul>
  84  *
  85  * Text alignment could be set to align the whole text block inside the text view's boundary. \see Toolkit::TextView::SetTextAlignment.
  86  *
  87  * Line justification could be set to align lines inside a text block. \see Toolkit::TextView::SetLineJustification.
  88  *
  89  * A default font could be set through the \see Toolkit::TextView::SetFont method. If any font is set, text view automatically detects a suitable font for every character.
  90  *
  91  * Font priority:
  92  * 1) Use the font specified in text decoration.
  93  * 2) Use automatic font detection.
  94  *
  95  * Integration with other classes (GetSizeAndPositionTable )
  96  *
  97  * Text decoration ( Color, Font, Size, italic and all features supported in TextActor )
  98  */
  99 class TextView : public Control
 100 {
 101 public:
 102
 103   // Signal Names
 104   static const char* const SIGNAL_TEXT_SCROLLED; ///< Signal emitted when the scroll position changes. @see SignalScrolled()
 105
 106   // Properties
 107   static const Property::Index PROPERTY_MARKUP_ENABLED;         ///< name "markup-enabled", @see SetMarkupProcessingEnabled(), type BOOLEAN
 108   static const Property::Index PROPERTY_TEXT;                   ///< name "text",                 type STRING
 109   static const Property::Index PROPERTY_MULTILINE_POLICY;       ///< name "multiline-policy",     type STRING
 110   static const Property::Index PROPERTY_WIDTH_EXCEED_POLICY;    ///< name "width-exceed-policy",  type STRING
 111   static const Property::Index PROPERTY_HEIGHT_EXCEED_POLICY;   ///< name "height-exceed-policy", type STRING
 112   static const Property::Index PROPERTY_LINE_JUSTIFICATION;     ///< name "line-justification",   type STRING
 113   static const Property::Index PROPERTY_FADE_BOUNDARY;          ///< name "fade-boundary",        type VECTOR4
 114   static const Property::Index PROPERTY_LINE_HEIGHT_OFFSET;     ///< name "line-height-offset",   type FLOAT
 115   static const Property::Index PROPERTY_HORIZONTAL_ALIGNMENT;   ///< name "horizontal-alignment", type STRING
 116   static const Property::Index PROPERTY_VERTICAL_ALIGNMENT;     ///< name "vertical-alignment",   type STRING
 117
 118   /**
 119    * @brief Structure used to retrieve Layout info per character.
 120    */
 121   struct CharacterLayoutInfo
 122   {
 123     /**
 124      * @brief Default constructor.
 125      *
 126      * Initializes all members to their default values.
 127      */
 128     CharacterLayoutInfo();
 129
 130     /**
 131      * @brief Empty destructor.
 132      *
 133      * @note Added to increase coverage.
 134      */
 135     ~CharacterLayoutInfo();
 136
 137     /**
 138      * @brief Copy constructor.
 139      */
 140     CharacterLayoutInfo( const CharacterLayoutInfo& characterLayoutInfo );
 141
 142     /**
 143      * @brief Assignment operator.
 144      */
 145     CharacterLayoutInfo& operator=( const CharacterLayoutInfo& character );
 146
 147     /**
 148      * @brief Constructor.
 149      *
 150      * @param[in] size of the character.
 151      * @param[in] position of the character.
 152      * @param[in] isNewLineChar Whether the character is a new line character.
 153      * @param[in] isRightToLeftCharacter Whether is a right to left character.
 154      * @param[in] visible Whether is visible.
 155      * @param[in] descender of the character (distance from the base line to the bottom of the character.)
 156      */
 157     CharacterLayoutInfo( const Size& size,
 158                          const Vector3& position,
 159                          bool isNewLineChar,
 160                          bool isRightToLeftCharacter,
 161                          bool visible,
 162                          float descender );
 163
 164     Size    mSize;                     ///< Size of the group of characters.
 165     Vector3 mPosition;                 ///< Position of the group of characters within the text view.
 166     bool    mIsNewLineChar:1;          ///< Whether this group of characters represent a new line.
 167     bool    mIsRightToLeftCharacter:1; ///< Whether it's a right-to-left character.
 168     bool    mIsVisible:1;              ///< Whether this group of characters is visible or not.
 169     float   mDescender;                ///< The character's descender which is the distance from the baseline to the bottom of the character
 170   };
 171
 172   typedef std::vector<CharacterLayoutInfo> CharacterLayoutInfoContainer; ///< Container of Character layouts
 173
 174   /**
 175    * @brief Stores some info about a laid-out line.
 176    */
 177   struct LineLayoutInfo
 178   {
 179     std::size_t mCharacterGlobalIndex; ///< Global index within the whole text of the first character of current laid-out line.
 180     Size        mSize;                 ///< Size of the current laid-out line.
 181     float       mAscender;             ///< The max ascender of the current laid-out line.
 182   };
 183
 184   typedef std::vector<LineLayoutInfo> LineLayoutInfoContainer; ///< Container of line layouts
 185
 186   /**
 187    * @brief How text is laid out.
 188    */
 189   struct TextLayoutInfo
 190   {
 191     /**
 192      * @brief Default constructor.
 193      */
 194     TextLayoutInfo();
 195
 196     /**
 197      * @brief Empty destructor.
 198      *
 199      * @note Added to increase coverage.
 200      */
 201     ~TextLayoutInfo();
 202
 203     /**
 204      * @brief Copy constructor.
 205      */
 206     TextLayoutInfo( const TextLayoutInfo& textLayoutInfo );
 207
 208     /**
 209      * @brief Assignment operator.
 210      */
 211     TextLayoutInfo& operator=( const TextLayoutInfo& textLayoutInfo );
 212
 213     CharacterLayoutInfoContainer mCharacterLayoutInfoTable;    ///< The table of character positions and sizes sorted by the characters' visual index.
 214     LineLayoutInfoContainer      mLines;                       ///< For each laid-out line, it stores an index to the first character of the line.
 215     std::vector<int>             mCharacterLogicalToVisualMap; ///< The map to store the character's logical (input) index according to its visual (reordered) index.
 216     std::vector<int>             mCharacterVisualToLogicalMap; ///< The map to store the character's visual (reordered) index according to its logical (input) index.
 217     Size                         mTextSize;                    ///< Text size after relayout.
 218     Vector2                      mScrollOffset;                ///< Scroll's position.
 219   };
 220
 221   /**
 222    * @brief This structure represents a fade boundary.
 223    *
 224    * If Exceed policy is set to Fade all text which does not fit within the text-view fade boundary is faded out. Text which exceeds the text-view boundary becomes invisible.
 225    * The \e left, \e right, \e top and \e bottom values are positive, in pixels and set the distances between the text-view and fade boundaries.
 226    */
 227   struct FadeBoundary
 228   {
 229     /**
 230      * @brief Default constructor.
 231      *
 232      * Initializes all values to 0. It means no fade boundary.
 233      */
 234     FadeBoundary();
 235
 236     /**
 237      * @brief Constructor.
 238      *
 239      * Initializes the fade boundary with the given values.
 240      *
 241      * @param[in] left value in pixels.
 242      * @param[in] right value in pixels.
 243      * @param[in] top value in pixels.
 244      * @param[in] bottom value in pixels.
 245      */
 246     FadeBoundary( PixelSize left, PixelSize right, PixelSize top, PixelSize bottom );
 247
 248     PixelSize mLeft;   ///< The left fade boundary
 249     PixelSize mRight;  ///< The right fade boundary
 250     PixelSize mTop;    ///< The top fade boundary
 251     PixelSize mBottom; ///< The bottom fade bounday
 252   };
 253
 254   /**
 255    * @brief Define how to split the text in lines.
 256    *
 257    * SplitByNewLineChar will split the text in lines when a '\\n' character is found.
 258    * SplitByWord has effect only when TextView size is assigned.
 259    * It will split the text in lines when a '\\n' character is found or if a line exceeds the TextView's boundary. This option won't split a word in two.
 260    * SplitByChar has effect only when TextView size is assigned.
 261    * It will split the text in lines when a '\\n' character is found or if a line exceeds the TextView's boundary. This option might split a word in two.
 262    * The default value is SplitByNewLineChar.
 263    */
 264   enum MultilinePolicy
 265   {
 266     SplitByNewLineChar, ///< Text lines will split when '\\n' character is found.
 267     SplitByWord,        ///< Text lines will split by word or if '\\n' character is found. It has effect only when TextView size is assigned.
 268     SplitByChar         ///< Text lines will split by char or if '\\n' character is found. It has effect only when TextView size is assigned.
 269   };
 270
 271   /**
 272    * @brief Define how to display the text when it doesn't fit inside the TextView.
 273    *
 274    * The default value is ShrinkToFit.
 275    */
 276   enum ExceedPolicy
 277   {
 278     Original,         ///< Will display the text in its original size. If a line, a word or a character is bigger than the TextView size it may exceed its boundary.
 279     Truncate,         ///< Will display the text in its original size. It won't display the text which exceeds the TextView boundary.
 280     Fade,             ///< Will display the text in its original size. It won't display the text which exceeds the TextView boundary. It fades the text out.
 281     Split,            ///< Will split the text in a new line.
 282     ShrinkToFit,      ///< Will shrink the text to fit the TextView boundary.
 283     EllipsizeEnd      ///< Will ellipsize the text by the end.
 284   };
 285
 286   /**
 287    * @brief Define how to justify lines inside the text area.
 288    *
 289    * The default value is Left.
 290    */
 291   enum LineJustification
 292   {
 293     Left,     ///< Justify to the left.
 294     Center,   ///< Centered.
 295     Right,    ///< Justify to the right.
 296     Justified ///< Line justified.
 297   };
 298
 299 public:
 300   /**
 301    * @brief Create an TextView handle; this can be initialised with TextView::New().
 302    *
 303    * Calling member functions with an uninitialised Dali::Object handle is not allowed.
 304    */
 305   TextView();
 306
 307   /**
 308    * @brief Copy constructor.
 309    *
 310    * Creates another handle that points to the same real object
 311    * @param[in] handle The handle to copy from
 312    */
 313   TextView( const TextView& handle );
 314
 315   /**
 316    * @brief Assignment operator.
 317    *
 318    * Changes this handle to point to another real object
 319    * @param[in] handle The handle to copy from
 320    * @return a reference to this
 321    */
 322   TextView& operator=( const TextView& handle );
 323
 324   /**
 325    * @brief Create a TextView control with no text.
 326    *
 327    * @return A handle the TextView control.
 328    */
 329   static TextView New();
 330
 331   /**
 332    * @brief Create a TextView control.
 333    *
 334    * @param[in] text to display.
 335    * @return A handle the TextView control.
 336    */
 337   static TextView New( const std::string& text );
 338
 339   /**
 340    * @copydoc TextView New( const std::string& text )
 341    */
 342   static TextView New( const MarkupProcessor::StyledTextArray& text );
 343
 344   /**
 345    * @brief Downcast an Object handle to TextView.
 346    *
 347    * If handle points to a TextView the
 348    * downcast produces valid handle. If not the returned handle is left uninitialized.
 349    * @param[in] handle Handle to an object
 350    * @return handle to a TextView or an uninitialized handle
 351    */
 352   static TextView DownCast( BaseHandle handle );
 353
 354   /**
 355    * @brief Virtual destructor.
 356    *
 357    * Dali::Object derived classes typically do not contain member data.
 358    */
 359   virtual ~TextView();
 360
 361   /**
 362    * @brief Replace the current text with a new text string.
 363    *
 364    * @param[in] text to display. The string may contain style tags.
 365    */
 366   void SetText( const std::string& text );
 367
 368   /**
 369    * @brief Replace the current text with a new text string with style.
 370    *
 371    * @param[in] text with style to display.
 372    */
 373   void SetText( const MarkupProcessor::StyledTextArray& text );
 374
 375   /**
 376    * @brief Inserts the given text in the specified position.
 377    *
 378    * @param[in] position Where the given text is going to be added.
 379    * @param[in] text The text to be added.
 380    */
 381   void InsertTextAt( std::size_t position, const std::string& text );
 382
 383   /**
 384    * @copydoc InsertTextAt( std::size_t position, const std::string& text )
 385    */
 386   void InsertTextAt( std::size_t position, const MarkupProcessor::StyledTextArray& text );
 387
 388   /**
 389    * @brief Replaces part of the text.
 390    *
 391    * It removes the specified number of characters from the given position and inserts the given text in the same specified position.
 392    *
 393    * @param[in] position of the first character to be removed and Where the given text is going to be added.
 394    * @param[in] numberOfCharacters number of characters to be removed.
 395    * @param[in] text The text to be added.
 396    */
 397   void ReplaceTextFromTo( std::size_t position, std::size_t numberOfCharacters, const std::string& text );
 398
 399   /**
 400    * @copydoc ReplaceTextFromTo( std::size_t position, std::size_t numberOfCharacters, const std::string& text )
 401    */
 402   void ReplaceTextFromTo( std::size_t position, std::size_t numberOfCharacters, const MarkupProcessor::StyledTextArray& text );
 403
 404   /**
 405    * @brief Removes the specified number of characters from the given position.
 406    *
 407    * @param[in] position of the first character to be removed.
 408    * @param[in] numberOfCharacters number of characters to be removed.
 409    */
 410   void RemoveTextFrom( std::size_t position, std::size_t numberOfCharacters );
 411
 412   /**
 413    * @brief Get the currently displayed text.
 414    *
 415    * @return The currently displayed text.
 416    */
 417   std::string GetText() const;
 418
 419   /**
 420    * @brief Sets a line height offset.
 421    *
 422    * The line height offset will be added to the font line height.
 423    * @param [in] offset The height offset in PointSize units.
 424    */
 425   void SetLineHeightOffset( PointSize offset );
 426
 427   /**
 428    * @brief Retrieves the line height offset.
 429    *
 430    * @return The line height offset in PointSize units.
 431    */
 432   PointSize GetLineHeightOffset() const;
 433
 434   /**
 435    * @brief Sets the given style to the current text.
 436    *
 437    * By default all style settings are applied but a bit mask could be used to modify only certain style settings.
 438    * @note TextView doesn't store a copy of the given style, it applies the given style to the current text only.
 439    * Subsequent calls to SetText() will override any style set by this method.
 440    * @param[in] style The given style
 441    * @param[in] mask The bit mask.
 442    */
 443   void SetStyleToCurrentText( const TextStyle& style, TextStyle::Mask mask = TextStyle::ALL );
 444
 445   /**
 446    * @brief Set the current text alignment.
 447    *
 448    * Default alignment is (HorizontalCenter | VerticalCenter)
 449    * @param[in] align The new alignment option.
 450    */
 451   void SetTextAlignment( Alignment::Type align );
 452
 453   /**
 454    * @brief Get the current text alignment combined into a single value.
 455    *
 456    * The values can be tested by using the & operator
 457    * and the desired flag. e.g. if (GetTextAlignment() & HorizontalCentre) ...
 458    * @return the combined alignment
 459    */
 460   Alignment::Type GetTextAlignment() const;
 461
 462   /**
 463    * @brief Sets how to split the text in lines policy.
 464    *
 465    * @param policy The multi-line policy. SplitByNewLineChar is set by default.
 466    */
 467   void SetMultilinePolicy( MultilinePolicy policy );
 468
 469   /**
 470    * @brief Gets the split in lines policy.
 471    *
 472    * @return The multi-line policy.
 473    */
 474   MultilinePolicy GetMultilinePolicy() const;
 475
 476   /**
 477    * @brief Sets how to display the text inside the TextView when it exceeds the text-view's width.
 478    *
 479    * @param policy The exceed policy. Original is set by default.
 480    */
 481   void SetWidthExceedPolicy( ExceedPolicy policy );
 482
 483   /**
 484    * @brief Gets the width exceed policy.
 485    *
 486    * @return The exceed policy.
 487    */
 488   ExceedPolicy GetWidthExceedPolicy() const;
 489
 490   /**
 491    * @brief Sets how to display the text inside the TextView when it exceeds the text-view's height.
 492    *
 493    * @param policy The exceed policy. Original is set by default.
 494    */
 495   void SetHeightExceedPolicy( ExceedPolicy policy );
 496
 497   /**
 498    * @brief Gets the height exceed policy.
 499    *
 500    * @return The exceed policy.
 501    */
 502   ExceedPolicy GetHeightExceedPolicy() const;
 503
 504   /**
 505    * @brief Sets how to justify lines inside the text area.
 506    *
 507    * @param justification The line justification. Left is set by default.
 508    */
 509   void SetLineJustification( LineJustification justification );
 510
 511   /**
 512    * @brief Gets the line justification.
 513    *
 514    * @return The line justification.
 515    */
 516   LineJustification GetLineJustification() const;
 517
 518   /**
 519    * @brief Sets a fade boundary.
 520    *
 521    * @see FadeBoundary.
 522    *
 523    * @param[in] fadeBoundary The given fade boundary.
 524    */
 525   void SetFadeBoundary( const FadeBoundary& fadeBoundary );
 526
 527   /**
 528    * @brief Retrieves the fade boundary.
 529    *
 530    * @see FadeBoundary.
 531    *
 532    * @return The fade boundary.
 533    */
 534   const FadeBoundary& GetFadeBoundary() const;
 535
 536   /**
 537    * @brief Sets the ellipsize text.
 538    *
 539    * @param[in] ellipsizeText The new text. The string may contain style tags. By default the ellipsize text is '...'
 540    */
 541   void SetEllipsizeText( const std::string& ellipsizeText );
 542
 543   /**
 544    * @brief Sets the ellipsize text.
 545    *
 546    * @param[in] ellipsizeText The new text with its style.
 547    */
 548   void SetEllipsizeText( const MarkupProcessor::StyledTextArray& ellipsizeText );
 549
 550   /**
 551    * @brief Retrieves the ellipsize text.
 552    *
 553    * @return The ellipsize text.
 554    */
 555   std::string GetEllipsizeText() const;
 556
 557   /**
 558    * @brief A mechanism to retrieve layout information from the TextView.
 559    *
 560    * It produces a vector of CharcterLayoutInfo structures which describe the size and position of each character,
 561    * two vectors which maps the logical and visual positions of the characters in a bidirectional text, the size
 562    * of the whole laid-out text and the scroll offset value.
 563    *
 564    * @see TextLayoutInfo.
 565    *
 566    * @param[out] textLayoutInfo A structure with text layout information.
 567    */
 568   void GetTextLayoutInfo( TextLayoutInfo& textLayoutInfo );
 569
 570   /**
 571    * @brief Allows modification of text-actor's position in the depth sort algorithm.
 572    *
 573    * @see Dali::RenderableActor::SetSortModifier()
 574    * @param [in] depthOffset the offset to be given to the internal text-actors. Positive values pushing it further back.
 575    */
 576   void SetSortModifier( float depthOffset );
 577
 578   /**
 579    * @brief Sets whether text-view renders text using a previously generated snapshot.
 580    *
 581    * Rendering long text using a snapshot may increase performance. The default value is \e true (render using a snapshot).
 582    *
 583    * @param[in] enable Whether text-view is using a snapshot to render text.
 584    */
 585   void SetSnapshotModeEnabled( bool enable );
 586
 587   /**
 588    * @brief Retrieves whether text-view is using a snapshot to render text.
 589    *
 590    * @return \e true if text-view is using a snapshot to render text, otherwhise it returns \e false.
 591    */
 592   bool IsSnapshotModeEnabled() const;
 593
 594   /**
 595    * @brief Sets whether markup processing should be carried out.
 596    *
 597    * @param[in] enable whether markup processing is carried out or not.
 598    */
 599   void SetMarkupProcessingEnabled( bool enable );
 600
 601   /**
 602    * @brief Retrieves whether text-view is processing markup text
 603    *
 604    * @return \e true if text-view markup processing is enabled, otherwhise it returns \e false.
 605    */
 606   bool IsMarkupProcessingEnabled() const;
 607
 608   /**
 609    * @brief Enables or disables the text scroll.
 610    *
 611    * When scroll is enabled, snapshot mode will be enabled automatically. Equally, if scroll is disabled
 612    * the snapshot mode is restored to the previous value.
 613    *
 614    * @param[in] enable Whether to enable the text scroll.
 615    */
 616   void SetScrollEnabled( bool enable );
 617
 618   /**
 619    * @brief Retrieves whether the text scroll is enabled.
 620    *
 621    * @return \e true if the scroll is enabled.
 622    */
 623   bool IsScrollEnabled() const;
 624
 625   /**
 626    * @brief Sets a new scroll position.
 627    *
 628    * The new scroll position set could be trimmed if the text doesn't cover the whole text-view.
 629    * i.e. If a text-view is 100x100 and a text is 200x100 a scroll position beyond 50x0 will be trimmed to 50x0.
 630    *
 631    * Call IsScrollPositionTrimmed() to know if the last scroll position set has been trimmed.
 632    *
 633    * A signal is emitted. @see ScrolledSignal().
 634    *
 635    * @param[in] position The new scroll position.
 636    */
 637   void SetScrollPosition( const Vector2& position );
 638
 639   /**
 640    * @brief Recrieves current scroll position.
 641    *
 642    * @return The scroll position.
 643    */
 644   const Vector2& GetScrollPosition() const;
 645
 646   /**
 647    * @brief Whether the last scroll position set was trimmed.
 648    *
 649    * @return \e true if the last scroll position set was trimmed, otherwise \e false.
 650    */
 651   bool IsScrollPositionTrimmed() const;
 652
 653 public:
 654   /// @brief Signal types
 655   typedef SignalV2< void ( TextView textView, Vector2 scrollDelta ) > ScrolledSignalV2;
 656
 657   /**
 658    * @brief Signal emitted when the scroll position changes.
 659    *
 660    * A callback with the following prototype can be connected to this signal.
 661    *
 662    * Callback(TextView textView, Vector2 scrollDelta)
 663    *
 664    * \e textView is the handle of the text-view emitting the signal.
 665    * \e scrollDelta is the differente of the current scroll position with the previous one.
 666    * @return The signal to connect to
 667    */
 668   ScrolledSignalV2& ScrolledSignal();
 669
 670 public: // Not intended for application developers
 671
 672   /**
 673    * @brief Creates a handle using the Toolkit::Internal implementation.
 674    *
 675    * @param[in]  implementation  The Control implementation.
 676    */
 677   TextView( Internal::TextView& implementation );
 678
 679   /**
 680    * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
 681    *
 682    * @param[in]  internal  A pointer to the internal CustomActor.
 683    */
 684   TextView( Dali::Internal::CustomActor* internal );
 685 };
 686
 687 } // namespace Toolkit
 688
 689 } // namespace Dali
 690
 691 /**
 692  * @}
 693  */
 694 #endif // __DALI_TOOLKIT_ITEM_VIEW_H__