efl.text.cursor: clean eo files from comments

Reviewers: segfaultxavi

Reviewed By: segfaultxavi

Subscribers: cedric, #reviewers, #committers

Tags: #efl

Maniphest Tasks: T8454

Differential Revision: https://phab.enlightenment.org/D10926
This commit is contained in:
Ali Alzyod 2019-12-19 16:07:12 +01:00 committed by Xavi Artigas
parent 11a1fc9f2b
commit 46fef6901d
1 changed files with 11 additions and 10 deletions

View File

@ -26,13 +26,11 @@ enum @beta Efl.Text.Cursor_Move_Type
paragraph_prev [[Advances to the end of the previous paragraph.]] paragraph_prev [[Advances to the end of the previous paragraph.]]
} }
// Missing pen_geometry get? - probably not, that's the cursor geometry with under.
// Should we always do split cursor and "under" should just be content geometry? -- probably!
// Problem with this is that it doesn't necessarily work correctly vertically.
class @beta Efl.Text.Cursor extends Efl.Object implements Efl.Duplicate{ class @beta Efl.Text.Cursor extends Efl.Object implements Efl.Duplicate{
[[Cursor API.]] [[Cursor API.]]
c_prefix: efl_text_cursor; c_prefix: efl_text_cursor;
methods { methods {
@property position { @property position {
[[Cursor position.]] [[Cursor position.]]
set { } set { }
@ -41,6 +39,7 @@ class @beta Efl.Text.Cursor extends Efl.Object implements Efl.Duplicate{
position: int; [[Cursor position.]] position: int; [[Cursor position.]]
} }
} }
@property content { @property content {
[[The content of the cursor (the character under the cursor).]] [[The content of the cursor (the character under the cursor).]]
get { get {
@ -49,6 +48,7 @@ class @beta Efl.Text.Cursor extends Efl.Object implements Efl.Duplicate{
content: Eina.Unicode; [[The unicode codepoint of the character.]] content: Eina.Unicode; [[The unicode codepoint of the character.]]
} }
} }
@property content_geometry { @property content_geometry {
[[The geometry of the item/char pointed by the cursor.]] [[The geometry of the item/char pointed by the cursor.]]
get { } get { }
@ -56,6 +56,7 @@ class @beta Efl.Text.Cursor extends Efl.Object implements Efl.Duplicate{
geometry: Eina.Rect; [[The geometry in pixels.]] geometry: Eina.Rect; [[The geometry in pixels.]]
} }
} }
@property line_number { @property line_number {
[[The line the cursor is on.]] [[The line the cursor is on.]]
set { } set { }
@ -101,6 +102,7 @@ class @beta Efl.Text.Cursor extends Efl.Object implements Efl.Duplicate{
} }
return: bool; [[$true if cursors are equal, $false otherwise.]] return: bool; [[$true if cursors are equal, $false otherwise.]]
} }
compare @const { compare @const {
[[Compare two cursors [[Compare two cursors
Return <0 if cursor position less than dst, 0 if cursor == dest and >0 otherwise.]] Return <0 if cursor position less than dst, 0 if cursor == dest and >0 otherwise.]]
@ -109,12 +111,14 @@ class @beta Efl.Text.Cursor extends Efl.Object implements Efl.Duplicate{
} }
return: int; [[Difference between cursors.]] return: int; [[Difference between cursors.]]
} }
copy @const { copy @const {
[[Copy existing cursor to destination cursor, like position and cursor text object.]] [[Copy existing cursor to destination cursor, like position and cursor text object.]]
params { params {
dst: Efl.Text.Cursor; [[Destination Cursor.]] dst: Efl.Text.Cursor; [[Destination Cursor.]]
} }
} }
move { move {
[[Move the cursor.]] [[Move the cursor.]]
params { params {
@ -122,14 +126,11 @@ class @beta Efl.Text.Cursor extends Efl.Object implements Efl.Duplicate{
} }
return: bool; [[True if actually moved.]] return: bool; [[True if actually moved.]]
} }
char_delete { char_delete {
[[Deletes a single character from position pointed by given cursor.]] [[Deletes a single character from position pointed by given cursor.]]
} }
// FIXME: It's just implemented as range delete with cluster start + end.
// Should we have convenience wrappers for those though? This and cluster prev/next?
// cluster_delete {
line_jump_by { line_jump_by {
[[Jump the cursor by the given number of lines.]] [[Jump the cursor by the given number of lines.]]
params { params {
@ -153,7 +154,6 @@ class @beta Efl.Text.Cursor extends Efl.Object implements Efl.Duplicate{
} }
} }
// FIXME: Add a way to add with a length parameter (always have it?) so we just copy n characters, or all if -1. Useful for saving copies when inserting from another source.
text_insert { text_insert {
[[Adds text to the current cursor position and set the cursor to [[Adds text to the current cursor position and set the cursor to
*after* the start of the text just added.]] *after* the start of the text just added.]]
@ -184,7 +184,7 @@ class @beta Efl.Text.Cursor extends Efl.Object implements Efl.Duplicate{
cur2: Efl.Text.Cursor; [[End of range.]] cur2: Efl.Text.Cursor; [[End of range.]]
} }
} }
// FIXME: returning an iterator here feels a bit stupid
range_geometry_get { range_geometry_get {
[[Get the simple geometry in pixels of a range in the text. [[Get the simple geometry in pixels of a range in the text.
@ -197,6 +197,7 @@ class @beta Efl.Text.Cursor extends Efl.Object implements Efl.Duplicate{
return: iterator<Eina.Rect> @move; [[ return: iterator<Eina.Rect> @move; [[
Iterator on all geoemtries of the given range.]] Iterator on all geoemtries of the given range.]]
} }
range_precise_geometry_get { range_precise_geometry_get {
[[Get the "precise" geometry in pixels of a range. [[Get the "precise" geometry in pixels of a range.
@ -208,6 +209,7 @@ class @beta Efl.Text.Cursor extends Efl.Object implements Efl.Duplicate{
return: iterator<Eina.Rect> @move; [[ return: iterator<Eina.Rect> @move; [[
Iterator on all simple geometries of the given range.]] Iterator on all simple geometries of the given range.]]
} }
range_delete { range_delete {
[[Deletes the range between given cursors. [[Deletes the range between given cursors.
@ -226,7 +228,6 @@ class @beta Efl.Text.Cursor extends Efl.Object implements Efl.Duplicate{
} }
} }
events { events {
// FIXME: Needed for people who cache the position.
changed: void; [[Called when its position has changed.]] changed: void; [[Called when its position has changed.]]
} }