summaryrefslogtreecommitdiff
path: root/src/lib/efl
diff options
context:
space:
mode:
authorStefan Schmidt <stefan@osg.samsung.com>2017-08-31 16:15:32 +0200
committerStefan Schmidt <stefan@osg.samsung.com>2017-08-31 16:15:32 +0200
commitf4fcb65bb47dd5cbba14b438a9f3ab110d2a5b73 (patch)
tree348c47e6acba3feaa7226e054abcf5ac1ec56f96 /src/lib/efl
parent72f16b48baad4c3b3afb3f3f84716231075ce65a (diff)
docs: efl_text_cursor: add missing documentation for many parts
Diffstat (limited to 'src/lib/efl')
-rw-r--r--src/lib/efl/interfaces/efl_text_cursor.eo82
1 files changed, 50 insertions, 32 deletions
diff --git a/src/lib/efl/interfaces/efl_text_cursor.eo b/src/lib/efl/interfaces/efl_text_cursor.eo
index c138769a68..2baff113bf 100644
--- a/src/lib/efl/interfaces/efl_text_cursor.eo
+++ b/src/lib/efl/interfaces/efl_text_cursor.eo
@@ -39,17 +39,18 @@ interface Efl.Text.Cursor {
39 return: ptr(Efl.Text.Cursor.Cursor); [[Text cursor object]] 39 return: ptr(Efl.Text.Cursor.Cursor); [[Text cursor object]]
40 } 40 }
41 keys { 41 keys {
42 get_type: Efl.Text.Cursor.Cursor_Get_Type; 42 get_type: Efl.Text.Cursor.Cursor_Get_Type; [[Cursor type]]
43 } 43 }
44 } 44 }
45 @property cursor_position { 45 @property cursor_position {
46 [[Cursor position]]
46 set { legacy: null; } 47 set { legacy: null; }
47 get { legacy: null; } 48 get { legacy: null; }
48 values { 49 values {
49 position: int; 50 position: int; [[Cursor position]]
50 } 51 }
51 keys { 52 keys {
52 cur: ptr(Efl.Text.Cursor.Cursor); 53 cur: ptr(Efl.Text.Cursor.Cursor); [[Cursor object]]
53 } 54 }
54 } 55 }
55 @property cursor_content { 56 @property cursor_content {
@@ -61,7 +62,7 @@ interface Efl.Text.Cursor {
61 content: Eina.Unicode; [[The unicode codepoint of the character]] 62 content: Eina.Unicode; [[The unicode codepoint of the character]]
62 } 63 }
63 keys { 64 keys {
64 cur: ptr(const(Efl.Text.Cursor.Cursor)); 65 cur: ptr(const(Efl.Text.Cursor.Cursor)); [[Cursor object]]
65 } 66 }
66 } 67 }
67 @property cursor_geometry { 68 @property cursor_geometry {
@@ -78,7 +79,7 @@ interface Efl.Text.Cursor {
78 return: bool; [[ $true if split cursor, $false otherwise.]] 79 return: bool; [[ $true if split cursor, $false otherwise.]]
79 } 80 }
80 keys { 81 keys {
81 cur: ptr(const(Efl.Text.Cursor.Cursor)); 82 cur: ptr(const(Efl.Text.Cursor.Cursor)); [[Cursor object]]
82 ctype: Efl.Text.Cursor.Cursor_Type; [[The type of the cursor.]] 83 ctype: Efl.Text.Cursor.Cursor_Type; [[The type of the cursor.]]
83 } 84 }
84 values { 85 values {
@@ -93,123 +94,140 @@ interface Efl.Text.Cursor {
93 } 94 }
94 } 95 }
95 cursor_new { 96 cursor_new {
97 [[Create new cursor]]
96 legacy: null; 98 legacy: null;
97 return: ptr(Efl.Text.Cursor.Cursor); 99 return: ptr(Efl.Text.Cursor.Cursor); [[Cursor object]]
98 } 100 }
99 cursor_free { 101 cursor_free {
102 [[Free existing cursor]]
100 legacy: null; 103 legacy: null;
101 params { 104 params {
102 cur: ptr(Efl.Text.Cursor.Cursor); 105 cur: ptr(Efl.Text.Cursor.Cursor); [[Cursor object]]
103 } 106 }
104 } 107 }
105 cursor_equal { 108 cursor_equal {
109 [[Check if two cursors are equal]]
106 legacy: null; 110 legacy: null;
107 params { 111 params {
108 cur1: ptr(const(Efl.Text.Cursor.Cursor)); 112 cur1: ptr(const(Efl.Text.Cursor.Cursor)); [[Cursor 1 object]]
109 cur2: ptr(const(Efl.Text.Cursor.Cursor)); 113 cur2: ptr(const(Efl.Text.Cursor.Cursor)); [[Cursor 2 object]]
110 } 114 }
111 return: bool; 115 return: bool; [[$true if cursors are equal, $false otherwise]]
112 } 116 }
113 cursor_compare { 117 cursor_compare {
118 [[Compare two cursors]]
114 legacy: null; 119 legacy: null;
115 params { 120 params {
116 cur1: ptr(const(Efl.Text.Cursor.Cursor)); 121 cur1: ptr(const(Efl.Text.Cursor.Cursor)); [[Cursor 1 object]]
117 cur2: ptr(const(Efl.Text.Cursor.Cursor)); 122 cur2: ptr(const(Efl.Text.Cursor.Cursor)); [[Cursor 2 object]]
118 } 123 }
119 return: int; 124 return: int; [[Difference between cursors]]
120 } 125 }
121 cursor_copy { 126 cursor_copy {
127 [[Copy existing cursor]]
122 legacy: null; 128 legacy: null;
123 params { 129 params {
124 dst: ptr(Efl.Text.Cursor.Cursor); 130 dst: ptr(Efl.Text.Cursor.Cursor); [[Destination cursor]]
125 src: ptr(const(Efl.Text.Cursor.Cursor)); 131 src: ptr(const(Efl.Text.Cursor.Cursor)); [[Source cursor]]
126 } 132 }
127 } 133 }
128 cursor_char_next { 134 cursor_char_next {
135 [[Advances to the next character]]
129 legacy: null; 136 legacy: null;
130 params { 137 params {
131 cur: ptr(Efl.Text.Cursor.Cursor); 138 cur: ptr(Efl.Text.Cursor.Cursor); [[Cursor object]]
132 } 139 }
133 } 140 }
134 cursor_char_prev { 141 cursor_char_prev {
142 [[Advances to the previous character]]
135 legacy: null; 143 legacy: null;
136 params { 144 params {
137 cur: ptr(Efl.Text.Cursor.Cursor); 145 cur: ptr(Efl.Text.Cursor.Cursor); [[Cursor object]]
138 } 146 }
139 } 147 }
140 cursor_paragraph_char_first { 148 cursor_paragraph_char_first {
149 [[Advances to the first character in this paragraph]]
141 legacy: null; 150 legacy: null;
142 params { 151 params {
143 cur: ptr(Efl.Text.Cursor.Cursor); 152 cur: ptr(Efl.Text.Cursor.Cursor); [[Cursor object]]
144 } 153 }
145 } 154 }
146 cursor_paragraph_char_last { 155 cursor_paragraph_char_last {
156 [[Advances to the last character in this paragraph]]
147 legacy: null; 157 legacy: null;
148 params { 158 params {
149 cur: ptr(Efl.Text.Cursor.Cursor); 159 cur: ptr(Efl.Text.Cursor.Cursor); [[Cursor object]]
150 } 160 }
151 } 161 }
152 cursor_word_start { 162 cursor_word_start {
163 [[Advance to current word start]]
153 legacy: null; 164 legacy: null;
154 params { 165 params {
155 cur: ptr(Efl.Text.Cursor.Cursor); 166 cur: ptr(Efl.Text.Cursor.Cursor); [[Cursor object]]
156 } 167 }
157 } 168 }
158 cursor_word_end { 169 cursor_word_end {
170 [[Advance to current word end]]
159 legacy: null; 171 legacy: null;
160 params { 172 params {
161 cur: ptr(Efl.Text.Cursor.Cursor); 173 cur: ptr(Efl.Text.Cursor.Cursor); [[Cursor object]]
162 } 174 }
163 } 175 }
164 cursor_line_char_first { 176 cursor_line_char_first {
177 [[Advance to current line first character]]
165 legacy: null; 178 legacy: null;
166 params { 179 params {
167 cur: ptr(Efl.Text.Cursor.Cursor); 180 cur: ptr(Efl.Text.Cursor.Cursor); [[Cursor object]]
168 } 181 }
169 } 182 }
170 cursor_line_char_last { 183 cursor_line_char_last {
184 [[Advance to current line last character]]
171 legacy: null; 185 legacy: null;
172 params { 186 params {
173 cur: ptr(Efl.Text.Cursor.Cursor); 187 cur: ptr(Efl.Text.Cursor.Cursor); [[Cursor object]]
174 } 188 }
175 } 189 }
176 cursor_paragraph_first { 190 cursor_paragraph_first {
191 [[Advance to current paragraph first character]]
177 legacy: null; 192 legacy: null;
178 params { 193 params {
179 cur: ptr(Efl.Text.Cursor.Cursor); 194 cur: ptr(Efl.Text.Cursor.Cursor); [[Cursor object]]
180 } 195 }
181 } 196 }
182 cursor_paragraph_last { 197 cursor_paragraph_last {
198 [[Advance to current paragraph last character]]
183 legacy: null; 199 legacy: null;
184 params { 200 params {
185 cur: ptr(Efl.Text.Cursor.Cursor); 201 cur: ptr(Efl.Text.Cursor.Cursor); [[Cursor object]]
186 } 202 }
187 } 203 }
188 cursor_paragraph_next { 204 cursor_paragraph_next {
189 [[Advances to the start of the next text node]] 205 [[Advances to the start of the next text node]]
190 legacy: null; 206 legacy: null;
191 params { 207 params {
192 cur: ptr(Efl.Text.Cursor.Cursor); 208 cur: ptr(Efl.Text.Cursor.Cursor); [[Cursor object]]
193 } 209 }
194 } 210 }
195 cursor_paragraph_prev { 211 cursor_paragraph_prev {
196 [[Advances to the end of the previous text node]] 212 [[Advances to the end of the previous text node]]
197 legacy: null; 213 legacy: null;
198 params { 214 params {
199 cur: ptr(Efl.Text.Cursor.Cursor); 215 cur: ptr(Efl.Text.Cursor.Cursor); [[Cursor object]]
200 } 216 }
201 } 217 }
202 cursor_line_jump_by { 218 cursor_line_jump_by {
219 [[Jump the cursor by the given number of lines]]
203 legacy: null; 220 legacy: null;
204 params { 221 params {
205 cur: ptr(Efl.Text.Cursor.Cursor); 222 cur: ptr(Efl.Text.Cursor.Cursor); [[Cursor object]]
206 by: int; 223 by: int; [[Number of lines]]
207 } 224 }
208 } 225 }
209 cursor_coord_set { 226 cursor_coord_set {
227 [[Set cursor coordinates]]
210 legacy: null; 228 legacy: null;
211 params { 229 params {
212 cur: ptr(Efl.Text.Cursor.Cursor); 230 cur: ptr(Efl.Text.Cursor.Cursor); [[Cursor object]]
213 @in x: int; [[X coord to set by.]] 231 @in x: int; [[X coord to set by.]]
214 @in y: int; [[Y coord to set by.]] 232 @in y: int; [[Y coord to set by.]]
215 } 233 }
@@ -220,7 +238,7 @@ interface Efl.Text.Cursor {
220 ]] 238 ]]
221 legacy: null; 239 legacy: null;
222 params { 240 params {
223 cur: ptr(Efl.Text.Cursor.Cursor); 241 cur: ptr(Efl.Text.Cursor.Cursor); [[Cursor object]]
224 @in text: string; [[Text to append (UTF-8 format).]] 242 @in text: string; [[Text to append (UTF-8 format).]]
225 } 243 }
226 return: int; [[Length of the appended text.]] 244 return: int; [[Length of the appended text.]]
@@ -229,7 +247,7 @@ interface Efl.Text.Cursor {
229 [[Deletes a single character from position pointed by given cursor.]] 247 [[Deletes a single character from position pointed by given cursor.]]
230 legacy: null; 248 legacy: null;
231 params { 249 params {
232 cur: ptr(Efl.Text.Cursor.Cursor); 250 cur: ptr(Efl.Text.Cursor.Cursor); [[Cursor object]]
233 } 251 }
234 } 252 }
235 } 253 }