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

   1 #ifndef __DALI_TOOLKIT_TEXT_DECORATOR_H__
   2 #define __DALI_TOOLKIT_TEXT_DECORATOR_H__
   3
   4 /*
   5  * Copyright (c) 2015 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/public-api/common/intrusive-ptr.h>
  23 #include <dali/public-api/object/ref-object.h>
  24 #include <dali/public-api/math/rect.h>
  25
  26 // INTERNAL INCLUDES
  27 #include <dali-toolkit/devel-api/controls/text-controls/text-selection-popup.h>
  28
  29 namespace Dali
  30 {
  31
  32 struct Vector2;
  33 struct Vector4;
  34
  35 namespace Toolkit
  36 {
  37
  38 namespace Text
  39 {
  40
  41 class Decorator;
  42 typedef IntrusivePtr<Decorator> DecoratorPtr;
  43
  44 // Used to set the cursor positions etc.
  45 enum Cursor
  46 {
  47   PRIMARY_CURSOR,   ///< The primary cursor for bidirectional text (or the regular cursor for single-direction text)
  48   SECONDARY_CURSOR, ///< The secondary cursor for bidirectional text
  49   CURSOR_COUNT
  50 };
  51
  52 // Determines which of the cursors are active (if any).
  53 enum ActiveCursor
  54 {
  55   ACTIVE_CURSOR_NONE,    ///< Neither primary nor secondary cursor are active
  56   ACTIVE_CURSOR_PRIMARY, ///< Primary cursor is active (only)
  57   ACTIVE_CURSOR_BOTH     ///< Both primary and secondary cursor are active
  58 };
  59
  60 // The state information for handle events.
  61 enum HandleState
  62 {
  63   HANDLE_TAPPED,
  64   HANDLE_PRESSED,
  65   HANDLE_RELEASED,
  66   HANDLE_SCROLLING,
  67   HANDLE_STOP_SCROLLING
  68 };
  69
  70 // Used to set different handle images
  71 enum HandleImageType
  72 {
  73   HANDLE_IMAGE_PRESSED,
  74   HANDLE_IMAGE_RELEASED,
  75   HANDLE_IMAGE_TYPE_COUNT
  76 };
  77
  78 // Types of handles.
  79 enum HandleType
  80 {
  81   GRAB_HANDLE,
  82   LEFT_SELECTION_HANDLE,
  83   RIGHT_SELECTION_HANDLE,
  84   LEFT_SELECTION_HANDLE_MARKER,
  85   RIGHT_SELECTION_HANDLE_MARKER,
  86   HANDLE_TYPE_COUNT
  87 };
  88
  89 /**
  90  * @brief A Text Decorator is used to display cursors, handles, selection highlights and pop-ups.
  91  *
  92  * The decorator is responsible for clipping decorations which are positioned outside of the parent area.
  93  *
  94  * The Popup decoration will be positioned either above the Grab handle or above the selection handles but if doing so
  95  * would cause the Popup to exceed the Decoration Bounding Box ( see SetBoundingBox API ) the the Popup will be repositioned below the handle(s).
  96  *
  97  * Selection handles will be flipped around to ensure they do not exceed the Decoration Bounding Box. ( Stay visible ).
  98  *
  99  * Decorator components forward input events to a controller class through an interface.
 100  * The controller is responsible for selecting which components are active.
 101  */
 102 class Decorator : public RefObject
 103 {
 104 public:
 105
 106   class ControllerInterface
 107   {
 108   public:
 109
 110     /**
 111      * @brief Constructor.
 112      */
 113     ControllerInterface() {};
 114
 115     /**
 116      * @brief Virtual destructor.
 117      */
 118     virtual ~ControllerInterface() {};
 119
 120     /**
 121      * @brief Query the target size of the UI control.
 122      *
 123      * @param[out] targetSize The size of the UI control the decorator is adding it's decorations to.
 124      */
 125     virtual void GetTargetSize( Vector2& targetSize ) = 0;
 126
 127     /**
 128      * @brief Add a decoration to the parent UI control.
 129      *
 130      * @param[in] decoration The actor displaying a decoration.
 131      */
 132     virtual void AddDecoration( Actor& actor, bool needsClipping ) = 0;
 133
 134     /**
 135      * @brief An input event from one of the handles.
 136      *
 137      * @param[in] handleType The handle's type.
 138      * @param[in] state The handle's state.
 139      * @param[in] x The x position relative to the top-left of the parent control.
 140      * @param[in] y The y position relative to the top-left of the parent control.
 141      */
 142     virtual void DecorationEvent( HandleType handleType, HandleState state, float x, float y ) = 0;
 143   };
 144
 145   /**
 146    * @brief Create a new instance of a Decorator.
 147    *
 148    * @param[in] controller The controller which receives input events from Decorator components.
 149    * @param[in] callbackInterface The text popup callback interface which receives the button click callbacks.
 150    *
 151    * @return A pointer to a new Decorator.
 152    */
 153   static DecoratorPtr New( ControllerInterface& controller,
 154                            TextSelectionPopupCallbackInterface& callbackInterface );
 155
 156   /**
 157    * @brief Set the bounding box which handles, popup and similar decorations will not exceed.
 158    *
 159    * The default value is the width and height of the stage from the top left origin.
 160    * If a title bar for example is on the top of the screen then the y should be the title's height and
 161    * the boundary height the stage height minus the title's height.
 162    * Restrictions - The boundary box should be set up with a fixed z position for the text-input and the default camera.
 163    *
 164    * ------------------------------------------
 165    * |(x,y)                                   |
 166    * |o---------------------------------------|
 167    * ||                                      ||
 168    * ||            Bounding Box              || boundary height
 169    * ||                                      ||
 170    * |----------------------------------------|
 171    * ------------------------------------------
 172    *               boundary width
 173    *
 174    * @param[in] boundingBox Vector( x coordinate, y coordinate, width, height )
 175    */
 176   void SetBoundingBox( const Rect<int>& boundingBox );
 177
 178   /**
 179    * @brief Retrieve the bounding box origin and dimensions.
 180    *
 181    * default is set once control is added to stage, before this the return vector will be Vector4:ZERO
 182    * @return Rect<int> the bounding box origin, width and height
 183    */
 184   const Rect<int>& GetBoundingBox() const;
 185
 186   /**
 187    * @brief The decorator waits until a relayout before creating actors etc.
 188    *
 189    * @param[in] size The size of the parent control after size-negotiation.
 190    */
 191   void Relayout( const Dali::Vector2& size );
 192
 193   /**
 194    * @brief Updates the decorator's actor positions after scrolling.
 195    *
 196    * @param[in] scrollOffset The scroll offset.
 197    */
 198   void UpdatePositions( const Vector2& scrollOffset );
 199
 200   /**
 201    * @brief Sets which of the cursors are active.
 202    *
 203    * @note Cursor will only be visible if within the parent area.
 204    * @param[in] activeCursor Which of the cursors should be active (if any).
 205    */
 206   void SetActiveCursor( ActiveCursor activeCursor );
 207
 208   /**
 209    * @brief Query which of the cursors are active.
 210    *
 211    * @return  Which of the cursors are active (if any).
 212    */
 213   unsigned int GetActiveCursor() const;
 214
 215   /**
 216    * @brief Sets the position of a cursor.
 217    *
 218    * @param[in] cursor The cursor to set.
 219    * @param[in] x The x position relative to the top-left of the parent control.
 220    * @param[in] y The y position relative to the top-left of the parent control.
 221    * @param[in] cursorHeight The logical height of the cursor.
 222    * @param[in] lineHeight The logical height of the line.
 223    */
 224   void SetPosition( Cursor cursor, float x, float y, float cursorHeight, float lineHeight );
 225
 226   /**
 227    * @brief Retrieves the position, height and lineHeight of a cursor.
 228    *
 229    * @param[in] cursor The cursor to get.
 230    * @param[out] x The x position relative to the top-left of the parent control.
 231    * @param[out] y The y position relative to the top-left of the parent control.
 232    * @param[out] cursorHeight The logical height of the cursor.
 233    * @param[out] lineHeight The logical height of the line.
 234    */
 235   void GetPosition( Cursor cursor, float& x, float& y, float& cursorHeight, float& lineHeight ) const;
 236
 237   /**
 238    * @brief Retrieves the position of a cursor.
 239    *
 240    * @param[in] cursor The cursor to get.
 241    *
 242    * @return The position.
 243    */
 244   const Vector2& GetPosition( Cursor cursor ) const;
 245
 246   /**
 247    * @brief Sets the color for a cursor.
 248    *
 249    * @param[in] cursor Whether this color is for the primary or secondary cursor.
 250    * @param[in] color The color to use.
 251    */
 252   void SetCursorColor( Cursor cursor, const Dali::Vector4& color );
 253
 254   /**
 255    * @brief Retrieves the color for a cursor.
 256    *
 257    * @param[in] cursor Whether this color is for the primary or secondary cursor.
 258    * @return The cursor color.
 259    */
 260   const Dali::Vector4& GetColor( Cursor cursor ) const;
 261
 262   /**
 263    * @brief Start blinking the cursor; see also SetCursorBlinkDuration().
 264    */
 265   void StartCursorBlink();
 266
 267   /**
 268    * @brief Stop blinking the cursor.
 269    */
 270   void StopCursorBlink();
 271
 272   /**
 273    * @brief Set the interval between cursor blinks.
 274    *
 275    * @param[in] seconds The interval in seconds.
 276    */
 277   void SetCursorBlinkInterval( float seconds );
 278
 279   /**
 280    * @brief Retrieves the blink-interval for a cursor.
 281    *
 282    * @return The cursor blink-interval.
 283    */
 284   float GetCursorBlinkInterval() const;
 285
 286   /**
 287    * @brief The cursor will stop blinking after this duration.
 288    *
 289    * @param[in] seconds The duration in seconds.
 290    */
 291   void SetCursorBlinkDuration( float seconds );
 292
 293   /**
 294    * @brief Retrieves the blink-duration for a cursor.
 295    *
 296    * @return The cursor blink-duration.
 297    */
 298   float GetCursorBlinkDuration() const;
 299
 300   /**
 301    * @brief Sets the width of the cursors.
 302    *
 303    * @param[in] width The width of the cursor in pixels.
 304    */
 305   void SetCursorWidth( int width );
 306
 307   /**
 308    * @brief Retrieves the width of the cursors.
 309    *
 310    * @return The width of the cursors in pixels.
 311    */
 312   int GetCursorWidth() const;
 313
 314   /**
 315    * @brief Sets whether a handle is active.
 316    *
 317    * @param[in] handleType One of the handles.
 318    * @param[in] active True if the handle should be active.
 319    */
 320   void SetHandleActive( HandleType handleType,
 321                         bool active );
 322
 323   /**
 324    * @brief Query whether a handle is active.
 325    *
 326    * @param[in] handleType One of the handles.
 327    *
 328    * @return True if the handle is active.
 329    */
 330   bool IsHandleActive( HandleType handleType ) const;
 331
 332   /**
 333    * @brief Sets the image for one of the handles.
 334    *
 335    * @param[in] handleType One of the handles.
 336    * @param[in] handleImageType A different image can be set for the pressed/released states.
 337    * @param[in] image The image to use.
 338    */
 339   void SetHandleImage( HandleType handleType, HandleImageType handleImageType, Dali::Image image );
 340
 341   /**
 342    * @brief Retrieves the image for one of the handles.
 343    *
 344    * @param[in] handleType One of the handles.
 345    * @param[in] handleImageType A different image can be set for the pressed/released states.
 346    *
 347    * @return The grab handle image.
 348    */
 349   Dali::Image GetHandleImage( HandleType handleType, HandleImageType handleImageType ) const;
 350
 351   /**
 352    * @brief Sets the color of the handles
 353    *
 354    * @param[in] color The color to use.
 355    */
 356   void SetHandleColor( const Vector4& color );
 357
 358   /**
 359    * @brief Retrieves the handles color.
 360    *
 361    * @return The color of the handles.
 362    */
 363   const Vector4& GetHandleColor() const;
 364
 365   /**
 366    * @brief Sets the position of a selection handle.
 367    *
 368    * @param[in] handleType The handle to set.
 369    * @param[in] x The x position relative to the top-left of the parent control.
 370    * @param[in] y The y position relative to the top-left of the parent control.
 371    * @param[in] lineHeight The logical line height at this position.
 372    */
 373   void SetPosition( HandleType handleType, float x, float y, float lineHeight );
 374
 375   /**
 376    * @brief Retrieves the position of a selection handle.
 377    *
 378    * @param[in] handleType The handle to get.
 379    * @param[out] x The x position relative to the top-left of the parent control.
 380    * @param[out] y The y position relative to the top-left of the parent control.
 381    * @param[out] lineHeight The logical line height at this position.
 382    */
 383   void GetPosition( HandleType handleType, float& x, float& y, float& lineHeight ) const;
 384
 385   /**
 386    * @brief Retrieves the position of a selection handle.
 387    *
 388    * @param[in] handleType The handle to get.
 389    *
 390    * @return The position of the selection handle relative to the top-left of the parent control.
 391    */
 392   const Vector2& GetPosition( HandleType handleType ) const;
 393
 394   /**
 395    * @brief Swaps the selection handle's images.
 396    *
 397    * This method is called by the text controller to swap the handles
 398    * when the start index is bigger than the end one.
 399    */
 400   void SwapSelectionHandlesEnabled( bool enable );
 401
 402   /**
 403    * @brief Adds a quad to the existing selection highlights.
 404    *
 405    * @param[in] x1 The top-left x position.
 406    * @param[in] y1 The top-left y position.
 407    * @param[in] x2 The bottom-right x position.
 408    * @param[in] y3 The bottom-right y position.
 409    */
 410   void AddHighlight( float x1, float y1, float x2, float y2 );
 411
 412   /**
 413    * @brief Removes all of the previously added highlights.
 414    */
 415   void ClearHighlights();
 416
 417   /**
 418    * @brief Sets the selection highlight color.
 419    *
 420    * @param[in] color The color to use.
 421    */
 422   void SetHighlightColor( const Vector4& color );
 423
 424   /**
 425    * @brief Retrieves the selection highlight color.
 426    *
 427    * @return The color of the highlight
 428    */
 429   const Vector4& GetHighlightColor() const;
 430
 431   /**
 432    * @brief Sets into the decorator the depth used to render the text.
 433    *
 434    * @param[in] depth The text's depth.
 435    */
 436   void SetTextDepth( int textDepth );
 437
 438   /**
 439    * @brief Set the Selection Popup to show or hide via the active flaf
 440    * @param[in] active true to show, false to hide
 441    */
 442   void SetPopupActive( bool active );
 443
 444   /**
 445    * @brief Query whether the Selection Popup is active.
 446    *
 447    * @return True if the Selection Popup should be active.
 448    */
 449   bool IsPopupActive() const;
 450
 451   /**
 452    * @brief Set a bit mask of the buttons to be shown by Popup
 453    * @param[in] enabledButtonsBitMask from TextSelectionPopup::Buttons enum
 454    */
 455   void SetEnabledPopupButtons( TextSelectionPopup::Buttons& enabledButtonsBitMask );
 456
 457   /**
 458    * @brief Get the current bit mask of buttons to be shown by Popup
 459    * @return bitmask of TextSelectionPopup::Buttons
 460    */
 461   TextSelectionPopup::Buttons& GetEnabledPopupButtons();
 462
 463   /**
 464    * @brief Sets the scroll threshold.
 465    *
 466    * It defines a square area inside the control, close to the edge.
 467    * When the cursor enters this area, the decorator starts to send scroll events.
 468    *
 469    * @param[in] threshold The scroll threshold.
 470    */
 471   void SetScrollThreshold( float threshold );
 472
 473   /**
 474    * @brief Retrieves the scroll threshold.
 475    *
 476    * @retunr The scroll threshold.
 477    */
 478   float GetScrollThreshold() const;
 479
 480   /**
 481    * @brief Sets the scroll speed.
 482    *
 483    * Is the distance the text is going to be scrolled during a scroll interval.
 484    *
 485    * @param[in] speed The scroll speed.
 486    */
 487   void SetScrollSpeed( float speed );
 488
 489   /**
 490    * @brief Retrieves the scroll speed.
 491    *
 492    * @return The scroll speed.
 493    */
 494   float GetScrollSpeed() const;
 495
 496   /**
 497    * @brief Notifies the decorator the whole text has been scrolled.
 498    */
 499   void NotifyEndOfScroll();
 500
 501 protected:
 502
 503   /**
 504    * @brief A reference counted object may only be deleted by calling Unreference().
 505    */
 506   virtual ~Decorator();
 507
 508 private:
 509
 510   /**
 511    * @brief Private constructor.
 512    * @param[in] controller The controller which receives input events from Decorator components.
 513    * @param[in] callbackInterface The text popup callback interface which receives the button click callbacks.
 514    */
 515   Decorator( ControllerInterface& controller,
 516              TextSelectionPopupCallbackInterface& callbackInterface );
 517
 518   // Undefined
 519   Decorator( const Decorator& handle );
 520
 521   // Undefined
 522   Decorator& operator=( const Decorator& handle );
 523
 524 private:
 525
 526   struct Impl;
 527   Impl* mImpl;
 528 };
 529 } // namespace Text
 530
 531 } // namespace Toolkit
 532
 533 } // namespace Dali
 534
 535 #endif // __DALI_TOOLKIT_TEXT_DECORATOR_H__