Added some keyboard & cursor plumbing

[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / text / text-controller.h

diff --git a/dali-toolkit/internal/text/text-controller.h b/dali-toolkit/internal/text/text-controller.h
index 3fa7c60..640c2b4 100644 (file)
--- a/dali-toolkit/internal/text/text-controller.h
+++ b/dali-toolkit/internal/text/text-controller.h
@@ -18,17 +18,20 @@
  *
  */
 
-// INTERNAL INCLUDES
-#include <dali-toolkit/internal/text/decorator/text-decorator.h>
-#include <dali-toolkit/internal/text/text-control-interface.h>
-#include <dali-toolkit/internal/text/text-view.h>
-
 // EXTERNAL INCLUDES
+#include <string>
+#include <dali/public-api/common/dali-vector.h>
 #include <dali/public-api/common/intrusive-ptr.h>
+#include <dali/public-api/events/key-event.h>
 #include <dali/public-api/math/vector3.h>
 #include <dali/public-api/math/vector2.h>
 #include <dali/public-api/object/ref-object.h>
-#include <string>
+
+// INTERNAL INCLUDES
+#include <dali-toolkit/internal/text/decorator/text-decorator.h>
+#include <dali-toolkit/internal/text/font-run.h>
+#include <dali-toolkit/internal/text/text-control-interface.h>
+#include <dali-toolkit/internal/text/text-view.h>
 
 namespace Dali
 {
@@ -69,14 +72,16 @@ private:
     VALIDATE_FONTS     = 0x0004,
     GET_LINE_BREAKS    = 0x0008,
     GET_WORD_BREAKS    = 0x0010,
-    SHAPE_TEXT         = 0x0020,
-    GET_GLYPH_METRICS  = 0x0040,
-    LAYOUT             = 0x0080,
-    UPDATE_ACTUAL_SIZE = 0x0100,
-    UPDATE_POSITIONS   = 0x0200,
-    REORDER            = 0x0400,
-    ALIGNMENT          = 0x0800,
-    RENDER             = 0x1000,
+    BIDI_INFO          = 0x0020,
+    SHAPE_TEXT         = 0x0040,
+    GET_GLYPH_METRICS  = 0x0080,
+    LAYOUT             = 0x0100,
+    UPDATE_ACTUAL_SIZE = 0x0200,
+    UPDATE_POSITIONS   = 0x0400,
+    UPDATE_LINES       = 0x0800,
+    REORDER            = 0x1000,
+    ALIGNMENT          = 0x2000,
+    RENDER             = 0x4000,
     ALL_OPERATIONS     = 0xFFFF
   };
 
@@ -106,6 +111,20 @@ public:
   void GetText( std::string& text ) const;
 
   /**
+   * @brief Replaces any placeholder text previously set.
+   *
+   * @param[in] text A string of UTF-8 characters.
+   */
+  void SetPlaceholderText( const std::string& text );
+
+  /**
+   * @brief Retrieve any placeholder text previously set.
+   *
+   * @return A string of UTF-8 characters.
+   */
+  void GetPlaceholderText( std::string& text ) const;
+
+  /**
    * @brief Set the default font family.
    *
    * @param[in] defaultFontFamily The default font family.
@@ -117,7 +136,7 @@ public:
    *
    * @return The default font family.
    */
-   const std::string& GetDefaultFontFamily() const;
+  const std::string& GetDefaultFontFamily() const;
 
   /**
    * @brief Set the default font style.
@@ -131,7 +150,7 @@ public:
    *
    * @return The default font style.
    */
-   const std::string& GetDefaultFontStyle() const;
+  const std::string& GetDefaultFontStyle() const;
 
   /**
    * @brief Set the default point size.
@@ -145,7 +164,15 @@ public:
    *
    * @return The default point size.
    */
-   float GetDefaultPointSize() const;
+  float GetDefaultPointSize() const;
+
+  /**
+   * @brief Retrieve the default fonts.
+   *
+   * @param[out] fonts The default font family, style and point sizes.
+   * @param[in] numberOfCharacters The number of characters in the logical model.
+   */
+  void GetDefaultFonts( Dali::Vector<FontRun>& fonts, Length numberOfCharacters );
 
   /**
    * @brief Called to enable text input.
@@ -156,6 +183,21 @@ public:
   void EnableTextInput( DecoratorPtr decorator );
 
   /**
+   * @brief Called to enable/disable cursor blink.
+   *
+   * @note Only editable controls should calls this.
+   * @param[in] enabled Whether the cursor should blink or not.
+   */
+  void SetEnableCursorBlink( bool enable );
+
+  /**
+   * @brief Query whether cursor blink is enabled.
+   *
+   * @return Whether the cursor should blink or not.
+   */
+  bool GetEnableCursorBlink() const;
+
+  /**
    * @brief Triggers a relayout which updates View (if necessary).
    *
    * @note UI Controls are expected to minimize calls to this method e.g. call once after size negotiation.
@@ -171,8 +213,11 @@ public:
    *
    * @param[in] size A the size of a bounding box to layout text within.
    * @param[in] operations The layout operations which need to be done.
+   * @param[out] layoutSize The size of the laid-out text.
    */
-  bool DoRelayout( const Vector2& size, OperationsMask operations );
+  bool DoRelayout( const Vector2& size,
+                   OperationsMask operations,
+                   Size& layoutSize );
 
   /**
    * @copydoc Control::GetNaturalSize()
@@ -209,6 +254,13 @@ public:
   void KeyboardFocusLostEvent();
 
   /**
+   * @brief Caller by editable UI controls when key events are received.
+   *
+   * @param[in] event The key event.
+   */
+  bool KeyEvent( const Dali::KeyEvent& event );
+
+  /**
    * @brief Caller by editable UI controls when a tap gesture occurs.
    * @param[in] tapCount The number of taps.
    * @param[in] x The x position relative to the top-left of the parent control.