Text cursor: add interface and implement in Canvas.Text

1 files changed, 212 insertions, 0 deletions

diff --git a/src/lib/efl/interfaces/efl_text_cursor.eo b/src/lib/efl/interfaces/efl_text_cursor.eo
new file mode 100644
index 0000000000..c2aeb3b022
--- /dev/null
+++ b/src/lib/efl/interfaces/efl_text_cursor.eo
@@ -0,0 +1,212 @@
+import eina_types;
+import efl_text_types;
+
+interface Efl.Text.Cursor {
+   [[Cursor API
+
+     @since 1.20
+   ]]
+   methods {
+      // Cursor
+      @property cursor {
+         [[The object's main cursor.
+
+           @since 1.18
+         ]]
+         get {
+            legacy: null;
+            return: ptr(Efl.Text.Cursor.Cursor_Data); [[Text cursor object]]
+         }
+      }
+      @property cursor_position {
+         set { legacy: null; }
+         get { legacy: null; }
+         values {
+            position: int;
+         }
+         keys {
+            cur: ptr(Efl.Text.Cursor.Cursor_Data);
+         }
+      }
+      @property cursor_content {
+         [[The content of the cursor (the character under the cursor)]]
+         get {
+            legacy: null;
+         }
+         values {
+            content: Eina.Unicode; [[The unicode codepoint of the character]]
+         }
+         keys {
+            cur: ptr(const(Efl.Text.Cursor.Cursor_Data));
+         }
+      }
+      @property cursor_geometry {
+         [[Returns the geometry of two cursors ("split cursor"), if logical cursor is
+           between LTR/RTL text, also considering paragraph direction.
+           Upper cursor is shown for the text of the same direction as paragraph,
+           lower cursor - for opposite.
+
+           Split cursor geometry is valid only  in '|' cursor mode.
+           In this case $true is returned and $cx2, $cy2, $cw2, $ch2 are set.
+         ]]
+         get {
+            legacy: null;
+            return: bool; [[ $true if split cursor, $false otherwise.]]
+         }
+         keys {
+            cur: ptr(const(Efl.Text.Cursor.Cursor_Data));
+            ctype: Efl.Text.Cursor.Cursor_Type; [[The type of the cursor.]]
+         }
+         values {
+            cx: int; [[The x of the cursor (or upper cursor)]]
+            cy: int; [[The y of the cursor (or upper cursor)]]
+            cw: int; [[The width of the cursor (or upper cursor)]]
+            ch: int; [[The height of the cursor (or upper cursor)]]
+            cx2: int; [[The x of the lower cursor]]
+            cy2: int; [[The y of the lower cursor]]
+            cw2: int; [[The width of the lower cursor]]
+            ch2: int; [[The height of the lower cursor]]
+         }
+      }
+      cursor_new {
+         legacy: null;
+         return: ptr(Efl.Text.Cursor.Cursor_Data);
+      }
+      cursor_free {
+         legacy: null;
+         params {
+            cur: ptr(Efl.Text.Cursor.Cursor_Data);
+         }
+      }
+      cursor_equal {
+         legacy: null;
+         params {
+            cur1: ptr(const(Efl.Text.Cursor.Cursor_Data));
+            cur2: ptr(const(Efl.Text.Cursor.Cursor_Data));
+         }
+         return: bool;
+      }
+      cursor_compare {
+         legacy: null;
+         params {
+            cur1: ptr(const(Efl.Text.Cursor.Cursor_Data));
+            cur2: ptr(const(Efl.Text.Cursor.Cursor_Data));
+         }
+         return: int;
+      }
+      cursor_copy {
+         legacy: null;
+         params {
+            dst: ptr(Efl.Text.Cursor.Cursor_Data);
+            src: ptr(const(Efl.Text.Cursor.Cursor_Data));
+         }
+      }
+      cursor_char_next {
+         legacy: null;
+         params {
+            cur: ptr(Efl.Text.Cursor.Cursor_Data);
+         }
+      }
+      cursor_char_prev {
+         legacy: null;
+         params {
+            cur: ptr(Efl.Text.Cursor.Cursor_Data);
+         }
+      }
+      cursor_paragraph_char_first {
+         legacy: null;
+         params {
+            cur: ptr(Efl.Text.Cursor.Cursor_Data);
+         }
+      }
+      cursor_paragraph_char_last {
+         legacy: null;
+         params {
+            cur: ptr(Efl.Text.Cursor.Cursor_Data);
+         }
+      }
+      cursor_word_start {
+         legacy: null;
+         params {
+            cur: ptr(Efl.Text.Cursor.Cursor_Data);
+         }
+      }
+      cursor_word_end {
+         legacy: null;
+         params {
+            cur: ptr(Efl.Text.Cursor.Cursor_Data);
+         }
+      }
+      cursor_line_char_first {
+         legacy: null;
+         params {
+            cur: ptr(Efl.Text.Cursor.Cursor_Data);
+         }
+      }
+      cursor_line_char_last {
+         legacy: null;
+         params {
+            cur: ptr(Efl.Text.Cursor.Cursor_Data);
+         }
+      }
+      cursor_paragraph_first {
+         legacy: null;
+         params {
+            cur: ptr(Efl.Text.Cursor.Cursor_Data);
+         }
+      }
+      cursor_paragraph_last {
+         legacy: null;
+         params {
+            cur: ptr(Efl.Text.Cursor.Cursor_Data);
+         }
+      }
+      cursor_paragraph_next {
+         [[Advances to the start of the next text node]]
+         legacy: null;
+         params {
+            cur: ptr(Efl.Text.Cursor.Cursor_Data);
+         }
+      }
+      cursor_paragraph_prev {
+         [[Advances to the end of the previous text node]]
+         legacy: null;
+         params {
+            cur: ptr(Efl.Text.Cursor.Cursor_Data);
+         }
+      }
+      cursor_line_jump_by {
+         legacy: null;
+         params {
+            cur: ptr(Efl.Text.Cursor.Cursor_Data);
+            by: int;
+         }
+      }
+      cursor_coord_set {
+         legacy: null;
+         params {
+            cur: ptr(Efl.Text.Cursor.Cursor_Data);
+            @in x: int; [[X coord to set by.]]
+            @in y: int; [[Y coord to set by.]]
+         }
+      }
+      cursor_text_insert {
+         [[Adds text to the current cursor position and set the cursor to
+           *after* the start of the text just added.
+         ]]
+         legacy: null;
+         params {
+            cur: ptr(Efl.Text.Cursor.Cursor_Data);
+            @in text: string; [[Text to append (UTF-8 format).]]
+         }
+         return: int; [[Length of the appended text.]]
+      }
+      cursor_char_delete {
+         [[Deletes a single character from position pointed by given cursor.]]
+         legacy: null;
+         params {
+            cur: ptr(Efl.Text.Cursor.Cursor_Data);
+         }
+      }
+   }
+}