summaryrefslogtreecommitdiff
path: root/src/lib/efl
diff options
context:
space:
mode:
authorXavi Artigas <xavierartigas@yahoo.es>2019-09-13 12:25:49 +0200
committerXavi Artigas <xavierartigas@yahoo.es>2019-09-13 12:30:03 +0200
commit8c09c1cae8b4368b88ec0b296f124d35e735dc7e (patch)
tree16548e1c5e3c8ac8b51398525da011ab555d4e29 /src/lib/efl
parent5e9b30153399014ff0aa52922f8460c7769eb741 (diff)
docs: Move property docs to property level instead of set/get
Eolian @properties should be documented at the property level, and documentation at the setter or getter level should be left to setter- or getter-specific comments. There is usually no need at all to have setter- or getter- specific comments. Also, a property is not a method so descriptions should match that. This patch removes lots of duplicated text, and will allow enabling by default the eolian check that ensures that properties have proper property-level docs. No functional changes.
Diffstat (limited to 'src/lib/efl')
-rw-r--r--src/lib/efl/interfaces/efl_cached_item.eo2
-rw-r--r--src/lib/efl/interfaces/efl_canvas_pointer.eo20
-rw-r--r--src/lib/efl/interfaces/efl_canvas_scene.eo28
-rw-r--r--src/lib/efl/interfaces/efl_file.eo56
-rw-r--r--src/lib/efl/interfaces/efl_gfx_color.eo51
-rw-r--r--src/lib/efl/interfaces/efl_gfx_color_class.eo78
-rw-r--r--src/lib/efl/interfaces/efl_gfx_filter.eo19
-rw-r--r--src/lib/efl/interfaces/efl_gfx_frame_controller.eo74
-rw-r--r--src/lib/efl/interfaces/efl_gfx_gradient.eo12
-rw-r--r--src/lib/efl/interfaces/efl_gfx_gradient_linear.eo6
-rw-r--r--src/lib/efl/interfaces/efl_gfx_gradient_radial.eo9
-rw-r--r--src/lib/efl/interfaces/efl_gfx_image.eo18
-rw-r--r--src/lib/efl/interfaces/efl_gfx_image_load_controller.eo38
-rw-r--r--src/lib/efl/interfaces/efl_gfx_size_class.eo20
-rw-r--r--src/lib/efl/interfaces/efl_gfx_stack.eo50
-rw-r--r--src/lib/efl/interfaces/efl_gfx_text_class.eo12
-rw-r--r--src/lib/efl/interfaces/efl_model.eo41
-rw-r--r--src/lib/efl/interfaces/efl_player.eo87
-rw-r--r--src/lib/efl/interfaces/efl_screen.eo34
-rw-r--r--src/lib/efl/interfaces/efl_text.eo17
-rw-r--r--src/lib/efl/interfaces/efl_text_font.eo54
21 files changed, 311 insertions, 415 deletions
diff --git a/src/lib/efl/interfaces/efl_cached_item.eo b/src/lib/efl/interfaces/efl_cached_item.eo
index a8da315453..533d0faa49 100644
--- a/src/lib/efl/interfaces/efl_cached_item.eo
+++ b/src/lib/efl/interfaces/efl_cached_item.eo
@@ -3,8 +3,8 @@ interface @beta Efl.Cached.Item
3 [[Efl Cached Item interface]] 3 [[Efl Cached Item interface]]
4 methods { 4 methods {
5 @property memory_size { 5 @property memory_size {
6 [[The memory size associated with an object.]]
6 get { 7 get {
7 [[Get the memory size associated with an object.]]
8 } 8 }
9 values { 9 values {
10 consumed: uint; [[Bytes of memory consumed by this object.]] 10 consumed: uint; [[Bytes of memory consumed by this object.]]
diff --git a/src/lib/efl/interfaces/efl_canvas_pointer.eo b/src/lib/efl/interfaces/efl_canvas_pointer.eo
index 705b17d5e6..f0c363a953 100644
--- a/src/lib/efl/interfaces/efl_canvas_pointer.eo
+++ b/src/lib/efl/interfaces/efl_canvas_pointer.eo
@@ -9,20 +9,18 @@ interface Efl.Canvas.Pointer
9 methods { 9 methods {
10 /* FIXME Efl.Input.Device is not stable yet*/ 10 /* FIXME Efl.Input.Device is not stable yet*/
11 @property pointer_inside @beta { 11 @property pointer_inside @beta {
12 get { 12 [[Whether the mouse pointer is logically inside the canvas.
13 [[Returns whether the mouse pointer is logically inside the
14 canvas.
15 13
16 When this function is called it will return a value of either 14 This value is $false or $true, depending on whether a pointer,in or pointer,out
17 $false or $true, depending on whether a pointer,in or pointer,out 15 event has been previously received.
18 event has been called previously.
19 16
20 A return value of $true indicates the mouse is logically 17 A return value of $true indicates the mouse is logically
21 inside the canvas, and $false implies it is logically 18 inside the canvas, and $false implies it is logically
22 outside the canvas. 19 outside the canvas.
23 20
24 A canvas begins with the mouse being assumed outside ($false). 21 A canvas begins with the mouse being assumed outside ($false).
25 ]] 22 ]]
23 get {
26 } 24 }
27 keys { 25 keys {
28 seat: Efl.Input.Device @optional; [[The seat to consider, if $null 26 seat: Efl.Input.Device @optional; [[The seat to consider, if $null
diff --git a/src/lib/efl/interfaces/efl_canvas_scene.eo b/src/lib/efl/interfaces/efl_canvas_scene.eo
index 22d97d4630..b31f0ba3b4 100644
--- a/src/lib/efl/interfaces/efl_canvas_scene.eo
+++ b/src/lib/efl/interfaces/efl_canvas_scene.eo
@@ -9,17 +9,17 @@ interface Efl.Canvas.Scene
9 ]] 9 ]]
10 methods { 10 methods {
11 @property image_max_size { 11 @property image_max_size {
12 get { 12 [[The maximum image size the canvas can possibly handle.
13 [[Get the maximum image size the canvas can possibly handle.
14 13
15 This function returns the largest image or surface size that 14 This function returns the largest image or surface size that
16 the canvas can handle in pixels, and if there is one, returns $true. 15 the canvas can handle in pixels, and if there is one, returns $true.
17 It returns $false if no extra constraint on maximum image 16 It returns $false if no extra constraint on maximum image
18 size exists. 17 size exists.
19 18
20 The default limit is 65535x65535. 19 The default limit is 65535x65535.
21 20
22 ]] 21 ]]
22 get {
23 return: bool; [[$true on success, $false otherwise]] 23 return: bool; [[$true on success, $false otherwise]]
24 } 24 }
25 values { 25 values {
@@ -33,8 +33,8 @@ interface Efl.Canvas.Scene
33 ]] 33 ]]
34 } 34 }
35 @property group_objects_calculating { 35 @property group_objects_calculating {
36 [[Get if the canvas is currently calculating group objects.]]
36 get { 37 get {
37 [[Get if the canvas is currently calculating group objects.]]
38 } 38 }
39 values { 39 values {
40 calculating: bool; [[$true if currently calculating group objects.]] 40 calculating: bool; [[$true if currently calculating group objects.]]
@@ -213,12 +213,12 @@ interface Efl.Canvas.Scene
213 } 213 }
214 /* FIXME Efl.Input.Device is not stable yet*/ 214 /* FIXME Efl.Input.Device is not stable yet*/
215 @property pointer_position @beta { 215 @property pointer_position @beta {
216 get { 216 [[The current known pointer coordinates.
217 [[This function returns the current known pointer coordinates
218 217
219 This function returns the current position of the main input 218 This function returns the current position of the main input
220 pointer (mouse, pen, etc...). 219 pointer (mouse, pen, etc...).
221 ]] 220 ]]
221 get {
222 return: bool; [[$true if a pointer exists for the given seat, otherwise $false.]] 222 return: bool; [[$true if a pointer exists for the given seat, otherwise $false.]]
223 } 223 }
224 keys { 224 keys {
diff --git a/src/lib/efl/interfaces/efl_file.eo b/src/lib/efl/interfaces/efl_file.eo
index 3227af49c0..93343dca3a 100644
--- a/src/lib/efl/interfaces/efl_file.eo
+++ b/src/lib/efl/interfaces/efl_file.eo
@@ -7,62 +7,50 @@ mixin Efl.File requires Efl.Object {
7 ]] 7 ]]
8 methods { 8 methods {
9 @property mmap { 9 @property mmap {
10 set { 10 [[The mmaped file from where an object will fetch the real
11 [[Set the mmaped file from where an object will fetch the real 11 data (it must be an @Eina.File).
12 data (it must be an @Eina.File).
13
14 If mmap is set during object construction, the object will automatically
15 call @.load during the finalize phase of construction.
16 ]]
17 12
13 If mmap is set during object construction, the object will automatically
14 call @.load during the finalize phase of construction.
15 ]]
16 set {
18 return: Eina.Error; [[0 on success, error code otherwise]] 17 return: Eina.Error; [[0 on success, error code otherwise]]
19 } 18 }
20 get { 19 get {
21 [[Get the mmaped file from where an object will fetch the real
22 data (it must be an @Eina.File).
23 ]]
24 } 20 }
25 values { 21 values {
26 f: const(Eina.File) @by_ref; [[The handle to the @Eina.File that will be used]] 22 f: const(Eina.File) @by_ref; [[The handle to the @Eina.File that will be used]]
27 } 23 }
28 } 24 }
29 @property file { 25 @property file {
30 set { 26 [[The file path from where an object will fetch the data.
31 [[Set the file path from where an object will fetch the data.
32 27
33 If file is set during object construction, the object will automatically 28 If file is set during object construction, the object will automatically
34 call @.load during the finalize phase of construction. 29 call @.load during the finalize phase of construction.
35 ]]
36 30
31 You must not modify the strings on the returned pointers.
32 ]]
33 set {
37 return: Eina.Error; [[0 on success, error code otherwise]] 34 return: Eina.Error; [[0 on success, error code otherwise]]
38 } 35 }
39 get { 36 get {
40 [[Retrieve the file path from where an object is to fetch the data.
41
42 You must not modify the strings on the returned pointers.
43 ]]
44 } 37 }
45 values { 38 values {
46 file: string; [[The file path.]] 39 file: string; [[The file path.]]
47 } 40 }
48 } 41 }
49 @property key { 42 @property key {
50 set { 43 [[The key which corresponds to the target data within a file.
51 [[Set the key which corresponds to the target data within a file. 44
45 Some file types can contain multiple data streams which are indexed by
46 a key. Use this property for such cases (See for example @Efl.Ui.Image or
47 @Efl.Ui.Layout).
52 48
53 Some filetypes can contain multiple data streams which are indexed by 49 You must not modify the strings on the returned pointers.
54 a key. Use this property for such cases. 50 ]]
55 ]] 51 set {
56 } 52 }
57 get { 53 get {
58 [[Get the previously-set key which corresponds to the target data within a file.
59
60 Some filetypes can contain multiple data streams which are indexed by
61 a key. Use this property for such cases (See for example @Efl.Ui.Image or
62 @Efl.Ui.Layout).
63
64 You must not modify the strings on the returned pointers.
65 ]]
66 } 54 }
67 values { 55 values {
68 key: string; [[The group that the data belongs to. See the class documentation 56 key: string; [[The group that the data belongs to. See the class documentation
@@ -71,9 +59,9 @@ mixin Efl.File requires Efl.Object {
71 } 59 }
72 } 60 }
73 @property loaded { 61 @property loaded {
62 [[The load state of the object.
63 ]]
74 get { 64 get {
75 [[Get the load state of the object.
76 ]]
77 } 65 }
78 values { 66 values {
79 loaded: bool; [[$true if the object is loaded, $false otherwise.]] 67 loaded: bool; [[$true if the object is loaded, $false otherwise.]]
diff --git a/src/lib/efl/interfaces/efl_gfx_color.eo b/src/lib/efl/interfaces/efl_gfx_color.eo
index fa0d1d4c37..e507440ace 100644
--- a/src/lib/efl/interfaces/efl_gfx_color.eo
+++ b/src/lib/efl/interfaces/efl_gfx_color.eo
@@ -9,35 +9,28 @@ mixin Efl.Gfx.Color
9 data: null; 9 data: null;
10 methods { 10 methods {
11 @property color @pure_virtual { 11 @property color @pure_virtual {
12 set { 12 [[The general/main color of the given Evas object.
13 [[Sets the general/main color of the given Evas object to the given
14 one.
15
16 See also @.color.get (for an example)
17
18 These color values are expected to be premultiplied by alpha.
19 ]]
20 }
21 get {
22 [[Retrieves the general/main color of the given Evas object.
23 13
24 Retrieves the main color's RGB component (and alpha channel) 14 Represents the main color's RGB component (and alpha channel)
25 values, which range from 0 to 255. For the alpha channel, 15 values, which range from 0 to 255. For the alpha channel,
26 which defines the object's transparency level, 0 means totally 16 which defines the object's transparency level, 0 means totally
27 transparent, while 255 means opaque. These color values are 17 transparent, while 255 means opaque. These color values are
28 premultiplied by the alpha value. 18 premultiplied by the alpha value.
29 19
30 Usually youll use this attribute for text and rectangle objects, 20 Usually you'll use this attribute for text and rectangle objects,
31 where the main color is their unique one. If set for objects 21 where the main color is the only color. If set for objects
32 which themselves have colors, like the images one, those colors 22 which themselves have colors, like the images one, those colors
33 get modulated by this one. 23 get modulated by this one.
34 24
35 All newly created Evas rectangles get the default color 25 All newly created Evas rectangles get the default color
36 values of 255 255 255 255 (opaque white). 26 values of 255 255 255 255 (opaque white).
37 27
38 Use null pointers on the components you're not interested 28 When reading this property, use $NULL pointers on the components you're not interested
39 in: they'll be ignored by the function. 29 in and they'll be ignored by the function.
40 ]] 30 ]]
31 set {
32 }
33 get {
41 } 34 }
42 values { 35 values {
43 r: int; 36 r: int;
@@ -47,15 +40,11 @@ mixin Efl.Gfx.Color
47 } 40 }
48 } 41 }
49 @property color_code { 42 @property color_code {
43 [[Hexadecimal color code of given Evas object (#RRGGBBAA).
44 ]]
50 set { 45 set {
51 [[Set the color of given Evas object to the given hex color code(#RRGGBBAA).
52 e.g. efl_gfx_color_code_set(obj, "#FFCCAACC");
53 ]]
54 } 46 }
55 get { 47 get {
56 [[Get hex color code of given Evas object.
57 This returns a short lived hex color code string.
58 ]]
59 } 48 }
60 values { 49 values {
61 colorcode: string; [[the hex color code.]] 50 colorcode: string; [[the hex color code.]]
diff --git a/src/lib/efl/interfaces/efl_gfx_color_class.eo b/src/lib/efl/interfaces/efl_gfx_color_class.eo
index ec6f5d71d4..6acfa42f0f 100644
--- a/src/lib/efl/interfaces/efl_gfx_color_class.eo
+++ b/src/lib/efl/interfaces/efl_gfx_color_class.eo
@@ -6,34 +6,27 @@ mixin @beta Efl.Gfx.Color_Class
6 data: null; 6 data: null;
7 methods { 7 methods {
8 @property color_class @pure_virtual { 8 @property color_class @pure_virtual {
9 set { 9 [[Color for the color class.
10 [[Set the color of color class. 10
11 This property sets the color values for a color class. This will
12 cause all edje parts in the specified object that have the specified
13 color class to have their colors multiplied by these values.
11 14
12 This function sets the color values for a color class. This will 15 The first color is the object, the second is the text outline, and
13 cause all edje parts in the specified object that have the specified 16 the third is the text shadow. (Note that the last two only apply
14 color class to have their colors multiplied by these values. 17 to text parts).
15 18
16 The first color is the object, the second is the text outline, and 19 Setting color emits a signal "color_class,set" with source being
17 the third is the text shadow. (Note that the second two only apply 20 the given color.
18 to text parts).
19 21
20 Setting color emits a signal "color_class,set" with source being 22 When retrieving the color of an object, if no explicit
21 the given color. 23 object color is set, then global values will be used.
22 24
23 Note: These color values are expected to be premultiplied by $a.]] 25 Note: These color values are expected to be premultiplied by $a.]]
26 set {
24 return: bool; [[$true if setting the color succeeded, $false otherwise]] 27 return: bool; [[$true if setting the color succeeded, $false otherwise]]
25 } 28 }
26 get { 29 get {
27 [[Get the color of color class.
28
29 This function gets the color values for a color class. If no explicit
30 object color is set, then global values will be used.
31
32 The first color is the object, the second is the text outline, and
33 the third is the text shadow. (Note that the second two only apply
34 to text parts).
35
36 Note: These color values are expected to be premultiplied by $a.]]
37 return: bool; [[$true if getting the color succeeded, $false otherwise]] 30 return: bool; [[$true if getting the color succeeded, $false otherwise]]
38 } 31 }
39 keys { 32 keys {
@@ -48,36 +41,27 @@ mixin @beta Efl.Gfx.Color_Class
48 } 41 }
49 } 42 }
50 @property color_class_code { 43 @property color_class_code {
51 set { 44 [[Hexadecimal color code string of the color class.
52 [[Set the hex color string of color class.
53 45
54 This function sets the color values for a color class. This will 46 This property sets the color values for a color class. This will
55 cause all edje parts in the specified object that have the specified 47 cause all edje parts in the specified object that have the specified
56 color class to have their colors multiplied by these values. 48 color class to have their colors multiplied by these values.
57 49
58 The first color is the object, the second is the text outline, and 50 The first color is the object, the second is the text outline, and
59 the third is the text shadow. (Note that the second two only apply 51 the third is the text shadow. (Note that the last two only apply
60 to text parts). 52 to text parts).
61 53
62 Setting color emits a signal "color_class,set" with source being 54 Setting color emits a signal "color_class,set" with source being
63 the given color. 55 the given color.
56
57 When retrieving the color of an object, if no explicit
58 object color is set, then global values will be used.
64 59
65 Note: These color values are expected to be premultiplied by the alpha.]] 60 Note: These color values are expected to be premultiplied by the alpha.]]
61 set {
66 return: bool; [[$true if setting the color succeeded, $false otherwise]] 62 return: bool; [[$true if setting the color succeeded, $false otherwise]]
67 } 63 }
68 get { 64 get {
69 [[Get the hex color string of color class.
70
71 This function gets the color values for a color class. If no explicit
72 object color is set, then global values will be used.
73
74 The first color is the object, the second is the text outline, and
75 the third is the text shadow. (Note that the second two only apply
76 to text parts).
77
78 Returns $NULL if the color class cannot be fetched.
79
80 Note: These color values are expected to be premultiplied by $a.]]
81 } 65 }
82 keys { 66 keys {
83 color_class: string; [[The name of color class]] 67 color_class: string; [[The name of color class]]
@@ -88,10 +72,10 @@ mixin @beta Efl.Gfx.Color_Class
88 } 72 }
89 } 73 }
90 @property color_class_description @pure_virtual { 74 @property color_class_description @pure_virtual {
91 get { 75 [[Get the description of a color class.
92 [[Get the description of a color class.
93 76
94 This function gets the description of a color class in use by an object.]] 77 This function gets the description of a color class in use by an object.]]
78 get {
95 } 79 }
96 keys { 80 keys {
97 color_class: string; [[The name of color class]] 81 color_class: string; [[The name of color class]]
diff --git a/src/lib/efl/interfaces/efl_gfx_filter.eo b/src/lib/efl/interfaces/efl_gfx_filter.eo
index 0ebd1e5294..ed74c087fd 100644
--- a/src/lib/efl/interfaces/efl_gfx_filter.eo
+++ b/src/lib/efl/interfaces/efl_gfx_filter.eo
@@ -11,22 +11,19 @@ interface @beta Efl.Gfx.Filter
11 c_prefix: efl_gfx; 11 c_prefix: efl_gfx;
12 methods { 12 methods {
13 @property filter_program { 13 @property filter_program {
14 set { 14 [[A graphical filter program on this object.
15 [[Set a graphical filter program on this object.
16 15
17 Valid for Text and Image objects at the moment. 16 Valid for Text and Image objects at the moment.
18 17
19 The argument passed to this function is a string containing 18 The argument passed to this function is a string containing
20 a valid Lua program based on the filters API as described in 19 a valid Lua program based on the filters API as described in
21 the "EFL Graphics Filters" reference page. 20 the "EFL Graphics Filters" reference page.
22 21
23 Set to $null to disable filtering. 22 Set to $null to disable filtering.
24 ]] 23 ]]
24 set {
25 } 25 }
26 get { 26 get {
27 [[Gets the code of the filter program set on this object.
28 May be $null.
29 ]]
30 } 27 }
31 values { 28 values {
32 code: string; [[The Lua program source code.]] 29 code: string; [[The Lua program source code.]]
diff --git a/src/lib/efl/interfaces/efl_gfx_frame_controller.eo b/src/lib/efl/interfaces/efl_gfx_frame_controller.eo
index 79712182f4..bedacf33d7 100644
--- a/src/lib/efl/interfaces/efl_gfx_frame_controller.eo
+++ b/src/lib/efl/interfaces/efl_gfx_frame_controller.eo
@@ -14,12 +14,12 @@ interface @beta Efl.Gfx.Frame_Controller
14 14
15 methods { 15 methods {
16 @property animated { 16 @property animated {
17 get { 17 [[Whether an object can be animated (has multiple frames).
18 [[Check if an object can be animated (has multiple frames).
19 18
20 This will be $true for animated object for instance but $false 19 This will be $true for animated object for instance but $false
21 for a single frame object. 20 for a single frame object.
22 ]] 21 ]]
22 get {
23 } 23 }
24 values { 24 values {
25 is_animated: bool; [[$true if the object is animated]] 25 is_animated: bool; [[$true if the object is animated]]
@@ -28,11 +28,9 @@ interface @beta Efl.Gfx.Frame_Controller
28 @property frame { 28 @property frame {
29 [[Index of the current frame of an animated object. 29 [[Index of the current frame of an animated object.
30 30
31 Ranges from 1 to @.frame_count. Valid only if @.animated. 31 Ranges from 1 to @.frame_count. Valid only if @.animated is $true.
32 ]] 32 ]]
33 set { 33 set {
34 [[Set the frame to current frame of an animated object.
35 ]]
36 return: bool; [[Returns $true if the frame index is valid.]] 34 return: bool; [[Returns $true if the frame index is valid.]]
37 } 35 }
38 get {} 36 get {}
@@ -41,58 +39,56 @@ interface @beta Efl.Gfx.Frame_Controller
41 } 39 }
42 } 40 }
43 @property frame_count { 41 @property frame_count {
44 get { 42 [[The total number of frames of the object, if animated.
45 [[Get the total number of frames of the object, if animated.
46 43
47 Returns -1 if not animated. 44 Returns -1 if not animated.
48 ]] 45 ]]
46 get {
49 return: int; [[The number of frames in the animated object.]] 47 return: int; [[The number of frames in the animated object.]]
50 } 48 }
51 } 49 }
52 @property loop_type { 50 @property loop_type {
53 /* FIXME: external type used from evas / emile */ 51 /* FIXME: external type used from evas / emile */
54 get { 52 [[The kind of looping the animated object does.
55 [[Get the kind of looping the animated object does.
56
57 This returns the kind of looping the animated object wants to do.
58 53
59 If it returns @Efl.Gfx.Frame_Controller_Loop_Hint.loop, you should 54 If it returns @Efl.Gfx.Frame_Controller_Loop_Hint.loop, you should
60 display frames in a sequence like: 1->2->3->1->2->3->1... 55 display frames in a sequence like: 1->2->3->1->2->3->1...
61 56
62 If it returns @Efl.Gfx.Frame_Controller_Loop_Hint.pingpong, it is 57 If it returns @Efl.Gfx.Frame_Controller_Loop_Hint.pingpong, it is
63 better to display frames in a sequence like: 58 better to display frames in a sequence like:
64 1->2->3->2->1->2->3->1... 59 1->2->3->2->1->2->3->1...
65 60
66 The default type is @Efl.Gfx.Frame_Controller_Loop_Hint.loop. 61 The default type is @Efl.Gfx.Frame_Controller_Loop_Hint.loop.
67 ]] 62 ]]
63 get {
68 return: Efl.Gfx.Frame_Controller_Loop_Hint; [[Loop type of the animated object.]] 64 return: Efl.Gfx.Frame_Controller_Loop_Hint; [[Loop type of the animated object.]]
69 } 65 }
70 } 66 }
71 @property loop_count { 67 @property loop_count {
72 get { 68 [[The number times the animation of the object loops.
73 [[Get the number times the animation of the object loops.
74 69
75 This returns loop count of animated object. The loop count is the number 70 This returns loop count of animated object. The loop count is the number
76 of times the animation will play fully from first to last frame 71 of times the animation will play fully from first to last frame
77 until the animation should stop (at the final frame). 72 until the animation should stop (at the final frame).
78 73
79 If 0 is returned, then looping should happen indefinitely 74 If 0 is returned, then looping should happen indefinitely
80 (no limit to the number of times it loops). 75 (no limit to the number of times it loops).
81 ]] 76 ]]
77 get {
82 return: int; [[The number of loop of an animated object.]] 78 return: int; [[The number of loop of an animated object.]]
83 } 79 }
84 } 80 }
85 @property frame_duration { 81 @property frame_duration {
86 get { 82 [[The duration of a sequence of frames.
87 [[Get the duration of a sequence of frames.
88 83
89 This returns total duration in seconds that the specified 84 This returns total duration in seconds that the specified
90 sequence of frames should take. 85 sequence of frames should take.
91 86
92 If $start_frame is 1 and $frame_num is 0, this returns the 87 If $start_frame is 1 and $frame_num is 0, this returns the
93 duration of frame 1. If $start_frame is 1 and $frame_num is 1, 88 duration of frame 1. If $start_frame is 1 and $frame_num is 1,
94 this returns the total duration of frame 1 + frame 2. 89 this returns the total duration of frame 1 + frame 2.
95 ]] 90 ]]
91 get {
96 } 92 }
97 keys { 93 keys {
98 start_frame: int; [[The first frame, rangers from 1 to @.frame_count.]] 94 start_frame: int; [[The first frame, rangers from 1 to @.frame_count.]]
diff --git a/src/lib/efl/interfaces/efl_gfx_gradient.eo b/src/lib/efl/interfaces/efl_gfx_gradient.eo
index 81f18a15e1..9f01c91063 100644
--- a/src/lib/efl/interfaces/efl_gfx_gradient.eo
+++ b/src/lib/efl/interfaces/efl_gfx_gradient.eo
@@ -6,11 +6,10 @@ interface @beta Efl.Gfx.Gradient
6 c_prefix: efl_gfx_gradient; 6 c_prefix: efl_gfx_gradient;
7 methods { 7 methods {
8 @property stop { 8 @property stop {
9 [[The list of color stops for the gradient]]
9 set { 10 set {
10 [[Set the list of color stops for the gradient]]
11 } 11 }
12 get { 12 get {
13 [[Get the list of color stops.]]
14 } 13 }
15 values { 14 values {
16 colors: ptr(const(Efl.Gfx.Gradient_Stop)); [[Color stops list]] 15 colors: ptr(const(Efl.Gfx.Gradient_Stop)); [[Color stops list]]
@@ -18,16 +17,15 @@ interface @beta Efl.Gfx.Gradient
18 } 17 }
19 } 18 }
20 @property spread { 19 @property spread {
20 [[The spread method that should be used for this gradient.
21 The default is @Efl.Gfx.Gradient_Spread.pad.
22 ]]
21 set { 23 set {
22 [[Specifies the spread method that should be used for this gradient.]]
23 } 24 }
24 get { 25 get {
25 [[Returns the spread method use by this gradient. The default is
26 EFL_GFX_GRADIENT_SPREAD_PAD.
27 ]]
28 } 26 }
29 values { 27 values {
30 s: Efl.Gfx.Gradient_Spread; [[Spread type to be used]] 28 s: Efl.Gfx.Gradient_Spread; [[Spread type to be used.]]
31 } 29 }
32 } 30 }
33 } 31 }
diff --git a/src/lib/efl/interfaces/efl_gfx_gradient_linear.eo b/src/lib/efl/interfaces/efl_gfx_gradient_linear.eo
index 238e5d04a4..30d2dbed86 100644
--- a/src/lib/efl/interfaces/efl_gfx_gradient_linear.eo
+++ b/src/lib/efl/interfaces/efl_gfx_gradient_linear.eo
@@ -3,11 +3,10 @@ interface @beta Efl.Gfx.Gradient_Linear extends Efl.Gfx.Gradient
3 [[Efl graphics gradient linear interface]] 3 [[Efl graphics gradient linear interface]]
4 methods { 4 methods {
5 @property start { 5 @property start {
6 [[The start point of this linear gradient.]]
6 set { 7 set {
7 [[Sets the start point of this linear gradient.]]
8 } 8 }
9 get { 9 get {
10 [[Gets the start point of this linear gradient.]]
11 } 10 }
12 values { 11 values {
13 x: double; [[X co-ordinate of start point]] 12 x: double; [[X co-ordinate of start point]]
@@ -15,11 +14,10 @@ interface @beta Efl.Gfx.Gradient_Linear extends Efl.Gfx.Gradient
15 } 14 }
16 } 15 }
17 @property end { 16 @property end {
17 [[The end point of this linear gradient.]]
18 set { 18 set {
19 [[Sets the end point of this linear gradient.]]
20 } 19 }
21 get { 20 get {
22 [[Gets the end point of this linear gradient.]]
23 } 21 }
24 values { 22 values {
25 x: double; [[X co-ordinate of end point]] 23 x: double; [[X co-ordinate of end point]]
diff --git a/src/lib/efl/interfaces/efl_gfx_gradient_radial.eo b/src/lib/efl/interfaces/efl_gfx_gradient_radial.eo
index 9cc3f3f069..d565a4a407 100644
--- a/src/lib/efl/interfaces/efl_gfx_gradient_radial.eo
+++ b/src/lib/efl/interfaces/efl_gfx_gradient_radial.eo
@@ -3,11 +3,10 @@ interface @beta Efl.Gfx.Gradient_Radial extends Efl.Gfx.Gradient
3 [[Efl graphics gradient radial interface]] 3 [[Efl graphics gradient radial interface]]
4 methods { 4 methods {
5 @property center { 5 @property center {
6 [[The center of this radial gradient.]]
6 set { 7 set {
7 [[Sets the center of this radial gradient.]]
8 } 8 }
9 get { 9 get {
10 [[Gets the center of this radial gradient.]]
11 } 10 }
12 values { 11 values {
13 x: double; [[X co-ordinate of center point]] 12 x: double; [[X co-ordinate of center point]]
@@ -15,22 +14,20 @@ interface @beta Efl.Gfx.Gradient_Radial extends Efl.Gfx.Gradient
15 } 14 }
16 } 15 }
17 @property radius { 16 @property radius {
17 [[The radius of this radial gradient.]]
18 set { 18 set {
19 [[Sets the center radius of this radial gradient.]]
20 } 19 }
21 get { 20 get {
22 [[Gets the center radius of this radial gradient.]]
23 } 21 }
24 values { 22 values {
25 r: double; [[Center radius]] 23 r: double; [[Center radius]]
26 } 24 }
27 } 25 }
28 @property focal { 26 @property focal {
27 [[The focal point of this radial gradient.]]
29 set { 28 set {
30 [[Sets the focal point of this radial gradient.]]
31 } 29 }
32 get { 30 get {
33 [[Gets the focal point of this radial gradient.]]
34 } 31 }
35 values { 32 values {
36 x: double; [[X co-ordinate of focal point]] 33 x: double; [[X co-ordinate of focal point]]
diff --git a/src/lib/efl/interfaces/efl_gfx_image.eo b/src/lib/efl/interfaces/efl_gfx_image.eo
index b46c1341fd..5a9303f786 100644
--- a/src/lib/efl/interfaces/efl_gfx_image.eo
+++ b/src/lib/efl/interfaces/efl_gfx_image.eo
@@ -248,20 +248,14 @@ interface @beta Efl.Gfx.Image
248 } 248 }
249 } 249 }
250 @property scale_hint { 250 @property scale_hint {
251 set { 251 [[The scale hint of a given image of the canvas.
252 [[Set the scale hint of a given image of the canvas.
253 252
254 This function sets the scale hint value of the given image 253 The scale hint affects how Evas is to cache
255 object in the canvas, which will affect how Evas is to cache 254 scaled versions of its original source image.
256 scaled versions of its original source image. 255 ]]
257 ]] 256 set {
258 } 257 }
259 get { 258 get {
260 [[Get the scale hint of a given image of the canvas.
261
262 This function returns the scale hint value of the given image
263 object of the canvas.
264 ]]
265 } 259 }
266 values { 260 values {
267 hint: Efl.Gfx.Image_Scale_Hint; [[Scalable or static size hint, 261 hint: Efl.Gfx.Image_Scale_Hint; [[Scalable or static size hint,
@@ -269,8 +263,8 @@ interface @beta Efl.Gfx.Image
269 } 263 }
270 } 264 }
271 @property image_load_error { 265 @property image_load_error {
266 [[The (last) file loading error for a given object.]]
272 get { 267 get {
273 [[Gets the (last) file loading error for a given object.]]
274 } 268 }
275 values { 269 values {
276 error: Eina.Error; [[The load error code.]] 270 error: Eina.Error; [[The load error code.]]
diff --git a/src/lib/efl/interfaces/efl_gfx_image_load_controller.eo b/src/lib/efl/interfaces/efl_gfx_image_load_controller.eo
index 84f0cc0527..2523d12d44 100644
--- a/src/lib/efl/interfaces/efl_gfx_image_load_controller.eo
+++ b/src/lib/efl/interfaces/efl_gfx_image_load_controller.eo
@@ -71,19 +71,13 @@ interface @beta Efl.Gfx.Image_Load_Controller
71 } 71 }
72 } 72 }
73 @property load_dpi { 73 @property load_dpi {
74 set { 74 [[The DPI resolution of an image object's source image.
75 [[Set the DPI resolution of an image object's source image.
76 75
77 This function sets the DPI resolution of a given loaded canvas 76 Most useful for the SVG image loader.
78 image. Most useful for the SVG image loader. 77 ]]
79 ]] 78 set {
80 } 79 }
81 get { 80 get {
82 [[Get the DPI resolution of a loaded image object in the canvas.
83
84 This function returns the DPI resolution of the given canvas
85 image.
86 ]]
87 } 81 }
88 values { 82 values {
89 dpi: double; [[The DPI resolution.]] 83 dpi: double; [[The DPI resolution.]]
@@ -99,22 +93,19 @@ interface @beta Efl.Gfx.Image_Load_Controller
99 } 93 }
100 } 94 }
101 @property load_region { 95 @property load_region {
102 set { 96 [[Inform a given image object to load a selective region of its
103 [[Inform a given image object to load a selective region of its 97 source image.
104 source image.
105 98
106 This function is useful when one is not showing all of an 99 This property is useful when one is not showing all of an
107 image's area on its image object. 100 image's area on its image object.
108 101
109 Note: The image loader for the image format in question has 102 Note: The image loader for the image format in question has
110 to support selective region loading in order for this function 103 to support selective region loading in order for this function
111 to work. 104 to work.
112 ]] 105 ]]
106 set {
113 } 107 }
114 get { 108 get {
115 [[Retrieve the coordinates of a given image object's selective
116 (source image) load region.
117 ]]
118 } 109 }
119 values { 110 values {
120 region: Eina.Rect; [[A region of the image.]] 111 region: Eina.Rect; [[A region of the image.]]
@@ -159,14 +150,13 @@ interface @beta Efl.Gfx.Image_Load_Controller
159 } 150 }
160 } 151 }
161 @property load_skip_header { 152 @property load_skip_header {
162 [[Initial load should skip header check and leave it all to data load 153 [[Initial load should skip header check and leave it all to data load.
163 154
164 If this is true, then future loads of images will defer header 155 If this is true, then future loads of images will defer header
165 loading to a preload stage and/or data load later on rather than 156 loading to a preload stage and/or data load later on rather than
166 at the start when the load begins (e.g. when file is set). 157 at the start when the load begins (e.g. when file is set).
167 ]] 158 ]]
168 set { 159 set {
169 [[Set the skip header state for susbsequent loads of a file. ]]
170 } 160 }
171 get {} 161 get {}
172 values { 162 values {
diff --git a/src/lib/efl/interfaces/efl_gfx_size_class.eo b/src/lib/efl/interfaces/efl_gfx_size_class.eo
index b7033e925d..0d3c800b5f 100644
--- a/src/lib/efl/interfaces/efl_gfx_size_class.eo
+++ b/src/lib/efl/interfaces/efl_gfx_size_class.eo
@@ -3,22 +3,18 @@ interface @beta Efl.Gfx.Size_Class
3 [[Efl Gfx Size Class interface]] 3 [[Efl Gfx Size Class interface]]
4 methods { 4 methods {
5 @property size_class { 5 @property size_class {
6 set { 6 [[Width and height of size class.
7 [[Set width and height of size class.
8 7
9 This function sets width and height for a size class. 8 This property sets width and height for a size class.
10 This will make all edje parts in the specified object that have 9 This will make all edje parts in the specified object that have
11 the specified size class update their size with given values. 10 the specified size class update their size with given values.
12 ]] 11 When reading, these values will only be valid until the size class is changed
12 or the edje object is deleted.
13 ]]
14 set {
13 return: bool; [[$true, on success or $false, on error]] 15 return: bool; [[$true, on success or $false, on error]]
14 } 16 }
15 get { 17 get {
16 [[Get width and height of size class.
17
18 This function gets width and height for a size class.
19 These values will only be valid until the size class is changed
20 or the edje object is deleted.
21 ]]
22 return: bool; [[$true, on success or $false, on error]] 18 return: bool; [[$true, on success or $false, on error]]
23 } 19 }
24 keys { 20 keys {
diff --git a/src/lib/efl/interfaces/efl_gfx_stack.eo b/src/lib/efl/interfaces/efl_gfx_stack.eo
index d8f8617d88..7eddb016f5 100644
--- a/src/lib/efl/interfaces/efl_gfx_stack.eo
+++ b/src/lib/efl/interfaces/efl_gfx_stack.eo
@@ -10,28 +10,24 @@ interface Efl.Gfx.Stack
10 event_prefix: efl_gfx_entity; 10 event_prefix: efl_gfx_entity;
11 methods { 11 methods {
12 @property layer { 12 @property layer {
13 set { 13 [[The layer of its canvas that the given object will be part of.
14 [[Sets the layer of its canvas that the given object will be part of.
15
16 If you don't use this function, you'll be dealing with an unique
17 layer of objects (the default one). Additional layers are handy when
18 you don't want a set of objects to interfere with another set with
19 regard to stacking. Two layers are completely disjoint in that
20 matter.
21 14
22 This is a low-level function, which you'd be using when something 15 If you don't use this property, you'll be dealing with a unique
23 should be always on top, for example. 16 layer of objects (the default one). Additional layers are handy when
17 you don't want a set of objects to interfere with another set with
18 regard to stacking. Two layers are completely disjoint in that
19 matter.
24 20
25 Warning: Don't change the layer of 21 This is a low-level function, which you'd be using when something
26 smart objects' children. Smart objects have a layer of their own, 22 should be always on top, for example.
27 which should contain all their child objects.
28 23
29 See also @.layer.get()]] 24 Warning: Don't change the layer of
25 smart objects' children. Smart objects have a layer of their own,
26 which should contain all their child objects.
27 ]]
28 set {
30 } 29 }
31 get { 30 get {
32 [[Retrieves the layer of its canvas that the given object is part of.
33
34 See also @.layer.set()]]
35 } 31 }
36 values { 32 values {
37 l: short; [[The number of the layer to place the object on. 33 l: short; [[The number of the layer to place the object on.
@@ -39,25 +35,25 @@ interface Efl.Gfx.Stack
39 } 35 }
40 } 36 }
41 @property below { 37 @property below {
42 get { 38 [[The Evas object stacked right below this object.
43 [[Get the Evas object stacked right below $obj
44 39
45 This function will traverse layers in its search, if there are 40 This function will traverse layers in its search, if there are
46 objects on layers below the one $obj is placed at. 41 objects on layers below the one $obj is placed at.
47 42
48 See also @.layer.get(), @.layer.set() and @.below.get()]] 43 See also @.layer.]]
44 get {
49 return: Efl.Gfx.Stack @no_unused; [[The @Efl.Gfx.Stack object directly below $obj, if any, 45 return: Efl.Gfx.Stack @no_unused; [[The @Efl.Gfx.Stack object directly below $obj, if any,
50 or $null, if none.]] 46 or $null, if none.]]
51 } 47 }
52 } 48 }
53 @property above { 49 @property above {
54 get { 50 [[Get the Evas object stacked right above this object.
55 [[Get the Evas object stacked right above $obj
56 51
57 This function will traverse layers in its search, if there are 52 This function will traverse layers in its search, if there are
58 objects on layers above the one $obj is placed at. 53 objects on layers above the one $obj is placed at.
59 54
60 See also @.layer.get(), @.layer.set() and @.below.get()]] 55 See also @.layer and @.below]]
56 get {
61 return: Efl.Gfx.Stack @no_unused; [[The @Efl.Gfx.Stack object directly below $obj, if any, 57 return: Efl.Gfx.Stack @no_unused; [[The @Efl.Gfx.Stack object directly below $obj, if any,
62 or $null, if none.]] 58 or $null, if none.]]
63 } 59 }
diff --git a/src/lib/efl/interfaces/efl_gfx_text_class.eo b/src/lib/efl/interfaces/efl_gfx_text_class.eo
index 0d92f97220..a01a2912e5 100644
--- a/src/lib/efl/interfaces/efl_gfx_text_class.eo
+++ b/src/lib/efl/interfaces/efl_gfx_text_class.eo
@@ -5,18 +5,14 @@ interface @beta Efl.Gfx.Text_Class
5 [[Efl Gfx Text Class interface]] 5 [[Efl Gfx Text Class interface]]
6 methods { 6 methods {
7 @property text_class { 7 @property text_class {
8 set { 8 [[Font and font size from edje text class.
9 [[Set Edje text class.
10 9
11 This function sets the text class for the Edje.]] 10 When reading the font string will only be valid until the text class is changed
11 or the edje object is deleted.]]
12 set {
12 return: bool; [[$true, on success or $false, on error]] 13 return: bool; [[$true, on success or $false, on error]]
13 } 14 }
14 get { 15 get {
15 [[Get font and font size from edje text class.
16
17 This function gets the font and the font size from text class.
18 The font string will only be valid until the text class is changed
19 or the edje object is deleted.]]
20 return: bool; [[$true, on success or $false, on error]] 16 return: bool; [[$true, on success or $false, on error]]
21 } 17 }
22 keys { 18 keys {
diff --git a/src/lib/efl/interfaces/efl_model.eo b/src/lib/efl/interfaces/efl_model.eo
index a425487822..c256483e54 100644
--- a/src/lib/efl/interfaces/efl_model.eo
+++ b/src/lib/efl/interfaces/efl_model.eo
@@ -19,22 +19,23 @@ interface @beta Efl.Model
19 c_prefix: efl_model; 19 c_prefix: efl_model;
20 methods { 20 methods {
21 @property properties { 21 @property properties {
22 get { 22 [[Get properties from model.
23 [[Get properties from model.
24 23
25 Properties_get is due to provide callers a way the fetch the 24 Properties_get is due to provide callers a way the fetch the
26 current properties implemented/used by the model. The event 25 current properties implemented/used by the model. The event
27 @[Efl.Model.properties,changed] will be raised to notify 26 @[Efl.Model.properties,changed] will be raised to notify
28 listeners of any modifications in the properties. 27 listeners of any modifications in the properties.
29 28
30 See also @[Efl.Model.properties,changed]. 29 See also @[Efl.Model.properties,changed].
31 ]] 30 ]]
31 get {
32 } 32 }
33 values { 33 values {
34 properties: iterator<string> @move; [[Array of current properties]] 34 properties: iterator<string> @move; [[Array of current properties]]
35 } 35 }
36 } 36 }
37 @property property { 37 @property property {
38 [[ ]]
38 set { 39 set {
39 [[Set a property value of a given property name. 40 [[Set a property value of a given property name.
40 41
@@ -71,7 +72,7 @@ interface @beta Efl.Model
71 value: any_value_ptr; [[Property value]] 72 value: any_value_ptr; [[Property value]]
72 } 73 }
73 } 74 }
74 property_ready_get { 75 property_ready_get {
75 [[Get a future value when it changes to something that is not error:EAGAIN 76 [[Get a future value when it changes to something that is not error:EAGAIN
76 77
77 @.property.get can return an error with code EAGAIN when it doesn't have any 78 @.property.get can return an error with code EAGAIN when it doesn't have any
@@ -82,7 +83,7 @@ interface @beta Efl.Model
82 83
83 84
84 The future can also be canceled if the model itself gets destroyed. 85 The future can also be canceled if the model itself gets destroyed.
85 ]] 86 ]]
86 params { 87 params {
87 @in property: string; [[Property name.]] 88 @in property: string; [[Property name.]]
88 } 89 }
@@ -126,17 +127,17 @@ interface @beta Efl.Model
126 return: future<array<Efl.Object>>; [[Array of children]] 127 return: future<array<Efl.Object>>; [[Array of children]]
127 } 128 }
128 @property children_count { 129 @property children_count {
129 get { 130 [[Number of children.
130 [[Get children count.
131 131
132 When efl_model_load is completed @.children_count.get 132 When efl_model_load is completed @.children_count.get
133 can be used to get the number of children. @.children_count.get 133 can be used to get the number of children. @.children_count.get
134 can also be used before calling @.children_slice_get so a valid 134 can also be used before calling @.children_slice_get so a valid
135 range is known. Event @[Efl.Model.children,count,changed] is 135 range is known. Event @[Efl.Model.children,count,changed] is
136 emitted when count is finished. 136 emitted when count is finished.
137 137
138 See also @.children_slice_get. 138 See also @.children_slice_get.
139 ]] 139 ]]
140 get {
140 } 141 }
141 values { 142 values {
142 count: uint; [[Current known children count]] 143 count: uint; [[Current known children count]]
diff --git a/src/lib/efl/interfaces/efl_player.eo b/src/lib/efl/interfaces/efl_player.eo
index 5c3a32c6d7..19c80f84ba 100644
--- a/src/lib/efl/interfaces/efl_player.eo
+++ b/src/lib/efl/interfaces/efl_player.eo
@@ -6,63 +6,58 @@ interface @beta Efl.Player
6 [[Start a playing playable object.]] 6 [[Start a playing playable object.]]
7 } 7 }
8 stop { 8 stop {
9 [[Stop playable object.]] 9 [[Stop playable object.]]
10 } 10 }
11 @property playable { 11 @property playable {
12 [[Whether or not the playable can be played.]] 12 [[Whether or not the playable can be played.]]
13 get { 13 get {
14 } 14 }
15 values { 15 values {
16 play: bool; [[$true if the object have playable data, $false otherwise]] 16 play: bool; [[$true if the object have playable data, $false otherwise]]
17 } 17 }
18 } 18 }
19 @property play { 19 @property play {
20 set { 20 [[Playback state of the media file.
21 [[Set play/pause state of the media file.
22 21
23 This functions sets the currently playing status of the 22 This property sets the currently playback state of the
24 video. Using this function to play or pause the video 23 video. Using this function to play or pause the video
25 doesn't alter it's current position. 24 doesn't alter it's current position.
26 ]] 25 ]]
27 } 26 set {
28 get { 27 }
29 [[Get play/pause state of the media file.]] 28 get {
30 } 29 }
31 values { 30 values {
32 play: bool; [[$true if playing, $false otherwise.]] 31 play: bool; [[$true if playing, $false otherwise.]]
33 } 32 }
34 } 33 }
35 @property pos { 34 @property pos {
36 set { 35 [[Position in the media file.
37 [[Set the position in the media file.
38 36
39 This functions sets the current position of the media file 37 This property sets the current position of the media file
40 to "sec", this only works on seekable streams. Setting the 38 to $sec seconds since the beginning of the media file.
41 position doesn't change the playing state of the media file. 39 This only works on seekable streams. Setting the
42 ]] 40 position doesn't change the playing state of the media file.
43 } 41 ]]
44 get { 42 set {
45 [[Get the position in the media file. 43 }
46 44 get {
47 The position is returned as the number of seconds since the 45 }
48 beginning of the media file. 46 values {
49 ]] 47 sec: double; [[The position (in seconds).]]
50 } 48 }
51 values {
52 sec: double; [[The position (in seconds).]]
53 }
54 } 49 }
55 @property progress { 50 @property progress {
56 get { 51 [[How much of the file has been played.
57 [[Get how much of the file has been played.
58 52
59 This function gets the progress in playing the file, the 53 This function gets the progress in playing the file, the
60 return value is in the [0, 1] range. 54 return value is in the [0, 1] range.
61 ]] 55 ]]
62 } 56 get {
63 values { 57 }
64 progress: double; [[The progress within the [0, 1] range.]] 58 values {
65 } 59 progress: double; [[The progress within the [0, 1] range.]]
60 }
66 } 61 }
67 @property play_speed { 62 @property play_speed {
68 [[Control the play speed of the media file. 63 [[Control the play speed of the media file.
diff --git a/src/lib/efl/interfaces/efl_screen.eo b/src/lib/efl/interfaces/efl_screen.eo
index 5fd9adef6e..10802e0c47 100644
--- a/src/lib/efl/interfaces/efl_screen.eo
+++ b/src/lib/efl/interfaces/efl_screen.eo
@@ -8,12 +8,12 @@ interface Efl.Screen
8 ]] 8 ]]
9 methods { 9 methods {
10 @property screen_size_in_pixels { 10 @property screen_size_in_pixels {
11 get { 11 [[Screen size (in pixels) for the screen.
12 [[Get screen size (in pixels) for the screen.
13 12
14 Note that on some display systems this information is not available and 13 Note that on some display systems this information is not available and
15 a value of 0x0 will be returned. 14 a value of 0x0 will be returned.
16 ]] 15 ]]
16 get {
17 } 17 }
18 values { 18 values {
19 size: Eina.Size2D; [[The screen size in pixels.]] 19 size: Eina.Size2D; [[The screen size in pixels.]]
@@ -32,34 +32,34 @@ interface Efl.Screen
32// } 32// }
33// } 33// }
34 @property screen_scale_factor { 34 @property screen_scale_factor {
35 get { 35 [[Screen scaling factor.
36 [[Get screen scaling factor.
37 36
38 This is the factor by which window contents will be scaled on the screen. 37 This is the factor by which window contents will be scaled on the screen.
39 38
40 Note that on some display systems this information is not available and a 39 Note that on some display systems this information is not available and a
41 value of 1.0 will be returned. 40 value of 1.0 will be returned.
42 ]] 41 ]]
42 get {
43 } 43 }
44 values { 44 values {
45 size: float; [[The screen scaling factor.]] 45 size: float; [[The screen scaling factor.]]
46 } 46 }
47 } 47 }
48 @property screen_rotation { 48 @property screen_rotation {
49 get { 49 [[The rotation of the screen.
50 [[Get the rotation of the screen.
51 50
52 Most engines only return multiples of 90. 51 Most engines only return multiples of 90.
53 ]] 52 ]]
53 get {
54 } 54 }
55 values { 55 values {
56 rotation: int; [[Screen rotation in degrees.]] 56 rotation: int; [[Screen rotation in degrees.]]
57 } 57 }
58 } 58 }
59 @property screen_dpi { 59 @property screen_dpi {
60 [[The pixel density in DPI (Dots Per Inch) for the screen that a window is on.
61 ]]
60 get { 62 get {
61 [[Get the pixel density in DPI (Dots Per Inch) for the screen that a window is on.
62 ]]
63 } 63 }
64 values { 64 values {
65 xdpi: int; [[Horizontal DPI.]] 65 xdpi: int; [[Horizontal DPI.]]
diff --git a/src/lib/efl/interfaces/efl_text.eo b/src/lib/efl/interfaces/efl_text.eo
index 35b44bbcdf..167fe55d9a 100644
--- a/src/lib/efl/interfaces/efl_text.eo
+++ b/src/lib/efl/interfaces/efl_text.eo
@@ -6,20 +6,15 @@ interface Efl.Text
6 ]] 6 ]]
7 methods { 7 methods {
8 @property text { 8 @property text {
9 set { 9 [[The text string to be displayed by the given text object.
10 [[Sets the text string to be displayed by the given text object. 10
11 Do not release (free) the returned value.
11 12
12 See also @.text.get. 13 See also @.text.get.
13 ]] 14 ]]
15 set {
14 } 16 }
15 get { 17 get {
16 [[Retrieves the text string currently being displayed by the given
17 text object.
18
19 Do not free() the return value.
20
21 See also @.text.set.
22 ]]
23 } 18 }
24 values { 19 values {
25 text: string; [[Text string to display on it.]] 20 text: string; [[Text string to display on it.]]
diff --git a/src/lib/efl/interfaces/efl_text_font.eo b/src/lib/efl/interfaces/efl_text_font.eo
index 31ded3e43e..ccd4e33b35 100644
--- a/src/lib/efl/interfaces/efl_text_font.eo
+++ b/src/lib/efl/interfaces/efl_text_font.eo
@@ -53,32 +53,25 @@ interface @beta Efl.Text_Font {
53 c_prefix: efl_text; 53 c_prefix: efl_text;
54 methods { 54 methods {
55 @property font { 55 @property font {
56 set { 56 [[The font family, filename and size for a given text object.
57 [[Set the font family, filename and size for a given text object.
58 57
59 This function allows the font name and size of a text object to 58 This property controls the font name and size of a text object.
60 be set. The font string has to follow fontconfig's convention for 59 The font string has to follow fontconfig's convention for
61 naming fonts, as it's the underlying library used to query system 60 naming fonts, as it's the underlying library used to query system
62 fonts by Evas (see the fc-list command's output, on your system, 61 fonts by Evas (see the fc-list command's output, on your system,
63 to get an idea). Alternatively, youe can use the full path to a font 62 to get an idea). Alternatively, youe can use the full path to a font
64 file. 63 file.
65 64
66 To skip changing font family pass null as font family. 65 To skip changing font family pass null as font family.
67 To skip changing font size pass 0 as font size. 66 To skip changing font size pass 0 as font size.
68 67
69 See also @.font.get, @.font_source.get. 68 When reading it, the font name string is still owned by
70 ]] 69 Evas and should not be freed.
70 See also @.font_source.
71 ]]
72 set {
71 } 73 }
72 get { 74 get {
73 [[Retrieve the font family and size in use on a given text object.
74
75 This function allows the font name and size of a text object to
76 be queried. Remember that the font name string is still owned by
77 Evas and should not have free() called on it by the caller of the
78 function.
79
80 See also @.font.set.
81 ]]
82 } 75 }
83 values { 76 values {
84 font: string; [[The font family name or filename.]] 77 font: string; [[The font family name or filename.]]
@@ -86,22 +79,17 @@ interface @beta Efl.Text_Font {
86 } 79 }
87 } 80 }
88 @property font_source { 81 @property font_source {
89 set { 82 [[The font (source) file to be used on a given text object.
90 [[Set the font (source) file to be used on a given text object.
91 83
92 This function allows the font file to be explicitly set for a 84 This function allows the font file to be explicitly set for a
93 given text object, overriding system lookup, which will first 85 given text object, overriding system lookup, which will first
94 occur in the given file's contents. 86 occur in the given file's contents.
95 87
96 See also @.font.set. 88 See also @.font.
97 ]] 89 ]]
90 set {
98 } 91 }
99 get { 92 get {
100 [[Get the font file's path which is being used on a given text
101 object.
102
103 See @.font.get for more details.
104 ]]
105 } 93 }
106 values { 94 values {
107 font_source: string; [[The font file's path.]] 95 font_source: string; [[The font file's path.]]
Copyright © Enlightenment.org