summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorXavi Artigas <xavierartigas@yahoo.es>2019-12-18 15:17:28 +0100
committerXavi Artigas <xavierartigas@yahoo.es>2019-12-18 15:17:28 +0100
commit8e622e72df868fb8f19e096529fae6ba651bcdb3 (patch)
tree57767a747fd84a183e25b55719f5f93eb0775c0d
parentf1ae8e0d981a05228258b4396152b7b6ec8c328b (diff)
docs: Polish Efl.Text_Interactive docs
Ref T8521 Ref D10711
-rw-r--r--src/lib/elementary/efl_text_interactive.eo54
1 files changed, 27 insertions, 27 deletions
diff --git a/src/lib/elementary/efl_text_interactive.eo b/src/lib/elementary/efl_text_interactive.eo
index a614810d7e..fe283aa1e0 100644
--- a/src/lib/elementary/efl_text_interactive.eo
+++ b/src/lib/elementary/efl_text_interactive.eo
@@ -3,51 +3,53 @@ import efl_text_types;
3interface @beta Efl.Text_Interactive extends Efl.Text, Efl.Text_Font, 3interface @beta Efl.Text_Interactive extends Efl.Text, Efl.Text_Font,
4 Efl.Text_Format, Efl.Text_Style 4 Efl.Text_Format, Efl.Text_Style
5{ 5{
6 [[This is an interface interactive text inputs should implement]] 6 [[Interface for interactive (editable) text inputs (text entries).
7
8 It handles cursors, edition and selection.
9 ]]
7 methods { 10 methods {
8 @property main_cursor { 11 @property main_cursor {
9 [[The user visible cursor.]] 12 [[The cursor used to insert new text, the one that's visible to the user.]]
10 get {} 13 get {}
11 values { 14 values {
12 cursor: Efl.Text.Cursor; [[The user visible cursor.]] 15 cursor: Efl.Text.Cursor; [[The cursor visible to the user.]]
13 } 16 }
14 } 17 }
15 @property selection_allowed { 18 @property selection_allowed {
16 [[Whether or not selection is allowed on this object.]] 19 [[Whether or not text selection is allowed on this object.]]
17 set {} 20 set {}
18 get {} 21 get {}
19 values { 22 values {
20 allowed: bool; [[$true if enabled, $false otherwise.]] 23 allowed: bool; [[$true if enabled.]]
21 } 24 }
22 } 25 }
23 @property selection_cursors { 26 @property selection_cursors {
24 [[The cursors used for selection handling. 27 [[The cursors used for selection handling.
25 28
26 If the cursors are equal there's 29 If the cursors are equal there's no selection.
27 no selection.
28 30
29 You are allowed to retain and modify them. Modifying them modifies 31 You are allowed to retain and modify them. Modifying them modifies
30 the selection of the object. 32 the selection of the object.
31 ]] 33 ]]
32 get {} 34 get {}
33 values { 35 values {
34 start: Efl.Text.Cursor; [[The start of the selection]] 36 start: Efl.Text.Cursor; [[The start of the selection.]]
35 end: Efl.Text.Cursor; [[The end of the selection]] 37 end: Efl.Text.Cursor; [[The end of the selection.]]
36 } 38 }
37 } 39 }
38 @property editable { 40 @property editable {
39 [[Whether the entry is editable. 41 [[Whether the entry is editable.
40 42
41 By default text interactives are editable. However setting this 43 By default interactive text objects are editable. Setting this
42 property to $false will make it so that key input will be disregarded. 44 property to $false will disregard all keyboard input.
43 ]] 45 ]]
44 set { 46 set {
45 } 47 }
46 get { 48 get {
47 } 49 }
48 values { 50 values {
49 editable: bool; [[If $true, user input will be inserted in the entry, 51 editable: bool; [[If $true, user input can modify the text.
50 if not, the entry is read-only and no user input is allowed.]] 52 Otherwise, the entry is read-only and no user input is allowed.]]
51 } 53 }
52 } 54 }
53 all_unselect { 55 all_unselect {
@@ -57,27 +59,25 @@ interface @beta Efl.Text_Interactive extends Efl.Text, Efl.Text_Font,
57 [[Select all the content.]] 59 [[Select all the content.]]
58 } 60 }
59 @property have_selection { 61 @property have_selection {
60 [[Whether the entry have a selected text. 62 [[Whether the entry has a selected text.
61 ]] 63 ]]
62 get { 64 get {
63 } 65 }
64 values { 66 values {
65 selected: bool; [[If $true, entry have selected text, $false otherwise.]] 67 selected: bool; [[If $true, entry has selected text.]]
66 } 68 }
67 } 69 }
68 } 70 }
69 events { 71 events {
70 preedit,changed: void; [[Called when entry preedit changed.]] 72 preedit,changed: void; [[Emitted when key presses do not result in a new character being added.
71 have_selection,changed: bool; [[Called when @.have_selection property value changed.]] 73 Multiple key presses are needed to produce a character in some languages like
72 selection,changed: Efl.Text_Range; [[Called when selection has changed. Query using @.selection_cursors.]] 74 Korean, for example. Each of these key presses will emit a @[.preedit,changed]
73 redo,request: void; [[Called when redo is requested]] 75 event but only the last one will emit a @[.changed,user] event.
74 undo,request: void; [[Called when undo is requested]] 76 ]]
75 changed,user: Efl.Text_Change_Info; [[The content has changed due to user interaction.]] 77 have_selection,changed: bool; [[Emitted when the @.have_selection property value changes.]]
76 // FIXME: efl_ui_text doesn't support anchor callbacks yet. 78 selection,changed: Efl.Text_Range; [[Emitted when selection has changed. Query using @.selection_cursors.]]
77 //anchor,down: Elm.Entry_Anchor_Info; [[Called on anchor down]] 79 redo,request: void; [[Emitted when a redo operation is requested.]]
78 //anchor,hover,opened: Elm.Entry_Anchor_Hover_Info; [[Called when hover opened]] 80 undo,request: void; [[Emitted when a undo operation is requested.]]
79 //anchor,in: Elm.Entry_Anchor_Info; [[Called on anchor in]] 81 changed,user: Efl.Text_Change_Info; [[Emitted when the text content has changed due to user interaction.]]
80 //anchor,out: Elm.Entry_Anchor_Info; [[Called on anchor out]]
81 //anchor,up: Elm.Entry_Anchor_Info; [[called on anchor up]]
82 } 82 }
83} 83}