Merge branch 'tizen' into new_text
[platform/core/uifw/dali-toolkit.git] / base / dali-toolkit / internal / controls / text-input / text-input-impl.h
index d38b7cb..76160de 100644 (file)
  *
  */
 
+// EXTERNAL INCLUDES
+#include <dali/public-api/actors/mesh-actor.h>
+#include <dali/public-api/adaptor-framework/clipboard.h>
+#include <dali/public-api/adaptor-framework/clipboard-event-notifier.h>
+#include <dali/public-api/adaptor-framework/imf-manager.h>
+#include <dali/public-api/adaptor-framework/timer.h>
+#include <dali/public-api/common/dali-vector.h>
+#include <dali/public-api/geometry/mesh.h>
+
 // INTERNAL INCLUDES
 #include <dali-toolkit/public-api/controls/control-impl.h>
 #include <dali-toolkit/public-api/controls/text-input/text-input.h>
 #include <dali-toolkit/public-api/controls/buttons/push-button.h>
 #include <dali-toolkit/internal/controls/text-input/text-input-popup-impl.h>
 
-#include <dali/public-api/common/dali-vector.h>
-#include <dali/public-api/adaptor-framework/common/imf-manager.h>
-#include <dali/public-api/geometry/mesh.h>
-
 namespace Dali
 {
 
@@ -616,7 +621,7 @@ private:
     * @param actor Handle of the selection or grab handle.
     * @param gesture Data structure with the parameters of the gesture.
     */
-   void OnHandlePan(Actor actor, PanGesture gesture);
+   void OnHandlePan(Actor actor, const PanGesture& gesture);
 
    /**
     * Callback for touch down on Grab handle
@@ -644,21 +649,21 @@ private:
     * @param[in] actor
     * @param[in] tap touch event
     */
-   void OnTextTap(Dali::Actor actor, Dali::TapGesture tap);
+   void OnTextTap(Dali::Actor actor, const Dali::TapGesture& tap);
 
    /**
     * Callback for double tap on TextInput
     * @param[in] actor
     * @param[in] tap touch event
     */
-   void OnDoubleTap(Dali::Actor actor, Dali::TapGesture tap);
+   void OnDoubleTap(Dali::Actor actor, const Dali::TapGesture& tap);
 
     /**
      * Callback for long press on TextInput
      * @param[in] actor
      * @param[in] longPress long press event
      */
-   void OnLongPress(Dali::Actor actor, Dali::LongPressGesture longPress);
+   void OnLongPress(Dali::Actor actor, const Dali::LongPressGesture& longPress);
 
    /**
     * Callback for the ClipboardEventNotifier when text is selected in the clipboard window.
@@ -703,6 +708,22 @@ private:
    bool OnKeyUpEvent(const KeyEvent& event);
 
    /**
+    * Chooses from all handle position and alternative handle positions where to set the position of the two selection handles.
+    *
+    * @param[in] cursorPositionOne The initial position of the first selection handle.
+    * @param[in] cursorPositionTwo The initial position of the second selection handle.
+    * @param[in] altPositionValidOne Whether there is an alternative position for the first selection handle.
+    * @param[in] altPositionValidTwo Whether there is an alternative position for the second selection handle.
+    * @param[in] altPositionOne The alternative position of the first selection handle.
+    * @param[in] altPositionTwo The alternative position of the second selection handle.
+    */
+   void ChooseRtlSelectionHandlePosition( const Vector3& cursorPositionOne,
+                                          const Vector3& cursorPositionTwo,
+                                          bool altPositionValidOne,
+                                          bool altPositionValidTwo,
+                                          const Vector3& altPositionOne,
+                                          const Vector3& altPositionTwo );
+   /**
     * Callback called when the text-view is scrolled.
     *
     * Updates the selection and grab handles, and the highlighted text.
@@ -866,12 +887,11 @@ public:  // Public to allow internal testing.
   std::size_t InsertAt( const Text& newText, const std::size_t insertionPosition, const std::size_t numberOfCharactersToReplace );
 
   /**
-   * Creates a cursor from the supplied image
-   * @param[in] cursorImage the image to be used for the cursor.
-   * @param[in] border the nine patch border corresponding to the supplied image.
-   * @return the image actor to be used as the cursor.
-   */
-  ImageActor CreateCursor( Image cursorImage, const Vector4& border );
+  * Creates a cursor.
+  * @param[in] color the cursor color.
+  * @return the image actor to be used as the cursor.
+  */
+  ImageActor CreateCursor( const Vector4 &color );
 
   /**
    * Moves cursor to the right
@@ -882,9 +902,8 @@ public:  // Public to allow internal testing.
 
   /**
    * Draw a cursor / caret at position where new text should appear
-   * @param[in] nthChar the position along the text string in which new text should appear.
    */
-  void DrawCursor(const std::size_t nthChar = 0);
+  void DrawCursor();
 
   /**
    * Sets cursor visibility
@@ -1019,15 +1038,6 @@ public:  // Public to allow internal testing.
   void SetSelectionHandlePosition(SelectionHandleId handleId);
 
   /**
-   * Gets the visual position of a logical position.
-   * @note This is preferred over directly accessing the Map, as it resolves visual
-   * positions outside of the character map range.
-   * @param[in] logicalPosition The logical position
-   * @return Visual position is returned.
-   */
-  std::size_t GetVisualPosition(std::size_t logicalPosition) const;
-
-  /**
    * Gets a table of the visual text positions which has a flag
    * for each Character. The flag is either true (character selected)
    * or false (character deselected)
@@ -1045,6 +1055,11 @@ public:  // Public to allow internal testing.
   HighlightInfo CalculateHighlightInfo();
 
   /**
+   * This method was added to fix a PLM. it creates one quad per character so the mesh can show different selection boxes when a mix of right to left and left to right text is selected.
+   */
+  HighlightInfo CalculateHighlightInfoRtl();
+
+  /**
    * Calculates new Mesh data so highlight moves with selection handles.
    */
   void UpdateHighlight();
@@ -1086,8 +1101,10 @@ public:  // Public to allow internal testing.
 
   /**
    * Setup the selection popup and clipboard if relevant so the correct options are shown when ShowPopup is called.
+   * @param[in] showCutButton Flag to show or hide cut button, in some cases like whitespace we do not want to cut just select.
+   * default is true.
    */
-  void SetUpPopupSelection();
+  void SetUpPopupSelection( bool showCutButton = true );
 
   /**
    * Return the logical index containing the character position closest to the source.
@@ -1154,6 +1171,15 @@ public:  // Public to allow internal testing.
   std::size_t GetRowStartFromCharacterPosition(std::size_t logicalPosition) const;
 
   /**
+   * Retrieves the first character of a group of characters with the same direction.
+   *
+   * @param[in] logicalPosition Index to a character.
+   *
+   * @return Index to the character.
+   */
+  std::size_t GetFirstCharacterWithSameDirection( std::size_t logicalPosition ) const;
+
+  /**
    * Retrieve the dimensions of this row of text that the character resides on.
    * @param[in] characterPosition the position in the 'string' of characters.
    * @return The size of the rectangle representing this row
@@ -1220,8 +1246,9 @@ public:  // Public to allow internal testing.
 
   /**
    * Hide highlight shown between selection handles.
+   * @param[in] hidePopup flag to hide the popup too, default is to hide popup.
    */
-  void RemoveHighlight();
+  void RemoveHighlight( bool hidePopup = true );
 
   /**
    * Highlights text that has been selected
@@ -1346,6 +1373,12 @@ public:  // Public to allow internal testing.
    */
   const Vector4& GetOffsetFromText() const;
 
+  /**
+   * Show the Placeholder text with an already created StyleTextArray
+   * @param[in] stylePlaceHolderText Required placeholder text to be used
+   */
+  void ShowPlaceholderText( const MarkupProcessor::StyledTextArray& stylePlaceHolderText );
+
   // Properties
 
   /**