summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndy Williams <andy@andywilliams.me>2017-12-22 10:41:11 +0000
committerAndy Williams <andy@andywilliams.me>2017-12-22 10:41:18 +0000
commit77dd065c52202c9f517d3b846e80c3db7e5526a0 (patch)
tree04f6fb831fe727b1754b8198b82055f67887fad7
parentf0d6a60cf815a89e6e80d8b5eecdcf9c7a66bc58 (diff)
docs: Update efl interface eo files for grammar and readability
Author: Nate Drake
-rw-r--r--src/lib/efl/interfaces/efl_gfx_stack.eo18
-rw-r--r--src/lib/efl/interfaces/efl_image_load.eo16
-rw-r--r--src/lib/efl/interfaces/efl_input_device.eo6
-rw-r--r--src/lib/efl/interfaces/efl_io_buffer.eo8
-rw-r--r--src/lib/efl/interfaces/efl_io_queue.eo18
-rw-r--r--src/lib/efl/interfaces/efl_io_writer.eo8
-rw-r--r--src/lib/efl/interfaces/efl_model.eo2
-rw-r--r--src/lib/efl/interfaces/efl_pack.eo2
-rw-r--r--src/lib/efl/interfaces/efl_pack_linear.eo10
-rw-r--r--src/lib/efl/interfaces/efl_pack_table.eo2
-rw-r--r--src/lib/efl/interfaces/efl_text_format.eo4
-rw-r--r--src/lib/efl/interfaces/efl_text_properties.eo8
-rw-r--r--src/lib/efl/interfaces/efl_ui_clickable.eo16
-rw-r--r--src/lib/efl/interfaces/efl_ui_drag.eo52
-rw-r--r--src/lib/efl/interfaces/efl_ui_draggable.eo10
-rw-r--r--src/lib/efl/interfaces/efl_ui_format.eo8
-rw-r--r--src/lib/efl/interfaces/efl_ui_range.eo4
-rw-r--r--src/lib/efl/interfaces/efl_ui_scrollable.eo22
-rw-r--r--src/lib/efl/interfaces/efl_ui_scrollable_interactive.eo12
-rw-r--r--src/lib/efl/interfaces/efl_ui_selectable.eo10
20 files changed, 118 insertions, 118 deletions
diff --git a/src/lib/efl/interfaces/efl_gfx_stack.eo b/src/lib/efl/interfaces/efl_gfx_stack.eo
index 8fd59322a8..744ed78a59 100644
--- a/src/lib/efl/interfaces/efl_gfx_stack.eo
+++ b/src/lib/efl/interfaces/efl_gfx_stack.eo
@@ -11,7 +11,7 @@ interface Efl.Gfx.Stack
11 [[Sets the layer of its canvas that the given object will be part of. 11 [[Sets the layer of its canvas that the given object will be part of.
12 12
13 If you don't use this function, you'll be dealing with an unique 13 If you don't use this function, you'll be dealing with an unique
14 layer of objects, the default one. Additional layers are handy when 14 layer of objects (the default one). Additional layers are handy when
15 you don't want a set of objects to interfere with another set with 15 you don't want a set of objects to interfere with another set with
16 regard to stacking. Two layers are completely disjoint in that 16 regard to stacking. Two layers are completely disjoint in that
17 matter. 17 matter.
@@ -19,9 +19,9 @@ interface Efl.Gfx.Stack
19 This is a low-level function, which you'd be using when something 19 This is a low-level function, which you'd be using when something
20 should be always on top, for example. 20 should be always on top, for example.
21 21
22 Warning: Be careful, it doesn't make sense to change the layer of 22 Warning: Don't change the layer of
23 smart objects' children. Smart objects have a layer of their own, 23 smart objects' children. Smart objects have a layer of their own,
24 which should contain all their children objects. 24 which should contain all their child objects.
25 25
26 See also @.layer.get()]] 26 See also @.layer.get()]]
27 } 27 }
@@ -62,12 +62,12 @@ interface Efl.Gfx.Stack
62 stack_below { 62 stack_below {
63 [[Stack $obj immediately $below 63 [[Stack $obj immediately $below
64 64
65 Objects, in a given canvas, are stacked in the order they get added 65 Objects, in a given canvas, are stacked in the order they're added.
66 to it. This means that, if they overlap, the highest ones will 66 This means that, if they overlap, the highest ones will
67 cover the lowest ones, in that order. This function is a way to 67 cover the lowest ones, in that order. This function is a way to
68 change the stacking order for the objects. 68 change the stacking order for the objects.
69 69
70 This function is intended to be used with objects belonging to 70 Its intended to be used with objects belonging to
71 the same layer in a given canvas, otherwise it will fail (and 71 the same layer in a given canvas, otherwise it will fail (and
72 accomplish nothing). 72 accomplish nothing).
73 73
@@ -96,12 +96,12 @@ interface Efl.Gfx.Stack
96 stack_above { 96 stack_above {
97 [[Stack $obj immediately $above 97 [[Stack $obj immediately $above
98 98
99 Objects, in a given canvas, are stacked in the order they get added 99 Objects, in a given canvas, are stacked in the order they're added.
100 to it. This means that, if they overlap, the highest ones will 100 This means that, if they overlap, the highest ones will
101 cover the lowest ones, in that order. This function is a way to 101 cover the lowest ones, in that order. This function is a way to
102 change the stacking order for the objects. 102 change the stacking order for the objects.
103 103
104 This function is intended to be used with objects belonging to 104 Its intended to be used with objects belonging to
105 the same layer in a given canvas, otherwise it will fail (and 105 the same layer in a given canvas, otherwise it will fail (and
106 accomplish nothing). 106 accomplish nothing).
107 107
diff --git a/src/lib/efl/interfaces/efl_image_load.eo b/src/lib/efl/interfaces/efl_image_load.eo
index 703dbebe1b..1f2f8d247d 100644
--- a/src/lib/efl/interfaces/efl_image_load.eo
+++ b/src/lib/efl/interfaces/efl_image_load.eo
@@ -20,7 +20,7 @@ interface Efl.Image.Load ()
20 load_async_start { 20 load_async_start {
21 [[Begin preloading an image object's image data in the background. 21 [[Begin preloading an image object's image data in the background.
22 22
23 Once the background task is done, the event $load,done will be 23 Once the background task is complete the event $load,done will be
24 emitted. 24 emitted.
25 ]] 25 ]]
26 } 26 }
@@ -28,7 +28,7 @@ interface Efl.Image.Load ()
28 [[Cancel preloading an image object's image data in the background. 28 [[Cancel preloading an image object's image data in the background.
29 29
30 The event $load,cancelled should be triggered soon after 30 The event $load,cancelled should be triggered soon after
31 cancellation happened, and the object should be left in a state 31 cancellation occurs and the object should be left in a state
32 where it has no image data. If cancel is called too late, the image 32 where it has no image data. If cancel is called too late, the image
33 will be kept in memory. 33 will be kept in memory.
34 ]] 34 ]]
@@ -51,7 +51,7 @@ interface Efl.Image.Load ()
51 [[The load size of an image. 51 [[The load size of an image.
52 52
53 The image will be loaded into memory as if it was the specified 53 The image will be loaded into memory as if it was the specified
54 size instead of its original size. This can save a lot of memory, 54 size instead of its original size. This can save a lot of memory
55 and is important for scalable types like svg. 55 and is important for scalable types like svg.
56 56
57 By default, the load size is not specified, so it is 0x0. 57 By default, the load size is not specified, so it is 0x0.
@@ -59,7 +59,7 @@ interface Efl.Image.Load ()
59 set { 59 set {
60 [[Requests the canvas to load the image at the given size. 60 [[Requests the canvas to load the image at the given size.
61 61
62 EFL will try to load the image at the requested size, but does 62 EFL will try to load an image of the requested size but does
63 not guarantee an exact match between the request and the loaded 63 not guarantee an exact match between the request and the loaded
64 image dimensions. 64 image dimensions.
65 ]] 65 ]]
@@ -110,8 +110,8 @@ interface Efl.Image.Load ()
110 image's area on its image object. 110 image's area on its image object.
111 111
112 Note: The image loader for the image format in question has 112 Note: The image loader for the image format in question has
113 to support selective region loading in order to this function 113 to support selective region loading in order for this function
114 to take effect. 114 to work.
115 ]] 115 ]]
116 } 116 }
117 get { 117 get {
@@ -144,11 +144,11 @@ interface Efl.Image.Load ()
144 @property load_scale_down { 144 @property load_scale_down {
145 [[The scale down factor is a divider on the original image size. 145 [[The scale down factor is a divider on the original image size.
146 146
147 Setting the scale down factor can reduce load time and memory usage, 147 Setting the scale down factor can reduce load time and memory usage
148 at the cost of having a scaled down image in memory. 148 at the cost of having a scaled down image in memory.
149 149
150 This function sets the scale down factor of a given canvas 150 This function sets the scale down factor of a given canvas
151 image. Most useful for the SVG image loader, but also applies 151 image. Most useful for the SVG image loader but also applies
152 to JPEG, PNG and BMP. 152 to JPEG, PNG and BMP.
153 153
154 Powers of two (2, 4, 8) are best supported (especially with JPEG) 154 Powers of two (2, 4, 8) are best supported (especially with JPEG)
diff --git a/src/lib/efl/interfaces/efl_input_device.eo b/src/lib/efl/interfaces/efl_input_device.eo
index 0efe918a39..22d50b3dec 100644
--- a/src/lib/efl/interfaces/efl_input_device.eo
+++ b/src/lib/efl/interfaces/efl_input_device.eo
@@ -10,7 +10,7 @@ enum Efl.Input.Device.Type
10 mouse, [[A mouse, trackball or touchpad relative motion device.]] 10 mouse, [[A mouse, trackball or touchpad relative motion device.]]
11 touch, [[A touchscreen with fingers or stylus.]] 11 touch, [[A touchscreen with fingers or stylus.]]
12 pen, [[A special pen device.]] 12 pen, [[A special pen device.]]
13 wand, [[A laser pointer, wii-style or "minority report" pointing device.]] 13 wand, [[A laser pointer, wii-style or "Minority Report" pointing device.]]
14 gamepad, [[A gamepad controller or joystick.]] 14 gamepad, [[A gamepad controller or joystick.]]
15} 15}
16 16
@@ -21,7 +21,7 @@ enum Efl.Input.Device.Type
21 21
22class Efl.Input.Device (Efl.Object) 22class Efl.Input.Device (Efl.Object)
23{ 23{
24 [[Represents a pointing device, such as a touch finger, a pen or a mouse. 24 [[Represents a pointing device such as a touch finger, pen or mouse.
25 25
26 @since 1.18 26 @since 1.18
27 ]] 27 ]]
@@ -78,7 +78,7 @@ class Efl.Input.Device (Efl.Object)
78 78
79 Returns 1 for Mouse, Touch, Pen, Pointer, and Wand type devices. 79 Returns 1 for Mouse, Touch, Pen, Pointer, and Wand type devices.
80 80
81 If a seat device is passed, returns the number of pointer devices in the seat. 81 If a seat device is passed returns the number of pointer devices in the seat.
82 82
83 @since 1.20 83 @since 1.20
84 ]] 84 ]]
diff --git a/src/lib/efl/interfaces/efl_io_buffer.eo b/src/lib/efl/interfaces/efl_io_buffer.eo
index d9d4d91e23..75358d7bb3 100644
--- a/src/lib/efl/interfaces/efl_io_buffer.eo
+++ b/src/lib/efl/interfaces/efl_io_buffer.eo
@@ -26,7 +26,7 @@ class Efl.Io.Buffer (Efl.Object, Efl.Io.Reader, Efl.Io.Writer, Efl.Io.Closer, Ef
26 [[Adopt a read-only slice as buffer's backing store. 26 [[Adopt a read-only slice as buffer's backing store.
27 27
28 The slice memory will not be copied and must remain 28 The slice memory will not be copied and must remain
29 alive during buffer's lifetime. Usually this is 29 alive during the buffer's lifetime. Usually this is
30 guaranteed by some global static-const memory or some 30 guaranteed by some global static-const memory or some
31 parent object and this buffer being a view of that -- be 31 parent object and this buffer being a view of that -- be
32 aware of parent memory remaining alive, such as 32 aware of parent memory remaining alive, such as
@@ -41,7 +41,7 @@ class Efl.Io.Buffer (Efl.Object, Efl.Io.Reader, Efl.Io.Writer, Efl.Io.Closer, Ef
41 [[Adopt a read-write slice as buffer's backing store. 41 [[Adopt a read-write slice as buffer's backing store.
42 42
43 The slice memory will not be copied and must remain 43 The slice memory will not be copied and must remain
44 alive during buffer's lifetime. Usually this is 44 alive during the buffer's lifetime. Usually this is
45 guaranteed by some global static memory or some 45 guaranteed by some global static memory or some
46 parent object and this buffer being a view of that -- be 46 parent object and this buffer being a view of that -- be
47 aware of parent memory remaining alive, such as 47 aware of parent memory remaining alive, such as
@@ -61,8 +61,8 @@ class Efl.Io.Buffer (Efl.Object, Efl.Io.Reader, Efl.Io.Writer, Efl.Io.Closer, Ef
61 This affects both @.preallocate and how buffer grows 61 This affects both @.preallocate and how buffer grows
62 when @Efl.Io.Writer.write is called. 62 when @Efl.Io.Writer.write is called.
63 63
64 If you want a buffer of an exact size, always set the 64 If you want a buffer of an exact size always set the
65 limit before any further calls that can grow it. 65 limit before any further calls that can expand it.
66 ]] 66 ]]
67 get { } 67 get { }
68 set { 68 set {
diff --git a/src/lib/efl/interfaces/efl_io_queue.eo b/src/lib/efl/interfaces/efl_io_queue.eo
index 0bcf8a3d7e..46bcde493f 100644
--- a/src/lib/efl/interfaces/efl_io_queue.eo
+++ b/src/lib/efl/interfaces/efl_io_queue.eo
@@ -26,7 +26,7 @@ class Efl.Io.Queue (Efl.Object, Efl.Io.Reader, Efl.Io.Writer, Efl.Io.Closer) {
26 when @Efl.Io.Writer.write is called. 26 when @Efl.Io.Writer.write is called.
27 27
28 If you want a buffer of an exact size, always set the 28 If you want a buffer of an exact size, always set the
29 limit before any further calls that can grow it. 29 limit before any further calls that can expand it.
30 ]] 30 ]]
31 get { } 31 get { }
32 set { 32 set {
@@ -46,9 +46,9 @@ class Efl.Io.Queue (Efl.Object, Efl.Io.Reader, Efl.Io.Writer, Efl.Io.Closer) {
46 } 46 }
47 47
48 @property slice { 48 @property slice {
49 [[Get a temporary access to queue's internal read memory. 49 [[Gain temporary access to queue's internal read memory.
50 50
51 The memory pointed by slice may be changed by other 51 The memory pointed to by slice may be changed by other
52 methods of this class. The event "slice,changed" will be 52 methods of this class. The event "slice,changed" will be
53 called in those situations. 53 called in those situations.
54 ]] 54 ]]
@@ -70,11 +70,11 @@ class Efl.Io.Queue (Efl.Object, Efl.Io.Reader, Efl.Io.Writer, Efl.Io.Closer) {
70 data must be discarded. 70 data must be discarded.
71 71
72 As an example, some protocols provide messages with a 72 As an example, some protocols provide messages with a
73 "size" header, then @.slice is used to peek into the 73 "size" header, in which case @.slice is used to peek into the
74 available memory to see if there is a "size" and if the 74 available memory to see if there is a "size" and if the
75 rest of the slice is the full payload, in this case the 75 rest of the slice is the full payload. In that situation the
76 slice may be handled to some processing function. When 76 slice may be handled by a processing function. When
77 the function is done, that amount of data must be 77 the function is complete the defined amount of data must be
78 discarded -- with this function. 78 discarded -- with this function.
79 ]] 79 ]]
80 params { 80 params {
@@ -83,9 +83,9 @@ class Efl.Io.Queue (Efl.Object, Efl.Io.Reader, Efl.Io.Writer, Efl.Io.Closer) {
83 } 83 }
84 84
85 clear { 85 clear {
86 [[Clear the queue. Same as reading all data. 86 [[Clears the queue. Same as reading all data.
87 87
88 This is equivalent as calling @.discard with @.usage 88 This is equivalent to calling @.discard with @.usage
89 amount of bytes. 89 amount of bytes.
90 ]] 90 ]]
91 } 91 }
diff --git a/src/lib/efl/interfaces/efl_io_writer.eo b/src/lib/efl/interfaces/efl_io_writer.eo
index 77807c37ad..cba6ff3be7 100644
--- a/src/lib/efl/interfaces/efl_io_writer.eo
+++ b/src/lib/efl/interfaces/efl_io_writer.eo
@@ -4,10 +4,10 @@ interface Efl.Io.Writer {
4 [[Generic interface for objects that can write data from a provided memory. 4 [[Generic interface for objects that can write data from a provided memory.
5 5
6 This interface allows external objects to transparently write 6 This interface allows external objects to transparently write
7 data to this object and be notified if more data can be written 7 data to this object and be notified whether more data can be written
8 or it's topped capacity. 8 or if it's reached capacity.
9 9
10 Calls to @.write() may or may not block, that's not up to this 10 Calls to @.write() may or may not block: that's not up to this
11 interface to specify. The user can check with event 11 interface to specify. The user can check with event
12 "can_write,changed" or property @.can_write to known whenever a write 12 "can_write,changed" or property @.can_write to known whenever a write
13 could push more data. 13 could push more data.
@@ -21,7 +21,7 @@ interface Efl.Io.Writer {
21 21
22 This operation will be executed immediately and may or 22 This operation will be executed immediately and may or
23 may not block the caller thread for some time. The 23 may not block the caller thread for some time. The
24 details of blocking behavior is to be defined by the 24 details of blocking behavior is defined by the
25 implementation and may be subject to other parameters 25 implementation and may be subject to other parameters
26 such as non-blocking flags, maximum timeout or even 26 such as non-blocking flags, maximum timeout or even
27 retry attempts. 27 retry attempts.
diff --git a/src/lib/efl/interfaces/efl_model.eo b/src/lib/efl/interfaces/efl_model.eo
index 39db6c4fa0..d615c4472b 100644
--- a/src/lib/efl/interfaces/efl_model.eo
+++ b/src/lib/efl/interfaces/efl_model.eo
@@ -104,7 +104,7 @@ interface Efl.Model ()
104 [[Get children count. 104 [[Get children count.
105 105
106 When efl_model_load is completed efl_model_coildren_count_get 106 When efl_model_load is completed efl_model_coildren_count_get
107 can be use to get the number of children. children_count_get 107 can be used to get the number of children. children_count_get
108 can also be used before calling children_slice_get so a valid 108 can also be used before calling children_slice_get so a valid
109 range is known. Event EFL_MODEL_CHILDREN_COUNT_CHANGED is 109 range is known. Event EFL_MODEL_CHILDREN_COUNT_CHANGED is
110 emitted when count is finished. 110 emitted when count is finished.
diff --git a/src/lib/efl/interfaces/efl_pack.eo b/src/lib/efl/interfaces/efl_pack.eo
index fbee67a076..98a7371323 100644
--- a/src/lib/efl/interfaces/efl_pack.eo
+++ b/src/lib/efl/interfaces/efl_pack.eo
@@ -30,7 +30,7 @@ interface Efl.Pack (Efl.Container)
30 spot, replacing any already existing element or append to the end 30 spot, replacing any already existing element or append to the end
31 of the container if there is no default part. 31 of the container if there is no default part.
32 32
33 When this container is deleted, it will request deletion on the 33 When this container is deleted, it will request deletion of the
34 given $subobj. Use @.unpack to remove $subobj from this container 34 given $subobj. Use @.unpack to remove $subobj from this container
35 without deleting it. 35 without deleting it.
36 ]] 36 ]]
diff --git a/src/lib/efl/interfaces/efl_pack_linear.eo b/src/lib/efl/interfaces/efl_pack_linear.eo
index 2ee7deee83..d1e740603b 100644
--- a/src/lib/efl/interfaces/efl_pack_linear.eo
+++ b/src/lib/efl/interfaces/efl_pack_linear.eo
@@ -8,7 +8,7 @@ interface Efl.Pack.Linear (Efl.Pack)
8 8
9 This is the same as @.pack_at($subobj, 0). 9 This is the same as @.pack_at($subobj, 0).
10 10
11 When this container is deleted, it will request deletion on the 11 When this container is deleted, it will request deletion of the
12 given $subobj. Use @Efl.Pack.unpack to remove $subobj from this 12 given $subobj. Use @Efl.Pack.unpack to remove $subobj from this
13 container without deleting it. 13 container without deleting it.
14 ]] 14 ]]
@@ -22,7 +22,7 @@ interface Efl.Pack.Linear (Efl.Pack)
22 22
23 This is the same as @.pack_at($subobj, -1). 23 This is the same as @.pack_at($subobj, -1).
24 24
25 When this container is deleted, it will request deletion on the 25 When this container is deleted, it will request deletion of the
26 given $subobj. Use @Efl.Pack.unpack to remove $subobj from this 26 given $subobj. Use @Efl.Pack.unpack to remove $subobj from this
27 container without deleting it. 27 container without deleting it.
28 ]] 28 ]]
@@ -34,7 +34,7 @@ interface Efl.Pack.Linear (Efl.Pack)
34 pack_before { 34 pack_before {
35 [[Prepend item before other sub object. 35 [[Prepend item before other sub object.
36 36
37 When this container is deleted, it will request deletion on the 37 When this container is deleted, it will request deletion of the
38 given $subobj. Use @Efl.Pack.unpack to remove $subobj from this 38 given $subobj. Use @Efl.Pack.unpack to remove $subobj from this
39 container without deleting it. 39 container without deleting it.
40 ]] 40 ]]
@@ -48,7 +48,7 @@ interface Efl.Pack.Linear (Efl.Pack)
48 pack_after { 48 pack_after {
49 [[Append item after other sub object. 49 [[Append item after other sub object.
50 50
51 When this container is deleted, it will request deletion on the 51 When this container is deleted, it will request deletion of the
52 given $subobj. Use @Efl.Pack.unpack to remove $subobj from this 52 given $subobj. Use @Efl.Pack.unpack to remove $subobj from this
53 container without deleting it. 53 container without deleting it.
54 ]] 54 ]]
@@ -65,7 +65,7 @@ interface Efl.Pack.Linear (Efl.Pack)
65 Valid range: -$count to +$count. -1 refers to the last element. 65 Valid range: -$count to +$count. -1 refers to the last element.
66 Out of range indices will trigger an append. 66 Out of range indices will trigger an append.
67 67
68 When this container is deleted, it will request deletion on the 68 When this container is deleted, it will request deletion of the
69 given $subobj. Use @Efl.Pack.unpack to remove $subobj from this 69 given $subobj. Use @Efl.Pack.unpack to remove $subobj from this
70 container without deleting it. 70 container without deleting it.
71 ]] 71 ]]
diff --git a/src/lib/efl/interfaces/efl_pack_table.eo b/src/lib/efl/interfaces/efl_pack_table.eo
index 4159fad19c..c79bd82b7a 100644
--- a/src/lib/efl/interfaces/efl_pack_table.eo
+++ b/src/lib/efl/interfaces/efl_pack_table.eo
@@ -8,7 +8,7 @@ interface Efl.Pack.Table (Efl.Pack.Linear)
8 pack_table { 8 pack_table {
9 [[Pack object at a given location in the table. 9 [[Pack object at a given location in the table.
10 10
11 When this container is deleted, it will request deletion on the 11 When this container is deleted, it will request deletion of the
12 given $subobj. Use @Efl.Pack.unpack to remove $subobj from this 12 given $subobj. Use @Efl.Pack.unpack to remove $subobj from this
13 container without deleting it. 13 container without deleting it.
14 ]] 14 ]]
diff --git a/src/lib/efl/interfaces/efl_text_format.eo b/src/lib/efl/interfaces/efl_text_format.eo
index 0e1829972b..0155625d78 100644
--- a/src/lib/efl/interfaces/efl_text_format.eo
+++ b/src/lib/efl/interfaces/efl_text_format.eo
@@ -108,9 +108,9 @@ interface Efl.Text.Format {
108 } 108 }
109 109
110 @property replacement_char { 110 @property replacement_char {
111 [[The character used to replace characters that can not be displayed 111 [[The character used to replace characters that can't be displayed
112 112
113 Currently, only used to replace characters if @.password 113 Currently only used to replace characters if @.password
114 is enabled. 114 is enabled.
115 ]] 115 ]]
116 values { 116 values {
diff --git a/src/lib/efl/interfaces/efl_text_properties.eo b/src/lib/efl/interfaces/efl_text_properties.eo
index 1d755761ed..8552fae4dd 100644
--- a/src/lib/efl/interfaces/efl_text_properties.eo
+++ b/src/lib/efl/interfaces/efl_text_properties.eo
@@ -6,13 +6,13 @@ interface Efl.Text.Properties
6 methods { 6 methods {
7 @property font { 7 @property font {
8 set { 8 set {
9 [[Set the font family or filename, and size on a given text object. 9 [[Set the font family, filename and size for a given text object.
10 10
11 This function allows the font name and size of a text object to 11 This function allows the font name and size of a text object to
12 be set. The font string has to follow fontconfig's convention on 12 be set. The font string has to follow fontconfig's convention for
13 naming fonts, as it's the underlying library used to query system 13 naming fonts, as it's the underlying library used to query system
14 fonts by Evas (see the fc-list command's output, on your system, 14 fonts by Evas (see the fc-list command's output, on your system,
15 to get an idea). Alternatively, one can use a full path to a font 15 to get an idea). Alternatively, youe can use the full path to a font
16 file. 16 file.
17 17
18 See also @.font.get, @.font_source.get. 18 See also @.font.get, @.font_source.get.
@@ -22,7 +22,7 @@ interface Efl.Text.Properties
22 [[Retrieve the font family and size in use on a given text object. 22 [[Retrieve the font family and size in use on a given text object.
23 23
24 This function allows the font name and size of a text object to 24 This function allows the font name and size of a text object to
25 be queried. Be aware that the font name string is still owned by 25 be queried. Remember that the font name string is still owned by
26 Evas and should not have free() called on it by the caller of the 26 Evas and should not have free() called on it by the caller of the
27 function. 27 function.
28 28
diff --git a/src/lib/efl/interfaces/efl_ui_clickable.eo b/src/lib/efl/interfaces/efl_ui_clickable.eo
index 5cfaa89a35..6706630302 100644
--- a/src/lib/efl/interfaces/efl_ui_clickable.eo
+++ b/src/lib/efl/interfaces/efl_ui_clickable.eo
@@ -3,13 +3,13 @@ interface Efl.Ui.Clickable ()
3 [[Efl UI clickable interface]] 3 [[Efl UI clickable interface]]
4 event_prefix: efl_ui; 4 event_prefix: efl_ui;
5 events { 5 events {
6 clicked; [[Called when object was clicked]] 6 clicked; [[Called when object iss clicked]]
7 clicked,double; [[Called when object received a double click]] 7 clicked,double; [[Called when object receives a double click]]
8 clicked,triple; [[Called when object received a triple click]] 8 clicked,triple; [[Called when object receives a triple click]]
9 clicked,right; [[Called when object received a right click]] 9 clicked,right; [[Called when object receives a right click]]
10 pressed; [[Called when the object was pressed]] 10 pressed; [[Called when the object is pressed]]
11 unpressed; [[Called when the object is now longer pressed]] 11 unpressed; [[Called when the object is no longer pressed]]
12 longpressed; [[Called when the object received a longpress]] 12 longpressed; [[Called when the object receives a long press]]
13 repeated; [[Called when the object received repeated presses/clicks]] 13 repeated; [[Called when the object receives repeated presses/clicks]]
14 } 14 }
15} 15}
diff --git a/src/lib/efl/interfaces/efl_ui_drag.eo b/src/lib/efl/interfaces/efl_ui_drag.eo
index 6fcd1f9640..227015f2b0 100644
--- a/src/lib/efl/interfaces/efl_ui_drag.eo
+++ b/src/lib/efl/interfaces/efl_ui_drag.eo
@@ -10,31 +10,31 @@ interface Efl.Ui.Drag
10 ]] 10 ]]
11 methods { 11 methods {
12 @property drag_value { 12 @property drag_value {
13 [[The dragable object relative location. 13 [[The draggable object relative location.
14 14
15 Some parts in Edje can be dragged along the X/Y axes, if the part 15 Some parts in Edje can be dragged along the X/Y axes, if the part
16 contains a "dragable" section (in EDC). For instance, scroll bars 16 contains a "draggable" section (in EDC). For instance, scroll bars
17 can be dragable objects. 17 can be draggable objects.
18 18
19 $dx and $dy are real numbers that range from 0 to 1, representing 19 $dx and $dy are real numbers that range from 0 to 1, representing
20 the relative position to the dragable area on that axis. 20 the relative position to the draggable area on that axis.
21 21
22 This value means, for the vertical axis, that 0.0 will be at the top 22 This value means, for the vertical axis, that 0.0 will be at the top
23 if the first parameter of $y in the dragable part theme is 1, and at 23 if the first parameter of $y in the draggable part theme is 1 and at
24 the bottom if it is -1. 24 the bottom if it is -1.
25 25
26 For the horizontal axis, 0.0 means left if the first parameter of $x 26 For the horizontal axis, 0.0 means left if the first parameter of $x
27 in the dragable part theme is 1, and right if it is -1. 27 in the draggable part theme is 1, and right if it is -1.
28 ]] 28 ]]
29 set { 29 set {
30 [[Sets the dragable object location. 30 [[Sets the draggable object location.
31 31
32 This places the dragable object at the given location. 32 This places the draggable object at the given location.
33 ]] 33 ]]
34 return: bool; [[$true on success, $false otherwise]] 34 return: bool; [[$true on success, $false otherwise]]
35 } 35 }
36 get { 36 get {
37 [[Gets the dragable object location.]] 37 [[Gets the draggable object location.]]
38 return: bool; [[$true on success, $false otherwise]] 38 return: bool; [[$true on success, $false otherwise]]
39 } 39 }
40 values { 40 values {
@@ -43,16 +43,16 @@ interface Efl.Ui.Drag
43 } 43 }
44 } 44 }
45 @property drag_size { 45 @property drag_size {
46 [[The dragable object relative size. 46 [[The draggable object relative size.
47 47
48 Values for $dw and $dh are real numbers that range from 0 to 1, 48 Values for $dw and $dh are real numbers that range from 0 to 1,
49 representing the relative size of the dragable area on that axis. 49 representing the relative size of the draggable area on that axis.
50 50
51 For instance a scroll bar handle size may depend on much large is 51 For instance a scroll bar handle size may depend on the size of
52 the scroller's content. 52 the scroller's content.
53 ]] 53 ]]
54 set { 54 set {
55 [[Sets the size of the dragable object.]] 55 [[Sets the size of the draggable object.]]
56 return: bool; [[$true on success, $false otherwise]] 56 return: bool; [[$true on success, $false otherwise]]
57 } 57 }
58 get { 58 get {
@@ -65,14 +65,14 @@ interface Efl.Ui.Drag
65 } 65 }
66 } 66 }
67 @property drag_dir { 67 @property drag_dir {
68 [[Determines the dragable directions (read-only). 68 [[Determines the draggable directions (read-only).
69 69
70 The dragable directions are defined in the EDC file, inside the 70 The draggable directions are defined in the EDC file, inside the
71 "dragable" section, by the attributes $x and $y. See the EDC 71 "draggable" section, by the attributes $x and $y. See the EDC
72 reference documentation for more information. 72 reference documentation for more information.
73 ]] 73 ]]
74 get { 74 get {
75 [[Gets the dragable direction.]] 75 [[Gets the draggable direction.]]
76 return: Efl.Ui.Drag.Dir; [[The direction(s) premitted for drag.]] 76 return: Efl.Ui.Drag.Dir; [[The direction(s) premitted for drag.]]
77 } 77 }
78 } 78 }
@@ -80,7 +80,7 @@ interface Efl.Ui.Drag
80 [[The drag step increment. 80 [[The drag step increment.
81 81
82 Values for $dx and $dy are real numbers that range from 0 to 1, 82 Values for $dx and $dy are real numbers that range from 0 to 1,
83 representing the relative size of the dragable area on that axis by 83 representing the relative size of the draggable area on that axis by
84 which the part will be moved. 84 which the part will be moved.
85 85
86 This differs from @.drag_page in that this is meant to 86 This differs from @.drag_page in that this is meant to
@@ -89,11 +89,11 @@ interface Efl.Ui.Drag
89 See also @.drag_page. 89 See also @.drag_page.
90 ]] 90 ]]
91 set { 91 set {
92 [[Sets the x,y step increments for a dragable object.]] 92 [[Sets the x,y step increments for a draggable object.]]
93 return: bool; [[$true on success, $false otherwise]] 93 return: bool; [[$true on success, $false otherwise]]
94 } 94 }
95 get { 95 get {
96 [[Gets the x and y step increments for the dragable object.]] 96 [[Gets the x and y step increments for the draggable object.]]
97 return: bool; [[$true on success, $false otherwise]] 97 return: bool; [[$true on success, $false otherwise]]
98 } 98 }
99 values { 99 values {
@@ -102,9 +102,9 @@ interface Efl.Ui.Drag
102 } 102 }
103 } 103 }
104 drag_step_move { 104 drag_step_move {
105 [[Moves the dragable by $dx,$dy steps. 105 [[Moves the draggable by $dx,$dy steps.
106 106
107 This moves the dragable part by $dx,$dy steps where the step 107 This moves the draggable part by $dx,$dy steps where the step
108 increment is the amount set by @.drag_step.set(). 108 increment is the amount set by @.drag_step.set().
109 109
110 $dx and $dy can be positive or negative numbers, integer values are 110 $dx and $dy can be positive or negative numbers, integer values are
@@ -120,7 +120,7 @@ interface Efl.Ui.Drag
120 [[The page step increments. 120 [[The page step increments.
121 121
122 Values for $dx and $dy are real numbers that range from 0 to 1, 122 Values for $dx and $dy are real numbers that range from 0 to 1,
123 representing the relative size of the dragable area on that axis by 123 representing the relative size of the draggable area on that axis by
124 which the part will be moved. 124 which the part will be moved.
125 125
126 This differs from @.drag_step in that this is meant to be a 126 This differs from @.drag_step in that this is meant to be a
@@ -134,7 +134,7 @@ interface Efl.Ui.Drag
134 return: bool; [[$true on success, $false otherwise]] 134 return: bool; [[$true on success, $false otherwise]]
135 } 135 }
136 get { 136 get {
137 [[Gets the x,y page step increments for the dragable object.]] 137 [[Gets the x,y page step increments for the draggable object.]]
138 return: bool; [[$true on success, $false otherwise]] 138 return: bool; [[$true on success, $false otherwise]]
139 } 139 }
140 values { 140 values {
@@ -143,9 +143,9 @@ interface Efl.Ui.Drag
143 } 143 }
144 } 144 }
145 drag_page_move { 145 drag_page_move {
146 [[Moves the dragable by $dx,$dy pages. 146 [[Moves the draggable by $dx,$dy pages.
147 147
148 This moves the dragable by $dx,$dy pages where the increment is 148 This moves the draggable by $dx,$dy pages. The increment is
149 defined by @.drag_page.set(). 149 defined by @.drag_page.set().
150 150
151 $dx and $dy can be positive or negative numbers, integer values are 151 $dx and $dy can be positive or negative numbers, integer values are
diff --git a/src/lib/efl/interfaces/efl_ui_draggable.eo b/src/lib/efl/interfaces/efl_ui_draggable.eo
index c3b8a68d3b..750bf46a57 100644
--- a/src/lib/efl/interfaces/efl_ui_draggable.eo
+++ b/src/lib/efl/interfaces/efl_ui_draggable.eo
@@ -7,11 +7,11 @@ interface Efl.Ui.Draggable ()
7 @property drag_target { 7 @property drag_target {
8 [[Control whether the object's content is changed by drag and drop. 8 [[Control whether the object's content is changed by drag and drop.
9 9
10 If $drag_target is true, the object can be target of dragging 10 If $drag_target is true the object can be the target of a dragging
11 object and the content of this object can be changed into 11 object. The content of this object can then be changed into
12 dragging content. For example, If object deals with image and 12 dragging content. For example, if an object deals with image and
13 $drag_target is true, user can drag new image and drop it into 13 $drag_target is true, the user can drag the new image and drop it into
14 this object. And then this object's image can be changed into 14 said object. This object's image can then be changed into a
15 new image.]] 15 new image.]]
16 set { 16 set {
17 } 17 }
diff --git a/src/lib/efl/interfaces/efl_ui_format.eo b/src/lib/efl/interfaces/efl_ui_format.eo
index 38647d33fb..88f3962e8e 100644
--- a/src/lib/efl/interfaces/efl_ui_format.eo
+++ b/src/lib/efl/interfaces/efl_ui_format.eo
@@ -24,10 +24,10 @@ mixin Efl.Ui.Format
24 @property format_string { 24 @property format_string {
25 [[Control the format string for a given units label 25 [[Control the format string for a given units label
26 26
27 If $NULL is passed on $format, it will make $obj's units 27 If $NULL is passed to $format, it will hide $obj's units
28 area to be hidden completely. If not, it'll set the <b>format 28 area completely. If not, it'll set the <b>format
29 string</b> for the units label's text. The units label is 29 string</b> for the units label text. The units label is
30 provided a floating point value, so the units text is up display 30 provided as a floating point value, so the units text can display
31 at most one floating point value. Note that the units label is 31 at most one floating point value. Note that the units label is
32 optional. Use a format string such as "%1.2f meters" for example. 32 optional. Use a format string such as "%1.2f meters" for example.
33 33
diff --git a/src/lib/efl/interfaces/efl_ui_range.eo b/src/lib/efl/interfaces/efl_ui_range.eo
index 56d4f89919..a387ef128f 100644
--- a/src/lib/efl/interfaces/efl_ui_range.eo
+++ b/src/lib/efl/interfaces/efl_ui_range.eo
@@ -25,8 +25,8 @@ interface Efl.Ui.Range
25 Define the allowed range of values to be selected by the user. 25 Define the allowed range of values to be selected by the user.
26 26
27 If actual value is less than $min, it will be updated to $min. 27 If actual value is less than $min, it will be updated to $min.
28 If it is bigger then $max, will be updated to $max. Actual value 28 If it is bigger then $max, will be updated to $max. The actual value
29 can be get with @Efl.Ui.Range.range_value.get 29 can be obtained with @Efl.Ui.Range.range_value.get
30 30
31 The minimum and maximum values may be different for each class. 31 The minimum and maximum values may be different for each class.
32 32
diff --git a/src/lib/efl/interfaces/efl_ui_scrollable.eo b/src/lib/efl/interfaces/efl_ui_scrollable.eo
index 203120613d..34b440d9af 100644
--- a/src/lib/efl/interfaces/efl_ui_scrollable.eo
+++ b/src/lib/efl/interfaces/efl_ui_scrollable.eo
@@ -17,20 +17,20 @@ interface Efl.Ui.Scrollable ()
17 [[Efl UI scrollable interface]] 17 [[Efl UI scrollable interface]]
18 event_prefix: efl_ui; 18 event_prefix: efl_ui;
19 events { 19 events {
20 scroll,start; [[Called when scroll operation started]] 20 scroll,start; [[Called when scroll operation starts]]
21 scroll; [[Called when scroll operation]] 21 scroll; [[Called when scrolling]]
22 scroll,stop; [[Called when scroll operation stopped]] 22 scroll,stop; [[Called when scroll operation stops]]
23 scroll,up; [[Called when scrolling to upwards]] 23 scroll,up; [[Called when scrolling upwards]]
24 scroll,down; [[Called when scrolling to downwards]] 24 scroll,down; [[Called when scrolling downwards]]
25 scroll,left; [[Called when scrolling to left]] 25 scroll,left; [[Called when scrolling left]]
26 scroll,right; [[Called when scrolling to right]] 26 scroll,right; [[Called when scrolling right]]
27 edge,up; [[Called when hitting the top edge]] 27 edge,up; [[Called when hitting the top edge]]
28 edge,down; [[Called when hitting the bottom edge]] 28 edge,down; [[Called when hitting the bottom edge]]
29 edge,left; [[Called when hitting the left edge]] 29 edge,left; [[Called when hitting the left edge]]
30 edge,right; [[Called when hitting the right edge]] 30 edge,right; [[Called when hitting the right edge]]
31 scroll,anim,start; [[Called when scroll animation started]] 31 scroll,anim,start; [[Called when scroll animation starts]]
32 scroll,anim,stop; [[Called when scroll animation stopped]] 32 scroll,anim,stop; [[Called when scroll animation stopps]]
33 scroll,drag,start; [[Called when scroll drag started]] 33 scroll,drag,start; [[Called when scroll drag starts]]
34 scroll,drag,stop; [[Called when scroll drag stopped]] 34 scroll,drag,stop; [[Called when scroll drag stops]]
35 } 35 }
36} 36}
diff --git a/src/lib/efl/interfaces/efl_ui_scrollable_interactive.eo b/src/lib/efl/interfaces/efl_ui_scrollable_interactive.eo
index f25192e374..d3139c8225 100644
--- a/src/lib/efl/interfaces/efl_ui_scrollable_interactive.eo
+++ b/src/lib/efl/interfaces/efl_ui_scrollable_interactive.eo
@@ -33,10 +33,10 @@ interface Efl.Ui.Scrollable.Interactive (Efl.Ui.Scrollable)
33 @property bounce_enabled { 33 @property bounce_enabled {
34 [[Bouncing behavior 34 [[Bouncing behavior
35 35
36 When scrolling, the scroller may "bounce" when reaching an edge of the 36 When scrolling, the scroller may "bounce" when reaching the edge of the
37 content object. This is a visual way to indicate the end has been reached. 37 content object. This is a visual way to indicate the end has been reached.
38 This is enabled by default for both axis. This API will set if it is enabled 38 This is enabled by default for both axes. This API will determine if it's enabled
39 for the given axis with the boolean parameters for each axis.]] 39 for the given axis with the boolean parameters for each one.]]
40 set { 40 set {
41 } 41 }
42 get { 42 get {
@@ -49,8 +49,8 @@ interface Efl.Ui.Scrollable.Interactive (Efl.Ui.Scrollable)
49 @property scroll_freeze { 49 @property scroll_freeze {
50 [[Freeze property 50 [[Freeze property
51 This function will freeze scrolling movement (by input of a user). 51 This function will freeze scrolling movement (by input of a user).
52 Unlike efl_ui_scrollable_movement_block_set, this function freezes bidirectional. 52 Unlike efl_ui_scrollable_movement_block_set, this function freezes bidirectionally.
53 If you want to freeze only one direction, 53 If you want to freeze in only one direction,
54 See @.movement_block.set. 54 See @.movement_block.set.
55 ]] 55 ]]
56 get { 56 get {
@@ -88,7 +88,7 @@ interface Efl.Ui.Scrollable.Interactive (Efl.Ui.Scrollable)
88 [[Blocking of scrolling (per axis) 88 [[Blocking of scrolling (per axis)
89 89
90 This function will block scrolling movement (by input of a user) in 90 This function will block scrolling movement (by input of a user) in
91 a given direction. One can disable movements in the X axis, the Y 91 a given direction. You can disable movements in the X axis, the Y
92 axis or both. The default value is $none, where movements are 92 axis or both. The default value is $none, where movements are
93 allowed in both directions. 93 allowed in both directions.
94 ]] 94 ]]
diff --git a/src/lib/efl/interfaces/efl_ui_selectable.eo b/src/lib/efl/interfaces/efl_ui_selectable.eo
index b24772ee02..f7cf257a5e 100644
--- a/src/lib/efl/interfaces/efl_ui_selectable.eo
+++ b/src/lib/efl/interfaces/efl_ui_selectable.eo
@@ -5,11 +5,11 @@ interface Efl.Ui.Selectable ()
5 events { 5 events {
6 selected; [[Called when selected]] 6 selected; [[Called when selected]]
7 unselected; [[Called when no longer selected]] 7 unselected; [[Called when no longer selected]]
8 selection,paste; [[Called when selection got pasted]] 8 selection,paste; [[Called when selection is pasted]]
9 selection,copy; [[Called when selection was copied]] 9 selection,copy; [[Called when selection is copied]]
10 selection,cut; [[Called when selection was cut]] 10 selection,cut; [[Called when selection is cut]]
11 selection,start; [[Called at selection start]] 11 selection,start; [[Called at selection start]]
12 selection,changed; [[Called when selection changed]] 12 selection,changed; [[Called when selection is changed]]
13 selection,cleared; [[Called when selection was cleared]] 13 selection,cleared; [[Called when selection is cleared]]
14 } 14 }
15} 15}