summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--src/lib/ecore/efl_app.eo9
-rw-r--r--src/lib/ecore/efl_appthread.eo3
-rw-r--r--src/lib/ecore/efl_core_command_line.eo8
-rw-r--r--src/lib/ecore/efl_core_env.eo3
-rw-r--r--src/lib/ecore/efl_filter_model.eo5
-rw-r--r--src/lib/ecore/efl_io_buffered_stream.eo26
-rw-r--r--src/lib/ecore/efl_io_copier.eo24
-rw-r--r--src/lib/ecore/efl_io_file.eo4
-rw-r--r--src/lib/ecore/efl_loop.eo24
-rw-r--r--src/lib/ecore/efl_loop_handler.eo3
-rw-r--r--src/lib/ecore/efl_loop_model.eo11
-rw-r--r--src/lib/ecore/efl_select_model.eo6
-rw-r--r--src/lib/ecore/efl_thread.eo3
-rw-r--r--src/lib/ecore/efl_view_model.eo40
-rw-r--r--src/lib/ecore_con/efl_net_control_technology.eo6
-rw-r--r--src/lib/ecore_con/efl_net_socket_fd.eo7
-rw-r--r--src/lib/efl/interfaces/efl_gfx_image.eo8
-rw-r--r--src/lib/efl/interfaces/efl_gfx_image_orientable.eo8
-rw-r--r--src/lib/efl/interfaces/efl_io_buffer.eo10
-rw-r--r--src/lib/efl/interfaces/efl_io_queue.eo4
-rw-r--r--src/lib/efl/interfaces/efl_io_reader.eo4
-rw-r--r--src/lib/efl/interfaces/efl_io_writer.eo8
-rw-r--r--src/lib/efl/interfaces/efl_model.eo10
-rw-r--r--src/lib/efl/interfaces/efl_ui_factory.eo15
-rw-r--r--src/lib/efl/interfaces/efl_ui_layout_orientable_readonly.eo3
-rw-r--r--src/lib/efl/interfaces/efl_ui_property_bind.eo7
-rw-r--r--src/lib/efl/interfaces/efl_ui_range_interactive.eo8
-rw-r--r--src/lib/efl/interfaces/efl_ui_view_factory.eo10
-rw-r--r--src/lib/elementary/efl_access_object.eo7
-rw-r--r--src/lib/elementary/efl_access_text.eo22
-rw-r--r--src/lib/elementary/efl_ui_animation_view.eo28
-rw-r--r--src/lib/elementary/efl_ui_bg.eo3
-rw-r--r--src/lib/elementary/efl_ui_caching_factory.eo16
-rw-r--r--src/lib/elementary/efl_ui_calendar.eo3
-rw-r--r--src/lib/elementary/efl_ui_check.eo4
-rw-r--r--src/lib/elementary/efl_ui_focus_composition.eo14
-rw-r--r--src/lib/elementary/efl_ui_focus_layer.eo10
-rw-r--r--src/lib/elementary/efl_ui_focus_manager.eo25
-rw-r--r--src/lib/elementary/efl_ui_focus_manager_root_focus.eo11
-rw-r--r--src/lib/elementary/efl_ui_focus_manager_window_root.eo4
-rw-r--r--src/lib/elementary/efl_ui_focus_object.eo7
-rw-r--r--src/lib/elementary/efl_ui_format.eo5
-rw-r--r--src/lib/elementary/efl_ui_list_view.eo3
-rw-r--r--src/lib/elementary/efl_ui_multi_selectable.eo11
-rw-r--r--src/lib/elementary/efl_ui_navigation_bar_part_back_button.eo5
-rw-r--r--src/lib/elementary/efl_ui_pan.eo7
-rw-r--r--src/lib/elementary/efl_ui_panel.eo5
-rw-r--r--src/lib/elementary/efl_ui_panes.eo5
-rw-r--r--src/lib/elementary/efl_ui_popup.eo59
-rw-r--r--src/lib/elementary/efl_ui_position_manager_data_access_v1.eo78
-rw-r--r--src/lib/elementary/efl_ui_position_manager_entity.eo37
-rw-r--r--src/lib/elementary/efl_ui_position_manager_grid.eo4
-rw-r--r--src/lib/elementary/efl_ui_position_manager_list.eo7
-rw-r--r--src/lib/elementary/efl_ui_radio.eo3
-rw-r--r--src/lib/elementary/efl_ui_selectable.eo9
-rw-r--r--src/lib/elementary/efl_ui_single_selectable.eo14
-rw-r--r--src/lib/elementary/efl_ui_spin_button.eo8
-rw-r--r--src/lib/elementary/efl_ui_spotlight_container.eo54
-rw-r--r--src/lib/elementary/efl_ui_spotlight_indicator.eo20
-rw-r--r--src/lib/elementary/efl_ui_spotlight_manager.eo31
-rw-r--r--src/lib/elementary/efl_ui_tab_page.eo7
-rw-r--r--src/lib/elementary/efl_ui_text.eo5
-rw-r--r--src/lib/elementary/efl_ui_timepicker.eo3
-rw-r--r--src/lib/elementary/efl_ui_widget.eo16
-rw-r--r--src/lib/elementary/efl_ui_win.eo3
-rw-r--r--src/lib/emotion/efl_canvas_video.eo3
-rw-r--r--src/lib/eo/efl_object.eo9
-rw-r--r--src/lib/evas/canvas/efl_canvas_animation.eo8
-rw-r--r--src/lib/evas/canvas/efl_canvas_animation_player.eo3
-rw-r--r--src/lib/evas/canvas/efl_canvas_animation_rotate.eo9
-rw-r--r--src/lib/evas/canvas/efl_canvas_animation_scale.eo9
-rw-r--r--src/lib/evas/canvas/efl_canvas_object.eo8
-rw-r--r--src/lib/evas/canvas/efl_canvas_vg_node.eo3
-rw-r--r--src/lib/evas/canvas/efl_input_clickable.eo10
-rw-r--r--src/lib/evas/canvas/efl_input_pointer.eo8
75 files changed, 567 insertions, 333 deletions
diff --git a/src/lib/ecore/efl_app.eo b/src/lib/ecore/efl_app.eo
index d4af8f631e..0e5d920659 100644
--- a/src/lib/ecore/efl_app.eo
+++ b/src/lib/ecore/efl_app.eo
@@ -45,9 +45,12 @@ abstract Efl.App extends Efl.Loop implements Efl.Core.Command_Line
45 resume: void; [[Called before a window is rendered after a pause event]] 45 resume: void; [[Called before a window is rendered after a pause event]]
46 standby: void; [[Called when the application's windows are all destroyed]] 46 standby: void; [[Called when the application's windows are all destroyed]]
47 terminate: void; [[Called before starting the shutdown of the application]] 47 terminate: void; [[Called before starting the shutdown of the application]]
48 signal,usr1: void; [[System specific, but on unix maps to SIGUSR1 signal to the process - only called on main loop object]] 48 signal,usr1: void; [[System specific, but on unix maps to SIGUSR1 signal to the process -
49 signal,usr2: void; [[System specific, but on unix maps to SIGUSR2 signal to the process - only called on main loop object]] 49 only called on main loop object]]
50 signal,hup: void; [[System specific, but on unix maps to SIGHUP signal to the process - only called on main loop object]] 50 signal,usr2: void; [[System specific, but on unix maps to SIGUSR2 signal to the process -
51 only called on main loop object]]
52 signal,hup: void; [[System specific, but on unix maps to SIGHUP signal to the process -
53 only called on main loop object]]
51 } 54 }
52 implements { 55 implements {
53 Efl.Task.priority { get; set; } 56 Efl.Task.priority { get; set; }
diff --git a/src/lib/ecore/efl_appthread.eo b/src/lib/ecore/efl_appthread.eo
index 076a1506ee..b293b4aa07 100644
--- a/src/lib/ecore/efl_appthread.eo
+++ b/src/lib/ecore/efl_appthread.eo
@@ -1,4 +1,5 @@
1class @beta Efl.Appthread extends Efl.Loop implements Efl.ThreadIO, Efl.Io.Reader, Efl.Io.Writer, Efl.Io.Closer, Efl.Core.Command_Line 1class @beta Efl.Appthread extends Efl.Loop
2 implements Efl.ThreadIO, Efl.Io.Reader, Efl.Io.Writer, Efl.Io.Closer, Efl.Core.Command_Line
2{ 3{
3 [[ ]] 4 [[ ]]
4 methods { 5 methods {
diff --git a/src/lib/ecore/efl_core_command_line.eo b/src/lib/ecore/efl_core_command_line.eo
index 54efbdb870..fff7157d12 100644
--- a/src/lib/ecore/efl_core_command_line.eo
+++ b/src/lib/ecore/efl_core_command_line.eo
@@ -1,7 +1,8 @@
1mixin @beta Efl.Core.Command_Line { 1mixin @beta Efl.Core.Command_Line {
2 [[A mixin that implements standard functions for command lines. 2 [[A mixin that implements standard functions for command lines.
3 3
4 This object parses the command line that gets passed, later the object can be accessed via accessor or the string directly. 4 This object parses the command line that gets passed, later the object can be accessed via accessor or the string
5 directly.
5 ]] 6 ]]
6 methods { 7 methods {
7 @property command { 8 @property command {
@@ -64,9 +65,10 @@ mixin @beta Efl.Core.Command_Line {
64 } 65 }
65 } 66 }
66 @property command_string { 67 @property command_string {
67 [[ Use a string to fill this object 68 [[Use a string to fill this object
68 69
69 The string will be split at every unescaped ' ', every resulting substring will be a new argument to the command line. 70 The string will be split at every unescaped ' ', every resulting substring will be a new argument to the
71 command line.
70 ]] 72 ]]
71 set { 73 set {
72 return : bool; [[On success $true, $false otherwise]] 74 return : bool; [[On success $true, $false otherwise]]
diff --git a/src/lib/ecore/efl_core_env.eo b/src/lib/ecore/efl_core_env.eo
index 5aaaa3a263..593a3a3cf5 100644
--- a/src/lib/ecore/efl_core_env.eo
+++ b/src/lib/ecore/efl_core_env.eo
@@ -4,7 +4,8 @@ class @beta Efl.Core.Env extends Efl.Object implements Efl.Duplicate {
4 A object of this type alone does not apply the object to the system. 4 A object of this type alone does not apply the object to the system.
5 For getting the value into the system, see @Efl.Core.Proc_Env. 5 For getting the value into the system, see @Efl.Core.Proc_Env.
6 6
7 A object can be forked, which will only copy its values, changes to the returned object will not change the object where it is forked off. 7 A object can be forked, which will only copy its values, changes to the returned object will not change the object
8 where it is forked off.
8 ]] 9 ]]
9 methods { 10 methods {
10 @property env { 11 @property env {
diff --git a/src/lib/ecore/efl_filter_model.eo b/src/lib/ecore/efl_filter_model.eo
index 8710707b06..4dafb94f51 100644
--- a/src/lib/ecore/efl_filter_model.eo
+++ b/src/lib/ecore/efl_filter_model.eo
@@ -2,7 +2,8 @@ function @beta EflFilterModel {
2 [[EflFilterModel function]] 2 [[EflFilterModel function]]
3 params { 3 params {
4 parent: Efl.Filter_Model; [[This object can be used to know when to cancel the future.]] 4 parent: Efl.Filter_Model; [[This object can be used to know when to cancel the future.]]
5 child: Efl.Model; [[You must reference this object for the duration of your use of it as the caller will not do that for you.]] 5 child: Efl.Model; [[You must reference this object for the duration of your use of it as the caller will not do
6 that for you.]]
6 } 7 }
7 return: future<bool>; [[$true if the model should be kept.]] 8 return: future<bool>; [[$true if the model should be kept.]]
8}; 9};
@@ -28,4 +29,4 @@ class @beta Efl.Filter_Model extends Efl.Composite_Model
28 constructors { 29 constructors {
29 .filter_set; 30 .filter_set;
30 } 31 }
31} \ No newline at end of file 32}
diff --git a/src/lib/ecore/efl_io_buffered_stream.eo b/src/lib/ecore/efl_io_buffered_stream.eo
index 5271006422..6a117de215 100644
--- a/src/lib/ecore/efl_io_buffered_stream.eo
+++ b/src/lib/ecore/efl_io_buffered_stream.eo
@@ -59,7 +59,8 @@ class @beta Efl.Io.Buffered_Stream extends Efl.Loop_Consumer implements Efl.Io.R
59 [[Constructor-only property to set buffer limit. 0 is unlimited]] 59 [[Constructor-only property to set buffer limit. 0 is unlimited]]
60 } 60 }
61 values { 61 values {
62 max_queue_size_input: size; [[Defines a maximum buffer size for incoming data or 0 to allow an unlimited amount of bytes]] 62 max_queue_size_input: size; [[Defines a maximum buffer size for incoming data or 0 to allow an
63 unlimited amount of bytes]]
63 } 64 }
64 } 65 }
65 66
@@ -74,12 +75,15 @@ class @beta Efl.Io.Buffered_Stream extends Efl.Loop_Consumer implements Efl.Io.R
74 [[Constructor-only property to set buffer limit. 0 is unlimited]] 75 [[Constructor-only property to set buffer limit. 0 is unlimited]]
75 } 76 }
76 values { 77 values {
77 max_queue_size_output: size; [[Defines a maximum buffer size for output data, or 0 to allow unlimited amount of bytes. If limited, @Efl.Io.Writer.write will take less data than requested.]] 78 max_queue_size_output: size; [[Defines a maximum buffer size for output data, or 0 to allow unlimited
79 amount of bytes. If limited, @Efl.Io.Writer.write will take less data
80 than requested.]]
78 } 81 }
79 } 82 }
80 83
81 @property line_delimiter { 84 @property line_delimiter {
82 [[If set incoming data will be checked for the delimiter and "line" events. The line may include the delimiter, unless it's end-of-stream in @.max_queue_size_input has been reached.]] 85 [[If set incoming data will be checked for the delimiter and "line" events. The line may include the
86 delimiter, unless it's end-of-stream in @.max_queue_size_input has been reached.]]
83 get { } 87 get { }
84 set { 88 set {
85 [[Changes line delimiter to use. If empty no delimiter is to be used]] 89 [[Changes line delimiter to use. If empty no delimiter is to be used]]
@@ -100,7 +104,8 @@ class @beta Efl.Io.Buffered_Stream extends Efl.Loop_Consumer implements Efl.Io.R
100 greater-than zero. Defaults to inactive. 104 greater-than zero. Defaults to inactive.
101 ]] 105 ]]
102 values { 106 values {
103 seconds: double; [[Number of inactive seconds to timeout this object. If zero or less it will be disabled.]] 107 seconds: double; [[Number of inactive seconds to timeout this object. If zero or less it will be
108 disabled.]]
104 } 109 }
105 } 110 }
106 111
@@ -162,7 +167,9 @@ class @beta Efl.Io.Buffered_Stream extends Efl.Loop_Consumer implements Efl.Io.R
162 ]] 167 ]]
163 get { } 168 get { }
164 values { 169 values {
165 slice: Eina.Slice; [[Slice of the current buffer, may be invalidated if @Efl.Io.Writer.write, @Efl.Io.Closer.close or @Efl.Io.Reader.read are called. It is the full slice available for reading.]] 170 slice: Eina.Slice; [[Slice of the current buffer, may be invalidated if @Efl.Io.Writer.write,
171 @Efl.Io.Closer.close or @Efl.Io.Reader.read are called. It is the full
172 slice available for reading.]]
166 } 173 }
167 } 174 }
168 175
@@ -216,7 +223,7 @@ class @beta Efl.Io.Buffered_Stream extends Efl.Loop_Consumer implements Efl.Io.R
216 otherwise and more calls to flush must be made. 223 otherwise and more calls to flush must be made.
217 224
218 If the @.inner_io implements @Efl.Io.Closer and it 225 If the @.inner_io implements @Efl.Io.Closer and it
219 is closed or the wrapper itself's closed, this 226 is closed or the wrapper itself is closed, this
220 function will do nothing and return $true. 227 function will do nothing and return $true.
221 228
222 Note: this function may block the main loop execution 229 Note: this function may block the main loop execution
@@ -226,7 +233,8 @@ class @beta Efl.Io.Buffered_Stream extends Efl.Loop_Consumer implements Efl.Io.R
226 "write,finished" event. 233 "write,finished" event.
227 ]] 234 ]]
228 params { 235 params {
229 may_block: bool; [[If $true, then @Efl.Io.Reader.can_read and @Efl.Io.Writer.can_write are not checked and the call may block.]] 236 may_block: bool; [[If $true, then @Efl.Io.Reader.can_read and @Efl.Io.Writer.can_write are not checked
237 and the call may block.]]
230 ignore_line_delimiter: bool; [[Forces flush ignoring line delimiters]] 238 ignore_line_delimiter: bool; [[Forces flush ignoring line delimiters]]
231 } 239 }
232 return: bool(true); [[$true if all data was sent, $false otherwise]] 240 return: bool(true); [[$true if all data was sent, $false otherwise]]
@@ -240,7 +248,9 @@ class @beta Efl.Io.Buffered_Stream extends Efl.Loop_Consumer implements Efl.Io.R
240 error: Eina.Error; [[An error has occurred and I/O has stopped]] 248 error: Eina.Error; [[An error has occurred and I/O has stopped]]
241 progress: void; [[Property @.progress changed]] 249 progress: void; [[Property @.progress changed]]
242 slice,changed: void; [[The read-slice returned by @.slice may have changed.]] 250 slice,changed: void; [[The read-slice returned by @.slice may have changed.]]
243 line: ptr(const(Eina.Slice)); [[If @.line_delimiter is set, will be emitted with current line. The memory is only valid during event callback dispatched and should not be modified. Note that the line slice may not be inside @.slice.]] 251 line: ptr(const(Eina.Slice)); [[If @.line_delimiter is set, will be emitted with current line. The memory is
252 only valid during event callback dispatched and should not be modified.
253 Note that the line slice may not be inside @.slice.]]
244 } 254 }
245 255
246 implements { 256 implements {
diff --git a/src/lib/ecore/efl_io_copier.eo b/src/lib/ecore/efl_io_copier.eo
index cf2d7695da..8b7301b14b 100644
--- a/src/lib/ecore/efl_io_copier.eo
+++ b/src/lib/ecore/efl_io_copier.eo
@@ -85,7 +85,7 @@ class @beta Efl.Io.Copier extends Efl.Loop_Consumer implements Efl.Io.Closer {
85 that in order to attempt to write a full line at a time, 85 that in order to attempt to write a full line at a time,
86 including the delimiter. Exceptions may be if the 86 including the delimiter. Exceptions may be if the
87 @.source object emitted "eos" and there is no trailing 87 @.source object emitted "eos" and there is no trailing
88 delimiter (ie: missing trailing newline in files) or if the 88 delimiter (i.e: missing trailing newline in files) or if the
89 @.buffer_limit is reached. 89 @.buffer_limit is reached.
90 90
91 Once @Efl.Io.Reader.eos is $true or "eos" event happen, 91 Once @Efl.Io.Reader.eos is $true or "eos" event happen,
@@ -184,7 +184,9 @@ class @beta Efl.Io.Copier extends Efl.Loop_Consumer implements Efl.Io.Closer {
184 } 184 }
185 185
186 @property line_delimiter { 186 @property line_delimiter {
187 [[If there is a line delimiter, reads will buffer/queue up to the line delimiter before calling @Efl.Io.Writer.write on the @.destination and the event line is emitted with the current line. The line may include the delimiter unless it's end-of-stream on @.source or @.buffer_limit was reached.]] 187 [[If there is a line delimiter, reads will buffer/queue up to the line delimiter before calling
188 @Efl.Io.Writer.write on the @.destination and the event line is emitted with the current line.
189 The line may include the delimiter unless it's end-of-stream on @.source or @.buffer_limit was reached.]]
188 get { } 190 get { }
189 set { 191 set {
190 [[Changes line delimiter to use. If empty, no delimiter is to be used]] 192 [[Changes line delimiter to use. If empty, no delimiter is to be used]]
@@ -264,7 +266,8 @@ class @beta Efl.Io.Copier extends Efl.Loop_Consumer implements Efl.Io.Closer {
264 values { 266 values {
265 read: uint64 @optional; [[Amount of bytes read from source]] 267 read: uint64 @optional; [[Amount of bytes read from source]]
266 written: uint64 @optional; [[Amount of bytes written to destination]] 268 written: uint64 @optional; [[Amount of bytes written to destination]]
267 total: uint64 @optional; [[If @.source is an Efl.Io.Sizer, its total size. Otherwise 0 to report unknown size]] 269 total: uint64 @optional; [[If @.source is an @Efl.Io.Sizer, its total size. Otherwise 0 to
270 report unknown size]]
268 } 271 }
269 } 272 }
270 273
@@ -279,7 +282,8 @@ class @beta Efl.Io.Copier extends Efl.Loop_Consumer implements Efl.Io.Closer {
279 greater-than zero. Defaults to inactive. 282 greater-than zero. Defaults to inactive.
280 ]] 283 ]]
281 values { 284 values {
282 seconds: double; [[Number inactive seconds to timeout this copier. If zero or less, it will be disabled.]] 285 seconds: double; [[Number inactive seconds to timeout this copier. If zero or less, it will be
286 disabled.]]
283 } 287 }
284 } 288 }
285 289
@@ -294,7 +298,8 @@ class @beta Efl.Io.Copier extends Efl.Loop_Consumer implements Efl.Io.Closer {
294 get { } 298 get { }
295 set @protected { } 299 set @protected { }
296 values { 300 values {
297 done: bool; [[If $true, source is "eos" and all data was written to "destination". If $false, it's still pending some more copies]] 301 done: bool; [[If $true, source is "eos" and all data was written to "destination". If $false, it's
302 still pending some more copies]]
298 } 303 }
299 } 304 }
300 305
@@ -351,7 +356,8 @@ class @beta Efl.Io.Copier extends Efl.Loop_Consumer implements Efl.Io.Closer {
351 "done" event. 356 "done" event.
352 ]] 357 ]]
353 params { 358 params {
354 may_block: bool; [[If $true, then @Efl.Io.Reader.can_read and @Efl.Io.Writer.can_write are not checked and the call may block.]] 359 may_block: bool; [[If $true, then @Efl.Io.Reader.can_read and @Efl.Io.Writer.can_write are not checked
360 and the call may block.]]
355 ignore_line_delimiter: bool; [[Forces flush ignoring line delimiters]] 361 ignore_line_delimiter: bool; [[Forces flush ignoring line delimiters]]
356 } 362 }
357 return: bool(true); [[$true on success, $false otherwise]] 363 return: bool(true); [[$true on success, $false otherwise]]
@@ -362,8 +368,10 @@ class @beta Efl.Io.Copier extends Efl.Loop_Consumer implements Efl.Io.Closer {
362 done: void; [[All available data was copied from source to destination]] 368 done: void; [[All available data was copied from source to destination]]
363 error: Eina.Error; [[An error happened and the copy stopped]] 369 error: Eina.Error; [[An error happened and the copy stopped]]
364 progress: void; [[Total size changed or Data was read/written]] 370 progress: void; [[Total size changed or Data was read/written]]
365 data: ptr(const(Eina.Slice)); [[When data is read to internal buffer, it's emitted in this event. The memory is only valid during event callback dispatched and should not be modified.]] 371 data: ptr(const(Eina.Slice)); [[When data is read to internal buffer, it's emitted in this event. The memory
366 line: ptr(const(Eina.Slice)); [[If @.line_delimiter is set, will be emitted with current line. The memory is only valid during event callback dispatched and should not be modified.]] 372 is only valid during event callback dispatched and should not be modified.]]
373 line: ptr(const(Eina.Slice)); [[If @.line_delimiter is set, will be emitted with current line. The memory is
374 only valid during event callback dispatched and should not be modified.]]
367 } 375 }
368 376
369 implements { 377 implements {
diff --git a/src/lib/ecore/efl_io_file.eo b/src/lib/ecore/efl_io_file.eo
index c0a968741e..5bf2c23e9f 100644
--- a/src/lib/ecore/efl_io_file.eo
+++ b/src/lib/ecore/efl_io_file.eo
@@ -1,4 +1,6 @@
1class @beta Efl.Io.File extends Efl.Loop_Fd implements Efl.File, Efl.Io.Reader_Fd, Efl.Io.Writer_Fd, Efl.Io.Closer_Fd, Efl.Io.Sizer_Fd, Efl.Io.Positioner_Fd { 1class @beta Efl.Io.File extends Efl.Loop_Fd
2 implements Efl.File, Efl.Io.Reader_Fd, Efl.Io.Writer_Fd, Efl.Io.Closer_Fd, Efl.Io.Sizer_Fd,
3 Efl.Io.Positioner_Fd {
2 [[File access (open, close, read, write, lseek, ftruncate) 4 [[File access (open, close, read, write, lseek, ftruncate)
3 5
4 @Efl.Io.Closer.close_on_exec and 6 @Efl.Io.Closer.close_on_exec and
diff --git a/src/lib/ecore/efl_loop.eo b/src/lib/ecore/efl_loop.eo
index b92e515bb9..20f0389f57 100644
--- a/src/lib/ecore/efl_loop.eo
+++ b/src/lib/ecore/efl_loop.eo
@@ -4,7 +4,8 @@ struct Efl.Loop_Arguments {
4 @since 1.22 4 @since 1.22
5 ]] 5 ]]
6 argv: const(array<const(stringshare)>); [[Array with loop arguments]] 6 argv: const(array<const(stringshare)>); [[Array with loop arguments]]
7 initialization: bool; [[Set to $true when the program should initialize its internal state. This happen once per process instance.]] 7 initialization: bool; [[Set to $true when the program should initialize its internal state.
8 This happens once per process instance.]]
8} 9}
9 10
10abstract Efl.Loop extends Efl.Task 11abstract Efl.Loop extends Efl.Task
@@ -69,8 +70,10 @@ abstract Efl.Loop extends Efl.Task
69 [[You should never need/call this, unless you are implementing a custom 70 [[You should never need/call this, unless you are implementing a custom
70 tick source for an animator. 71 tick source for an animator.
71 72
72 Note: The time point must match whatever zero time you get from ecore_time_get() and @.time.get() (same 0 point). 73 Note: The time point must match whatever zero time you get from ecore_time_get() and @.time.get()
73 What this point is is undefined, so unless your source uses the same 0 time, then you may have to adjust and do some guessing. 74 (same 0 point).
75 What this point is is undefined, so unless your source uses the same 0 time, then you may have to adjust
76 and do some guessing.
74 ]] 77 ]]
75 } 78 }
76 get { 79 get {
@@ -106,12 +109,17 @@ abstract Efl.Loop extends Efl.Task
106 events { 109 events {
107 idle,enter @restart: void; [[Event occurs once the main loop enters the idle state.]] 110 idle,enter @restart: void; [[Event occurs once the main loop enters the idle state.]]
108 idle,exit @restart: void; [[Event occurs once the main loop exits the idle state.]] 111 idle,exit @restart: void; [[Event occurs once the main loop exits the idle state.]]
109 idle @restart: void; [[Event occurs once the main loop is idle. If you keep listening on this event it may increase the burden on your CPU.]] 112 idle @restart: void; [[Event occurs once the main loop is idle. If you keep listening on this event it may
113 increase the burden on your CPU.]]
110 arguments: Efl.Loop_Arguments; [[Event happens when args are provided to the loop by args_add().]] 114 arguments: Efl.Loop_Arguments; [[Event happens when args are provided to the loop by args_add().]]
111 poll,high: void; [[Event occurs multiple times per second. The exact tick is undefined and can be adjusted system wide.]] 115 poll,high: void; [[Event occurs multiple times per second. The exact tick is undefined and can be adjusted
112 poll,medium: void; [[Event occurs multiple times per minute. The exact tick is undefined and can be adjusted system wide.]] 116 system-wide.]]
113 poll,low: void; [[Event occurs multiple times every 15 minutes. The exact tick is undefined and can be adjusted system wide.]] 117 poll,medium: void; [[Event occurs multiple times per minute. The exact tick is undefined and can be adjusted
114 quit: void; [[Event occurs when the loop was requested to quit externally e.g. by a ctrl+c signal or a request from a parent loop/thread to have the child exit.]] 118 system-wide.]]
119 poll,low: void; [[Event occurs multiple times every 15 minutes. The exact tick is undefined and can be adjusted
120 system-wide.]]
121 quit: void; [[Event occurs when the loop was requested to quit externally e.g. by a ctrl+c signal or a request
122 from a parent loop/thread to have the child exit.]]
115 } 123 }
116 implements { 124 implements {
117 Efl.Object.constructor; 125 Efl.Object.constructor;
diff --git a/src/lib/ecore/efl_loop_handler.eo b/src/lib/ecore/efl_loop_handler.eo
index 8779324ef3..b7d96ac29a 100644
--- a/src/lib/ecore/efl_loop_handler.eo
+++ b/src/lib/ecore/efl_loop_handler.eo
@@ -20,7 +20,8 @@ class @beta Efl.Loop_Handler extends Efl.Object
20 set { } 20 set { }
21 get { } 21 get { }
22 values { 22 values {
23 flags: Efl.Loop_Handler_Flags; [[ The flags that indicate what kind of I/O should be listened for like read, write or error channels. ]] 23 flags: Efl.Loop_Handler_Flags; [[The flags that indicate what kind of I/O should be listened for like
24 read, write or error channels. ]]
24 } 25 }
25 } 26 }
26 @property fd { 27 @property fd {
diff --git a/src/lib/ecore/efl_loop_model.eo b/src/lib/ecore/efl_loop_model.eo
index 7d727efbc3..3a15490fce 100644
--- a/src/lib/ecore/efl_loop_model.eo
+++ b/src/lib/ecore/efl_loop_model.eo
@@ -3,12 +3,13 @@ abstract @beta Efl.Loop_Model extends Efl.Loop_Consumer implements Efl.Model
3 data: null; 3 data: null;
4 methods { 4 methods {
5 volatile_make { 5 volatile_make {
6 [[To be called when a Child model is created by @Efl.Model.children_slice_get by the one creating the child object. 6 [[To be called when a Child model is created by @Efl.Model.children_slice_get by the one creating the
7 child object.
7 8
8 This function is used to properly define the lifecycle of the new Child Model object 9 This function is used to properly define the lifecycle of the new Child Model object
9 and make sure that once it has 0 ref except its parent Model, it will be destroyed. 10 and make sure that once it has 0 ref except its parent Model, it will be destroyed.
10 This function should only be called once per child. It is useful for @Efl.Model who 11 This function should only be called once per child. It is useful for @Efl.Model who
11 have a lot of children and shouldn't keep more than what is used in memory.]] 12 have a lot of children and shouldn't keep more than what is used in memory.]]
12 } 13 }
13 } 14 }
14 implements { 15 implements {
diff --git a/src/lib/ecore/efl_select_model.eo b/src/lib/ecore/efl_select_model.eo
index b137686de0..ea1fd52015 100644
--- a/src/lib/ecore/efl_select_model.eo
+++ b/src/lib/ecore/efl_select_model.eo
@@ -5,12 +5,14 @@ class @beta Efl.Select_Model extends Efl.Boolean_Model
5 selected_get { 5 selected_get {
6 [[Get an iterator of all the selected child of this model. 6 [[Get an iterator of all the selected child of this model.
7 ]] 7 ]]
8 return: iterator<uint64>; [[The iterator give indexes of selected child. It is valid until any change is made on the model.]] 8 return: iterator<uint64>; [[The iterator gives indices of selected children.
9 It is valid until any change is made on the model.]]
9 } 10 }
10 unselected_get { 11 unselected_get {
11 [[Get an iterator of all the child of this model that are not selected. 12 [[Get an iterator of all the child of this model that are not selected.
12 ]] 13 ]]
13 return: iterator<uint64>; [[The iterator give indexes of unselected child. It is valid until any change is made on the model.]] 14 return: iterator<uint64>; [[The iterator gives indices of unselected children.
15 It is valid until any change is made on the model.]]
14 } 16 }
15 @property single_selection { 17 @property single_selection {
16 [[Define if we support only one exclusive selection at a time when set to $true. 18 [[Define if we support only one exclusive selection at a time when set to $true.
diff --git a/src/lib/ecore/efl_thread.eo b/src/lib/ecore/efl_thread.eo
index 901ecf4f78..3635775d89 100644
--- a/src/lib/ecore/efl_thread.eo
+++ b/src/lib/ecore/efl_thread.eo
@@ -1,4 +1,5 @@
1class @beta Efl.Thread extends Efl.Task implements Efl.ThreadIO, Efl.Io.Reader, Efl.Io.Writer, Efl.Io.Closer, Efl.Core.Command_Line 1class @beta Efl.Thread extends Efl.Task
2 implements Efl.ThreadIO, Efl.Io.Reader, Efl.Io.Writer, Efl.Io.Closer, Efl.Core.Command_Line
2{ 3{
3 methods { 4 methods {
4 } 5 }
diff --git a/src/lib/ecore/efl_view_model.eo b/src/lib/ecore/efl_view_model.eo
index f429c67b7b..2b6f8684ad 100644
--- a/src/lib/ecore/efl_view_model.eo
+++ b/src/lib/ecore/efl_view_model.eo
@@ -19,27 +19,34 @@ function @beta EflViewModelPropertySet {
19 19
20class @beta Efl.View_Model extends Efl.Composite_Model 20class @beta Efl.View_Model extends Efl.Composite_Model
21{ 21{
22 [[Efl model providing helpers for custom properties used when linking a model to a view and you need to generate/adapt values for display. 22 [[Efl model providing helpers for custom properties used when linking a model to a view and you need to
23 generate/adapt values for display.
23 24
24 There is two ways to use this class, you can either inherit from it and have a custom constructor for example. Or you can just instantiate 25 There is two ways to use this class, you can either inherit from it and have a custom constructor for example.
25 it and manually define your property on it via callbacks. 26 Or you can just instantiate it and manually define your property on it via callbacks.
26 ]] 27 ]]
27 methods { 28 methods {
28 property_string_add { 29 property_string_add {
29 [[Adds a synthetic string property, generated from a $definition string and other properties in the model. 30 [[Adds a synthetic string property, generated from a $definition string and other properties in the model.
30 31
31 The $definition string, similar to how $printf works, contains ${} placeholders that are replaced by the actual value of the property inside the placeholder tags when the synthetic property is retrieved. 32 The $definition string, similar to how $printf works, contains ${} placeholders that are replaced by the
32 For example, a numeric property $length might be strange to use as a label, since it will only display a number. However, a synthetic string can be generated with the definition "Length ${length}." which renders more nicely and does not require any more code by the user of the property. 33 actual value of the property inside the placeholder tags when the synthetic property is retrieved.
34 For example, a numeric property $length might be strange to use as a label, since it will only display a
35 number. However, a synthetic string can be generated with the definition "Length ${length}." which renders
36 more nicely and does not require any more code by the user of the property.
33 37
34 $not_ready and $on_error strings can be given to be used when the data is not ready or there is some error, respectively. These strings do accept placeholder tags. 38 $not_ready and $on_error strings can be given to be used when the data is not ready or there is some error,
39 respectively. These strings do accept placeholder tags.
35 40
36 See @.property_string_del 41 See @.property_string_del
37 ]] 42 ]]
38 params { 43 params {
39 name: string; [[The name for the new synthetic property.]] 44 name: string; [[The name for the new synthetic property.]]
40 definition: string; [[The definition string for the new synthetic property.]] 45 definition: string; [[The definition string for the new synthetic property.]]
41 not_ready: string; [[The text to be used if any of the properties used in $definition is not ready yet. If set to $null, no check against EAGAIN will be done.]] 46 not_ready: string; [[The text to be used if any of the properties used in $definition is not ready yet.
42 on_error: string; [[The text to be used if any of the properties used in $definition is in error. It takes precedence over $not_ready. If set to $null, no error checks are performed.]] 47 If set to $null, no check against EAGAIN will be done.]]
48 on_error: string; [[The text to be used if any of the properties used in $definition is in error. It takes
49 precedence over $not_ready. If set to $null, no error checks are performed.]]
43 } 50 }
44 return: Eina.Error; 51 return: Eina.Error;
45 } 52 }
@@ -54,7 +61,8 @@ class @beta Efl.View_Model extends Efl.Composite_Model
54 return: Eina.Error; 61 return: Eina.Error;
55 } 62 }
56 property_logic_add { 63 property_logic_add {
57 [[Add callbacks that will be triggered when someone ask for the specified property name when getting or setting a property. 64 [[Add callbacks that will be triggered when someone ask for the specified property name when getting or
65 setting a property.
58 66
59 A get or set should at least be provided for this call to succeed. 67 A get or set should at least be provided for this call to succeed.
60 68
@@ -62,14 +70,18 @@ class @beta Efl.View_Model extends Efl.Composite_Model
62 ]] 70 ]]
63 params { 71 params {
64 property: string; [[The property to bind on to.]] 72 property: string; [[The property to bind on to.]]
65 get: EflViewModelPropertyGet; [[Define the get callback called when the @Efl.Model.property.get is called with the above property name.]] 73 get: EflViewModelPropertyGet; [[Define the get callback called when the @Efl.Model.property.get is called
66 set: EflViewModelPropertySet; [[Define the set callback called when the @Efl.Model.property.set is called with the above property name.]] 74 with the above property name.]]
67 binded: iterator<string>; [[Iterator of property name to bind with this defined property see @.property_bind.]] 75 set: EflViewModelPropertySet; [[Define the set callback called when the @Efl.Model.property.set is called
76 with the above property name.]]
77 binded: iterator<string>; [[Iterator of property name to bind with this defined property see
78 @.property_bind.]]
68 } 79 }
69 return: Eina.Error; 80 return: Eina.Error;
70 } 81 }
71 property_logic_del { 82 property_logic_del {
72 [[Delete previously added callbacks that were triggered when someone asked for the specified property name when getting or setting a property. 83 [[Delete previously added callbacks that were triggered when someone asked for the specified property name
84 when getting or setting a property.
73 85
74 A get or set should at least be provided for this call to succeed. 86 A get or set should at least be provided for this call to succeed.
75 87
@@ -102,7 +114,7 @@ class @beta Efl.View_Model extends Efl.Composite_Model
102 } 114 }
103 } 115 }
104 @property children_bind { 116 @property children_bind {
105 [[Define if we will intercept all childrens object reference and 117 [[Define if we will intercept all children object reference and
106 bind them through the ViewModel with the same property logic as this 118 bind them through the ViewModel with the same property logic as this
107 one. Be careful of recursivity. 119 one. Be careful of recursivity.
108 120
diff --git a/src/lib/ecore_con/efl_net_control_technology.eo b/src/lib/ecore_con/efl_net_control_technology.eo
index dc674339a7..01daedd7d3 100644
--- a/src/lib/ecore_con/efl_net_control_technology.eo
+++ b/src/lib/ecore_con/efl_net_control_technology.eo
@@ -48,8 +48,10 @@ class @beta Efl.Net.Control.Technology extends Efl.Loop_Consumer {
48 set { } 48 set { }
49 values { 49 values {
50 enabled: bool; [[When to enable or disable tethering for this technology.]] 50 enabled: bool; [[When to enable or disable tethering for this technology.]]
51 identifier: string @optional; [[The name to identify the tethering. For WiFi this will translate to an SSID.]] 51 identifier: string @optional; [[The name to identify the tethering. For WiFi this will translate to an
52 passphrase: string @optional; [[The passphrase for tethering access. For WiFi this will translate to WPA passphrase.]] 52 SSID.]]
53 passphrase: string @optional; [[The passphrase for tethering access. For WiFi this will translate to
54 WPA passphrase.]]
53 } 55 }
54 } 56 }
55 57
diff --git a/src/lib/ecore_con/efl_net_socket_fd.eo b/src/lib/ecore_con/efl_net_socket_fd.eo
index 8c4147fa33..3fccb44c7a 100644
--- a/src/lib/ecore_con/efl_net_socket_fd.eo
+++ b/src/lib/ecore_con/efl_net_socket_fd.eo
@@ -1,8 +1,9 @@
1class @beta Efl.Net.Socket_Fd extends Efl.Loop_Fd implements Efl.Io.Reader_Fd, Efl.Io.Writer_Fd, Efl.Io.Closer_Fd, Efl.Net.Socket { 1class @beta Efl.Net.Socket_Fd extends Efl.Loop_Fd
2 [[A base implementation for sockets over filedescriptors (fd) 2 implements Efl.Io.Reader_Fd, Efl.Io.Writer_Fd, Efl.Io.Closer_Fd, Efl.Net.Socket {
3 [[A base implementation for sockets over file descriptors (fd)
3 4
4 This is the common class and takes an existing FD, usually 5 This is the common class and takes an existing FD, usually
5 created by an dialer or server. 6 created by an dialler or server.
6 7
7 @Efl.Io.Closer.close_on_exec and 8 @Efl.Io.Closer.close_on_exec and
8 @Efl.Io.Closer.close_on_invalidate are respected and default to 9 @Efl.Io.Closer.close_on_invalidate are respected and default to
diff --git a/src/lib/efl/interfaces/efl_gfx_image.eo b/src/lib/efl/interfaces/efl_gfx_image.eo
index c3d39d8842..b46c1341fd 100644
--- a/src/lib/efl/interfaces/efl_gfx_image.eo
+++ b/src/lib/efl/interfaces/efl_gfx_image.eo
@@ -183,7 +183,7 @@ interface @beta Efl.Gfx.Image
183 making frames and decorations. You would most probably also be 183 making frames and decorations. You would most probably also be
184 using a filled image (as in @Efl.Gfx.Fill.fill_auto) to use as a frame. 184 using a filled image (as in @Efl.Gfx.Fill.fill_auto) to use as a frame.
185 185
186 The default value is @Efl.Gfx.Border_Fill_Mode.default, ie. render 186 The default value is @Efl.Gfx.Border_Fill_Mode.default, i.e. render
187 and scale the center area, respecting its transparency. 187 and scale the center area, respecting its transparency.
188 ]] 188 ]]
189 set {} 189 set {}
@@ -208,8 +208,10 @@ interface @beta Efl.Gfx.Image
208 } 208 }
209 get {} 209 get {}
210 values { 210 values {
211 horizontal: iterator<ptr(Efl.Gfx.Image_Stretch_Region)>; [[Representation of area that are stretchable in the image horizontal space.]] 211 horizontal: iterator<ptr(Efl.Gfx.Image_Stretch_Region)>; [[Representation of areas that are stretchable in
212 vertical: iterator<ptr(Efl.Gfx.Image_Stretch_Region)>; [[Representation of area that are stretchable in the image vertical space.]] 212 the image horizontal space.]]
213 vertical: iterator<ptr(Efl.Gfx.Image_Stretch_Region)>; [[Representation of areas that are stretchable in
214 the image vertical space.]]
213 } 215 }
214 } 216 }
215 @property image_size { 217 @property image_size {
diff --git a/src/lib/efl/interfaces/efl_gfx_image_orientable.eo b/src/lib/efl/interfaces/efl_gfx_image_orientable.eo
index 5a3003094b..09653edd9e 100644
--- a/src/lib/efl/interfaces/efl_gfx_image_orientable.eo
+++ b/src/lib/efl/interfaces/efl_gfx_image_orientable.eo
@@ -8,7 +8,7 @@ enum Efl.Gfx.Image_Orientation
8 Directional values ($up, $down, $left, $right) indicate the final direction in 8 Directional values ($up, $down, $left, $right) indicate the final direction in
9 which the top of the image will be facing (e.g. a picture of a house will have 9 which the top of the image will be facing (e.g. a picture of a house will have
10 its roof pointing to the right if the $right orientation is used). 10 its roof pointing to the right if the $right orientation is used).
11 Flipping values ($flip_horizontal and $flip_vertical) can be additionaly added 11 Flipping values ($flip_horizontal and $flip_vertical) can be additionally added
12 to produce a mirroring in each axis. 12 to produce a mirroring in each axis.
13 Not to be confused with @Efl.Ui.Layout_Orientation which is meant for widgets, rather 13 Not to be confused with @Efl.Ui.Layout_Orientation which is meant for widgets, rather
14 than images and canvases. This enum is used to rotate images, videos and 14 than images and canvases. This enum is used to rotate images, videos and
@@ -19,10 +19,12 @@ enum Efl.Gfx.Image_Orientation
19 right = 1, [[Orient right, rotate 90 degrees clock-wise.]] 19 right = 1, [[Orient right, rotate 90 degrees clock-wise.]]
20 down = 2, [[Orient down, rotate 180 degrees.]] 20 down = 2, [[Orient down, rotate 180 degrees.]]
21 left = 3, [[Orient left, rotate 270 degrees clock-wise.]] 21 left = 3, [[Orient left, rotate 270 degrees clock-wise.]]
22 rotation_bitmask = 3, [[Bitmask that can be used to isolate rotation values, that is, $none, $up, $down, $left and $right.]] 22 rotation_bitmask = 3, [[Bitmask that can be used to isolate rotation values, that is, $none, $up, $down, $left and
23 $right.]]
23 flip_horizontal = 4, [[Mirror horizontally. Can be added to the other values.]] 24 flip_horizontal = 4, [[Mirror horizontally. Can be added to the other values.]]
24 flip_vertical = 8, [[Mirror vertically. Can be added to the other values.]] 25 flip_vertical = 8, [[Mirror vertically. Can be added to the other values.]]
25 flip_bitmask = 12 [[Bitmask that can be used to isolate flipping values, that is, $flip_vertical and $flip_horizontal.]] 26 flip_bitmask = 12 [[Bitmask that can be used to isolate flipping values, that is, $flip_vertical and
27 $flip_horizontal.]]
26} 28}
27 29
28interface Efl.Gfx.Image_Orientable 30interface Efl.Gfx.Image_Orientable
diff --git a/src/lib/efl/interfaces/efl_io_buffer.eo b/src/lib/efl/interfaces/efl_io_buffer.eo
index 5d18bbf49f..f54bba953a 100644
--- a/src/lib/efl/interfaces/efl_io_buffer.eo
+++ b/src/lib/efl/interfaces/efl_io_buffer.eo
@@ -1,4 +1,5 @@
1class @beta Efl.Io.Buffer extends Efl.Object implements Efl.Io.Reader, Efl.Io.Writer, Efl.Io.Closer, Efl.Io.Sizer, Efl.Io.Positioner { 1class @beta Efl.Io.Buffer extends Efl.Object
2 implements Efl.Io.Reader, Efl.Io.Writer, Efl.Io.Closer, Efl.Io.Sizer, Efl.Io.Positioner {
2 [[Generic In-memory buffer of data to be used as I/O. 3 [[Generic In-memory buffer of data to be used as I/O.
3 4
4 This class offers both input and output, which can be used at 5 This class offers both input and output, which can be used at
@@ -118,7 +119,9 @@ class @beta Efl.Io.Buffer extends Efl.Object implements Efl.Io.Reader, Efl.Io.Wr
118 ]] 119 ]]
119 get { } 120 get { }
120 values { 121 values {
121 slice: Eina.Slice; [[Slice of the current buffer, may be invalidated if @Efl.Io.Writer.write, @Efl.Io.Closer.close or @Efl.Io.Sizer.resize are called. It is the full slice, not a partial one starting at current position.]] 122 slice: Eina.Slice; [[Slice of the current buffer, may be invalidated if @Efl.Io.Writer.write,
123 @Efl.Io.Closer.close or @Efl.Io.Sizer.resize are called.
124 It is the full slice, not a partial one starting at current position.]]
122 } 125 }
123 } 126 }
124 127
@@ -137,7 +140,8 @@ class @beta Efl.Io.Buffer extends Efl.Object implements Efl.Io.Reader, Efl.Io.Wr
137 events { 140 events {
138 position_read,changed: void; [[Notifies @.position_read changed]] 141 position_read,changed: void; [[Notifies @.position_read changed]]
139 position_write,changed: void; [[Notifies @.position_write changed]] 142 position_write,changed: void; [[Notifies @.position_write changed]]
140 reallocated: void; [[Notifies the internal buffer was reallocated, thus whatever was returned by @.slice becomes invalid]] 143 reallocated: void; [[Notifies the internal buffer was reallocated, thus whatever was returned by @.slice
144 becomes invalid.]]
141 } 145 }
142 146
143 implements { 147 implements {
diff --git a/src/lib/efl/interfaces/efl_io_queue.eo b/src/lib/efl/interfaces/efl_io_queue.eo
index 75011d87d2..0da629b7bc 100644
--- a/src/lib/efl/interfaces/efl_io_queue.eo
+++ b/src/lib/efl/interfaces/efl_io_queue.eo
@@ -52,7 +52,9 @@ class @beta Efl.Io.Queue extends Efl.Object implements Efl.Io.Reader, Efl.Io.Wri
52 ]] 52 ]]
53 get { } 53 get { }
54 values { 54 values {
55 slice: Eina.Slice; [[Slice of the current buffer, may be invalidated if @Efl.Io.Writer.write, @Efl.Io.Closer.close or @Efl.Io.Reader.read are called. It is the full slice available for reading.]] 55 slice: Eina.Slice; [[Slice of the current buffer, may be invalidated if @Efl.Io.Writer.write,
56 @Efl.Io.Closer.close or @Efl.Io.Reader.read are called.
57 It is the full slice available for reading.]]
56 } 58 }
57 } 59 }
58 60
diff --git a/src/lib/efl/interfaces/efl_io_reader.eo b/src/lib/efl/interfaces/efl_io_reader.eo
index 374e81e1fb..fca65ab59a 100644
--- a/src/lib/efl/interfaces/efl_io_reader.eo
+++ b/src/lib/efl/interfaces/efl_io_reader.eo
@@ -29,7 +29,9 @@ interface Efl.Io.Reader {
29 You can understand this method as read(2) libc function. 29 You can understand this method as read(2) libc function.
30 ]] 30 ]]
31 params { 31 params {
32 @inout rw_slice: rw_slice<ubyte>; [[Provides a pre-allocated memory to be filled up to rw_slice.len. It will be populated and the length will be set to the actually used amount of bytes, which can be smaller than the request.]] 32 @inout rw_slice: rw_slice<ubyte>; [[Provides a pre-allocated memory to be filled up to rw_slice.len.
33 It will be populated and the length will be set to the actually
34 used amount of bytes, which can be smaller than the request.]]
33 } 35 }
34 return: Eina.Error; [[0 on succeed, a mapping of errno otherwise]] 36 return: Eina.Error; [[0 on succeed, a mapping of errno otherwise]]
35 } 37 }
diff --git a/src/lib/efl/interfaces/efl_io_writer.eo b/src/lib/efl/interfaces/efl_io_writer.eo
index d83d5beb0f..8822772f57 100644
--- a/src/lib/efl/interfaces/efl_io_writer.eo
+++ b/src/lib/efl/interfaces/efl_io_writer.eo
@@ -29,8 +29,12 @@ interface Efl.Io.Writer {
29 You can understand this method as write(2) libc function. 29 You can understand this method as write(2) libc function.
30 ]] 30 ]]
31 params { 31 params {
32 @inout slice: slice<ubyte>; [[Provides a pre-populated memory to be used up to slice.len. The returned slice will be adapted as length will be set to the actually used amount of bytes, which can be smaller than the request.]] 32 @inout slice: slice<ubyte>; [[Provides a pre-populated memory to be used up to slice.len.
33 @out remaining: slice<ubyte> @optional; [[Convenience to output the remaining parts of slice that was not written. If the full slice was written, this will be a slice of zero-length.]] 33 The returned slice will be adapted as length will be set to the actually
34 used amount of bytes, which can be smaller than the request.]]
35 @out remaining: slice<ubyte> @optional; [[Convenience to output the remaining parts of slice that were
36 not written. If the full slice was written, this will be a
37 slice of zero-length.]]
34 } 38 }
35 return: Eina.Error; [[0 on succeed, a mapping of errno otherwise]] 39 return: Eina.Error; [[0 on succeed, a mapping of errno otherwise]]
36 } 40 }
diff --git a/src/lib/efl/interfaces/efl_model.eo b/src/lib/efl/interfaces/efl_model.eo
index b6e78cc04a..8e58c24926 100644
--- a/src/lib/efl/interfaces/efl_model.eo
+++ b/src/lib/efl/interfaces/efl_model.eo
@@ -22,7 +22,7 @@ interface @beta Efl.Model
22 get { 22 get {
23 [[Get properties from model. 23 [[Get properties from model.
24 24
25 properties_get is due to provide callers a way the fetch the 25 Properties_get is due to provide callers a way the fetch the
26 current properties implemented/used by the model. The event 26 current properties implemented/used by the model. The event
27 @[Efl.Model.properties,changed] will be raised to notify 27 @[Efl.Model.properties,changed] will be raised to notify
28 listeners of any modifications in the properties. 28 listeners of any modifications in the properties.
@@ -51,7 +51,8 @@ interface @beta Efl.Model
51 51
52 See @.property.get, @[Efl.Model.properties,changed] 52 See @.property.get, @[Efl.Model.properties,changed]
53 ]] 53 ]]
54 return: future<any_value_ptr>; [[Return an error in case the property could not be set, the value that was set otherwise.]] 54 return: future<any_value_ptr>; [[Return an error in case the property could not be set,
55 or the value that was set otherwise.]]
55 } 56 }
56 get { 57 get {
57 [[Retrieve the value of a given property name. 58 [[Retrieve the value of a given property name.
@@ -75,7 +76,7 @@ interface @beta Efl.Model
75 76
76 @.property.get can return an error with code EAGAIN when it doesn't have any 77 @.property.get can return an error with code EAGAIN when it doesn't have any
77 meaningful value. To make life easier, this future will resolve when 78 meaningful value. To make life easier, this future will resolve when
78 the error:EAGAIN disapears. Either into a failed future in case the error 79 the error:EAGAIN disappears. Either into a failed future in case the error
79 code changed to something else or a success with the value of the property 80 code changed to something else or a success with the value of the property
80 whenever the property finally changes. 81 whenever the property finally changes.
81 82
@@ -85,7 +86,8 @@ interface @beta Efl.Model
85 params { 86 params {
86 @in property: string; [[Property name.]] 87 @in property: string; [[Property name.]]
87 } 88 }
88 return: future<any_value_ptr>; [[Future to be resolved when the property changes to anything other than error:EAGAIN]] 89 return: future<any_value_ptr>; [[Future to be resolved when the property changes to anything other than
90 error:EAGAIN]]
89 } 91 }
90 children_slice_get { 92 children_slice_get {
91 [[Get children slice OR full range. 93 [[Get children slice OR full range.
diff --git a/src/lib/efl/interfaces/efl_ui_factory.eo b/src/lib/efl/interfaces/efl_ui_factory.eo
index ff0cd1076d..3a531af533 100644
--- a/src/lib/efl/interfaces/efl_ui_factory.eo
+++ b/src/lib/efl/interfaces/efl_ui_factory.eo
@@ -1,5 +1,5 @@
1struct @beta Efl.Ui.Factory_Item_Created_Event { 1struct @beta Efl.Ui.Factory_Item_Created_Event {
2 [[EFL Ui Factory event structure provided when an item was just created.]] 2 [[EFL UI Factory event structure provided when an item was just created.]]
3 model: Efl.Model; [[The model already set on the new item.]] 3 model: Efl.Model; [[The model already set on the new item.]]
4 item: Efl.Gfx.Entity; [[The item that was just created.]] 4 item: Efl.Gfx.Entity; [[The item that was just created.]]
5} 5}
@@ -11,10 +11,11 @@ interface @beta Efl.Ui.Factory extends Efl.Ui.Property_Bind, Efl.Ui.Factory_Bind
11 create @protected { 11 create @protected {
12 [[Create a UI object from the necessary properties in the specified model. 12 [[Create a UI object from the necessary properties in the specified model.
13 13
14 14 Note: This is the function you need to implement for a custom factory, but if you want to use a factory,
15 Note: This is the function you need to implement for a custom factory, but if you want to use a factory, you should rely on @Efl.Ui.View_Factory.create_with_event.]] 15 you should rely on @Efl.Ui.View_Factory.create_with_event.]]
16 params { 16 params {
17 models: iterator<Efl.Model>; [[Efl iterator providing the model to be associated to the new item. It should remain valid until the end of the function call.]] 17 models: iterator<Efl.Model>; [[Efl iterator providing the model to be associated to the new item.
18 It should remain valid until the end of the function call.]]
18 parent: Efl.Gfx.Entity; [[Efl canvas]] 19 parent: Efl.Gfx.Entity; [[Efl canvas]]
19 } 20 }
20 return: future<Efl.Gfx.Entity>; [[Created UI object]] 21 return: future<Efl.Gfx.Entity>; [[Created UI object]]
@@ -26,9 +27,11 @@ interface @beta Efl.Ui.Factory extends Efl.Ui.Property_Bind, Efl.Ui.Factory_Bind
26 } 27 }
27 } 28 }
28 building @const { 29 building @const {
29 [[This function is called during the creation of an UI object between the @Efl.Object.constructor and @Efl.Object.finalize call. 30 [[This function is called during the creation of an UI object between the @Efl.Object.constructor and
31 @Efl.Object.finalize call.
30 32
31 Note: if the @Efl.Ui.Factory does keep a cache of object, this won't be called when object are pulled out of the cache.]] 33 Note: If the @Efl.Ui.Factory does keep a cache of objects, this won't be called when objects are pulled out
34 of the cache.]]
32 params { 35 params {
33 ui_view: Efl.Gfx.Entity; [[The UI object being created.]] 36 ui_view: Efl.Gfx.Entity; [[The UI object being created.]]
34 } 37 }
diff --git a/src/lib/efl/interfaces/efl_ui_layout_orientable_readonly.eo b/src/lib/efl/interfaces/efl_ui_layout_orientable_readonly.eo
index 8131181025..7daf601ca9 100644
--- a/src/lib/efl/interfaces/efl_ui_layout_orientable_readonly.eo
+++ b/src/lib/efl/interfaces/efl_ui_layout_orientable_readonly.eo
@@ -1,6 +1,7 @@
1mixin @beta Efl.Ui.Layout_Orientable_Readonly extends Efl.Ui.Layout_Orientable 1mixin @beta Efl.Ui.Layout_Orientable_Readonly extends Efl.Ui.Layout_Orientable
2{ 2{
3 implements { 3 implements {
4 Efl.Ui.Layout_Orientable.orientation { set; [[This will always print an error saying that this is a readonly object.]] } 4 Efl.Ui.Layout_Orientable.orientation { set; [[This will always print an error saying that this is a read-only
5 object.]] }
5 } 6 }
6} 7}
diff --git a/src/lib/efl/interfaces/efl_ui_property_bind.eo b/src/lib/efl/interfaces/efl_ui_property_bind.eo
index e60de731a1..31d66e0134 100644
--- a/src/lib/efl/interfaces/efl_ui_property_bind.eo
+++ b/src/lib/efl/interfaces/efl_ui_property_bind.eo
@@ -25,7 +25,10 @@ interface @beta Efl.Ui.Property_Bind
25 } 25 }
26 } 26 }
27 events { 27 events {
28 properties,changed: Efl.Ui.Property_Event; [[Event dispatched when a property on the object has changed due to an user interaction on the object that a model could be interested in.]] 28 properties,changed: Efl.Ui.Property_Event; [[Event dispatched when a property on the object has changed due to
29 property,bound: stringshare; [[Event dispatched when a property on the object is bound to a model. This is useful to not overgenerate event.]] 29 a user interaction on the object that a model could be interested
30 in.]]
31 property,bound: stringshare; [[Event dispatched when a property on the object is bound to a model.
32 This is useful to avoid generating too many events.]]
30 } 33 }
31} 34}
diff --git a/src/lib/efl/interfaces/efl_ui_range_interactive.eo b/src/lib/efl/interfaces/efl_ui_range_interactive.eo
index 3bea8abe2a..7a37918e12 100644
--- a/src/lib/efl/interfaces/efl_ui_range_interactive.eo
+++ b/src/lib/efl/interfaces/efl_ui_range_interactive.eo
@@ -25,9 +25,9 @@ interface @beta Efl.Ui.Range_Interactive extends Efl.Ui.Range_Display
25 } 25 }
26 events { 26 events {
27 steady: void; [[Called when the widget's value has changed and has remained unchanged for 0.2s. 27 steady: void; [[Called when the widget's value has changed and has remained unchanged for 0.2s.
28 This allows filtering out unwanted "noise" from the widget if you are only 28 This allows filtering out unwanted "noise" from the widget if you are only
29 interested in its final position. 29 interested in its final position.
30 Use this event instead of @[Efl.Ui.Range_Display.changed] if you are going to perform a costly operation 30 Use this event instead of @[Efl.Ui.Range_Display.changed] if you are going to perform a costly
31 on its handler. ]] 31 operation on its handler. ]]
32 } 32 }
33} 33}
diff --git a/src/lib/efl/interfaces/efl_ui_view_factory.eo b/src/lib/efl/interfaces/efl_ui_view_factory.eo
index a8a860c7ba..94db98b53a 100644
--- a/src/lib/efl/interfaces/efl_ui_view_factory.eo
+++ b/src/lib/efl/interfaces/efl_ui_view_factory.eo
@@ -4,10 +4,14 @@ class @beta Efl.Ui.View_Factory
4 data: null; 4 data: null;
5 methods { 5 methods {
6 create_with_event @static { 6 create_with_event @static {
7 [[Create a UI object from the necessary properties in the specified model and generate the created event on the factory when the object is done building. This function must be use by all @Efl.Ui.View that need to create object. They should not use @Efl.Ui.Factory.create directly.]] 7 [[Create a UI object from the necessary properties in the specified model and generate the created event on
8 the factory when the object is done building. This function must be use by all @Efl.Ui.View that need to
9 create object. They should not use @Efl.Ui.Factory.create directly.]]
8 params { 10 params {
9 factory: Efl.Ui.Factory; [[The factory to use for requesting the new object from and generating the created event onto.]] 11 factory: Efl.Ui.Factory; [[The factory to use for requesting the new object from and generating the created
10 models: iterator<Efl.Model>; [[Efl iterator providing the model to be associated to the new item. It should remain valid until the end of the function call.]] 12 event onto.]]
13 models: iterator<Efl.Model>; [[Efl iterator providing the model to be associated to the new item. It should
14 remain valid until the end of the function call.]]
11 parent: Efl.Gfx.Entity; [[Efl canvas]] 15 parent: Efl.Gfx.Entity; [[Efl canvas]]
12 } 16 }
13 return: future<Efl.Gfx.Entity>; [[Created UI object]] 17 return: future<Efl.Gfx.Entity>; [[Created UI object]]
diff --git a/src/lib/elementary/efl_access_object.eo b/src/lib/elementary/efl_access_object.eo
index 5d8a2a0718..5689638efe 100644
--- a/src/lib/elementary/efl_access_object.eo
+++ b/src/lib/elementary/efl_access_object.eo
@@ -284,7 +284,7 @@ mixin @beta Efl.Access.Object requires Efl.Object
284 } 284 }
285 } 285 }
286 @property role_name @protected @beta { 286 @property role_name @protected @beta {
287 [[Gets human-readable string indentifying object accessibility role.]] 287 [[Gets human-readable string identifying object accessibility role.]]
288 get { 288 get {
289 } 289 }
290 values { 290 values {
@@ -292,11 +292,12 @@ mixin @beta Efl.Access.Object requires Efl.Object
292 } 292 }
293 } 293 }
294 @property attributes @protected @beta { 294 @property attributes @protected @beta {
295 [[Gets key-value pairs indentifying object extra attributes. Must be free by a user.]] 295 [[Gets key-value pairs identifying object extra attributes. Must be free by a user.]]
296 get { 296 get {
297 } 297 }
298 values { 298 values {
299 attributes: list<ptr(Efl.Access.Attribute) @owned> @owned; [[List of object attributes, Must be freed by the user]] 299 attributes: list<ptr(Efl.Access.Attribute) @owned> @owned; [[List of object attributes.
300 Must be freed by the user]]
300 } 301 }
301 } 302 }
302 attribute_append { 303 attribute_append {
diff --git a/src/lib/elementary/efl_access_text.eo b/src/lib/elementary/efl_access_text.eo
index 9511419986..b1acc3e93e 100644
--- a/src/lib/elementary/efl_access_text.eo
+++ b/src/lib/elementary/efl_access_text.eo
@@ -55,7 +55,9 @@ interface @beta Efl.Access.Text
55 offset: int; [[Position in text.]] 55 offset: int; [[Position in text.]]
56 } 56 }
57 values { 57 values {
58 character: Eina.Unicode; [[Character at offset. 0 when out-of bounds offset has been given. Codepoints between DC80 and DCFF indicates that string includes invalid UTF8 chars.]] 58 character: Eina.Unicode; [[Character at offset. 0 when out-of bounds offset has been given.
59 Codepoints between DC80 and DCFF indicate that string includes invalid
60 UTF8 chars.]]
59 } 61 }
60 } 62 }
61 @property string @protected @beta { 63 @property string @protected @beta {
@@ -64,8 +66,10 @@ interface @beta Efl.Access.Text
64 } 66 }
65 keys { 67 keys {
66 granularity: Efl.Access.Text_Granularity; [[Text granularity]] 68 granularity: Efl.Access.Text_Granularity; [[Text granularity]]
67 start_offset: ptr(int); [[Offset indicating start of string according to given granularity. -1 in case of error.]] 69 start_offset: ptr(int); [[Offset indicating start of string according to given granularity.
68 end_offset: ptr(int); [[Offset indicating end of string according to given granularity. -1 in case of error.]] 70 -1 in case of error.]]
71 end_offset: ptr(int); [[Offset indicating end of string according to given granularity.
72 -1 in case of error.]]
69 } 73 }
70 values { 74 values {
71 string: mstring @owned; [[Newly allocated UTF-8 encoded string. Must be free by a user.]] 75 string: mstring @owned; [[Newly allocated UTF-8 encoded string. Must be free by a user.]]
@@ -136,7 +140,8 @@ interface @beta Efl.Access.Text
136 } 140 }
137 keys { 141 keys {
138 offset: int; [[Offset]] 142 offset: int; [[Offset]]
139 screen_coords: bool; [[If $true, x and y values will be relative to screen origin, otherwise relative to canvas]] 143 screen_coords: bool; [[If $true, x and y values will be relative to screen origin,
144 otherwise relative to canvas]]
140 } 145 }
141 values { 146 values {
142 rect: Eina.Rect; [[Extents rectangle]] 147 rect: Eina.Rect; [[Extents rectangle]]
@@ -155,7 +160,8 @@ interface @beta Efl.Access.Text
155 get { 160 get {
156 } 161 }
157 keys { 162 keys {
158 screen_coords: bool; [[If $true, x and y values will be relative to screen origin, otherwise relative to canvas]] 163 screen_coords: bool; [[If $true, x and y values will be relative to screen origin,
164 otherwise relative to canvas]]
159 x: int; [[X coordinate]] 165 x: int; [[X coordinate]]
160 y: int; [[Y coordinate]] 166 y: int; [[Y coordinate]]
161 } 167 }
@@ -168,7 +174,8 @@ interface @beta Efl.Access.Text
168 get { 174 get {
169 } 175 }
170 keys { 176 keys {
171 screen_coords: bool; [[If $true, x and y values will be relative to screen origin, otherwise relative to canvas]] 177 screen_coords: bool; [[If $true, x and y values will be relative to screen origin,
178 otherwise relative to canvas]]
172 rect: Eina.Rect; [[Bounding box]] 179 rect: Eina.Rect; [[Bounding box]]
173 xclip: Efl.Access.Text_Clip_Type; [[xclip]] 180 xclip: Efl.Access.Text_Clip_Type; [[xclip]]
174 yclip: Efl.Access.Text_Clip_Type; [[yclip]] 181 yclip: Efl.Access.Text_Clip_Type; [[yclip]]
@@ -183,7 +190,8 @@ interface @beta Efl.Access.Text
183 return: bool; [[$true if range extents, $false otherwise]] 190 return: bool; [[$true if range extents, $false otherwise]]
184 } 191 }
185 keys { 192 keys {
186 screen_coords: bool; [[If $true, x and y values will be relative to screen origin, otherwise relative to canvas]] 193 screen_coords: bool; [[If $true, x and y values will be relative to screen origin,
194 otherwise relative to canvas]]
187 start_offset: int; [[Start offset]] 195 start_offset: int; [[Start offset]]
188 end_offset: int; [[End offset]] 196 end_offset: int; [[End offset]]
189 } 197 }
diff --git a/src/lib/elementary/efl_ui_animation_view.eo b/src/lib/elementary/efl_ui_animation_view.eo
index de3dd261ab..e826b08a26 100644
--- a/src/lib/elementary/efl_ui_animation_view.eo
+++ b/src/lib/elementary/efl_ui_animation_view.eo
@@ -3,24 +3,26 @@ enum Efl.Ui.Animation_View_State
3{ 3{
4 [[State of animation view]] 4 [[State of animation view]]
5 not_ready, [[Animation is not ready to play. (Probably, it didn't file set yet or failed to read file.]] 5 not_ready, [[Animation is not ready to play. (Probably, it didn't file set yet or failed to read file.]]
6 play, [[Animation is on playing. see @Efl.Ui.Animation_View.play]] 6 play, [[Animation is playing. See @Efl.Ui.Animation_View.play.]]
7 play_back, [[Animation is on playing back (rewinding). see @Efl.Ui.Animation_View.play_back]] 7 play_back, [[Animation is playing back (rewinding). See @Efl.Ui.Animation_View.play_back.]]
8 pause, [[Animation has been paused. To continue animation, call @Efl.Ui.Animation_View.resume. see @Efl.Ui.Animation_View.pause]] 8 pause, [[Animation has been paused. To continue animation call @Efl.Ui.Animation_View.resume.
9 stop [[Animation view successfully loaded a file then readied for playing. Otherwise after finished animation or stopped forcely by request. see @Efl.Ui.Animation_View.stop]] 9 See @Efl.Ui.Animation_View.pause.]]
10 stop [[Animation view successfully loaded a file then readied for playing.
11 Otherwise after finished animation or stopped forcibly by request. See @Efl.Ui.Animation_View.stop.]]
10} 12}
11 13
12class @beta Efl.Ui.Animation_View extends Efl.Ui.Widget implements Efl.Gfx.View, Efl.File 14class @beta Efl.Ui.Animation_View extends Efl.Ui.Widget implements Efl.Gfx.View, Efl.File
13{ 15{
14 [[Elementary Animation view class. 16 [[Elementary Animation view class.
15 Animation view is designed to show and play animation of 17 Animation view is designed to show and play animation of
16 vector graphics based content. It hides all efl_canvas_vg details 18 vector graphics based content. It hides all @Efl.Canvas.Vg.Object details
17 but just open an API to read vector data from file. Also, it implements 19 but just open an API to read vector data from file. Also, it implements
18 details of animation control methods of Vector. 20 details of animation control methods of Vector.
19 21
20 Vector data could contain static or animatable vector elements including 22 Vector data could contain static or animatable vector elements including
21 animation infomation. Currently approved vector data file format is svg, json and eet. 23 animation information. Available vector data file formats are SVG, JSON and EET.
22 Only json(known for Lottie file as well) and eet could contains animation infomation, 24 @Efl.Ui.Animation_View currently only supports the animation information contained in
23 currently Animation_View is supporting. 25 JSON (known as Lottie file as well) and EET files.
24 ]] 26 ]]
25 event_prefix: efl_ui_animation_view; 27 event_prefix: efl_ui_animation_view;
26 methods { 28 methods {
@@ -59,7 +61,7 @@ class @beta Efl.Ui.Animation_View extends Efl.Ui.Widget implements Efl.Gfx.View,
59 get { 61 get {
60 } 62 }
61 values { 63 values {
62 auto_repeat: bool; [[Loop mode, Defalut is $false.]] 64 auto_repeat: bool; [[Loop mode, Default is $false.]]
63 } 65 }
64 } 66 }
65 @property speed { 67 @property speed {
@@ -168,7 +170,7 @@ class @beta Efl.Ui.Animation_View extends Efl.Ui.Widget implements Efl.Gfx.View,
168 stop { 170 stop {
169 [[Stop playing animation. 171 [[Stop playing animation.
170 172
171 Stop animation instatly regardless of it's status and reset to 173 Stop animation instantly regardless of its status and reset to
172 show first frame of animation. Even though current animation is paused, 174 show first frame of animation. Even though current animation is paused,
173 the animation status will be stopped. 175 the animation status will be stopped.
174 ]] 176 ]]
@@ -186,7 +188,7 @@ class @beta Efl.Ui.Animation_View extends Efl.Ui.Widget implements Efl.Gfx.View,
186 } 188 }
187 @property state { 189 @property state {
188 [[Current animation view state. 190 [[Current animation view state.
189 see @Efl.Ui.Animation_View_State 191 See @Efl.Ui.Animation_View_State
190 ]] 192 ]]
191 get{ 193 get{
192 } 194 }
@@ -196,13 +198,13 @@ class @beta Efl.Ui.Animation_View extends Efl.Ui.Widget implements Efl.Gfx.View,
196 } 198 }
197 is_playing_back { 199 is_playing_back {
198 [[Returns the status whether current animation is on playing forward or backward. 200 [[Returns the status whether current animation is on playing forward or backward.
199 warning: If animation view is not on playing, it will return $false. 201 Note: If animation view is not on playing, it will return $false.
200 ]] 202 ]]
201 return: bool; [[$true, if animation on playing back, $false otherwise.]] 203 return: bool; [[$true, if animation on playing back, $false otherwise.]]
202 } 204 }
203 @property frame_count { 205 @property frame_count {
204 [[The index of end frame of the animation view, if it's animated. 206 [[The index of end frame of the animation view, if it's animated.
205 note : frame number starts with 0. 207 Note : frame number starts with 0.
206 ]] 208 ]]
207 get { 209 get {
208 } 210 }
diff --git a/src/lib/elementary/efl_ui_bg.eo b/src/lib/elementary/efl_ui_bg.eo
index 2d38a32392..f4552e341f 100644
--- a/src/lib/elementary/efl_ui_bg.eo
+++ b/src/lib/elementary/efl_ui_bg.eo
@@ -1,4 +1,5 @@
1class @beta Efl.Ui.Bg extends Efl.Ui.Layout_Base implements Efl.File, Efl.Gfx.Color, Efl.Gfx.Image, Efl.Gfx.Image_Load_Controller 1class @beta Efl.Ui.Bg extends Efl.Ui.Layout_Base
2 implements Efl.File, Efl.Gfx.Color, Efl.Gfx.Image, Efl.Gfx.Image_Load_Controller
2{ 3{
3 [[The bg (background) widget is used for setting (solid) background decorations 4 [[The bg (background) widget is used for setting (solid) background decorations
4 for a window (unless it has transparency enabled) or for any container object. It 5 for a window (unless it has transparency enabled) or for any container object. It
diff --git a/src/lib/elementary/efl_ui_caching_factory.eo b/src/lib/elementary/efl_ui_caching_factory.eo
index 266ea5803d..f0a5aae443 100644
--- a/src/lib/elementary/efl_ui_caching_factory.eo
+++ b/src/lib/elementary/efl_ui_caching_factory.eo
@@ -1,22 +1,24 @@
1class @beta Efl.Ui.Caching_Factory extends Efl.Ui.Widget_Factory 1class @beta Efl.Ui.Caching_Factory extends Efl.Ui.Widget_Factory
2{ 2{
3 [[Efl Ui Factory that provides object caching. 3 [[Efl UI Factory that provides object caching.
4 4
5 This factory handles caching of one type of object that must be an @Efl.Gfx.Entity with an @Efl.Ui.View interface defined. 5 This factory handles caching of one type of object that must be an @Efl.Gfx.Entity with an @Efl.Ui.View interface
6 This factory will rely on its parent class @Efl.Ui.Widget_Factory for creating the subset of class that match @Efl.Ui.Widget 6 defined.
7 interface. 7 This factory will rely on its parent class @Efl.Ui.Widget_Factory for creating the subset of class that match the
8 @Efl.Ui.Widget interface.
8 The factory will automatically empties the cache when the application goes into pause. 9 The factory will automatically empties the cache when the application goes into pause.
9 10
10 Creating objects is costly and time consuming, keeping a few on hand for when you next will need them helps a lot. 11 Creating objects is costly and time consuming, keeping a few on hand for when you next will need them helps a lot.
11 This is what this factory caching infrastructure provides. It will create the object from the class defined on it and 12 This is what this factory caching infrastructure provides. It will create the object from the class defined on it
12 set the parent and the model as needed for all created items. The View has to release the Item using the 13 and set the parent and the model as needed for all created items. The View has to release the Item using the
13 release function of the Factory interface for all of this to work properly. 14 release function of the Factory interface for all of this to work properly.
14 15
15 The cache might decide to flush itself when the application event pause is triggered. 16 The cache might decide to flush itself when the application event pause is triggered.
16 ]] 17 ]]
17 methods { 18 methods {
18 @property memory_limit { 19 @property memory_limit {
19 [[Define the maxium size in Bytes that all the object waiting on standby in the cache take. They must provide the @Efl.Cached.Item interface for an accurate accounting.]] 20 [[Define the maximum size in Bytes that all the objects waiting on standby in the cache can take.
21 They must provide the @Efl.Cached.Item interface for an accurate accounting.]]
20 get {} 22 get {}
21 set {} 23 set {}
22 values { 24 values {
diff --git a/src/lib/elementary/efl_ui_calendar.eo b/src/lib/elementary/efl_ui_calendar.eo
index 586535f500..1d522f6385 100644
--- a/src/lib/elementary/efl_ui_calendar.eo
+++ b/src/lib/elementary/efl_ui_calendar.eo
@@ -16,7 +16,8 @@ enum @beta Efl.Ui.Calendar_Weekday
16 last [[Sentinel value to indicate last enum field during iteration]] 16 last [[Sentinel value to indicate last enum field during iteration]]
17} 17}
18 18
19class @beta Efl.Ui.Calendar extends Efl.Ui.Layout_Base implements Efl.Ui.Focus.Composition, Efl.Access.Widget.Action, Efl.Ui.Format 19class @beta Efl.Ui.Calendar extends Efl.Ui.Layout_Base
20 implements Efl.Ui.Focus.Composition, Efl.Access.Widget.Action, Efl.Ui.Format
20{ 21{
21 [[Calendar widget 22 [[Calendar widget
22 23
diff --git a/src/lib/elementary/efl_ui_check.eo b/src/lib/elementary/efl_ui_check.eo
index d3f6a39a42..9144ec4f87 100644
--- a/src/lib/elementary/efl_ui_check.eo
+++ b/src/lib/elementary/efl_ui_check.eo
@@ -1,4 +1,6 @@
1class @beta Efl.Ui.Check extends Efl.Ui.Layout_Base implements Efl.Access.Widget.Action, Efl.Text, Efl.Content, Efl.Input.Clickable, Efl.Ui.Selectable 1class @beta Efl.Ui.Check extends Efl.Ui.Layout_Base
2 implements Efl.Access.Widget.Action, Efl.Text, Efl.Content, Efl.Input.Clickable,
3 Efl.Ui.Selectable
2{ 4{
3 [[Check widget 5 [[Check widget
4 6
diff --git a/src/lib/elementary/efl_ui_focus_composition.eo b/src/lib/elementary/efl_ui_focus_composition.eo
index c52bf8cadf..92062976ed 100644
--- a/src/lib/elementary/efl_ui_focus_composition.eo
+++ b/src/lib/elementary/efl_ui_focus_composition.eo
@@ -1,26 +1,28 @@
1mixin @beta Efl.Ui.Focus.Composition requires Efl.Ui.Widget { 1mixin @beta Efl.Ui.Focus.Composition requires Efl.Ui.Widget {
2 [[This defines the inheriting widget as Composition widget. 2 [[This defines the inheriting widget as Composition widget.
3 3
4 A composition widget is a widget that's the logical parent of another set of widgets which can be used for interaction. 4 A composition widget is a widget that's the logical parent of another set of widgets
5 which can be used for interaction.
5 ]] 6 ]]
6 methods { 7 methods {
7 @property composition_elements @protected { 8 @property composition_elements @protected {
8 [[Set the order of elements that will be used for composition 9 [[Set the order of elements that will be used for composition
9 10
10 Elements of the list can be either an Efl.Ui.Widget, an Efl.Ui.Focus.Object or an Efl.Gfx. 11 Elements of the list can be either an @Efl.Ui.Widget, an @Efl.Ui.Focus.Object or an @Efl.Gfx.Entity.
11 12
12 If the element is an Efl.Gfx.Entity, then the geometry is used as focus geometry, the focus property is redirected to the evas focus property. The mixin will take care of registration. 13 If the element is an @Efl.Ui.Widget nothing is done and the widget is simply part of the order.
13 14
14 If the element is an Efl.Ui.Focus.Object, then the mixin will take care of registering the element. 15 If the element is an @Efl.Ui.Focus.Object, then the mixin will take care of registering the element.
15 16
16 If the element is a Efl.Ui.Widget nothing is done and the widget is simply part of the order. 17 If the element is an @Efl.Gfx.Entity, then the geometry is used as focus geometry,
18 the focus property is redirected to the evas focus property. The mixin will take care of registration.
17 ]] 19 ]]
18 values { 20 values {
19 logical_order : list<Efl.Gfx.Entity> @owned; [[The order to use]] 21 logical_order : list<Efl.Gfx.Entity> @owned; [[The order to use]]
20 } 22 }
21 } 23 }
22 dirty @protected { 24 dirty @protected {
23 [[ Mark this widget as dirty, the children can be considered to be changed after that call 25 [[Mark this widget as dirty, the children can be considered to be changed after that call
24 ]] 26 ]]
25 } 27 }
26 prepare @protected { 28 prepare @protected {
diff --git a/src/lib/elementary/efl_ui_focus_layer.eo b/src/lib/elementary/efl_ui_focus_layer.eo
index 4773de3201..05d847ad98 100644
--- a/src/lib/elementary/efl_ui_focus_layer.eo
+++ b/src/lib/elementary/efl_ui_focus_layer.eo
@@ -1,9 +1,10 @@
1mixin @beta Efl.Ui.Focus.Layer requires Efl.Ui.Widget extends Efl.Ui.Widget_Focus_Manager { 1mixin @beta Efl.Ui.Focus.Layer requires Efl.Ui.Widget extends Efl.Ui.Widget_Focus_Manager {
2 [[This defines the inheriting widget as focus layer 2 [[This defines the inheriting widget as focus layer.
3 3
4 A focus layer is the uppermost one which received input and handles all focus related events for as long as it exists and is visible. It's NOT possible to escape this layer with focus movement. 4 A focus layer is the uppermost one which receives input and handles all focus related events for as long as
5 it exists and is visible. It's NOT possible to escape this layer with focus movement.
5 6
6 Once the object is hidden or destroyed the focus will go back to the mainwindow, where it was before. 7 Once the object is hidden or destroyed the focus will go back to the main window, where it was before.
7 ]] 8 ]]
8 methods { 9 methods {
9 @property enable @protected { 10 @property enable @protected {
@@ -15,7 +16,8 @@ mixin @beta Efl.Ui.Focus.Layer requires Efl.Ui.Widget extends Efl.Ui.Widget_Focu
15 @property behaviour @protected { 16 @property behaviour @protected {
16 [[Constructor for setting the behaviour of the layer]] 17 [[Constructor for setting the behaviour of the layer]]
17 values { 18 values {
18 enable_on_visible : bool; [[$true means layer will set itself once the inheriting widget becomes visible, $false means the layer isn't enabled automatically]] 19 enable_on_visible : bool; [[$true means layer will set itself once the inheriting widget becomes visible,
20 $false means the layer isn't enabled automatically]]
19 cycle : bool; [[If $true the focus will cycle in the layer, if $false]] 21 cycle : bool; [[If $true the focus will cycle in the layer, if $false]]
20 } 22 }
21 } 23 }
diff --git a/src/lib/elementary/efl_ui_focus_manager.eo b/src/lib/elementary/efl_ui_focus_manager.eo
index fbc78884f0..14172a55f1 100644
--- a/src/lib/elementary/efl_ui_focus_manager.eo
+++ b/src/lib/elementary/efl_ui_focus_manager.eo
@@ -22,7 +22,7 @@ struct Efl.Ui.Focus.Manager_Logical_End_Detail {
22 22
23 @since 1.22 23 @since 1.22
24 ]] 24 ]]
25 is_regular_end : bool; [[$true if element is registered as regular element in the @Efl.Ui.Focus.Manager obejct, $false otherwise]] 25 is_regular_end : bool; [[$true if element is registered as regular element in the @Efl.Ui.Focus.Manager object.]]
26 element : Efl.Ui.Focus.Object; [[The last element of the logical chain in the @Efl.Ui.Focus.Manager]] 26 element : Efl.Ui.Focus.Object; [[The last element of the logical chain in the @Efl.Ui.Focus.Manager]]
27} 27}
28 28
@@ -53,7 +53,8 @@ interface Efl.Ui.Focus.Manager {
53 [[Return the object in the $direction from $child.]] 53 [[Return the object in the $direction from $child.]]
54 params { 54 params {
55 direction : Efl.Ui.Focus.Direction; [[Direction to move focus.]] 55 direction : Efl.Ui.Focus.Direction; [[Direction to move focus.]]
56 child : Efl.Ui.Focus.Object; [[The child to move from. Pass $null to indicate the currently focused child.]] 56 child : Efl.Ui.Focus.Object; [[The child to move from.
57 Pass $null to indicate the currently focused child.]]
57 logical : bool; [[Wether you want to have a logical node as result or a non-logical. 58 logical : bool; [[Wether you want to have a logical node as result or a non-logical.
58 Note, in a @.move call no logical node will get focus.]] 59 Note, in a @.move call no logical node will get focus.]]
59 } 60 }
@@ -110,7 +111,7 @@ interface Efl.Ui.Focus.Manager {
110 } 111 }
111 } 112 }
112 @property root { 113 @property root {
113 [[Root node for all logical subtrees. 114 [[Root node for all logical sub-trees.
114 115
115 This property can only be set once. 116 This property can only be set once.
116 ]] 117 ]]
@@ -151,7 +152,8 @@ interface Efl.Ui.Focus.Manager {
151 logical_end { 152 logical_end {
152 [[Return the last logical object. 153 [[Return the last logical object.
153 154
154 The returned object is the last object that would be returned if you start at the root and move the direction into next. 155 The returned object is the last object that would be returned if you start at the root
156 and move in the "next" direction.
155 ]] 157 ]]
156 return : Efl.Ui.Focus.Manager_Logical_End_Detail; [[Last object.]] 158 return : Efl.Ui.Focus.Manager_Logical_End_Detail; [[Last object.]]
157 } 159 }
@@ -188,7 +190,7 @@ interface Efl.Ui.Focus.Manager {
188 190
189 Even if an object is moved, the focus manager will not recalculate its relations. 191 Even if an object is moved, the focus manager will not recalculate its relations.
190 This can be used when you know that the set of widgets in the focus manager is 192 This can be used when you know that the set of widgets in the focus manager is
191 moved the same way, so the relations between the widets in the set do not change 193 moved the same way, so the relations between the widgets in the set do not change
192 and the complex calculations can be avoided. 194 and the complex calculations can be avoided.
193 Use @.dirty_logic_unfreeze to re-enable relationship calculation. 195 Use @.dirty_logic_unfreeze to re-enable relationship calculation.
194 ]] 196 ]]
@@ -201,10 +203,15 @@ interface Efl.Ui.Focus.Manager {
201 } 203 }
202 } 204 }
203 events { 205 events {
204 redirect,changed : Efl.Ui.Focus.Manager; [[Redirect object has changed, the old manager is passed as an event argument.]] 206 redirect,changed : Efl.Ui.Focus.Manager; [[Redirect object has changed, the old manager is passed as
205 flush,pre: void; [[After this event, the manager object will calculate relations in the graph. Can be used to add / remove children in a lazy fashion.]] 207 an event argument.]]
208 flush,pre: void; [[After this event, the manager object will calculate relations in the graph.
209 Can be used to add / remove children in a lazy fashion.]]
206 coords,dirty: void; [[Cached relationship calculation results have been invalidated.]] 210 coords,dirty: void; [[Cached relationship calculation results have been invalidated.]]
207 manager_focus,changed : Efl.Ui.Focus.Object; [[The manager_focus property has changed. The previously focused object is passed as an event argument.]] 211 manager_focus,changed : Efl.Ui.Focus.Object; [[The manager_focus property has changed.
208 dirty_logic_freeze,changed : bool; [[Called when this focus manager is frozen or thawed, even_info being $true indicates that it is now frozen, $false indicates that it is thawed.]] 212 The previously focused object is passed as an event argument.]]
213 dirty_logic_freeze,changed : bool; [[Called when this focus manager is frozen or thawed,
214 even_info being $true indicates that it is now frozen,
215 $false indicates that it is thawed.]]
209 } 216 }
210} 217}
diff --git a/src/lib/elementary/efl_ui_focus_manager_root_focus.eo b/src/lib/elementary/efl_ui_focus_manager_root_focus.eo
index 64b4d83695..0accc6bbe0 100644
--- a/src/lib/elementary/efl_ui_focus_manager_root_focus.eo
+++ b/src/lib/elementary/efl_ui_focus_manager_root_focus.eo
@@ -1,14 +1,13 @@
1class @beta Efl.Ui.Focus.Manager_Root_Focus extends Efl.Ui.Focus.Manager_Calc { 1class @beta Efl.Ui.Focus.Manager_Root_Focus extends Efl.Ui.Focus.Manager_Calc {
2 [[ This class ensures that the root is at least focusable, if nothing else is focusable]] 2 [[This class ensures that the root is at least focusable, if nothing else is focusable.]]
3 methods { 3 methods {
4 @property canvas_object { 4 @property canvas_object {
5 [[ 5 [[The default replacement object for the case that there is no focusable object inside the manager is the root
6 The default replacement object for the case that there is no focusable object inside the manager is the root object. 6 object. However, you can change this by setting this value to something else.
7 However, you can change this by setting this value to something else. 7 $null means that the same value as @Efl.Ui.Focus.Manager.root will be used.
8 $null is triggered as the same value as Efl.Ui.Focus.Manager.root.get
9 ]] 8 ]]
10 values { 9 values {
11 canvas_object : Efl.Canvas.Object; [[Canvas object]] 10 canvas_object : Efl.Canvas.Object; [[Canvas object.]]
12 } 11 }
13 } 12 }
14 } 13 }
diff --git a/src/lib/elementary/efl_ui_focus_manager_window_root.eo b/src/lib/elementary/efl_ui_focus_manager_window_root.eo
index f56e6ccf58..278521345e 100644
--- a/src/lib/elementary/efl_ui_focus_manager_window_root.eo
+++ b/src/lib/elementary/efl_ui_focus_manager_window_root.eo
@@ -1,7 +1,7 @@
1interface Efl.Ui.Focus.Manager_Window_Root { 1interface Efl.Ui.Focus.Manager_Window_Root {
2 [[ A interface to indicate the end of a focus chain. 2 [[An interface to indicate the end of a focus chain.
3 3
4 Focusmanagers are ensuring that if they give focus to something, that they are registered in the upper focus manager. 4 Focus managers are ensuring that if they give focus to something, that is registered in the upper focus manager.
5 The most upper focus manager does not need to do that, and can implement this interface to indicate that. 5 The most upper focus manager does not need to do that, and can implement this interface to indicate that.
6 6
7 @since 1.22 7 @since 1.22
diff --git a/src/lib/elementary/efl_ui_focus_object.eo b/src/lib/elementary/efl_ui_focus_object.eo
index 3210db0e15..77e1f81466 100644
--- a/src/lib/elementary/efl_ui_focus_object.eo
+++ b/src/lib/elementary/efl_ui_focus_object.eo
@@ -33,7 +33,9 @@ mixin Efl.Ui.Focus.Object
33 } 33 }
34 @property focus_manager { 34 @property focus_manager {
35 [[This is the focus manager where this focus object is registered in. 35 [[This is the focus manager where this focus object is registered in.
36 The element which is the $root of a Efl.Ui.Focus.Manager will not have this focus manager as this object, but rather the second focus manager where it is registered in. 36 The element which is the $root of a Efl.Ui.Focus.Manager will not
37 have this focus manager as this object, but rather the second focus
38 manager where it is registered in.
37 ]] 39 ]]
38 get {} 40 get {}
39 values { 41 values {
@@ -60,7 +62,8 @@ mixin Efl.Ui.Focus.Object
60 ]] 62 ]]
61 } 63 }
62 setup_order_non_recursive @protected { 64 setup_order_non_recursive @protected {
63 [[This is called when @.setup_order is called, but only on the first call, additional recursive calls to @.setup_order will not call this function again.]] 65 [[This is called when @.setup_order is called, but only on the first call,
66 additional recursive calls to @.setup_order will not call this function again.]]
64 } 67 }
65 on_focus_update @protected { 68 on_focus_update @protected {
66 [[Virtual function handling focus in/out events on the widget]] 69 [[Virtual function handling focus in/out events on the widget]]
diff --git a/src/lib/elementary/efl_ui_format.eo b/src/lib/elementary/efl_ui_format.eo
index 3858a79ef1..baa8613946 100644
--- a/src/lib/elementary/efl_ui_format.eo
+++ b/src/lib/elementary/efl_ui_format.eo
@@ -44,7 +44,8 @@ mixin @beta Efl.Ui.Format requires Efl.Object
44 or an @Efl.Ui.Spin can hold numbers 1 to 7, but display the strings "Monday" thru "Sunday". 44 or an @Efl.Ui.Spin can hold numbers 1 to 7, but display the strings "Monday" thru "Sunday".
45 45
46 This conversion can be controlled through the @.format_func, @.format_values and @.format_string properties. 46 This conversion can be controlled through the @.format_func, @.format_values and @.format_string properties.
47 Only one of them needs to be set. When more than one is set @.format_values has the highest priority, followed by @.format_func and then @.format_string. 47 Only one of them needs to be set. When more than one is set @.format_values has the highest priority,
48 followed by @.format_func and then @.format_string.
48 If one mechanism fails to produce a valid string the others will be tried (if provided) in descending 49 If one mechanism fails to produce a valid string the others will be tried (if provided) in descending
49 order of priority. 50 order of priority.
50 If no user-provided mechanism works, a fallback is used that just displays the value. 51 If no user-provided mechanism works, a fallback is used that just displays the value.
@@ -103,7 +104,7 @@ mixin @beta Efl.Ui.Format requires Efl.Object
103 string: string; [[Formatting string containing regular characters and format specifiers.]] 104 string: string; [[Formatting string containing regular characters and format specifiers.]]
104 type: Efl.Ui.Format_String_Type(Efl.Ui.Format_String_Type.simple); 105 type: Efl.Ui.Format_String_Type(Efl.Ui.Format_String_Type.simple);
105 [[Type of formatting string, which controls how the 106 [[Type of formatting string, which controls how the
106 different format specifiers are to be traslated.]] 107 different format specifiers are to be translated.]]
107 } 108 }
108 } 109 }
109 110
diff --git a/src/lib/elementary/efl_ui_list_view.eo b/src/lib/elementary/efl_ui_list_view.eo
index b5e15591a6..f1490b3b26 100644
--- a/src/lib/elementary/efl_ui_list_view.eo
+++ b/src/lib/elementary/efl_ui_list_view.eo
@@ -13,7 +13,8 @@ class @beta Efl.Ui.List_View extends Efl.Ui.Layout_Base implements Efl.Ui.Scroll
13{ 13{
14 methods { 14 methods {
15 @property homogeneous { 15 @property homogeneous {
16 [[When in homogeneous mode, all items have the same height and width. Otherwise, each item's size is respected. 16 [[When in homogeneous mode, all items have the same height and width.
17 Otherwise, each item's size is respected.
17 ]] 18 ]]
18 get { 19 get {
19 } 20 }
diff --git a/src/lib/elementary/efl_ui_multi_selectable.eo b/src/lib/elementary/efl_ui_multi_selectable.eo
index a980389072..87f155d36c 100644
--- a/src/lib/elementary/efl_ui_multi_selectable.eo
+++ b/src/lib/elementary/efl_ui_multi_selectable.eo
@@ -1,18 +1,19 @@
1enum @beta Efl.Ui.Select_Mode { 1enum @beta Efl.Ui.Select_Mode {
2 [[Type of multi selectable object.]] 2 [[Type of multi selectable object.]]
3 single, [[Only single child is selected. if the child is selected, 3 single, [[Only single child is selected. If a child is selected,
4 previous selected child will be unselected.]] 4 previous selected child will be unselected.]]
5 single_always, [[Same as single select except, this will be selected 5 single_always, [[Same as single select except, this will be selected
6 in every select calls though child is already been selected.]] 6 in every select call even if child is already been selected.]]
7 multi, [[allow multiple selection of children.]] 7 multi, [[Allow multiple selection of children.]]
8 none [[Last value of select mode. child cannot be selected at all.]] 8 none [[No child can be selected at all.]]
9} 9}
10 10
11interface @beta Efl.Ui.Multi_Selectable extends Efl.Ui.Single_Selectable 11interface @beta Efl.Ui.Multi_Selectable extends Efl.Ui.Single_Selectable
12{ 12{
13 [[Interface for getting access to a range of selected items. 13 [[Interface for getting access to a range of selected items.
14 14
15 The implementor of this interface provides the possibility to select multiple Selectables. (If not, only Efl.Ui.Single_Selectable should be implemented)]] 15 The implementor of this interface provides the possibility to select multiple Selectables.
16 If not, only @Efl.Ui.Single_Selectable should be implemented.]]
16 c_prefix: efl_ui; 17 c_prefix: efl_ui;
17 methods 18 methods
18 { 19 {
diff --git a/src/lib/elementary/efl_ui_navigation_bar_part_back_button.eo b/src/lib/elementary/efl_ui_navigation_bar_part_back_button.eo
index 1690a54617..9ee060996c 100644
--- a/src/lib/elementary/efl_ui_navigation_bar_part_back_button.eo
+++ b/src/lib/elementary/efl_ui_navigation_bar_part_back_button.eo
@@ -1,6 +1,7 @@
1class @beta Efl.Ui.Navigation_Bar_Part_Back_Button extends Efl.Ui.Layout_Part implements Efl.Gfx.Entity, Efl.Text, Efl.Content 1class @beta Efl.Ui.Navigation_Bar_Part_Back_Button extends Efl.Ui.Layout_Part
2 implements Efl.Gfx.Entity, Efl.Text, Efl.Content
2{ 3{
3 [[Efl Ui Navigation_Bar internal part back button class]] 4 [[@Efl.Ui.Navigation_Bar internal part back button class.]]
4 data: null; 5 data: null;
5 implements { 6 implements {
6 Efl.Gfx.Entity.visible { set; get; } 7 Efl.Gfx.Entity.visible { set; get; }
diff --git a/src/lib/elementary/efl_ui_pan.eo b/src/lib/elementary/efl_ui_pan.eo
index 2437f977ed..c9fbbd8294 100644
--- a/src/lib/elementary/efl_ui_pan.eo
+++ b/src/lib/elementary/efl_ui_pan.eo
@@ -8,7 +8,7 @@ class @beta Efl.Ui.Pan extends Efl.Canvas.Group implements Efl.Content
8 8
9 The position of this "window" into the content can be changed using @Efl.Ui.Pan.pan_position. 9 The position of this "window" into the content can be changed using @Efl.Ui.Pan.pan_position.
10 This widget does not provide means for a user to change the content's position (like scroll bars). 10 This widget does not provide means for a user to change the content's position (like scroll bars).
11 This widget is meant to be used internally by other clases like @Efl.Ui.Scroll.Manager. 11 This widget is meant to be used internally by other classes like @Efl.Ui.Scroll.Manager.
12 ]] 12 ]]
13 methods { 13 methods {
14 @property pan_position { 14 @property pan_position {
@@ -64,7 +64,8 @@ class @beta Efl.Ui.Pan extends Efl.Canvas.Group implements Efl.Content
64 Efl.Canvas.Group.group_calculate; 64 Efl.Canvas.Group.group_calculate;
65 } 65 }
66 events { 66 events {
67 pan,content_position,changed: Eina.Position2D; [[The content's position has changed, its position in the event is the new position.]] 67 pan,content_position,changed: Eina.Position2D; [[The content's position has changed, its position in the event
68 pan,content_size,changed: Eina.Size2D; [[The content's size has changed, its size in the event is the new size]] 68 is the new position.]]
69 pan,content_size,changed: Eina.Size2D; [[The content's size has changed, its size in the event is the new size.]]
69 } 70 }
70} 71}
diff --git a/src/lib/elementary/efl_ui_panel.eo b/src/lib/elementary/efl_ui_panel.eo
index 3868949801..0cde869b3e 100644
--- a/src/lib/elementary/efl_ui_panel.eo
+++ b/src/lib/elementary/efl_ui_panel.eo
@@ -15,8 +15,9 @@ struct @beta Efl.Ui.Panel_Scroll_Info
15 rel_y: double; [[content scrolled position (0.0 ~ 1.0) in the panel]] 15 rel_y: double; [[content scrolled position (0.0 ~ 1.0) in the panel]]
16} 16}
17 17
18class @beta Efl.Ui.Panel extends Efl.Ui.Layout_Base implements Efl.Ui.Focus.Layer, Efl.Ui.Scrollable_Interactive, Efl.Content, 18class @beta Efl.Ui.Panel extends Efl.Ui.Layout_Base
19 Efl.Access.Widget.Action 19 implements Efl.Ui.Focus.Layer, Efl.Ui.Scrollable_Interactive, Efl.Content,
20 Efl.Access.Widget.Action
20{ 21{
21 [[Elementary panel class]] 22 [[Elementary panel class]]
22 methods { 23 methods {
diff --git a/src/lib/elementary/efl_ui_panes.eo b/src/lib/elementary/efl_ui_panes.eo
index 0194fe0ec1..a4661189fc 100644
--- a/src/lib/elementary/efl_ui_panes.eo
+++ b/src/lib/elementary/efl_ui_panes.eo
@@ -1,5 +1,5 @@
1class @beta Efl.Ui.Panes extends Efl.Ui.Layout_Base implements Efl.Ui.Layout_Orientable, 1class @beta Efl.Ui.Panes extends Efl.Ui.Layout_Base implements Efl.Ui.Layout_Orientable,
2 Efl.Input.Clickable 2 Efl.Input.Clickable
3{ 3{
4 [[Elementary panes class]] 4 [[Elementary panes class]]
5 event_prefix: elm_panes; 5 event_prefix: elm_panes;
@@ -49,7 +49,8 @@ class @beta Efl.Ui.Panes extends Efl.Ui.Layout_Base implements Efl.Ui.Layout_Ori
49 Efl.Object.constructor; 49 Efl.Object.constructor;
50 Efl.Canvas.Group.group_calculate; 50 Efl.Canvas.Group.group_calculate;
51 Efl.Ui.Widget.theme_apply; 51 Efl.Ui.Widget.theme_apply;
52 Efl.Ui.Layout_Orientable.orientation { get; set; [[Only supports $vertical and $horizontal. Default is $vertical.]] } 52 Efl.Ui.Layout_Orientable.orientation { get; set; [[Only supports $vertical and $horizontal.
53 Default is $vertical.]] }
53 Efl.Part.part_get; 54 Efl.Part.part_get;
54 } 55 }
55 events { 56 events {
diff --git a/src/lib/elementary/efl_ui_popup.eo b/src/lib/elementary/efl_ui_popup.eo
index e61cebb322..f2d0208fa2 100644
--- a/src/lib/elementary/efl_ui_popup.eo
+++ b/src/lib/elementary/efl_ui_popup.eo
@@ -1,69 +1,70 @@
1enum @beta Efl.Ui.Popup_Align { 1enum @beta Efl.Ui.Popup_Align {
2 [[Popup alignment type]] 2 [[Popup alignment type.]]
3 none = 0, [[Popup not aligned]] 3 none = 0, [[Popup not aligned.]]
4 center, [[Popup aligned to center]] 4 center, [[Popup aligned to center.]]
5 left, [[Popup aligned to left]] 5 left, [[Popup aligned to left.]]
6 right, [[Popup aligned to right]] 6 right, [[Popup aligned to right.]]
7 top, [[Popup aligned to top]] 7 top, [[Popup aligned to top.]]
8 bottom [[Popup aligned to bottom]] 8 bottom [[Popup aligned to bottom.]]
9} 9}
10 10
11class @beta Efl.Ui.Popup extends Efl.Ui.Layout_Base implements Efl.Content, Efl.Ui.Focus.Layer, Efl.Ui.Widget_Scrollable_Content 11class @beta Efl.Ui.Popup extends Efl.Ui.Layout_Base implements Efl.Content, Efl.Ui.Focus.Layer,
12 Efl.Ui.Widget_Scrollable_Content
12{ 13{
13 [[EFL UI popup class]] 14 [[EFL UI popup class]]
14 methods { 15 methods {
15 @property align { 16 @property align {
17 [[Popup alignment.]]
16 set { 18 set {
17 [[ Set the popup alignment.]]
18 } 19 }
19 get { 20 get {
20 [[ Get the current popup alignment.]]
21 } 21 }
22 values { 22 values {
23 type: Efl.Ui.Popup_Align; [[Alignment type]] 23 type: Efl.Ui.Popup_Align; [[Alignment type.]]
24 } 24 }
25 } 25 }
26 @property closing_timeout { 26 @property closing_timeout {
27 [[Set the timeout seconds.
28 After timeout seconds, popup will be deleted automatically.
29 ]]
27 set { 30 set {
28 [[ Set the timeout seconds.
29 After timeout seconds, popup will be deleted automatically.
30 ]]
31 } 31 }
32 get { 32 get {
33 [[ Get the currently set timeout seconds.]]
34 } 33 }
35 values { 34 values {
36 time: double; [[Timeout in seconds]] 35 time: double; [[Timeout in seconds.]]
37 } 36 }
38 } 37 }
39 @property anchor { 38 @property anchor {
39 [[Anchor object which sets this popup's position.
40 If anchor object is moved or parent window is resized, the popup moves to the new position.
41 If anchor object is set to NULL, the popup stops following the anchor object.
42 When the popup is moved by using @Efl.Gfx.Entity.position.set, $anchor is set NULL.
43 ]]
40 set { 44 set {
41 [[Set anchor popup to follow an anchor object.
42 If anchor object is moved or parent window is resized, the anchor popup moves to the new position.
43 If anchor object is set to NULL, the anchor popup stops following the anchor object.
44 When the popup is moved by using gfx_position_set, anchor is set NULL.
45 ]]
46 } 45 }
47 get { 46 get {
48 [[Returns the anchor object which the popup is following.]]
49 } 47 }
50 values { 48 values {
51 anchor: Efl.Canvas.Object; [[The object which popup is following.]] 49 anchor: Efl.Canvas.Object; [[The object which popup is following.]]
52 } 50 }
53 } 51 }
54 @property align_priority { 52 @property align_priority {
53 [[Prioritized popup alignment.
54
55 In contrast to the @.align property, each alignment is tried in turn until one is found which allows
56 the popup to be placed in the exact requested position relative to the @.anchor.
57 ]]
55 set { 58 set {
56 [[Set the align priority of a popup.]]
57 } 59 }
58 get { 60 get {
59 [[Get the align priority of a popup.]]
60 } 61 }
61 values { 62 values {
62 first: Efl.Ui.Popup_Align; [[First align priority]] 63 first: Efl.Ui.Popup_Align; [[First alignment.]]
63 second: Efl.Ui.Popup_Align; [[Second align priority]] 64 second: Efl.Ui.Popup_Align; [[Second alignment.]]
64 third: Efl.Ui.Popup_Align; [[Third align priority]] 65 third: Efl.Ui.Popup_Align; [[Third alignment.]]
65 fourth: Efl.Ui.Popup_Align; [[Fourth align priority]] 66 fourth: Efl.Ui.Popup_Align; [[Fourth alignment.]]
66 fifth: Efl.Ui.Popup_Align; [[Fifth align priority]] 67 fifth: Efl.Ui.Popup_Align; [[Fifth alignment.]]
67 } 68 }
68 } 69 }
69 } 70 }
diff --git a/src/lib/elementary/efl_ui_position_manager_data_access_v1.eo b/src/lib/elementary/efl_ui_position_manager_data_access_v1.eo
index c2dcd91f0f..4f6e678411 100644
--- a/src/lib/elementary/efl_ui_position_manager_data_access_v1.eo
+++ b/src/lib/elementary/efl_ui_position_manager_data_access_v1.eo
@@ -10,8 +10,9 @@ struct @beta Efl.Ui.Position_Manager.Object_Batch_Entity{
10 entity : Efl.Gfx.Entity; [[The canvas object.]] 10 entity : Efl.Gfx.Entity; [[The canvas object.]]
11 element_depth : ubyte; [[The depth change in this returned entity. 11 element_depth : ubyte; [[The depth change in this returned entity.
12 Every Element has a depth, if the parent is $null the depth is 0. 12 Every Element has a depth, if the parent is $null the depth is 0.
13 Every step deeper into the hirachy is exactly one depth deeper. 13 Every step deeper into the hierarchy is exactly one depth deeper.
14 If this depth has been different to the previous item, then this element can be seen as the group leader. The following elements with the same depth are in the same group.]] 14 If this depth has been different to the previous item, then this element can be seen as the
15 group leader. The following elements with the same depth are in the same group.]]
15 depth_leader : bool; [[$true if this is the leader of a group]] 16 depth_leader : bool; [[$true if this is the leader of a group]]
16} 17}
17 18
@@ -20,8 +21,9 @@ struct @beta Efl.Ui.Position_Manager.Size_Batch_Entity{
20 size : Eina.Size2D; [[The size of the element.]] 21 size : Eina.Size2D; [[The size of the element.]]
21 element_depth : ubyte; [[The depth change in this returned entity. 22 element_depth : ubyte; [[The depth change in this returned entity.
22 Every Element has a depth, if the parent is $null the depth is 0. 23 Every Element has a depth, if the parent is $null the depth is 0.
23 Every step deeper into the hirachy is exactly one depth deeper. 24 Every step deeper into the hierarchy is exactly one depth deeper.
24 If this depth has been different to the previous item, then this element can be seen as the group leader. The following elements with the same depth are in the same group.]] 25 If this depth has been different to the previous item, then this element can be seen as the
26 group leader. The following elements with the same depth are in the same group.]]
25 depth_leader : bool; [[$true if this is the leader of a group]] 27 depth_leader : bool; [[$true if this is the leader of a group]]
26} 28}
27 29
@@ -34,8 +36,13 @@ struct @beta Efl.Ui.Position_Manager.Size_Batch_Result {
34 36
35struct @beta Efl.Ui.Position_Manager.Size_Call_Config { 37struct @beta Efl.Ui.Position_Manager.Size_Call_Config {
36 [[Struct that is returned by the function callbacks.]] 38 [[Struct that is returned by the function callbacks.]]
37 range : Efl.Ui.Position_Manager.Request_Range; [[The range of items to fill into @.memory. The length of memory must be bigger or equal to the requested items]] // This struct does not contain a @.memory field. 39 range : Efl.Ui.Position_Manager.Request_Range; [[The range of items to fill into @.memory. The length of memory must
38 cache_request : bool; [[Indicate if this request is made for caching or displaying. If its for caching, the data-provider will fill in approximations, instead of doing heavy lifting from some backend. If this is not a caching call, the exact size should be requested and delivered at some later point.]] 40 be bigger or equal to the requested items]]
41 // This struct does not contain a @.memory field.
42 cache_request : bool; [[Indicate if this request is made for caching or displaying.
43 If it's for caching, the data-provider will fill in approximations, instead of doing heavy
44 lifting from some back-end. If this is not a caching call, the exact size should be
45 requested and delivered at some later point.]]
39} 46}
40 47
41struct @beta Efl.Ui.Position_Manager.Object_Batch_Result { 48struct @beta Efl.Ui.Position_Manager.Object_Batch_Result {
@@ -48,8 +55,11 @@ struct @beta Efl.Ui.Position_Manager.Object_Batch_Result {
48function @beta Efl.Ui.Position_Manager.Object_Batch_Callback { 55function @beta Efl.Ui.Position_Manager.Object_Batch_Callback {
49 [[ Function callback for getting a batch of items.]] 56 [[ Function callback for getting a batch of items.]]
50 params { 57 params {
51 range : Efl.Ui.Position_Manager.Request_Range; [[The range of items to fill into @.memory. The length of memory must be bigger or equal to the requested items]] 58 range : Efl.Ui.Position_Manager.Request_Range; [[The range of items to fill into @.memory. The length of memory
52 memory : rw_slice<Efl.Ui.Position_Manager.Object_Batch_Entity>; [[The slice to fill the information in, the full slice will be filled if there are enough items]] 59 must be bigger or equal to the requested items]]
60 memory : rw_slice<Efl.Ui.Position_Manager.Object_Batch_Entity>; [[The slice to fill the information in, the full
61 slice will be filled if there are enough items.
62 ]]
53 } 63 }
54 return: Efl.Ui.Position_Manager.Object_Batch_Result; [[The returned stats of this function call.]] 64 return: Efl.Ui.Position_Manager.Object_Batch_Result; [[The returned stats of this function call.]]
55}; 65};
@@ -58,8 +68,9 @@ function @beta Efl.Ui.Position_Manager.Object_Batch_Callback {
58function @beta Efl.Ui.Position_Manager.Size_Batch_Callback { 68function @beta Efl.Ui.Position_Manager.Size_Batch_Callback {
59 [[ Function callback for getting sizes of a batch of items.]] 69 [[ Function callback for getting sizes of a batch of items.]]
60 params { 70 params {
61 conf : Efl.Ui.Position_Manager.Size_Call_Config; [[The configution for this call]] 71 conf : Efl.Ui.Position_Manager.Size_Call_Config; [[The configuration for this call.]]
62 memory : rw_slice<Efl.Ui.Position_Manager.Size_Batch_Entity>; [[The slice to fill the information in, the full slice will be filled if there are enough items]] 72 memory : rw_slice<Efl.Ui.Position_Manager.Size_Batch_Entity>; [[The slice to fill the information in, the full
73 slice will be filled if there are enough items.]]
63 } 74 }
64 return: Efl.Ui.Position_Manager.Size_Batch_Result; [[The returned stats of this function call]] 75 return: Efl.Ui.Position_Manager.Size_Batch_Result; [[The returned stats of this function call]]
65}; 76};
@@ -68,32 +79,49 @@ function @beta Efl.Ui.Position_Manager.Size_Batch_Callback {
68interface @beta Efl.Ui.Position_Manager.Data_Access_V1 { 79interface @beta Efl.Ui.Position_Manager.Data_Access_V1 {
69 [[Interface for abstracting the data access of the position managers. 80 [[Interface for abstracting the data access of the position managers.
70 81
71 The idea here is that a data-provider, calls @.data_access on the positon manager object and passes the functions that are defined here. At any pointer later in time, the position manager can call these function callbacks to get sizes or objects. 82 The idea here is that a data-provider calls @.data_access on the position manager object and passes the functions
72 A data-provider should always fill all requested items. If a item is not available $null is inserted. If a size is not available, a as-close-as-possible approximation should be inserted. 83 that are defined here. Later, the position manager can call these function callbacks to get sizes or objects.
73 The Size callback is equipped with a parameter for if this is a caching request or not. This flag can be used to differentiate between two usecases. The size can be requested for building up a cache over all items. The size can also be requested for applying it to the object. The data-provider might needs to do heavy loading for getting the right size available, in case of a cache build up the as-close-as-possible aproximation is enough there. If it is real placement, the size should be correct. 84 A data-provider should always fill all requested items. If an item is not available $null should be inserted.
74 If a size changes after it was returned due to batching, this change still should be annonced with the @Efl.Ui.Position_Manager.Entity.item_size_changed function. 85 If a size is not available, an as-close-as-possible approximation should be inserted.
75 86 The Size callback is equipped with a parameter to specify caching requests. This flag can be used to differentiate
76 The depth of the items is used to express a hierachical structure on the items themselves. 87 between two use cases: When the size is being requested to build up a cache over all items, and when the size is
88 being requested to apply it to the object. Since the data-provider might need to do expensive operations to find
89 the exact size, the as-close-as-possible approximation is usually enough when building caches.
90 If real object placement is happening, then real sizes must be requested.
91 If a size changes after it was returned due to batching, this change still should be announced with the
92 @Efl.Ui.Position_Manager.Entity.item_size_changed function.
93
94 The depth of the items is used to express a hierarchical structure on the items themselves.
77 Any given depth might or might not have a $depth_leader. 95 Any given depth might or might not have a $depth_leader.
78 A group is ended when there is either a lower depth, or another depth_leader. 96 A group is ended when there is either a lower depth, or another $depth_leader.
79 ]] 97 ]]
80 methods { 98 methods {
81 @property data_access { 99 @property data_access {
82 [[This gives access to items to be managed. The manager reads this information and modifies the retrieved items' positions and sizes. 100 [[This gives access to items to be managed. The manager reads this information and modifies the retrieved
101 items' positions and sizes.
83 102
84 $obj_access gives access to the graphical entitites to manage. Some of them might be NULL, meaning they are not yet ready to be displayed. Their size in the $size_access array will be correct, though, so other entities can still be positioned correctly. 103 $obj_access gives access to the graphical entities to manage. Some of them might be $NULL, meaning they are
85 Typically, only entities inside the viewport will be retrieved. 104 not yet ready to be displayed. Their size in the $size_access array will be correct, though, so other
105 entities can still be positioned correctly.
106 Typically, only entities inside the viewport will be retrieved.
86 107
87 $size_access gives access to the 2D sizes for the items to manage. All sizes will always be valid, and might change over time (indicated through the @Efl.Ui.Position_Manager.Entity.item_size_changed method). 108 $size_access gives access to the 2D sizes for the items to manage. All sizes will always be valid, and might
88 The whole range might need to be traversed in order to calculate the position of all items in some arrangements. 109 change over time (indicated through the @Efl.Ui.Position_Manager.Entity.item_size_changed method).
110 The whole range might need to be traversed in order to calculate the position of all items in some
111 arrangements.
89 112
90 You can access a batch of objects or sizes by calling the here passed function callbacks. Further details can be found at the function definitions. 113 You can access a batch of objects or sizes by calling the here passed function callbacks. Further details
114 can be found at the function definitions.
91 ]] 115 ]]
92 set { 116 set {
93 } 117 }
94 values { 118 values {
95 obj_access : Efl.Ui.Position_Manager.Object_Batch_Callback; [[Function callback for canvas objects, even if the start_id is valid, the returned objects may be NULL.]] 119 obj_access : Efl.Ui.Position_Manager.Object_Batch_Callback; [[Function callback for canvas objects, even if
96 size_access : Efl.Ui.Position_Manager.Size_Batch_Callback; [[Function callback for the size, returned values are always valid, but might be changed later on.]] 120 the start_id is valid, the returned objects
121 may be NULL.]]
122 size_access : Efl.Ui.Position_Manager.Size_Batch_Callback; [[Function callback for the size, returned values
123 are always valid, but might be changed later on.
124 ]]
97 size : int; [[valid size for start_id, 0 <= i < size]] 125 size : int; [[valid size for start_id, 0 <= i < size]]
98 } 126 }
99 } 127 }
diff --git a/src/lib/elementary/efl_ui_position_manager_entity.eo b/src/lib/elementary/efl_ui_position_manager_entity.eo
index 5209f13425..d61c7c62d1 100644
--- a/src/lib/elementary/efl_ui_position_manager_entity.eo
+++ b/src/lib/elementary/efl_ui_position_manager_entity.eo
@@ -1,22 +1,24 @@
1import efl_ui; 1import efl_ui;
2 2
3struct Efl.Ui.Position_Manager.Range_Update { 3struct Efl.Ui.Position_Manager.Range_Update {
4 [[A struct containing the the updated range of visible items in this position manger.]] 4 [[A structure containing the updated range of visible items in this position manger.]]
5 start_id : uint; [[The first item that is visible]] 5 start_id : uint; [[The first item that is visible]]
6 end_id : uint; [[The last item that is visible]] 6 end_id : uint; [[The last item that is visible]]
7} 7}
8 8
9interface @beta Efl.Ui.Position_Manager.Entity extends Efl.Ui.Layout_Orientable 9interface @beta Efl.Ui.Position_Manager.Entity extends Efl.Ui.Layout_Orientable
10{ 10{
11 [[ 11 [[This abstracts the basic placement of items in a not-defined form under a viewport.
12 This abstracts the basic placement of items in a not defined form under a viewport.
13 12
14 The interface gets a defined set of elements that is meant to be displayed. The implementation provides a way to calculate the size that is required to display all items. Every time this absolut size of items is changed, content_size,changed is called. 13 The interface gets a defined set of elements that is meant to be displayed.
14 The implementation provides a way to calculate the size that is required to display all items.
15 Every time this absolute size of items is changed, @[Efl.Ui.Position_Manager.Entity.content_size,changed] is
16 emitted.
15 ]] 17 ]]
16 methods { 18 methods {
17 version { 19 version {
18 [[ Return the version of Data_Access that is used. 20 [[Returns the version of Data_Access that is used.
19 This object needs to implement the interface Efl.Ui.Position_Manager.Data_Access_V1 if 1 is returned. 2 if V2 (not available yet) is implemented. 21 This object needs to implement the interface @Efl.Ui.Position_Manager.Data_Access_V1 if 1 is returned.
20 ]] 22 ]]
21 params { 23 params {
22 max : int; [[The maximum version that is available from the data-provider.]] 24 max : int; [[The maximum version that is available from the data-provider.]]
@@ -50,20 +52,22 @@ interface @beta Efl.Ui.Position_Manager.Entity extends Efl.Ui.Layout_Orientable
50 } 52 }
51 } 53 }
52 position_single_item { 54 position_single_item {
53 [[Return the position and size of item idx 55 [[Return the position and size of item idx.
54 56
55 This method returns the size and position of the item at $idx. 57 This method returns the size and position of the item at $idx.
56 Even if the item is outside the viewport, the returned rectangle must be valid. The result can be used for scrolling calculations. 58 Even if the item is outside the viewport, the returned rectangle must be valid.
59 The result can be used for scrolling calculations.
57 ]] 60 ]]
58 params { 61 params {
59 idx : int; [[The id for the item]] 62 idx : int; [[The id for the item]]
60 } 63 }
61 return : Eina.Rect; [[Position and Size in canvas coordinations]] 64 return : Eina.Rect; [[Position and Size in canvas coordinates.]]
62 } 65 }
63 item_added { 66 item_added {
64 [[The new item $subobj has been added at the $added_index field. 67 [[The new item $subobj has been added at the $added_index field.
65 68
66 The accessor provided through @Efl.Ui.Position_Manager.Data_Access_V1.data_access will contain updated Entities.]] 69 The accessor provided through @Efl.Ui.Position_Manager.Data_Access_V1.data_access will contain updated
70 Entities.]]
67 params { 71 params {
68 added_index : int; 72 added_index : int;
69 subobj : Efl.Gfx.Entity; 73 subobj : Efl.Gfx.Entity;
@@ -71,7 +75,8 @@ interface @beta Efl.Ui.Position_Manager.Entity extends Efl.Ui.Layout_Orientable
71 } 75 }
72 item_removed { 76 item_removed {
73 [[The item $subobj previously at position $removed_index has been removed. 77 [[The item $subobj previously at position $removed_index has been removed.
74 The accessor provided through @Efl.Ui.Position_Manager.Data_Access_V1.data_access will contain updated Entities. 78 The accessor provided through @Efl.Ui.Position_Manager.Data_Access_V1.data_access will contain updated
79 Entities.
75 ]] 80 ]]
76 params { 81 params {
77 removed_index : int; 82 removed_index : int;
@@ -87,7 +92,8 @@ interface @beta Efl.Ui.Position_Manager.Entity extends Efl.Ui.Layout_Orientable
87 } 92 }
88 } 93 }
89 relative_item { 94 relative_item {
90 [[translate the current_id, into a new id which is oriented in the $direction of $current_id. In case that there is no item, -1 is returned]] 95 [[Translates the $current_id, into a new id which is oriented in the $direction of $current_id.
96 In case that there is no item, -1 is returned]]
91 params { 97 params {
92 current_id : uint; [[The id where the direction is oriented at]] 98 current_id : uint; [[The id where the direction is oriented at]]
93 direction : Efl.Ui.Focus.Direction; [[The direction where the new id is]] 99 direction : Efl.Ui.Focus.Direction; [[The direction where the new id is]]
@@ -96,8 +102,11 @@ interface @beta Efl.Ui.Position_Manager.Entity extends Efl.Ui.Layout_Orientable
96 } 102 }
97 } 103 }
98 events { 104 events {
99 content_size,changed : Eina.Size2D; [[Emitted when the aggregate size of all items has changed. This can be used to resize an enclosing Pan object.]] 105 content_size,changed : Eina.Size2D; [[Emitted when the aggregate size of all items has changed.
100 content_min_size,changed : Eina.Size2D; [[Emitted when the minimum size of all items has changed. The minimum size is the size, that this position_manager needs at *least* to display a single item.]] 106 This can be used to resize an enclosing Pan object.]]
107 content_min_size,changed : Eina.Size2D; [[Emitted when the minimum size of all items has changed.
108 The minimum size is the size that this position_manager needs
109 to display a single item.]]
101 visible_range,changed : Efl.Ui.Position_Manager.Range_Update; 110 visible_range,changed : Efl.Ui.Position_Manager.Range_Update;
102 } 111 }
103} 112}
diff --git a/src/lib/elementary/efl_ui_position_manager_grid.eo b/src/lib/elementary/efl_ui_position_manager_grid.eo
index a9705584d2..f8f1aa831f 100644
--- a/src/lib/elementary/efl_ui_position_manager_grid.eo
+++ b/src/lib/elementary/efl_ui_position_manager_grid.eo
@@ -1,4 +1,6 @@
1class @beta Efl.Ui.Position_Manager.Grid extends Efl.Object implements Efl.Ui.Position_Manager.Entity, Efl.Ui.Position_Manager.Data_Access_V1 1class @beta Efl.Ui.Position_Manager.Grid extends Efl.Object
2 implements Efl.Ui.Position_Manager.Entity,
3 Efl.Ui.Position_Manager.Data_Access_V1
2{ 4{
3 [[Implementation of @Efl.Ui.Position_Manager.Entity for two-dimensional grids. 5 [[Implementation of @Efl.Ui.Position_Manager.Entity for two-dimensional grids.
4 6
diff --git a/src/lib/elementary/efl_ui_position_manager_list.eo b/src/lib/elementary/efl_ui_position_manager_list.eo
index 121873ed84..0f66b0a282 100644
--- a/src/lib/elementary/efl_ui_position_manager_list.eo
+++ b/src/lib/elementary/efl_ui_position_manager_list.eo
@@ -1,8 +1,11 @@
1class @beta Efl.Ui.Position_Manager.List extends Efl.Object implements Efl.Ui.Position_Manager.Entity, Efl.Ui.Position_Manager.Data_Access_V1 1class @beta Efl.Ui.Position_Manager.List extends Efl.Object
2 implements Efl.Ui.Position_Manager.Entity,
3 Efl.Ui.Position_Manager.Data_Access_V1
2{ 4{
3 [[Implementation of @Efl.Ui.Position_Manager.Entity for a list 5 [[Implementation of @Efl.Ui.Position_Manager.Entity for a list
4 6
5 Every item in the list will get at least his minsize applied, changes to the misize are listend to and change the layouting of all items. This supports the vertical and horizontal orientation. 7 Every item in the list will get at least his minsize applied, changes to the misize are listened to and change
8 the layout of all items. This supports the vertical and horizontal orientation.
6 ]] 9 ]]
7 implements { 10 implements {
8 Efl.Object.destructor; 11 Efl.Object.destructor;
diff --git a/src/lib/elementary/efl_ui_radio.eo b/src/lib/elementary/efl_ui_radio.eo
index 061573948b..be595031b9 100644
--- a/src/lib/elementary/efl_ui_radio.eo
+++ b/src/lib/elementary/efl_ui_radio.eo
@@ -9,7 +9,8 @@ class @beta Efl.Ui.Radio extends Efl.Ui.Check implements Efl.Access.Widget.Actio
9 9
10 They are a common way to allow a user to select one option among a list. 10 They are a common way to allow a user to select one option among a list.
11 11
12 To handle button grouping, you can either use an @Efl.Ui.Radio_Group_Impl object or use more convenient widgets like @Efl.Ui.Radio_Box. 12 To handle button grouping, you can either use an @Efl.Ui.Radio_Group_Impl object or
13 use more convenient widgets like @Efl.Ui.Radio_Box.
13 ]] 14 ]]
14 methods { 15 methods {
15 @property state_value { 16 @property state_value {
diff --git a/src/lib/elementary/efl_ui_selectable.eo b/src/lib/elementary/efl_ui_selectable.eo
index 91ca452b5b..553d12e90a 100644
--- a/src/lib/elementary/efl_ui_selectable.eo
+++ b/src/lib/elementary/efl_ui_selectable.eo
@@ -1,7 +1,8 @@
1interface @beta Efl.Ui.Selectable { 1interface @beta Efl.Ui.Selectable {
2 [[Selectable interface for ui objects 2 [[Selectable interface for UI objects
3 3
4 A object implementing this can be selected. When the selected property of this object changes, the selected,changed event is emitted. 4 An object implementing this interface can be selected.
5 When the selected property of this object changes, the @[Efl.Ui.Selectable.selected,changed] event is emitted.
5 ]] 6 ]]
6 event_prefix: efl_ui; 7 event_prefix: efl_ui;
7 methods { 8 methods {
@@ -11,11 +12,11 @@ interface @beta Efl.Ui.Selectable {
11 A change to this property emits the changed event. 12 A change to this property emits the changed event.
12 ]] 13 ]]
13 values { 14 values {
14 selected : bool; [[The selected state of this object]] 15 selected : bool; [[The selected state of this object.]]
15 } 16 }
16 } 17 }
17 } 18 }
18 events { 19 events {
19 selected,changed : bool; [[Called when the selected state has changed]] 20 selected,changed : bool; [[Called when the selected state has changed.]]
20 } 21 }
21} 22}
diff --git a/src/lib/elementary/efl_ui_single_selectable.eo b/src/lib/elementary/efl_ui_single_selectable.eo
index 198ac10193..373cefa5c2 100644
--- a/src/lib/elementary/efl_ui_single_selectable.eo
+++ b/src/lib/elementary/efl_ui_single_selectable.eo
@@ -1,7 +1,8 @@
1interface @beta Efl.Ui.Single_Selectable { 1interface @beta Efl.Ui.Single_Selectable {
2 [[Interface for getting access to a single selected item in the implementor. 2 [[Interface for getting access to a single selected item in the implementor.
3 3
4 The implementor is free to allow a specific number of selectables beeing selected or not. This interface just covers always the latest selected selectable. 4 The implementor is free to allow a specific number of selectables being selected or not.
5 This interface just covers always the latest selected selectable.
5 ]] 6 ]]
6 methods { 7 methods {
7 @property last_selected { 8 @property last_selected {
@@ -16,8 +17,9 @@ interface @beta Efl.Ui.Single_Selectable {
16 @property fallback_selection { 17 @property fallback_selection {
17 [[A object that will be selected in case nothing is selected 18 [[A object that will be selected in case nothing is selected
18 19
19 A object set to this property will be selected instead of no item beeing selected. Which means, there will be always at least one element selected. 20 A object set to this property will be selected instead of no item being selected.
20 If this property is NULL, the state of "no item is selected" can be reached. 21 Which means, there will be always at least one element selected.
22 If this property is $NULL, the state of "no item is selected" can be reached.
21 23
22 Setting this property as a result of selection events results in undefined behavior. 24 Setting this property as a result of selection events results in undefined behavior.
23 ]] 25 ]]
@@ -27,6 +29,10 @@ interface @beta Efl.Ui.Single_Selectable {
27 } 29 }
28 } 30 }
29 events { 31 events {
30 selection_changed : void; [[Called when there is a change in the selection state, this event will collect all the item selection change events that are happening within one loop iteration. This means, you will only get this event once, even if a lot of items have changed. If you are interested in detailed changes, subscribe to the selection,changed event of Efl.Ui.Selectable.]] 32 selection_changed : void; [[Emitted when there is a change in the selection state. This event will collect all
33 the item selection change events that are happening within one loop iteration.
34 This means, you will only get this event once, even if a lot of items have changed.
35 If you are interested in detailed changes, subscribe to the individual
36 @[Efl.Ui.Selectable.selected,changed] events of each item.]]
31 } 37 }
32} 38}
diff --git a/src/lib/elementary/efl_ui_spin_button.eo b/src/lib/elementary/efl_ui_spin_button.eo
index 8216c5d3c9..a8b2778b58 100644
--- a/src/lib/elementary/efl_ui_spin_button.eo
+++ b/src/lib/elementary/efl_ui_spin_button.eo
@@ -1,4 +1,6 @@
1class @beta Efl.Ui.Spin_Button extends Efl.Ui.Spin implements Efl.Ui.Focus.Composition, Efl.Ui.Layout_Orientable, Efl.Ui.Range_Interactive, Efl.Access.Widget.Action 1class @beta Efl.Ui.Spin_Button extends Efl.Ui.Spin
2 implements Efl.Ui.Focus.Composition, Efl.Ui.Layout_Orientable, Efl.Ui.Range_Interactive,
3 Efl.Access.Widget.Action
2{ 4{
3 [[A Button Spin. 5 [[A Button Spin.
4 6
@@ -20,7 +22,7 @@ class @beta Efl.Ui.Spin_Button extends Efl.Ui.Spin implements Efl.Ui.Focus.Compo
20 22
21 If enabled, when the user tries to increment the value 23 If enabled, when the user tries to increment the value
22 but displayed value plus step value is bigger than maximum value, 24 but displayed value plus step value is bigger than maximum value,
23 the new value will become the minimum value. When the the user tries to 25 the new value will become the minimum value. When the user tries to
24 decrement it, if the value minus step is less than minimum value, 26 decrement it, if the value minus step is less than minimum value,
25 the new displayed value will be the maximum value. 27 the new displayed value will be the maximum value.
26 28
@@ -55,7 +57,7 @@ class @beta Efl.Ui.Spin_Button extends Efl.Ui.Spin implements Efl.Ui.Focus.Compo
55 get { 57 get {
56 } 58 }
57 values { 59 values {
58 direct_text_input: bool(false); [[$true to allow users to edit it or $false to don't allow users to edit it directly.]] 60 direct_text_input: bool(false); [[$true to allow users to directly edit the value.]]
59 } 61 }
60 } 62 }
61 } 63 }
diff --git a/src/lib/elementary/efl_ui_spotlight_container.eo b/src/lib/elementary/efl_ui_spotlight_container.eo
index 721304e27f..31d39ef373 100644
--- a/src/lib/elementary/efl_ui_spotlight_container.eo
+++ b/src/lib/elementary/efl_ui_spotlight_container.eo
@@ -8,18 +8,23 @@ class @beta Efl.Ui.Spotlight.Container extends Efl.Ui.Layout_Base implements Efl
8{ 8{
9 [[The Spotlight widget is a container for other sub-widgets, where only one sub-widget is active at any given time. 9 [[The Spotlight widget is a container for other sub-widgets, where only one sub-widget is active at any given time.
10 10
11 Sub-widgets are added using the @Efl.Pack_Linear interface and the active one (the one in the "spotlight") is selected using @.active_index. 11 Sub-widgets are added using the @Efl.Pack_Linear interface and the active one (the one in the "spotlight") is
12 selected using @.active_index.
12 13
13 The way the different sub-widgets are rendered can be customized through the @.spotlight_manager object. For example, only the active sub-widget 14 The way the different sub-widgets are rendered can be customized through the @.spotlight_manager object.
14 might be shown, or it might be shown in a central position whereas the other sub-widgets are displayed on the sides, or grayed-out. 15 For example, only the active sub-widget might be shown, or it might be shown in a central position whereas the
16 other sub-widgets are displayed on the sides, or grayed-out.
15 All sub-widgets are displayed with the same size, selected with @.spotlight_size. 17 All sub-widgets are displayed with the same size, selected with @.spotlight_size.
16 18
17 Additionally, the transition from one sub-widget to another can be animated. This animation is also controlled by the @.spotlight_manager object. 19 Additionally, the transition from one sub-widget to another can be animated.
20 This animation is also controlled by the @.spotlight_manager object.
18 21
19 Also, an indicator widget can be used to show a visual cue of how many sub-widgets are there and which one is the active one. 22 Also, an indicator widget can be used to show a visual cue of how many sub-widgets are there and which one is the
23 active one.
20 24
21 This class can be used to create other widgets like Pagers, Tabbed pagers or Stacks, where each sub-widget represents a "page" full 25 This class can be used to create other widgets like Pagers, Tabbed pagers or Stacks, where each sub-widget
22 of other widgets. All these cases can be implemented with a different @.spotlight_manager and use the same @Efl.Ui.Spotlight.Container. 26 represents a "page" full of other widgets. All these cases can be implemented with a different
27 @.spotlight_manager and use the same @Efl.Ui.Spotlight.Container.
23 ]] 28 ]]
24 c_prefix: efl_ui_spotlight; 29 c_prefix: efl_ui_spotlight;
25 methods { 30 methods {
@@ -32,7 +37,8 @@ class @beta Efl.Ui.Spotlight.Container extends Efl.Ui.Layout_Base implements Efl
32 } 37 }
33 } 38 }
34 @property indicator { 39 @property indicator {
35 [[An indicator object to use, which will display the current state of the spotlight (number of sub-widgets and active one). 40 [[An indicator object to use, which will display the current state of the spotlight (number of sub-widgets
41 and active one).
36 When this object is set, it is immediately updated to reflect the current state of the widget. 42 When this object is set, it is immediately updated to reflect the current state of the widget.
37 Its location inside the container is controlled by the @.spotlight_manager. 43 Its location inside the container is controlled by the @.spotlight_manager.
38 ]] 44 ]]
@@ -46,14 +52,17 @@ class @beta Efl.Ui.Spotlight.Container extends Efl.Ui.Layout_Base implements Efl
46 Changing this value might trigger an animation. 52 Changing this value might trigger an animation.
47 ]] 53 ]]
48 values { 54 values {
49 index: int; [[Index of the sub-widget that has the spotlight, from 0 to the number of sub-widgets - 1 (@Efl.Container.content_count - 1).]] 55 index: int; [[Index of the sub-widget that has the spotlight, from 0 to the number of sub-widgets - 1
56 (@Efl.Container.content_count - 1).]]
50 } 57 }
51 } 58 }
52 @property spotlight_size { 59 @property spotlight_size {
53 [[The size to use when displaying the Sub-Widget which has the spotlight. This is used by the @.spotlight_manager to perform the rendering. 60 [[The size to use when displaying the Sub-Widget which has the spotlight.
61 This is used by the @.spotlight_manager to perform the rendering.
54 Sub-Widgets other than the Active one may or may not use this size.]] 62 Sub-Widgets other than the Active one may or may not use this size.]]
55 values { 63 values {
56 size: Eina.Size2D; [[Render size for the spotlight. (-1, -1) means that all available space inside the container is used.]] 64 size: Eina.Size2D; [[Render size for the spotlight.
65 (-1, -1) means that all available space inside the container can be used.]]
57 } 66 }
58 } 67 }
59 push @beta { 68 push @beta {
@@ -70,19 +79,28 @@ class @beta Efl.Ui.Spotlight.Container extends Efl.Ui.Layout_Base implements Efl
70 pop @beta { 79 pop @beta {
71 [[Removes the sub-widget that has the spotlight from the widget. 80 [[Removes the sub-widget that has the spotlight from the widget.
72 81
73 The sub-widgets behind it naturally flow down so the next one gets the spotlight. This is the same behavior as a pop operation on a stack. 82 The sub-widgets behind it naturally flow down so the next one gets the spotlight.
74 When combined with @.push you don't have to worry about @.active_index since only the first sub-widget is manipulated. 83 This is the same behavior as a pop operation on a stack.
84 When combined with @.push you don't have to worry about @.active_index since only the first sub-widget is
85 manipulated.
75 86
76 An animation might be triggered to give the new sub-widget the spotlight, come into position and the old one disappear. 87 An animation might be triggered to give the new sub-widget the spotlight, come into position and the old
88 one disappear.
77 89
78 The removed sub-widget can be returned to the caller or deleted (depending on $delete_on_transition_end). 90 The removed sub-widget can be returned to the caller or deleted (depending on $delete_on_transition_end).
79 ]] 91 ]]
80 params { 92 params {
81 deletion_on_transition_end : bool; [[ if $true, then the object will be deleted before resolving the future, and a NULL pointer is the value of the future. $false if no operation should be applied to it]] 93 deletion_on_transition_end : bool; [[If $true, then the object will be deleted before resolving the future,
94 and a NULL pointer is the value of the future.
95 $false if no operation should be applied to it.]]
82 } 96 }
83 return : future<Efl.Gfx.Entity>; [[ This Future gets resolved when any transition animation finishes and the popped sub-widget is ready for collection. 97 return : future<Efl.Gfx.Entity>; [[This Future gets resolved when any transition animation finishes and the
84 If there is no animation, the Future resolves immediately. 98 popped sub-widget is ready for collection.
85 If $deletion_on_transition_end is $true then this widget will destroy the popped sub-widget and the Future will contain no Value. Otherwise, the caller becomes the owner of the sub-widget contained in the Future and must dispose of it appropriately. ]] 99 If there is no animation, the Future resolves immediately.
100 If $deletion_on_transition_end is $true then this widget will destroy the
101 popped sub-widget and the Future will contain no Value.
102 Otherwise, the caller becomes the owner of the sub-widget contained in the
103 Future and must dispose of it appropriately. ]]
86 } 104 }
87 } 105 }
88 events { 106 events {
diff --git a/src/lib/elementary/efl_ui_spotlight_indicator.eo b/src/lib/elementary/efl_ui_spotlight_indicator.eo
index 230fb5b835..c846048203 100644
--- a/src/lib/elementary/efl_ui_spotlight_indicator.eo
+++ b/src/lib/elementary/efl_ui_spotlight_indicator.eo
@@ -1,16 +1,18 @@
1abstract @beta Efl.Ui.Spotlight.Indicator extends Efl.Object { 1abstract @beta Efl.Ui.Spotlight.Indicator extends Efl.Object {
2 [[Object used by @Efl.Ui.Spotlight.Container to render an indication of the active widgets's position among 2 [[Object used by @Efl.Ui.Spotlight.Container to render an indication of the active widgets' position among
3 the rest of the container's widgets. 3 the rest of the container's widgets.
4 4
5 An example would be Android's little dots in the home screen. 5 An example would be Android's little dots in the home screen.
6 ]] 6 ]]
7 methods { 7 methods {
8 bind @pure_virtual { 8 bind @pure_virtual {
9 [[This method is called the first time an @Efl.Ui.Spotlight.Indicator is assigned to an @Efl.Ui.Spotlight.Container, binding them together. 9 [[This method is called the first time an @Efl.Ui.Spotlight.Indicator is assigned to an
10 @Efl.Ui.Spotlight.Container, binding them together.
10 11
11 This call can be used to setup the indicator part of the $spotlight. 12 This call can be used to setup the indicator part of the $spotlight.
12 13
13 The Active View of the container (if there is any) will be informed to the indicator by a later call to @.position_update. 14 The Active View of the container (if there is any) will be informed to the indicator by a later call to
15 @.position_update.
14 ]] 16 ]]
15 params { 17 params {
16 spotlight : Efl.Ui.Spotlight.Container; [[The container to bind this indicator to.]] 18 spotlight : Efl.Ui.Spotlight.Container; [[The container to bind this indicator to.]]
@@ -39,16 +41,18 @@ abstract @beta Efl.Ui.Spotlight.Indicator extends Efl.Object {
39 } 41 }
40 } 42 }
41 position_update @pure_virtual { 43 position_update @pure_virtual {
42 [[This method tells the indicator that @Efl.Ui.Spotlight.Container.active_index has changed in the bound container. 44 [[This method tells the indicator that @Efl.Ui.Spotlight.Container.active_index has changed in the bound
45 container.
43 46
44 $position ranges from -1 to the number of views in the bound container (@Efl.Container.content_count). 47 $position ranges from -1 to the number of views in the bound container (@Efl.Container.content_count).
45 Notice this allows moving to a position before the first view or past the last view, which might happen if the view 48 Notice this allows moving to a position before the first view or past the last view, which might happen if the
46 is thumb-scrolled out-of-bounds. Indicators can choose to render these out-of-bounds positions or not. 49 view is thumb-scrolled out-of-bounds. Indicators can choose to render these out-of-bounds positions or not.
47 50
48 Fractional values indicate positions in-between two views and should be respected to obtain a smooth transition. 51 Fractional values indicate positions in-between two views and should be respected to obtain smooth transitions.
49 ]] 52 ]]
50 params { 53 params {
51 position : double; [[The index of the active view, or a value in-between views if a transition is currently playing.]] 54 position : double; [[The index of the active view, or a value in-between views if a transition is currently
55 playing.]]
52 } 56 }
53 } 57 }
54 } 58 }
diff --git a/src/lib/elementary/efl_ui_spotlight_manager.eo b/src/lib/elementary/efl_ui_spotlight_manager.eo
index 3b1d625a59..2257dfeefd 100644
--- a/src/lib/elementary/efl_ui_spotlight_manager.eo
+++ b/src/lib/elementary/efl_ui_spotlight_manager.eo
@@ -1,19 +1,26 @@
1abstract @beta Efl.Ui.Spotlight.Manager extends Efl.Object { 1abstract @beta Efl.Ui.Spotlight.Manager extends Efl.Object {
2 [[Manager object used by @Efl.Ui.Spotlight.Container to handle rendering and animation of its sub-widgets, and user interaction. 2 [[Manager object used by @Efl.Ui.Spotlight.Container to handle rendering and animation of its sub-widgets,
3 and user interaction.
3 4
4 For instance, changes to the current sub-widget in the spotlight (@Efl.Ui.Spotlight.Container.active_index) can be animated with a transition. 5 For instance, changes to the current sub-widget in the spotlight (@Efl.Ui.Spotlight.Container.active_index) can be
5 This object can also handle user interaction. For example, dragging the sub-widget to one side to get to a different sub-widget (like an smartphone home screen). 6 animated with a transition.
7 This object can also handle user interaction. For example, dragging the sub-widget to one side to get to a
8 different sub-widget (like an smartphone home screen).
6 Such user interactions should end up setting a new @Efl.Ui.Spotlight.Container.active_index. 9 Such user interactions should end up setting a new @Efl.Ui.Spotlight.Container.active_index.
7 During a transition, the evolution of the current position should be exposed by emitting $pos_update events. 10 During a transition, the evolution of the current position should be exposed by emitting $pos_update events.
8 ]] 11 ]]
9 methods { 12 methods {
10 bind @pure_virtual { 13 bind @pure_virtual {
11 [[This method is called the first time an @Efl.Ui.Spotlight.Manager is assigned to an @Efl.Ui.Spotlight.Container, binding them together. 14 [[This method is called the first time an @Efl.Ui.Spotlight.Manager is assigned to an
12 The manager can read the current content of the container, subscribe to events, or do any initialization it requires. 15 @Efl.Ui.Spotlight.Container, binding them together.
16 The manager can read the current content of the container, subscribe to events, or do any initialization it
17 requires.
13 ]] 18 ]]
14 params { 19 params {
15 spotlight : Efl.Ui.Spotlight.Container; [[The container to bind the manager to.]] 20 spotlight : Efl.Ui.Spotlight.Container; [[The container to bind the manager to.]]
16 group : Efl.Canvas.Group; [[The graphical group where the views should be added with @Efl.Canvas.Group.group_member_add and removed with @Efl.Canvas.Group.group_member_remove.]] 21 group : Efl.Canvas.Group; [[The graphical group where the views should be added with
22 @Efl.Canvas.Group.group_member_add and removed with
23 @Efl.Canvas.Group.group_member_remove.]]
17 } 24 }
18 } 25 }
19 content_add @pure_virtual { 26 content_add @pure_virtual {
@@ -48,7 +55,8 @@ abstract @beta Efl.Ui.Spotlight.Manager extends Efl.Object {
48 } 55 }
49 } 56 }
50 @property size @pure_virtual { 57 @property size @pure_virtual {
51 [[Will be called whenever the @Efl.Ui.Spotlight.Container.spotlight_size changes so the @Efl.Ui.Spotlight.Manager can update itself.]] 58 [[Will be called whenever the @Efl.Ui.Spotlight.Container.spotlight_size changes so the
59 @Efl.Ui.Spotlight.Manager can update itself.]]
52 set { 60 set {
53 } 61 }
54 values { 62 values {
@@ -63,9 +71,10 @@ abstract @beta Efl.Ui.Spotlight.Manager extends Efl.Object {
63 } 71 }
64 } 72 }
65 events { 73 events {
66 pos_update : double; [[Index of the sub-widget currently being displayed. Fractional values indicate a position in-between sub-widgets. 74 pos_update : double; [[Index of the sub-widget currently being displayed. Fractional values indicate a position
67 For instance, when transitioning from sub-widget 2 to sub-widget 3, this event should be emitted with monotonically 75 in-between sub-widgets. For instance, when transitioning from sub-widget 2 to sub-widget 3,
68 increasing values ranging from 2.0 to 3.0. 76 this event should be emitted with monotonically increasing values ranging from 2.0 to 3.0.
69 Animations can perform any movement they want, but the reported $pos_update must move in the same direction.]] 77 Animations can perform any movement they want, but the reported $pos_update must move in
78 the same direction.]]
70 } 79 }
71} 80}
diff --git a/src/lib/elementary/efl_ui_tab_page.eo b/src/lib/elementary/efl_ui_tab_page.eo
index 736658c5bd..d13dde7ac6 100644
--- a/src/lib/elementary/efl_ui_tab_page.eo
+++ b/src/lib/elementary/efl_ui_tab_page.eo
@@ -5,14 +5,15 @@ class @beta Efl.Ui.Tab_Page extends Efl.Ui.Layout_Base implements Efl.Content
5 @property tab_bar_item { 5 @property tab_bar_item {
6 [[Get this page represented as a @Efl.Ui.Tab_Bar_Default_Item 6 [[Get this page represented as a @Efl.Ui.Tab_Bar_Default_Item
7 7
8 The object returned here will reflect all the properties from the part here. Properties will be automatically updated. 8 The object returned here will reflect all the properties from the part here.
9 This property is unique per @Efl.Ui.Tab_Page 9 Properties will be automatically updated.
10 This property is unique per @Efl.Ui.Tab_Page.
10 ]] 11 ]]
11 get { 12 get {
12 13
13 } 14 }
14 values { 15 values {
15 item : Efl.Ui.Tab_Bar_Default_Item; [[The @Efl.Ui.Tab_Bar_Default_Item for the tab bar]] 16 item : Efl.Ui.Tab_Bar_Default_Item; [[The @Efl.Ui.Tab_Bar_Default_Item for the tab bar.]]
16 } 17 }
17 } 18 }
18 } 19 }
diff --git a/src/lib/elementary/efl_ui_text.eo b/src/lib/elementary/efl_ui_text.eo
index 502a4ee37b..a8cee69e40 100644
--- a/src/lib/elementary/efl_ui_text.eo
+++ b/src/lib/elementary/efl_ui_text.eo
@@ -215,7 +215,7 @@ class @beta Efl.Ui.Text extends Efl.Ui.Layout_Base implements Efl.Input.Clickabl
215 ]] 215 ]]
216 } 216 }
217 values { 217 values {
218 enabled: bool; [[If $enabled is $true, the return key is automatically disabled when the entry has no text.]] 218 enabled: bool; [[If $true, the return key is automatically disabled when the entry has no text.]]
219 } 219 }
220 } 220 }
221 @property item_factory { 221 @property item_factory {
@@ -227,7 +227,8 @@ class @beta Efl.Ui.Text extends Efl.Ui.Layout_Base implements Efl.Input.Clickabl
227 } 227 }
228 } 228 }
229 input_panel_show { 229 input_panel_show {
230 [[Show the input panel (virtual keyboard) based on the input panel property of entry such as layout, autocapital types and so on. 230 [[Show the input panel (virtual keyboard) based on the input panel property of entry such as layout,
231 autocapital types and so on.
231 232
232 Note that input panel is shown or hidden automatically according to the focus state of entry widget. 233 Note that input panel is shown or hidden automatically according to the focus state of entry widget.
233 This API can be used in the case of manually controlling by using @.input_panel_enabled.set(en, $false). 234 This API can be used in the case of manually controlling by using @.input_panel_enabled.set(en, $false).
diff --git a/src/lib/elementary/efl_ui_timepicker.eo b/src/lib/elementary/efl_ui_timepicker.eo
index 7e2d48cced..b71a9f5c2f 100644
--- a/src/lib/elementary/efl_ui_timepicker.eo
+++ b/src/lib/elementary/efl_ui_timepicker.eo
@@ -30,7 +30,8 @@ class @beta Efl.Ui.Timepicker extends Efl.Ui.Layout_Base
30 get { 30 get {
31 } 31 }
32 values { 32 values {
33 is_24hour: bool; [[$true to display the 24 hour time, $false to display 12 hour time including AM/PM button.]] 33 is_24hour: bool; [[$true to display the 24 hour time,
34 $false to display 12 hour time including AM/PM label.]]
34 } 35 }
35 } 36 }
36 } 37 }
diff --git a/src/lib/elementary/efl_ui_widget.eo b/src/lib/elementary/efl_ui_widget.eo
index 0517e3ae28..60e5815888 100644
--- a/src/lib/elementary/efl_ui_widget.eo
+++ b/src/lib/elementary/efl_ui_widget.eo
@@ -72,7 +72,7 @@ abstract Efl.Ui.Widget extends Efl.Canvas.Group implements Efl.Access.Object,
72 [[Returns the current cursor style name.]] 72 [[Returns the current cursor style name.]]
73 } 73 }
74 values { 74 values {
75 style: string; [[A specific style to use, eg. default, 75 style: string; [[A specific style to use, e.g. default,
76 transparent, ....]] 76 transparent, ....]]
77 } 77 }
78 } 78 }
@@ -111,7 +111,8 @@ abstract Efl.Ui.Widget extends Efl.Canvas.Group implements Efl.Access.Object,
111 @property disabled { 111 @property disabled {
112 [[Whether the widget is enabled (accepts and reacts to user inputs). 112 [[Whether the widget is enabled (accepts and reacts to user inputs).
113 113
114 The property works counted, this means, whenever n-caller set the value to $true, n-caller have to set it to $false in order to get it out of the disabled state again. 114 The property is counted, this is, if it is set n times to $true,
115 it has to be set n times to $false in order to get it out of the disabled state again.
115 116
116 Each widget may handle the disabled state differently, but overall 117 Each widget may handle the disabled state differently, but overall
117 disabled widgets shall not respond to any input events. This is 118 disabled widgets shall not respond to any input events. This is
@@ -193,7 +194,7 @@ abstract Efl.Ui.Widget extends Efl.Canvas.Group implements Efl.Access.Object,
193 Note: Objects which are meant to be interacted with by input events 194 Note: Objects which are meant to be interacted with by input events
194 are created able to be focused, by default. All the others are not. 195 are created able to be focused, by default. All the others are not.
195 196
196 This property's default value depends on the widget (eg. a box is 197 This property's default value depends on the widget (e.g. a box is
197 not focusable, but a button is). 198 not focusable, but a button is).
198 ]] 199 ]]
199 set { 200 set {
@@ -383,10 +384,13 @@ abstract Efl.Ui.Widget extends Efl.Canvas.Group implements Efl.Access.Object,
383 focus_state_apply @protected { 384 focus_state_apply @protected {
384 [[Apply a new focus state on the widget. 385 [[Apply a new focus state on the widget.
385 386
386 This method is called internally by @Efl.Ui.Widget. Override it to change how a widget interacts with its focus manager. 387 This method is called internally by @Efl.Ui.Widget.
387 If a widget desires to change the applied configuration, it has to modify $configured_state in addition to any internal changes. 388 Override it to change how a widget interacts with its focus manager.
389 If a widget desires to change the applied configuration,
390 it has to modify $configured_state in addition to any internal changes.
388 391
389 The default implementation (when this method is not overridden) applies $configured_state using the $manager contained inside. 392 The default implementation (when this method is not overridden) applies $configured_state using
393 the $manager contained inside.
390 ]] 394 ]]
391 params { 395 params {
392 @in current_state : Efl.Ui.Widget_Focus_State; 396 @in current_state : Efl.Ui.Widget_Focus_State;
diff --git a/src/lib/elementary/efl_ui_win.eo b/src/lib/elementary/efl_ui_win.eo
index bf0582d1c9..42c309dfb6 100644
--- a/src/lib/elementary/efl_ui_win.eo
+++ b/src/lib/elementary/efl_ui_win.eo
@@ -752,7 +752,8 @@ class Efl.Ui.Win extends Efl.Ui.Widget implements Efl.Canvas.Scene, Efl.Access.W
752 @property win_rotation @beta { 752 @property win_rotation @beta {
753 [[The rotation of this window 753 [[The rotation of this window
754 754
755 The value will automatically change when the WM of this window changes its rotation. This rotation is automatically applied to all @Efl.Ui.Layout objects. 755 The value will automatically change when the Window Manager of this window changes its rotation.
756 This rotation is automatically applied to all @Efl.Ui.Layout objects.
756 ]] 757 ]]
757 set { 758 set {
758 } 759 }
diff --git a/src/lib/emotion/efl_canvas_video.eo b/src/lib/emotion/efl_canvas_video.eo
index be94fcc88a..2ee6f6bb73 100644
--- a/src/lib/emotion/efl_canvas_video.eo
+++ b/src/lib/emotion/efl_canvas_video.eo
@@ -1,4 +1,5 @@
1class @beta Efl.Canvas.Video extends Efl.Canvas.Group implements Efl.File, Efl.Player, Efl.Gfx.Image, Efl.Gfx.Image_Load_Controller 1class @beta Efl.Canvas.Video extends Efl.Canvas.Group
2 implements Efl.File, Efl.Player, Efl.Gfx.Image, Efl.Gfx.Image_Load_Controller
2{ 3{
3 [[Efl canvas video class]] 4 [[Efl canvas video class]]
4 methods { 5 methods {
diff --git a/src/lib/eo/efl_object.eo b/src/lib/eo/efl_object.eo
index 27a0a495a8..5ec9d5c2af 100644
--- a/src/lib/eo/efl_object.eo
+++ b/src/lib/eo/efl_object.eo
@@ -406,12 +406,14 @@ abstract Efl.Object
406 [[Will register a manager of a specific class to be answered by eo.provider_find.]] 406 [[Will register a manager of a specific class to be answered by eo.provider_find.]]
407 params { 407 params {
408 @in klass: const(Efl.Class); [[The class provided by the registered provider.]] 408 @in klass: const(Efl.Class); [[The class provided by the registered provider.]]
409 @in provider: const(Efl.Object); [[The provider for the newly registered class that has to provide that said Efl.Class.]] 409 @in provider: const(Efl.Object); [[The provider for the newly registered class that has to provide that
410 said Efl.Class.]]
410 } 411 }
411 return: bool; [[$true if successfully register, $false otherwise.]] 412 return: bool; [[$true if successfully register, $false otherwise.]]
412 } 413 }
413 provider_unregister { 414 provider_unregister {
414 [[Will unregister a manager of a specific class that was previously registered and answered by eo.provider_find.]] 415 [[Will unregister a manager of a specific class that was previously registered and answered by
416 eo.provider_find.]]
415 params { 417 params {
416 @in klass: const(Efl.Class); [[The class provided by the provider to unregister for.]] 418 @in klass: const(Efl.Class); [[The class provided by the provider to unregister for.]]
417 @in provider: const(Efl.Object); [[The provider for the registered class to unregister.]] 419 @in provider: const(Efl.Object); [[The provider for the registered class to unregister.]]
@@ -426,7 +428,8 @@ abstract Efl.Object
426 events { 428 events {
427 del @hot: void; [[Object is being deleted. See @.destructor.]] 429 del @hot: void; [[Object is being deleted. See @.destructor.]]
428 invalidate @hot: void; [[Object is being invalidated and losing its parent. See @.invalidate.]] 430 invalidate @hot: void; [[Object is being invalidated and losing its parent. See @.invalidate.]]
429 noref @hot: void; [[Object has lost its last reference, only parent relationship is keeping it alive. Advanced usage.]] 431 noref @hot: void; [[Object has lost its last reference, only parent relationship is keeping it alive.
432 Advanced usage.]]
430 ownership,unique @hot: void; [[Object has lost a reference and only one is left. It has just one owner now. 433 ownership,unique @hot: void; [[Object has lost a reference and only one is left. It has just one owner now.
431 Triggered whenever the refcount goes from two to one.]] 434 Triggered whenever the refcount goes from two to one.]]
432 ownership,shared @hot: void; [[Object has acquired a second reference. It has multiple owners now. 435 ownership,shared @hot: void; [[Object has acquired a second reference. It has multiple owners now.
diff --git a/src/lib/evas/canvas/efl_canvas_animation.eo b/src/lib/evas/canvas/efl_canvas_animation.eo
index a118d89661..a64047820f 100644
--- a/src/lib/evas/canvas/efl_canvas_animation.eo
+++ b/src/lib/evas/canvas/efl_canvas_animation.eo
@@ -32,7 +32,7 @@ class @beta Efl.Canvas.Animation extends Efl.Object implements Efl.Playable
32 get { 32 get {
33 } 33 }
34 values { 34 values {
35 mode: Efl.Canvas.Animation_Repeat_Mode; [[Repeat mode. EFL_ANIMATION_REPEAT_MODE_RESTART restarts animation when the animation ends and EFL_ANIMATION_REPEAT_MODE_REVERSE reverses animation when the animation ends.]] 35 mode: Efl.Canvas.Animation_Repeat_Mode; [[Repeat mode.]]
36 } 36 }
37 } 37 }
38 @property repeat_count { 38 @property repeat_count {
@@ -42,7 +42,7 @@ class @beta Efl.Canvas.Animation extends Efl.Object implements Efl.Playable
42 get { 42 get {
43 } 43 }
44 values { 44 values {
45 count: int; [[Repeat count. EFL_ANIMATION_REPEAT_INFINITE repeats animation infinitely.]] 45 count: int; [[Repeat count. -1 repeats animation infinitely.]]
46 } 46 }
47 } 47 }
48 @property start_delay { 48 @property start_delay {
@@ -52,7 +52,7 @@ class @beta Efl.Canvas.Animation extends Efl.Object implements Efl.Playable
52 get { 52 get {
53 } 53 }
54 values { 54 values {
55 sec: double; [[Delay time, in seconds, from when the animation starts until the animation is animated]] 55 sec: double; [[Delay time, in seconds, from when the animation starts until the animation is animated.]]
56 } 56 }
57 } 57 }
58 @property interpolator { 58 @property interpolator {
@@ -62,7 +62,7 @@ class @beta Efl.Canvas.Animation extends Efl.Object implements Efl.Playable
62 get { 62 get {
63 } 63 }
64 values { 64 values {
65 interpolator: Efl.Interpolator; [[Interpolator which indicates interpolation function. Efl_Interpolator is required.]] 65 interpolator: Efl.Interpolator; [[Interpolator which indicates interpolation function.]]
66 } 66 }
67 } 67 }
68 animation_apply { 68 animation_apply {
diff --git a/src/lib/evas/canvas/efl_canvas_animation_player.eo b/src/lib/evas/canvas/efl_canvas_animation_player.eo
index 53cdf59cb6..8d33cc783d 100644
--- a/src/lib/evas/canvas/efl_canvas_animation_player.eo
+++ b/src/lib/evas/canvas/efl_canvas_animation_player.eo
@@ -17,7 +17,8 @@ class @beta Efl.Canvas.Animation_Player extends Efl.Object implements Efl.Player
17 get { 17 get {
18 } 18 }
19 values { 19 values {
20 auto_del: bool; [[$true to delete animation object automatically when animation is finished or animation is cancelled, $false otherwise.]] 20 auto_del: bool; [[$true to delete animation object automatically when animation is finished or animation is
21 cancelled, $false otherwise.]]
21 } 22 }
22 } 23 }
23 @property target { 24 @property target {
diff --git a/src/lib/evas/canvas/efl_canvas_animation_rotate.eo b/src/lib/evas/canvas/efl_canvas_animation_rotate.eo
index 818058aa4d..631d9f2067 100644
--- a/src/lib/evas/canvas/efl_canvas_animation_rotate.eo
+++ b/src/lib/evas/canvas/efl_canvas_animation_rotate.eo
@@ -13,9 +13,12 @@ class @beta Efl.Canvas.Animation_Rotate extends Efl.Canvas.Animation
13 values { 13 values {
14 from_degree: double; [[Rotation degree when animation starts]] 14 from_degree: double; [[Rotation degree when animation starts]]
15 to_degree: double; [[Rotation degree when animation ends]] 15 to_degree: double; [[Rotation degree when animation ends]]
16 pivot: Efl.Canvas.Object; [[Pivot object for the center point. If the pivot object is NULL, then the object is rotated on itself.]] 16 pivot: Efl.Canvas.Object; [[Pivot object for the center point.
17 cx: double; [[X relative coordinate of the center point. The left end is 0.0 and the right end is 1.0 (the center is 0.5).]] 17 If the pivot object is NULL, then the object is rotated on itself.]]
18 cy: double; [[Y relative coordinate of the center point. The top end is 0.0 and the bottom end is 1.0 (the center is 0.5).]] 18 cx: double; [[X relative coordinate of the center point.
19 The left end is 0.0 and the right end is 1.0 (the center is 0.5).]]
20 cy: double; [[Y relative coordinate of the center point.
21 The top end is 0.0 and the bottom end is 1.0 (the center is 0.5).]]
19 } 22 }
20 } 23 }
21 @property rotate_absolute { 24 @property rotate_absolute {
diff --git a/src/lib/evas/canvas/efl_canvas_animation_scale.eo b/src/lib/evas/canvas/efl_canvas_animation_scale.eo
index b4da878f9d..20a979dd11 100644
--- a/src/lib/evas/canvas/efl_canvas_animation_scale.eo
+++ b/src/lib/evas/canvas/efl_canvas_animation_scale.eo
@@ -15,9 +15,12 @@ class @beta Efl.Canvas.Animation_Scale extends Efl.Canvas.Animation
15 from_scale_y: double; [[Scale factor along y axis when animation starts]] 15 from_scale_y: double; [[Scale factor along y axis when animation starts]]
16 to_scale_x: double; [[Scale factor along x axis when animation ends]] 16 to_scale_x: double; [[Scale factor along x axis when animation ends]]
17 to_scale_y: double; [[Scale factor along y axis when animation ends]] 17 to_scale_y: double; [[Scale factor along y axis when animation ends]]
18 pivot: Efl.Canvas.Object; [[Pivot object for the center point. If the pivot object is NULL, then the object is scaled on itself.]] 18 pivot: Efl.Canvas.Object; [[Pivot object for the center point. If the pivot object is NULL, then the object
19 cx: double; [[X relative coordinate of the center point. The left end is 0.0 and the right end is 1.0 (the center is 0.5).]] 19 is scaled on itself.]]
20 cy: double; [[Y relative coordinate of the center point. The top end is 0.0 and the bottom end is 1.0 (the center is 0.5).]] 20 cx: double; [[X relative coordinate of the center point. The left end is 0.0 and the right end is 1.0
21 (the center is 0.5).]]
22 cy: double; [[Y relative coordinate of the center point. The top end is 0.0 and the bottom end is 1.0
23 (the center is 0.5).]]
21 } 24 }
22 } 25 }
23 @property scale_absolute { 26 @property scale_absolute {
diff --git a/src/lib/evas/canvas/efl_canvas_object.eo b/src/lib/evas/canvas/efl_canvas_object.eo
index 51154068f9..103a267c6a 100644
--- a/src/lib/evas/canvas/efl_canvas_object.eo
+++ b/src/lib/evas/canvas/efl_canvas_object.eo
@@ -72,7 +72,7 @@ abstract Efl.Canvas.Object extends Efl.Loop_Consumer implements Efl.Gfx.Entity,
72 Please do not assume that @Efl.Gfx.Render_Op.copy mode can be 72 Please do not assume that @Efl.Gfx.Render_Op.copy mode can be
73 used to "poke" holes in a window (to see through it), as only the 73 used to "poke" holes in a window (to see through it), as only the
74 compositor can ensure that. Copy mode should only be used with 74 compositor can ensure that. Copy mode should only be used with
75 otherwise opaque widgets or inside non-window surfaces (eg. a 75 otherwise opaque widgets or inside non-window surfaces (e.g. a
76 transparent background inside a buffer canvas). 76 transparent background inside a buffer canvas).
77 ]] 77 ]]
78 set { 78 set {
@@ -232,7 +232,8 @@ abstract Efl.Canvas.Object extends Efl.Loop_Consumer implements Efl.Gfx.Entity,
232 Note: The old focus APIs still work, however they will only act on the default seat. 232 Note: The old focus APIs still work, however they will only act on the default seat.
233 ]] 233 ]]
234 params { 234 params {
235 @in seat: Efl.Input.Device; [[The seat that should be added to the focus list. Use $null for the default seat.]] 235 @in seat: Efl.Input.Device; [[The seat that should be added to the focus list. Use $null for the default
236 seat.]]
236 } 237 }
237 return: bool; [[$true if the focus has been set or $false otherwise.]] 238 return: bool; [[$true if the focus has been set or $false otherwise.]]
238 } 239 }
@@ -241,7 +242,8 @@ abstract Efl.Canvas.Object extends Efl.Loop_Consumer implements Efl.Gfx.Entity,
241 [[ Remove a seat from the focus list. 242 [[ Remove a seat from the focus list.
242 ]] 243 ]]
243 params { 244 params {
244 @in seat: Efl.Input.Device; [[The seat that should be removed from the focus list. Use $null for the default seat.]] 245 @in seat: Efl.Input.Device; [[The seat that should be removed from the focus list. Use $null for the
246 default seat.]]
245 } 247 }
246 return: bool; [[$true if the seat was removed from the focus list or $false otherwise.]] 248 return: bool; [[$true if the seat was removed from the focus list or $false otherwise.]]
247 } 249 }
diff --git a/src/lib/evas/canvas/efl_canvas_vg_node.eo b/src/lib/evas/canvas/efl_canvas_vg_node.eo
index 9c5935e1ca..e8846fb0c3 100644
--- a/src/lib/evas/canvas/efl_canvas_vg_node.eo
+++ b/src/lib/evas/canvas/efl_canvas_vg_node.eo
@@ -1,6 +1,7 @@
1import eina_types; 1import eina_types;
2 2
3abstract @beta Efl.Canvas.Vg.Node extends Efl.Object implements Efl.Gfx.Entity, Efl.Gfx.Color, Efl.Gfx.Stack, Efl.Duplicate, Efl.Gfx.Path 3abstract @beta Efl.Canvas.Vg.Node extends Efl.Object
4 implements Efl.Gfx.Entity, Efl.Gfx.Color, Efl.Gfx.Stack, Efl.Duplicate, Efl.Gfx.Path
4{ 5{
5 [[Efl vector graphics abstract class]] 6 [[Efl vector graphics abstract class]]
6 methods { 7 methods {
diff --git a/src/lib/evas/canvas/efl_input_clickable.eo b/src/lib/evas/canvas/efl_input_clickable.eo
index 680c0fbdb7..a9285db4fc 100644
--- a/src/lib/evas/canvas/efl_input_clickable.eo
+++ b/src/lib/evas/canvas/efl_input_clickable.eo
@@ -30,7 +30,8 @@ mixin @beta Efl.Input.Clickable
30 button_state_reset @protected { 30 button_state_reset @protected {
31 [[This aborts the internal state after a press call. 31 [[This aborts the internal state after a press call.
32 32
33 This will stop the timer for longpress. And set the state of the clickable mixin back into the unpressed state. 33 This will stop the timer for longpress and set the state of the clickable mixin back into the unpressed
34 state.
34 ]] 35 ]]
35 params { 36 params {
36 button : uint; 37 button : uint;
@@ -56,8 +57,11 @@ mixin @beta Efl.Input.Clickable
56 } 57 }
57 } 58 }
58 events { 59 events {
59 clicked: Efl.Input.Clickable_Clicked; [[Called when object is in sequence pressed and unpressed, by the primary button]] 60 clicked: Efl.Input.Clickable_Clicked; [[Called when object is in sequence pressed and unpressed by the primary
60 clicked,any: Efl.Input.Clickable_Clicked; [[Called when object is in sequence pressed and unpressed by any button. The button that triggered the event can be found in the event information.]] 61 button]]
62 clicked,any: Efl.Input.Clickable_Clicked; [[Called when object is in sequence pressed and unpressed by any
63 button. The button that triggered the event can be found in the event
64 information.]]
61 pressed: int; [[Called when the object is pressed, event_info is the button that got pressed]] 65 pressed: int; [[Called when the object is pressed, event_info is the button that got pressed]]
62 unpressed: int; [[Called when the object is no longer pressed, event_info is the button that got pressed]] 66 unpressed: int; [[Called when the object is no longer pressed, event_info is the button that got pressed]]
63 longpressed: int; [[Called when the object receives a long press, event_info is the button that got pressed]] 67 longpressed: int; [[Called when the object receives a long press, event_info is the button that got pressed]]
diff --git a/src/lib/evas/canvas/efl_input_pointer.eo b/src/lib/evas/canvas/efl_input_pointer.eo
index dd31ad4453..f60c4979f1 100644
--- a/src/lib/evas/canvas/efl_input_pointer.eo
+++ b/src/lib/evas/canvas/efl_input_pointer.eo
@@ -34,7 +34,7 @@ class Efl.Input.Pointer extends Efl.Object implements Efl.Input.Event, Efl.Input
34 with the other methods of this class. 34 with the other methods of this class.
35 ]] 35 ]]
36 set { 36 set {
37 return: bool; [[$false if the value could not be set (eg. delta).]] 37 return: bool; [[$false if the value could not be set.]]
38 } 38 }
39 get {} 39 get {}
40 keys { 40 keys {
@@ -103,9 +103,11 @@ class Efl.Input.Pointer extends Efl.Object implements Efl.Input.Event, Efl.Input
103 } 103 }
104 } 104 }
105 @property touch_id { 105 @property touch_id {
106 [[TThe ID associated with this pointer. 106 [[The ID associated with this pointer.
107 107
108 In case there are multiple pointers (for example when multiple fingers are touching the screen) this number uniquely identifies each pointer, for as long as it is present. This is, when a finger is lifted its ID can be later reused by another finger touching the screen. 108 In case there are multiple pointers (for example when multiple fingers are touching the screen) this number
109 uniquely identifies each pointer, for as long as it is present. This is, when a finger is lifted its ID can
110 be later reused by another finger touching the screen.
109 ]] 111 ]]
110 values { 112 values {
111 id: int; [[An ID uniquely identifying this pointer among the currently present pointers.]] 113 id: int; [[An ID uniquely identifying this pointer among the currently present pointers.]]