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) 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 <string>
  23 #include <dali/public-api/common/dali-vector.h>
  24 #include <dali/public-api/common/intrusive-ptr.h>
  25 #include <dali/public-api/events/gesture.h>
  26 #include <dali/public-api/events/key-event.h>
  27 #include <dali/public-api/math/vector3.h>
  28 #include <dali/public-api/math/vector2.h>
  29 #include <dali/public-api/object/ref-object.h>
  30
  31 // INTERNAL INCLUDES
  32 #include <dali-toolkit/internal/text/decorator/text-decorator.h>
  33 #include <dali-toolkit/internal/text/font-run.h>
  34 #include <dali-toolkit/internal/text/text-control-interface.h>
  35 #include <dali-toolkit/internal/text/text-view.h>
  36
  37 namespace Dali
  38 {
  39
  40 namespace Toolkit
  41 {
  42
  43 namespace Text
  44 {
  45
  46 class Controller;
  47 class LayoutEngine;
  48
  49 typedef IntrusivePtr<Controller> ControllerPtr;
  50 typedef Dali::Toolkit::Text::ControlInterface ControlInterface;
  51
  52 /**
  53  * @brief A Text Controller is used by UI Controls which display text.
  54  *
  55  * It manipulates the Logical & Visual text models on behalf of the UI Controls.
  56  * It provides a view of the text that can be used by rendering back-ends.
  57  *
  58  * For selectable/editable UI controls, the controller handles input events from the UI control
  59  * and decorations (grab handles etc) via an observer interface.
  60  */
  61 class Controller : public RefObject, public Decorator::Observer
  62 {
  63 private:
  64
  65   /**
  66    * @brief Text related operations to be done in the relayout process.
  67    */
  68   enum OperationsMask
  69   {
  70     NO_OPERATION       = 0x0000,
  71     CONVERT_TO_UTF32   = 0x0001,
  72     GET_SCRIPTS        = 0x0002,
  73     VALIDATE_FONTS     = 0x0004,
  74     GET_LINE_BREAKS    = 0x0008,
  75     GET_WORD_BREAKS    = 0x0010,
  76     BIDI_INFO          = 0x0020,
  77     SHAPE_TEXT         = 0x0040,
  78     GET_GLYPH_METRICS  = 0x0080,
  79     LAYOUT             = 0x0100,
  80     UPDATE_ACTUAL_SIZE = 0x0200,
  81     REORDER            = 0x0400,
  82     ALIGN              = 0x0800,
  83     ALL_OPERATIONS     = 0xFFFF
  84   };
  85
  86 public:
  87
  88   /**
  89    * @brief Create a new instance of a Controller.
  90    *
  91    * @param[in] controlInterface An interface used to request a text relayout.
  92    * @return A pointer to a new Controller.
  93    */
  94   static ControllerPtr New( ControlInterface& controlInterface );
  95
  96   /**
  97    * @brief Replaces any text previously set.
  98    *
  99    * @note This will be converted into UTF-32 when stored in the text model.
 100    * @param[in] text A string of UTF-8 characters.
 101    */
 102   void SetText( const std::string& text );
 103
 104   /**
 105    * @brief Retrieve any text previously set.
 106    *
 107    * @return A string of UTF-8 characters.
 108    */
 109   void GetText( std::string& text ) const;
 110
 111   /**
 112    * @brief Replaces any placeholder text previously set.
 113    *
 114    * @param[in] text A string of UTF-8 characters.
 115    */
 116   void SetPlaceholderText( const std::string& text );
 117
 118   /**
 119    * @brief Retrieve any placeholder text previously set.
 120    *
 121    * @return A string of UTF-8 characters.
 122    */
 123   void GetPlaceholderText( std::string& text ) const;
 124
 125   /**
 126    * @brief Set the default font family.
 127    *
 128    * @param[in] defaultFontFamily The default font family.
 129    */
 130   void SetDefaultFontFamily( const std::string& defaultFontFamily );
 131
 132   /**
 133    * @brief Retrieve the default font family.
 134    *
 135    * @return The default font family.
 136    */
 137   const std::string& GetDefaultFontFamily() const;
 138
 139   /**
 140    * @brief Set the default font style.
 141    *
 142    * @param[in] defaultFontStyle The default font style.
 143    */
 144   void SetDefaultFontStyle( const std::string& defaultFontStyle );
 145
 146   /**
 147    * @brief Retrieve the default font style.
 148    *
 149    * @return The default font style.
 150    */
 151   const std::string& GetDefaultFontStyle() const;
 152
 153   /**
 154    * @brief Set the default point size.
 155    *
 156    * @param[in] defaultFontStyle The default point size.
 157    */
 158   void SetDefaultPointSize( float pointSize );
 159
 160   /**
 161    * @brief Retrieve the default point size.
 162    *
 163    * @return The default point size.
 164    */
 165   float GetDefaultPointSize() const;
 166
 167   /**
 168    * @brief Retrieve the default fonts.
 169    *
 170    * @param[out] fonts The default font family, style and point sizes.
 171    * @param[in] numberOfCharacters The number of characters in the logical model.
 172    */
 173   void GetDefaultFonts( Dali::Vector<FontRun>& fonts, Length numberOfCharacters ) const;
 174
 175   /**
 176    * @brief Set the text color
 177    *
 178    * @param textColor The text color
 179    */
 180   void SetTextColor( const Vector4& textColor );
 181
 182   /**
 183    * @brief Retrieve the text color
 184    *
 185    * @return The text color
 186    */
 187   const Vector4& GetTextColor() const;
 188
 189   /**
 190    * @brief Set the shadow offset.
 191    *
 192    * @param[in] shadowOffset The shadow offset, 0,0 indicates no shadow.
 193    */
 194   void SetShadowOffset( const Vector2& shadowOffset );
 195
 196   /**
 197    * @brief Retrieve the shadow offset.
 198    *
 199    * @return The shadow offset.
 200    */
 201   const Vector2& GetShadowOffset() const;
 202
 203   /**
 204    * @brief Set the shadow color.
 205    *
 206    * @param[in] shadowColor The shadow color.
 207    */
 208   void SetShadowColor( const Vector4& shadowColor );
 209
 210   /**
 211    * @brief Retrieve the shadow color.
 212    *
 213    * @return The shadow color.
 214    */
 215   const Vector4& GetShadowColor() const;
 216
 217   /**
 218    * @brief Set the underline color.
 219    *
 220    * @param[in] color color of underline.
 221    */
 222   void SetUnderlineColor( const Vector4& color );
 223
 224   /**
 225    * @brief Retrieve the underline color.
 226    *
 227    * @return The underline color.
 228    */
 229   const Vector4& GetUnderlineColor() const;
 230
 231   /**
 232    * @brief Set the underline enabled flag.
 233    *
 234    * @param[in] enabled The underline enabled flag.
 235    */
 236   void SetUnderlineEnabled( bool enabled );
 237
 238   /**
 239    * @brief Returns whether the text is underlined or not.
 240    *
 241    * @return The underline state.
 242    */
 243   bool IsUnderlineEnabled() const;
 244
 245   /**
 246    * @brief Called to enable text input.
 247    *
 248    * @note Only selectable or editable controls should calls this.
 249    * @param[in] decorator Used to create cursor, selection handle decorations etc.
 250    */
 251   void EnableTextInput( DecoratorPtr decorator );
 252
 253   /**
 254    * @brief Called to enable/disable cursor blink.
 255    *
 256    * @note Only editable controls should calls this.
 257    * @param[in] enabled Whether the cursor should blink or not.
 258    */
 259   void SetEnableCursorBlink( bool enable );
 260
 261   /**
 262    * @brief Query whether cursor blink is enabled.
 263    *
 264    * @return Whether the cursor should blink or not.
 265    */
 266   bool GetEnableCursorBlink() const;
 267
 268   /**
 269    * @brief Query the current scroll position; the UI control is responsible for moving actors to this position.
 270    *
 271    * @return The scroll position.
 272    */
 273   const Vector2& GetScrollPosition() const;
 274
 275   /**
 276    * @brief Query the alignment offset.
 277    *
 278    * @return The alignmnet offset.
 279    */
 280   const Vector2& GetAlignmentOffset() const;
 281
 282   /**
 283    * @copydoc Control::GetNaturalSize()
 284    */
 285   Vector3 GetNaturalSize();
 286
 287   /**
 288    * @copydoc Control::GetHeightForWidth()
 289    */
 290   float GetHeightForWidth( float width );
 291
 292   /**
 293    * @brief Triggers a relayout which updates View (if necessary).
 294    *
 295    * @note UI Controls are expected to minimize calls to this method e.g. call once after size negotiation.
 296    * @param[in] size A the size of a bounding box to layout text within.
 297    * @return True if the text model or decorations were updated.
 298    */
 299   bool Relayout( const Size& size );
 300
 301   /**
 302    * @brief Process queued events which modify the model.
 303    */
 304   void ProcessModifyEvents();
 305
 306   /**
 307    * @brief Used to process an event queued from SetText()
 308    *
 309    * @param[in] newText The new text to store in the logical model.
 310    */
 311   void ReplaceTextEvent( const std::string& newText );
 312
 313   /**
 314    * @brief Used to process an event queued from key events etc.
 315    *
 316    * @param[in] text The text to insert into the logical model.
 317    */
 318   void InsertTextEvent( const std::string& text );
 319
 320   /**
 321    * @brief Used to process an event queued from backspace key etc.
 322    */
 323   void DeleteTextEvent();
 324
 325   /**
 326    * @brief Update the model following text replace/insert etc.
 327    *
 328    * @param[in] operationsRequired The layout operations which need to be done.
 329    */
 330   void UpdateModel( OperationsMask operationsRequired );
 331
 332   /**
 333    * @brief Lays-out the text.
 334    *
 335    * GetNaturalSize(), GetHeightForWidth() and Relayout() calls this method.
 336    *
 337    * @param[in] size A the size of a bounding box to layout text within.
 338    * @param[in] operations The layout operations which need to be done.
 339    * @param[out] layoutSize The size of the laid-out text.
 340    */
 341   bool DoRelayout( const Size& size,
 342                    OperationsMask operations,
 343                    Size& layoutSize );
 344
 345   /**
 346    * @brief Calulates the alignment of the whole text inside the bounding box.
 347    *
 348    * @param[in] size The size of the bounding box.
 349    */
 350   void CalculateTextAlignment( const Size& size );
 351
 352   /**
 353    * @brief Return the layout engine.
 354    *
 355    * @return A reference to the layout engine.
 356    */
 357   LayoutEngine& GetLayoutEngine();
 358
 359   /**
 360    * @brief Return a view of the text.
 361    *
 362    * @return A reference to the view.
 363    */
 364   View& GetView();
 365
 366   // Text-input Event Queuing
 367
 368   /**
 369    * @brief Caller by editable UI controls when keyboard focus is gained.
 370    */
 371   void KeyboardFocusGainEvent();
 372
 373   /**
 374    * @brief Caller by editable UI controls when focus is lost.
 375    */
 376   void KeyboardFocusLostEvent();
 377
 378   /**
 379    * @brief Caller by editable UI controls when key events are received.
 380    *
 381    * @param[in] event The key event.
 382    */
 383   bool KeyEvent( const Dali::KeyEvent& event );
 384
 385   /**
 386    * @brief Caller by editable UI controls when a tap gesture occurs.
 387    * @param[in] tapCount The number of taps.
 388    * @param[in] x The x position relative to the top-left of the parent control.
 389    * @param[in] y The y position relative to the top-left of the parent control.
 390    */
 391   void TapEvent( unsigned int tapCount, float x, float y );
 392
 393   /**
 394    * @brief Caller by editable UI controls when a pan gesture occurs.
 395    *
 396    * @param[in] state The state of the gesture.
 397    * @param[in] displacement This distance panned since the last pan gesture.
 398    */
 399   void PanEvent( Gesture::State state, const Vector2& displacement );
 400
 401   /**
 402    * @copydoc Dali::Toolkit::Text::Decorator::Observer::GrabHandleEvent()
 403    */
 404   virtual void GrabHandleEvent( GrabHandleState state, float x, float y );
 405
 406 protected:
 407
 408   /**
 409    * @brief A reference counted object may only be deleted by calling Unreference().
 410    */
 411   virtual ~Controller();
 412
 413 private:
 414
 415   /**
 416    * @brief Request a relayout using the ControlInterface.
 417    */
 418   void RequestRelayout();
 419
 420   /**
 421    * @brief Private constructor.
 422    */
 423   Controller( ControlInterface& controlInterface );
 424
 425   // Undefined
 426   Controller( const Controller& handle );
 427
 428   // Undefined
 429   Controller& operator=( const Controller& handle );
 430
 431 private:
 432
 433   struct Impl;
 434   Impl* mImpl;
 435
 436   // Avoid allocating this when the user does not specify a font
 437   struct FontDefaults;
 438
 439   // Avoid allocating this for non-editable controls
 440   struct TextInput;
 441 };
 442
 443 } // namespace Text
 444
 445 } // namespace Toolkit
 446
 447 } // namespace Dali
 448
 449 #endif // __DALI_TOOLKIT_TEXT_CONTROLLER_H__