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/key-event.h>
  26 #include <dali/public-api/math/vector3.h>
  27 #include <dali/public-api/math/vector2.h>
  28 #include <dali/public-api/object/ref-object.h>
  29
  30 // INTERNAL INCLUDES
  31 #include <dali-toolkit/internal/text/decorator/text-decorator.h>
  32 #include <dali-toolkit/internal/text/font-run.h>
  33 #include <dali-toolkit/internal/text/text-control-interface.h>
  34 #include <dali-toolkit/internal/text/text-view.h>
  35
  36 namespace Dali
  37 {
  38
  39 namespace Toolkit
  40 {
  41
  42 namespace Text
  43 {
  44
  45 class Controller;
  46 class LayoutEngine;
  47
  48 typedef IntrusivePtr<Controller> ControllerPtr;
  49 typedef Dali::Toolkit::Text::ControlInterface ControlInterface;
  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 an observer interface.
  59  */
  60 class Controller : public RefObject, public Decorator::Observer
  61 {
  62 private:
  63
  64   /**
  65    * @brief Text related operations to be done in the relayout process.
  66    */
  67   enum OperationsMask
  68   {
  69     NO_OPERATION       = 0x0000,
  70     CONVERT_TO_UTF32   = 0x0001,
  71     GET_SCRIPTS        = 0x0002,
  72     VALIDATE_FONTS     = 0x0004,
  73     GET_LINE_BREAKS    = 0x0008,
  74     GET_WORD_BREAKS    = 0x0010,
  75     BIDI_INFO          = 0x0020,
  76     SHAPE_TEXT         = 0x0040,
  77     GET_GLYPH_METRICS  = 0x0080,
  78     LAYOUT             = 0x0100,
  79     UPDATE_ACTUAL_SIZE = 0x0200,
  80     REORDER            = 0x0400,
  81     ALIGN              = 0x0800,
  82     ALL_OPERATIONS     = 0xFFFF
  83   };
  84
  85 public:
  86
  87   /**
  88    * @brief Create a new instance of a Controller.
  89    *
  90    * @param[in] controlInterface An interface used to request a text relayout.
  91    * @return A pointer to a new Controller.
  92    */
  93   static ControllerPtr New( ControlInterface& controlInterface );
  94
  95   /**
  96    * @brief Replaces any text previously set.
  97    *
  98    * @note This will be converted into UTF-32 when stored in the text model.
  99    * @param[in] text A string of UTF-8 characters.
 100    */
 101   void SetText( const std::string& text );
 102
 103   /**
 104    * @brief Retrieve any text previously set.
 105    *
 106    * @return A string of UTF-8 characters.
 107    */
 108   void GetText( std::string& text ) const;
 109
 110   /**
 111    * @brief Replaces any placeholder text previously set.
 112    *
 113    * @param[in] text A string of UTF-8 characters.
 114    */
 115   void SetPlaceholderText( const std::string& text );
 116
 117   /**
 118    * @brief Retrieve any placeholder text previously set.
 119    *
 120    * @return A string of UTF-8 characters.
 121    */
 122   void GetPlaceholderText( std::string& text ) const;
 123
 124   /**
 125    * @brief Set the default font family.
 126    *
 127    * @param[in] defaultFontFamily The default font family.
 128    */
 129   void SetDefaultFontFamily( const std::string& defaultFontFamily );
 130
 131   /**
 132    * @brief Retrieve the default font family.
 133    *
 134    * @return The default font family.
 135    */
 136   const std::string& GetDefaultFontFamily() const;
 137
 138   /**
 139    * @brief Set the default font style.
 140    *
 141    * @param[in] defaultFontStyle The default font style.
 142    */
 143   void SetDefaultFontStyle( const std::string& defaultFontStyle );
 144
 145   /**
 146    * @brief Retrieve the default font style.
 147    *
 148    * @return The default font style.
 149    */
 150   const std::string& GetDefaultFontStyle() const;
 151
 152   /**
 153    * @brief Set the default point size.
 154    *
 155    * @param[in] defaultFontStyle The default point size.
 156    */
 157   void SetDefaultPointSize( float pointSize );
 158
 159   /**
 160    * @brief Retrieve the default point size.
 161    *
 162    * @return The default point size.
 163    */
 164   float GetDefaultPointSize() const;
 165
 166   /**
 167    * @brief Retrieve the default fonts.
 168    *
 169    * @param[out] fonts The default font family, style and point sizes.
 170    * @param[in] numberOfCharacters The number of characters in the logical model.
 171    */
 172   void GetDefaultFonts( Dali::Vector<FontRun>& fonts, Length numberOfCharacters );
 173
 174   /**
 175    * @brief Called to enable text input.
 176    *
 177    * @note Only selectable or editable controls should calls this.
 178    * @param[in] decorator Used to create cursor, selection handle decorations etc.
 179    */
 180   void EnableTextInput( DecoratorPtr decorator );
 181
 182   /**
 183    * @brief Called to enable/disable cursor blink.
 184    *
 185    * @note Only editable controls should calls this.
 186    * @param[in] enabled Whether the cursor should blink or not.
 187    */
 188   void SetEnableCursorBlink( bool enable );
 189
 190   /**
 191    * @brief Query whether cursor blink is enabled.
 192    *
 193    * @return Whether the cursor should blink or not.
 194    */
 195   bool GetEnableCursorBlink() const;
 196
 197   /**
 198    * @copydoc Control::GetNaturalSize()
 199    */
 200   Vector3 GetNaturalSize();
 201
 202   /**
 203    * @copydoc Control::GetHeightForWidth()
 204    */
 205   float GetHeightForWidth( float width );
 206
 207   /**
 208    * @brief Triggers a relayout which updates View (if necessary).
 209    *
 210    * @note UI Controls are expected to minimize calls to this method e.g. call once after size negotiation.
 211    * @param[in] size A the size of a bounding box to layout text within.
 212    * @return True if the text model or decorations were updated.
 213    */
 214   bool Relayout( const Vector2& size );
 215
 216   /**
 217    * @brief Process queued events which modify the model.
 218    */
 219   void ProcessModifyEvents();
 220
 221   /**
 222    * @brief Used to process an event queued from SetText()
 223    *
 224    * @param[in] newText The new text to store in the logical model.
 225    */
 226   void ReplaceTextEvent( const std::string& newText );
 227
 228   /**
 229    * @brief Used to process an event queued from key events etc.
 230    *
 231    * @param[in] text The text to insert into the logical model.
 232    */
 233   void InsertTextEvent( const std::string& text );
 234
 235   /**
 236    * @brief Used to process an event queued from backspace key etc.
 237    */
 238   void DeleteTextEvent();
 239
 240   /**
 241    * @brief Update the model following text replace/insert etc.
 242    *
 243    * @param[in] operationsRequired The layout operations which need to be done.
 244    */
 245   void UpdateModel( OperationsMask operationsRequired );
 246
 247   /**
 248    * @brief Lays-out the text.
 249    *
 250    * GetNaturalSize(), GetHeightForWidth() and Relayout() calls this method.
 251    *
 252    * @param[in] size A the size of a bounding box to layout text within.
 253    * @param[in] operations The layout operations which need to be done.
 254    * @param[out] layoutSize The size of the laid-out text.
 255    */
 256   bool DoRelayout( const Vector2& size,
 257                    OperationsMask operations,
 258                    Size& layoutSize );
 259
 260   /**
 261    * @brief Return the layout engine.
 262    *
 263    * @return A reference to the layout engine.
 264    */
 265   LayoutEngine& GetLayoutEngine();
 266
 267   /**
 268    * @brief Return a view of the text.
 269    *
 270    * @return A reference to the view.
 271    */
 272   View& GetView();
 273
 274   // Text-input Event Queuing
 275
 276   /**
 277    * @brief Caller by editable UI controls when keyboard focus is gained.
 278    */
 279   void KeyboardFocusGainEvent();
 280
 281   /**
 282    * @brief Caller by editable UI controls when focus is lost.
 283    */
 284   void KeyboardFocusLostEvent();
 285
 286   /**
 287    * @brief Caller by editable UI controls when key events are received.
 288    *
 289    * @param[in] event The key event.
 290    */
 291   bool KeyEvent( const Dali::KeyEvent& event );
 292
 293   /**
 294    * @brief Caller by editable UI controls when a tap gesture occurs.
 295    * @param[in] tapCount The number of taps.
 296    * @param[in] x The x position relative to the top-left of the parent control.
 297    * @param[in] y The y position relative to the top-left of the parent control.
 298    */
 299   void TapEvent( unsigned int tapCount, float x, float y );
 300
 301   /**
 302    * @copydoc Dali::Toolkit::Text::Decorator::Observer::GrabHandleEvent()
 303    */
 304   virtual void GrabHandleEvent( GrabHandleState state, float x, float y );
 305
 306 protected:
 307
 308   /**
 309    * @brief A reference counted object may only be deleted by calling Unreference().
 310    */
 311   virtual ~Controller();
 312
 313 private:
 314
 315   /**
 316    * @brief Request a relayout using the ControlInterface.
 317    */
 318   void RequestRelayout();
 319
 320   /**
 321    * @brief Private constructor.
 322    */
 323   Controller( ControlInterface& controlInterface );
 324
 325   // Undefined
 326   Controller( const Controller& handle );
 327
 328   // Undefined
 329   Controller& operator=( const Controller& handle );
 330
 331 private:
 332
 333   struct Impl;
 334   Impl* mImpl;
 335
 336   // Avoid allocating this when the user does not specify a font
 337   struct FontDefaults;
 338
 339   // Avoid allocating this for non-editable controls
 340   struct TextInput;
 341 };
 342
 343 } // namespace Text
 344
 345 } // namespace Toolkit
 346
 347 } // namespace Dali
 348
 349 #endif // __DALI_TOOLKIT_TEXT_CONTROLLER_H__