diff options
author | Xavi Artigas <xavierartigas@yahoo.es> | 2019-09-13 12:25:49 +0200 |
---|---|---|
committer | Xavi Artigas <xavierartigas@yahoo.es> | 2019-09-13 12:30:03 +0200 |
commit | 8c09c1cae8b4368b88ec0b296f124d35e735dc7e (patch) | |
tree | 16548e1c5e3c8ac8b51398525da011ab555d4e29 /src/lib | |
parent | 5e9b30153399014ff0aa52922f8460c7769eb741 (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')
56 files changed, 1059 insertions, 1395 deletions
diff --git a/src/lib/ecore_audio/ecore_audio_in.eo b/src/lib/ecore_audio/ecore_audio_in.eo index 4411cc8c45..f8c1fdbebb 100644 --- a/src/lib/ecore_audio/ecore_audio_in.eo +++ b/src/lib/ecore_audio/ecore_audio_in.eo | |||
@@ -79,18 +79,18 @@ class @beta Ecore.Audio.In extends Ecore.Audio | |||
79 | } | 79 | } |
80 | } | 80 | } |
81 | @property output { | 81 | @property output { |
82 | [[The output that this input is attached to | ||
83 | ]] | ||
82 | get { | 84 | get { |
83 | [[Gets the output that this input is attached to | ||
84 | ]] | ||
85 | } | 85 | } |
86 | values { | 86 | values { |
87 | output: Ecore.Audio; [[The output]] /* FIXME-cyclic Should be Ecore.Audio.Out */ | 87 | output: Ecore.Audio; [[The output]] /* FIXME-cyclic Should be Ecore.Audio.Out */ |
88 | } | 88 | } |
89 | } | 89 | } |
90 | @property remaining { | 90 | @property remaining { |
91 | [[The remaining time of the input | ||
92 | ]] | ||
91 | get { | 93 | get { |
92 | [[Gets the remaining time of the input | ||
93 | ]] | ||
94 | } | 94 | } |
95 | values { | 95 | values { |
96 | remaining: double; [[The amount of time in seconds left to play]] | 96 | remaining: double; [[The amount of time in seconds left to play]] |
diff --git a/src/lib/edje/efl_canvas_layout.eo b/src/lib/edje/efl_canvas_layout.eo index 0644fddc56..63fbc4c562 100644 --- a/src/lib/edje/efl_canvas_layout.eo +++ b/src/lib/edje/efl_canvas_layout.eo | |||
@@ -22,10 +22,8 @@ class @beta Efl.Canvas.Layout extends Efl.Canvas.Group implements Efl.File, Efl. | |||
22 | value. | 22 | value. |
23 | ]] | 23 | ]] |
24 | get { | 24 | get { |
25 | [[Get the current state of animation, $true by default.]] | ||
26 | } | 25 | } |
27 | set { | 26 | set { |
28 | [[Start or stop animating this object.]] | ||
29 | } | 27 | } |
30 | values { | 28 | values { |
31 | on: bool; [[The animation state, $true by default.]] | 29 | on: bool; [[The animation state, $true by default.]] |
@@ -37,15 +35,14 @@ class @beta Efl.Canvas.Layout extends Efl.Canvas.Group implements Efl.File, Efl. | |||
37 | return: iterator<string> @move; [[Part name iterator]] | 35 | return: iterator<string> @move; [[Part name iterator]] |
38 | } | 36 | } |
39 | @property seat { | 37 | @property seat { |
40 | get { | 38 | [[The seat device given its Edje's name. |
41 | [[Returns the seat device given its Edje's name. | ||
42 | |||
43 | Edje references seats by a name that differs from Evas. | ||
44 | Edje naming follows a incrementional convention: first | ||
45 | registered name is "seat1", second is "seat2", differently | ||
46 | from Evas. | ||
47 | ]] | ||
48 | 39 | ||
40 | Edje references seats by a name that differs from Evas. | ||
41 | Edje naming follows a incrementional convention: first | ||
42 | registered name is "seat1", second is "seat2", differently | ||
43 | from Evas. | ||
44 | ]] | ||
45 | get { | ||
49 | return: Efl.Input.Device; [[The seat device or $null if not found.]] | 46 | return: Efl.Input.Device; [[The seat device or $null if not found.]] |
50 | } | 47 | } |
51 | keys { | 48 | keys { |
@@ -53,14 +50,14 @@ class @beta Efl.Canvas.Layout extends Efl.Canvas.Group implements Efl.File, Efl. | |||
53 | } | 50 | } |
54 | } | 51 | } |
55 | @property seat_name { | 52 | @property seat_name { |
56 | get { | 53 | [[The name given to a set by Edje. |
57 | [[Gets the name given to a set by Edje. | ||
58 | 54 | ||
59 | Edje references seats by a name that differs from Evas. | 55 | Edje references seats by a name that differs from Evas. |
60 | Edje naming follows a incrementional convention: first | 56 | Edje naming follows a incrementional convention: first |
61 | registered name is "seat1", second is "seat2", differently | 57 | registered name is "seat1", second is "seat2", differently |
62 | from Evas. | 58 | from Evas. |
63 | ]] | 59 | ]] |
60 | get { | ||
64 | return: stringshare; [[The name's character string or $null if not found.]] | 61 | return: stringshare; [[The name's character string or $null if not found.]] |
65 | } | 62 | } |
66 | keys { | 63 | keys { |
@@ -68,8 +65,8 @@ class @beta Efl.Canvas.Layout extends Efl.Canvas.Group implements Efl.File, Efl. | |||
68 | } | 65 | } |
69 | } | 66 | } |
70 | @property layout_load_error { | 67 | @property layout_load_error { |
68 | [[The (last) file loading error for a given object.]] | ||
71 | get { | 69 | get { |
72 | [[Gets the (last) file loading error for a given object.]] | ||
73 | } | 70 | } |
74 | values { | 71 | values { |
75 | error: Eina.Error; [[The load error code.]] | 72 | error: Eina.Error; [[The load error code.]] |
diff --git a/src/lib/edje/efl_layout_group.eo b/src/lib/edje/efl_layout_group.eo index d6de69e168..df1d9dc5ac 100644 --- a/src/lib/edje/efl_layout_group.eo +++ b/src/lib/edje/efl_layout_group.eo | |||
@@ -8,87 +8,87 @@ interface Efl.Layout.Group | |||
8 | ]] | 8 | ]] |
9 | methods { | 9 | methods { |
10 | @property group_size_min { | 10 | @property group_size_min { |
11 | get { | 11 | [[The minimum size specified -- as an EDC property -- for a |
12 | [[Gets the minimum size specified -- as an EDC property -- for a | 12 | given Edje object |
13 | given Edje object | 13 | |
14 | 14 | This property retrieves the obj object's minimum size values, as | |
15 | This function retrieves the obj object's minimum size values, as | 15 | declared in its EDC group definition. For instance, for an Edje |
16 | declared in its EDC group definition. For instance, for an Edje | 16 | object of minimum size 100x100 pixels: |
17 | object of minimum size 100x100 pixels: | 17 | collections { |
18 | collections { | 18 | group { |
19 | group { | 19 | name: "a_group"; |
20 | name: "a_group"; | 20 | min: 100 100; |
21 | min: 100 100; | ||
22 | } | ||
23 | } | 21 | } |
22 | } | ||
24 | 23 | ||
25 | Note: If the $min EDC property was not declared for this object, | 24 | Note: If the $min EDC property was not declared for this object, |
26 | this call will return 0x0. | 25 | this call will return 0x0. |
27 | 26 | ||
28 | Note: On failure, this function also return 0x0. | 27 | Note: On failure, this function also return 0x0. |
29 | 28 | ||
30 | See also @.group_size_max. | 29 | See also @.group_size_max. |
31 | ]] | 30 | ]] |
31 | get { | ||
32 | } | 32 | } |
33 | values { | 33 | values { |
34 | min: Eina.Size2D; [[The minimum size as set in EDC.]] | 34 | min: Eina.Size2D; [[The minimum size as set in EDC.]] |
35 | } | 35 | } |
36 | } | 36 | } |
37 | @property group_size_max { | 37 | @property group_size_max { |
38 | get { | 38 | [[The maximum size specified -- as an EDC property -- for a |
39 | [[Gets the maximum size specified -- as an EDC property -- for a | 39 | given Edje object |
40 | given Edje object | 40 | |
41 | 41 | This property retrieves the object's maximum size values, as | |
42 | This function retrieves the object's maximum size values, as | 42 | declared in its EDC group definition. For instance, for an Edje |
43 | declared in its EDC group definition. For instance, for an Edje | 43 | object of maximum size 100x100 pixels: |
44 | object of maximum size 100x100 pixels: | 44 | collections { |
45 | collections { | 45 | group { |
46 | group { | 46 | name: "a_group"; |
47 | name: "a_group"; | 47 | max: 100 100; |
48 | max: 100 100; | ||
49 | } | ||
50 | } | 48 | } |
49 | } | ||
51 | 50 | ||
52 | Note: If the $max EDC property was not declared for the object, | 51 | Note: If the $max EDC property was not declared for the object, |
53 | this call will return the maximum size a given Edje object may | 52 | this call will return the maximum size a given Edje object may |
54 | have, for each axis. | 53 | have, for each axis. |
55 | 54 | ||
56 | Note: On failure, this function will return 0x0. | 55 | Note: On failure, this function will return 0x0. |
57 | 56 | ||
58 | See also @.group_size_min. | 57 | See also @.group_size_min. |
59 | ]] | 58 | ]] |
59 | get { | ||
60 | } | 60 | } |
61 | values { | 61 | values { |
62 | max: Eina.Size2D; [[The maximum size as set in EDC.]] | 62 | max: Eina.Size2D; [[The maximum size as set in EDC.]] |
63 | } | 63 | } |
64 | } | 64 | } |
65 | @property group_data { | 65 | @property group_data { |
66 | get { | 66 | [[The EDC data field's value from a given Edje object's group. |
67 | [[Retrives an EDC data field's value from a given Edje object's group. | 67 | |
68 | 68 | This property represents an EDC data field's value, which is declared | |
69 | This function fetches an EDC data field's value, which is declared | 69 | on the objects building EDC file, under its group. EDC data blocks |
70 | on the objects building EDC file, under its group. EDC data blocks | 70 | are most commonly used to pass arbitrary parameters from an |
71 | are most commonly used to pass arbitrary parameters from an | 71 | application's theme to its code. |
72 | application's theme to its code. | 72 | |
73 | 73 | EDC data fields always hold strings as values, hence the return | |
74 | EDC data fields always hold strings as values, hence the return | 74 | type of this function. Check the complete "syntax reference" for |
75 | type of this function. Check the complete "syntax reference" for | 75 | EDC files. |
76 | EDC files. | 76 | |
77 | 77 | This is how a data item is defined in EDC: | |
78 | This is how a data item is defined in EDC: | 78 | collections { |
79 | collections { | 79 | group { |
80 | group { | 80 | name: "a_group"; |
81 | name: "a_group"; | 81 | data { |
82 | data { | 82 | item: "key1" "value1"; |
83 | item: "key1" "value1"; | 83 | item: "key2" "value2"; |
84 | item: "key2" "value2"; | ||
85 | } | ||
86 | } | 84 | } |
87 | } | 85 | } |
86 | } | ||
88 | 87 | ||
89 | Warning: Do not confuse this call with edje_file_data_get(), which | 88 | Warning: Do not confuse this call with edje_file_data_get(), which |
90 | queries for a global EDC data field on an EDC declaration file. | 89 | queries for a global EDC data field on an EDC declaration file. |
91 | ]] | 90 | ]] |
91 | get { | ||
92 | } | 92 | } |
93 | keys { | 93 | keys { |
94 | key: string; [[The data field's key string]] | 94 | key: string; [[The data field's key string]] |
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.]] |
diff --git a/src/lib/elementary/efl_access_object.eo b/src/lib/elementary/efl_access_object.eo index 3219332952..fafeb11822 100644 --- a/src/lib/elementary/efl_access_object.eo +++ b/src/lib/elementary/efl_access_object.eo | |||
@@ -319,15 +319,14 @@ mixin @beta Efl.Access.Object requires Efl.Object | |||
319 | [[Removes all attributes in accessible object.]] | 319 | [[Removes all attributes in accessible object.]] |
320 | } | 320 | } |
321 | @property reading_info_type @protected { | 321 | @property reading_info_type @protected { |
322 | [[Reading information of an accessible object. | ||
323 | |||
324 | If no reading information is set, 0 is returned which means all four reading information types will be | ||
325 | read from object highlight. | ||
326 | If set to 0, existing reading info will be deleted.]] | ||
322 | get { | 327 | get { |
323 | [[Gets reading information types of an accessible object. if no reading information | ||
324 | is set, 0 is returned which means all four reading information types will be read on | ||
325 | object highlight]] | ||
326 | } | 328 | } |
327 | set { | 329 | set { |
328 | [[Sets reading information of an accessible object. If set as 0, existing | ||
329 | reading info will be deleted and by default all four reading information types | ||
330 | like name, role, state and description will be read on object highlight]] | ||
331 | } | 330 | } |
332 | values { | 331 | values { |
333 | reading_info: Efl.Access.Reading.Info.Type; [[Reading information types]] | 332 | reading_info: Efl.Access.Reading.Info.Type; [[Reading information types]] |
@@ -447,8 +446,8 @@ mixin @beta Efl.Access.Object requires Efl.Object | |||
447 | [[Removes all relationships in accessible object.]] | 446 | [[Removes all relationships in accessible object.]] |
448 | } | 447 | } |
449 | @property access_root @static @beta { | 448 | @property access_root @static @beta { |
449 | [[Root object of accessible object hierarchy]] | ||
450 | get { | 450 | get { |
451 | [[Get root object of accessible object hierarchy]] | ||
452 | values { | 451 | values { |
453 | ret: Efl.Object; [[Root object]] | 452 | ret: Efl.Object; [[Root object]] |
454 | } | 453 | } |
diff --git a/src/lib/elementary/efl_access_selection.eo b/src/lib/elementary/efl_access_selection.eo index 3b2d703ed2..e41dca643d 100644 --- a/src/lib/elementary/efl_access_selection.eo +++ b/src/lib/elementary/efl_access_selection.eo | |||
@@ -3,8 +3,8 @@ interface @beta Efl.Access.Selection | |||
3 | [[Elementary access selection interface]] | 3 | [[Elementary access selection interface]] |
4 | methods { | 4 | methods { |
5 | @property selected_children_count @protected @beta { | 5 | @property selected_children_count @protected @beta { |
6 | [[Gets the number of currently selected children]] | ||
6 | get { | 7 | get { |
7 | [[Gets the number of currently selected children]] | ||
8 | return: int; [[Number of currently selected children]] | 8 | return: int; [[Number of currently selected children]] |
9 | } | 9 | } |
10 | } | 10 | } |
diff --git a/src/lib/elementary/efl_access_text.eo b/src/lib/elementary/efl_access_text.eo index 8e0d0ee1a7..02a7e1688a 100644 --- a/src/lib/elementary/efl_access_text.eo +++ b/src/lib/elementary/efl_access_text.eo | |||
@@ -48,8 +48,8 @@ interface @beta Efl.Access.Text | |||
48 | [[Elementary accessible text interface]] | 48 | [[Elementary accessible text interface]] |
49 | methods { | 49 | methods { |
50 | @property character @protected @beta { | 50 | @property character @protected @beta { |
51 | [[Gets single character present in accessible widget's text at given offset.]] | ||
51 | get { | 52 | get { |
52 | [[Gets single character present in accessible widget's text at given offset.]] | ||
53 | } | 53 | } |
54 | keys { | 54 | keys { |
55 | offset: int; [[Position in text.]] | 55 | offset: int; [[Position in text.]] |
@@ -61,8 +61,8 @@ interface @beta Efl.Access.Text | |||
61 | } | 61 | } |
62 | } | 62 | } |
63 | @property string @protected @beta { | 63 | @property string @protected @beta { |
64 | [[Gets string, start and end offset in text according to given initial offset and granularity.]] | ||
64 | get { | 65 | get { |
65 | [[Gets string, start and end offset in text according to given initial offset and granularity.]] | ||
66 | } | 66 | } |
67 | keys { | 67 | keys { |
68 | granularity: Efl.Access.Text_Granularity; [[Text granularity]] | 68 | granularity: Efl.Access.Text_Granularity; [[Text granularity]] |
@@ -76,8 +76,8 @@ interface @beta Efl.Access.Text | |||
76 | } | 76 | } |
77 | } | 77 | } |
78 | @property access_text @protected @beta { | 78 | @property access_text @protected @beta { |
79 | [[Gets text of accessible widget.]] | ||
79 | get { | 80 | get { |
80 | [[Gets text of accessible widget.]] | ||
81 | } | 81 | } |
82 | keys { | 82 | keys { |
83 | start_offset: int; [[Position in text.]] | 83 | start_offset: int; [[Position in text.]] |
@@ -100,8 +100,8 @@ interface @beta Efl.Access.Text | |||
100 | } | 100 | } |
101 | } | 101 | } |
102 | @property attribute @protected @beta { | 102 | @property attribute @protected @beta { |
103 | [[Indicate if a text attribute with a given name is set]] | ||
103 | get { | 104 | get { |
104 | [[Indicate if a text attribute with a given name is set]] | ||
105 | return: bool; [[$true if attribute name is set, $false otherwise]] | 105 | return: bool; [[$true if attribute name is set, $false otherwise]] |
106 | } | 106 | } |
107 | keys { | 107 | keys { |
@@ -114,8 +114,8 @@ interface @beta Efl.Access.Text | |||
114 | } | 114 | } |
115 | } | 115 | } |
116 | @property text_attributes @protected @beta { | 116 | @property text_attributes @protected @beta { |
117 | [[Gets list of all text attributes.]] | ||
117 | get { | 118 | get { |
118 | [[Gets list of all text attributes.]] | ||
119 | } | 119 | } |
120 | keys { | 120 | keys { |
121 | start_offset: ptr(int); [[Start offset]] | 121 | start_offset: ptr(int); [[Start offset]] |
diff --git a/src/lib/elementary/efl_access_value.eo b/src/lib/elementary/efl_access_value.eo index 4ab0a7b35e..c2b8107a86 100644 --- a/src/lib/elementary/efl_access_value.eo +++ b/src/lib/elementary/efl_access_value.eo | |||
@@ -16,8 +16,8 @@ interface @beta Efl.Access.Value | |||
16 | } | 16 | } |
17 | } | 17 | } |
18 | @property range @protected @beta { | 18 | @property range @protected @beta { |
19 | [[The range of all possible values and its description]] | ||
19 | get { | 20 | get { |
20 | [[Gets a range of all possible values and its description]] | ||
21 | } | 21 | } |
22 | values { | 22 | values { |
23 | lower_limit: double; [[Lower limit of the range]] | 23 | lower_limit: double; [[Lower limit of the range]] |
@@ -26,8 +26,8 @@ interface @beta Efl.Access.Value | |||
26 | } | 26 | } |
27 | } | 27 | } |
28 | @property increment @protected @beta { | 28 | @property increment @protected @beta { |
29 | [[Gets an minimal incrementation value]] | ||
29 | get { | 30 | get { |
30 | [[Gets an minimal incrementation value]] | ||
31 | } | 31 | } |
32 | values { | 32 | values { |
33 | increment: double; [[Minimal incrementation value]] | 33 | increment: double; [[Minimal incrementation value]] |
diff --git a/src/lib/elementary/efl_datetime_manager.eo b/src/lib/elementary/efl_datetime_manager.eo index 3368fdcdc5..706ba29fe9 100644 --- a/src/lib/elementary/efl_datetime_manager.eo +++ b/src/lib/elementary/efl_datetime_manager.eo | |||
@@ -32,8 +32,8 @@ class @beta Efl.Datetime.Manager extends Efl.Object | |||
32 | } | 32 | } |
33 | } | 33 | } |
34 | @property string { | 34 | @property string { |
35 | [[Get the string that matches with the format.]] | ||
35 | get { | 36 | get { |
36 | [[Get the string that matches with the format.]] | ||
37 | } | 37 | } |
38 | keys { | 38 | keys { |
39 | fmt: string; [[The format string]] | 39 | fmt: string; [[The format string]] |
diff --git a/src/lib/elementary/efl_ui_flip.eo b/src/lib/elementary/efl_ui_flip.eo index 9545d1f318..545d97b3d9 100644 --- a/src/lib/elementary/efl_ui_flip.eo +++ b/src/lib/elementary/efl_ui_flip.eo | |||
@@ -77,8 +77,8 @@ class @beta Efl.Ui.Flip extends Efl.Ui.Widget implements Efl.Pack_Linear | |||
77 | } | 77 | } |
78 | } | 78 | } |
79 | @property front_visible { | 79 | @property front_visible { |
80 | [[Get flip front visibility state.]] | ||
80 | get { | 81 | get { |
81 | [[Get flip front visibility state.]] | ||
82 | return: bool; [[$true if front front is showing, $false if | 82 | return: bool; [[$true if front front is showing, $false if |
83 | the back is showing.]] | 83 | the back is showing.]] |
84 | } | 84 | } |
diff --git a/src/lib/elementary/efl_ui_focus_object.eo b/src/lib/elementary/efl_ui_focus_object.eo index 23248804d6..2de9620c3c 100644 --- a/src/lib/elementary/efl_ui_focus_object.eo +++ b/src/lib/elementary/efl_ui_focus_object.eo | |||
@@ -16,8 +16,8 @@ mixin Efl.Ui.Focus.Object | |||
16 | } | 16 | } |
17 | } | 17 | } |
18 | @property focus { | 18 | @property focus { |
19 | [[Whether the widget is currently focused or not.]] | ||
19 | get { | 20 | get { |
20 | [[Returns whether the widget is currently focused or not.]] | ||
21 | } | 21 | } |
22 | set @protected { | 22 | set @protected { |
23 | [[This is called by the manager and should never be called by | 23 | [[This is called by the manager and should never be called by |
diff --git a/src/lib/elementary/efl_ui_frame.eo b/src/lib/elementary/efl_ui_frame.eo index 31849f95d7..46b8604415 100644 --- a/src/lib/elementary/efl_ui_frame.eo +++ b/src/lib/elementary/efl_ui_frame.eo | |||
@@ -9,35 +9,26 @@ class @beta Efl.Ui.Frame extends Efl.Ui.Layout_Base implements Efl.Input.Clickab | |||
9 | ]] | 9 | ]] |
10 | methods { | 10 | methods { |
11 | @property collapse { | 11 | @property collapse { |
12 | [[Manually collapse a frame without animations. | ||
13 | Use this to toggle the collapsed state of a frame, bypassing animations. | ||
14 | ]] | ||
12 | set { | 15 | set { |
13 | [[Manually collapse a frame without animations | ||
14 | Use this to toggle the collapsed state of a frame, bypassing animations. | ||
15 | ]] | ||
16 | } | 16 | } |
17 | get { | 17 | get { |
18 | [[Determine the collapse state of a frame | ||
19 | Use this to determine the collapse state of a frame. | ||
20 | ]] | ||
21 | } | 18 | } |
22 | values { | 19 | values { |
23 | collapse: bool; [[$true to collapse, $false to expand.]] | 20 | collapse: bool; [[$true to collapse, $false to expand.]] |
24 | } | 21 | } |
25 | } | 22 | } |
26 | @property autocollapse { | 23 | @property autocollapse { |
24 | [[Toggle autocollapsing of a frame. | ||
25 | When $enable is $true, clicking a frame's label will collapse the frame | ||
26 | vertically, shrinking it to the height of the label. | ||
27 | By default, this is DISABLED. | ||
28 | ]] | ||
27 | set { | 29 | set { |
28 | [[Toggle autocollapsing of a frame | ||
29 | When $enable is $true, clicking a frame's label will collapse the frame | ||
30 | vertically, shrinking it to the height of the label. | ||
31 | By default, this is DISABLED. | ||
32 | ]] | ||
33 | } | 30 | } |
34 | get { | 31 | get { |
35 | [[Determine autocollapsing of a frame | ||
36 | |||
37 | When this returns $true, clicking a frame's label will collapse the frame | ||
38 | vertically, shrinking it to the height of the label. | ||
39 | By default, this is DISABLED. | ||
40 | ]] | ||
41 | } | 32 | } |
42 | values { | 33 | values { |
43 | autocollapse: bool; [[Whether to enable autocollapse.]] | 34 | autocollapse: bool; [[Whether to enable autocollapse.]] |
diff --git a/src/lib/elementary/efl_ui_image.eo b/src/lib/elementary/efl_ui_image.eo index ab95bd761c..3abf738524 100644 --- a/src/lib/elementary/efl_ui_image.eo +++ b/src/lib/elementary/efl_ui_image.eo | |||
@@ -31,34 +31,32 @@ class @beta Efl.Ui.Image extends Efl.Ui.Widget implements Efl.Input.Clickable, E | |||
31 | event_prefix: efl_ui_image; | 31 | event_prefix: efl_ui_image; |
32 | methods { | 32 | methods { |
33 | @property icon { | 33 | @property icon { |
34 | set { | 34 | [[The image name, using icon standards names. |
35 | [[Set the image by icon standards names. | 35 | |
36 | For example, freedesktop.org defines standard icon names such | ||
37 | as "home" and "network". There can be different icon sets to | ||
38 | match those icon keys. The "name" given as parameter is one of | ||
39 | these "keys" and will be used to look in the freedesktop.org | ||
40 | paths and elementary theme. | ||
36 | 41 | ||
37 | For example, freedesktop.org defines standard icon names such | 42 | If the name is not found in any of the expected locations and is |
38 | as "home" and "network". There can be different icon sets to | 43 | the absolute path of an image file, this image will be used. |
39 | match those icon keys. The "name" given as parameter is one of | 44 | Lookup order used by @.icon.set can be set using "icon_theme" in config. |
40 | these "keys" and will be used to look in the freedesktop.org | ||
41 | paths and elementary theme. | ||
42 | 45 | ||
43 | If the name is not found in any of the expected locations and is | 46 | If the image was set using @Efl.File.file instead of |
44 | the absolute path of an image file, this image will be used. | 47 | @.icon.set, then reading this property will return null. |
45 | Lookup order used by @.icon.set can be set using "icon_theme" in config. | ||
46 | 48 | ||
47 | Note: The image set by this function is changed when | 49 | Note: The image set by this function is changed when |
48 | @Efl.File.load is called. | 50 | @Efl.File.load is called. |
49 | 51 | ||
50 | Note: This function does not accept relative icon path. | 52 | Note: This function does not accept relative icon paths. |
51 | 53 | ||
52 | See also @.icon.get. | 54 | See also @.icon.get. |
53 | ]] | 55 | ]] |
56 | set { | ||
54 | return: bool; [[$true on success, $false on error]] | 57 | return: bool; [[$true on success, $false on error]] |
55 | } | 58 | } |
56 | get { | 59 | get { |
57 | [[Get the icon name of image set by icon standard names. | ||
58 | |||
59 | If the image was set using @Efl.File.file instead of | ||
60 | @.icon.set, then this function will return null. | ||
61 | ]] | ||
62 | } | 60 | } |
63 | values { | 61 | values { |
64 | name: string; [[The icon name]] | 62 | name: string; [[The icon name]] |
diff --git a/src/lib/elementary/efl_ui_image_zoomable.eo b/src/lib/elementary/efl_ui_image_zoomable.eo index 62ae9bc591..932c732e15 100644 --- a/src/lib/elementary/efl_ui_image_zoomable.eo +++ b/src/lib/elementary/efl_ui_image_zoomable.eo | |||
@@ -10,35 +10,27 @@ class @beta Efl.Ui.Image_Zoomable extends Efl.Ui.Image implements Efl.Ui.Zoom, | |||
10 | [[Elementary Image Zoomable class]] | 10 | [[Elementary Image Zoomable class]] |
11 | methods { | 11 | methods { |
12 | @property gesture_enabled { | 12 | @property gesture_enabled { |
13 | set { | 13 | [[The gesture state for photocam. |
14 | [[Set the gesture state for photocam. | ||
15 | 14 | ||
16 | This sets the gesture state to on or off for photocam. The | 15 | This sets the gesture state to on or off for photocam. The |
17 | default is off. This will start multi touch zooming. | 16 | default is off. This will start multi touch zooming. |
18 | ]] | 17 | ]] |
18 | set { | ||
19 | } | 19 | } |
20 | get { | 20 | get { |
21 | [[Get the gesture state for photocam. | ||
22 | |||
23 | This gets the current gesture state for the photocam object. | ||
24 | ]] | ||
25 | } | 21 | } |
26 | values { | 22 | values { |
27 | gesture: bool; [[The gesture state.]] | 23 | gesture: bool; [[The gesture state.]] |
28 | } | 24 | } |
29 | } | 25 | } |
30 | @property image_region { | 26 | @property image_region { |
31 | get { | 27 | [[The region of the image that is currently shown |
32 | [[Get the region of the image that is currently shown | ||
33 | 28 | ||
34 | See also @.image_region.set. | 29 | Setting it shows the region of the image without using animation. |
35 | ]] | 30 | ]] |
31 | get { | ||
36 | } | 32 | } |
37 | set { | 33 | set { |
38 | [[Set the viewed region of the image | ||
39 | |||
40 | This shows the region of the image without using animation. | ||
41 | ]] | ||
42 | } | 34 | } |
43 | values { | 35 | values { |
44 | region: Eina.Rect; [[The region in the original image pixels.]] | 36 | region: Eina.Rect; [[The region in the original image pixels.]] |
diff --git a/src/lib/elementary/efl_ui_panel.eo b/src/lib/elementary/efl_ui_panel.eo index 24182af750..edf688c2eb 100644 --- a/src/lib/elementary/efl_ui_panel.eo +++ b/src/lib/elementary/efl_ui_panel.eo | |||
@@ -23,49 +23,43 @@ class @beta Efl.Ui.Panel extends Efl.Ui.Layout_Base | |||
23 | [[Elementary panel class]] | 23 | [[Elementary panel class]] |
24 | methods { | 24 | methods { |
25 | @property orient { | 25 | @property orient { |
26 | set { | 26 | [[The orientation of the panel |
27 | [[Sets the orientation of the panel | ||
28 | 27 | ||
29 | Sets from where the panel will (dis)appear. | 28 | Sets from where the panel will (dis)appear. |
30 | ]] | 29 | ]] |
30 | set { | ||
31 | } | 31 | } |
32 | get { | 32 | get { |
33 | [[Gets the orientation of the panel.]] | ||
34 | } | 33 | } |
35 | values { | 34 | values { |
36 | orient: Efl.Ui.Panel_Orient; [[The panel orientation.]] | 35 | orient: Efl.Ui.Panel_Orient; [[The panel orientation.]] |
37 | } | 36 | } |
38 | } | 37 | } |
39 | @property hidden { | 38 | @property hidden { |
39 | [[The state of the panel.]] | ||
40 | set { | 40 | set { |
41 | [[Sets the state of the panel.]] | ||
42 | } | 41 | } |
43 | get { | 42 | get { |
44 | [[Gets the state of the panel.]] | ||
45 | } | 43 | } |
46 | values { | 44 | values { |
47 | hidden: bool; [[If $true, the panel will run the animation to disappear.]] | 45 | hidden: bool; [[If $true, the panel will run the animation to disappear.]] |
48 | } | 46 | } |
49 | } | 47 | } |
50 | @property scrollable { | 48 | @property scrollable { |
49 | [[The scrollability of the panel.]] | ||
51 | set { | 50 | set { |
52 | [[Sets the scrollability of the panel.]] | ||
53 | } | 51 | } |
54 | get { | 52 | get { |
55 | [[Gets the state of the scrollability. | ||
56 | ]] | ||
57 | } | 53 | } |
58 | values { | 54 | values { |
59 | scrollable: bool; [[The scrollable state.]] | 55 | scrollable: bool; [[The scrollable state.]] |
60 | } | 56 | } |
61 | } | 57 | } |
62 | @property scrollable_content_size { | 58 | @property scrollable_content_size { |
59 | [[The size of the scrollable panel.]] | ||
63 | set { | 60 | set { |
64 | [[Sets the size of the scrollable panel.]] | ||
65 | } | 61 | } |
66 | get { | 62 | get { |
67 | [[Gets the size of the scrollable panel. | ||
68 | ]] | ||
69 | } | 63 | } |
70 | values { | 64 | values { |
71 | ratio: double; [[Size ratio]] | 65 | ratio: double; [[Size ratio]] |
diff --git a/src/lib/elementary/efl_ui_progressbar.eo b/src/lib/elementary/efl_ui_progressbar.eo index c14bf2a3fe..e2994a266f 100644 --- a/src/lib/elementary/efl_ui_progressbar.eo +++ b/src/lib/elementary/efl_ui_progressbar.eo | |||
@@ -27,15 +27,13 @@ class @beta Efl.Ui.Progressbar extends Efl.Ui.Layout_Base implements Efl.Ui.Rang | |||
27 | } | 27 | } |
28 | } | 28 | } |
29 | @property pulse { | 29 | @property pulse { |
30 | set { | 30 | [[Start/stop a given progress bar "pulsing" animation, if its under that mode. |
31 | [[Start/stop a given progress bar "pulsing" animation, if its under that mode | ||
32 | 31 | ||
33 | Note: This call won't do anything if $obj is not under "pulsing mode". See @.pulse_mode. | 32 | Note: This call won't do anything if $obj is not under "pulsing mode". See @.pulse_mode. |
34 | ]] | 33 | ]] |
34 | set { | ||
35 | } | 35 | } |
36 | get { | 36 | get { |
37 | [[ Get the pulsing state on a given progressbar widget. See @.pulse_mode. | ||
38 | ]] | ||
39 | } | 37 | } |
40 | values { | 38 | values { |
41 | state: bool; [[$true, to start the pulsing animation, $false to stop it]] | 39 | state: bool; [[$true, to start the pulsing animation, $false to stop it]] |
diff --git a/src/lib/elementary/efl_ui_text.eo b/src/lib/elementary/efl_ui_text.eo index 50845d125f..eb74be4b1a 100644 --- a/src/lib/elementary/efl_ui_text.eo +++ b/src/lib/elementary/efl_ui_text.eo | |||
@@ -24,14 +24,12 @@ class @beta Efl.Ui.Text extends Efl.Ui.Layout_Base implements Efl.Input.Clickabl | |||
24 | } | 24 | } |
25 | } | 25 | } |
26 | @property input_panel_show_on_demand { | 26 | @property input_panel_show_on_demand { |
27 | [[The attribute to show the input panel in case of only a user's explicit Mouse Up event. | ||
28 | It doesn't request to show the input panel even though it has focus. | ||
29 | ]] | ||
27 | set { | 30 | set { |
28 | [[Set the attribute to show the input panel in case of only a user's explicit Mouse Up event. | ||
29 | It doesn't request to show the input panel even though it has focus. | ||
30 | ]] | ||
31 | } | 31 | } |
32 | get { | 32 | get { |
33 | [[Get the attribute to show the input panel in case of only an user's explicit Mouse Up event. | ||
34 | ]] | ||
35 | } | 33 | } |
36 | values { | 34 | values { |
37 | ondemand: bool; [[If $true, the input panel will be shown in case of only Mouse up event. | 35 | ondemand: bool; [[If $true, the input panel will be shown in case of only Mouse up event. |
@@ -40,13 +38,10 @@ class @beta Efl.Ui.Text extends Efl.Ui.Layout_Base implements Efl.Input.Clickabl | |||
40 | } | 38 | } |
41 | } | 39 | } |
42 | @property context_menu_disabled { | 40 | @property context_menu_disabled { |
41 | [[This disables the entry's contextual (longpress) menu.]] | ||
43 | set { | 42 | set { |
44 | [[This disables the entry's contextual (longpress) menu.]] | ||
45 | } | 43 | } |
46 | get { | 44 | get { |
47 | [[This returns whether the entry's contextual (longpress) menu is | ||
48 | disabled. | ||
49 | ]] | ||
50 | } | 45 | } |
51 | values { | 46 | values { |
52 | disabled: bool; [[If $true, the menu is disabled.]] | 47 | disabled: bool; [[If $true, the menu is disabled.]] |
@@ -54,95 +49,83 @@ class @beta Efl.Ui.Text extends Efl.Ui.Layout_Base implements Efl.Input.Clickabl | |||
54 | } | 49 | } |
55 | @property cnp_mode { | 50 | @property cnp_mode { |
56 | /* FIXME: Efl.Ui.Selection_Format does not allow markup without images! */ | 51 | /* FIXME: Efl.Ui.Selection_Format does not allow markup without images! */ |
57 | set { | 52 | [[Control pasting of text and images for the widget. |
58 | [[Control pasting of text and images for the widget. | ||
59 | 53 | ||
60 | Normally the entry allows both text and images to be pasted. | 54 | Normally the entry allows both text and images to be pasted. |
61 | 55 | ||
62 | Note: This only changes the behaviour of text. | 56 | Note: This only changes the behaviour of text. |
63 | ]] | 57 | ]] |
58 | set { | ||
64 | } | 59 | } |
65 | get { | 60 | get { |
66 | [[Getting elm_entry text paste/drop mode. | ||
67 | |||
68 | Normally the entry allows both text and images to be pasted. | ||
69 | This gets the copy & paste mode of the entry. | ||
70 | ]] | ||
71 | } | 61 | } |
72 | values { | 62 | values { |
73 | format: Efl.Ui.Selection_Format; [[Format for copy & paste.]] | 63 | format: Efl.Ui.Selection_Format; [[Format for copy & paste.]] |
74 | } | 64 | } |
75 | } | 65 | } |
76 | @property input_panel_language { | 66 | @property input_panel_language { |
77 | set { | 67 | [[The language mode of the input panel. |
78 | [[Set the language mode of the input panel. | ||
79 | 68 | ||
80 | This API can be used if you want to show the alphabet keyboard mode. | 69 | This API can be used if you want to show the alphabet keyboard mode. |
81 | ]] | 70 | ]] |
71 | set { | ||
82 | } | 72 | } |
83 | get { | 73 | get { |
84 | [[Get the language mode of the input panel.]] | ||
85 | } | 74 | } |
86 | values { | 75 | values { |
87 | lang: Elm.Input.Panel.Lang; [[Language to be set to the input panel.]] | 76 | lang: Elm.Input.Panel.Lang; [[Language to be set to the input panel.]] |
88 | } | 77 | } |
89 | } | 78 | } |
90 | @property selection_handler_disabled { | 79 | @property selection_handler_disabled { |
80 | [[This disables the entry's selection handlers.]] | ||
91 | set { | 81 | set { |
92 | [[This disables the entry's selection handlers.]] | ||
93 | } | 82 | } |
94 | get { | 83 | get { |
95 | [[This returns whether the entry's selection handlers are disabled.]] | ||
96 | } | 84 | } |
97 | values { | 85 | values { |
98 | disabled: bool; [[If $true, the selection handlers are disabled.]] | 86 | disabled: bool; [[If $true, the selection handlers are disabled.]] |
99 | } | 87 | } |
100 | } | 88 | } |
101 | @property input_panel_layout_variation { | 89 | @property input_panel_layout_variation { |
90 | [[Set the input panel layout variation of the entry | ||
91 | ]] | ||
102 | set { | 92 | set { |
103 | [[Set the input panel layout variation of the entry | ||
104 | ]] | ||
105 | } | 93 | } |
106 | get { | 94 | get { |
107 | [[Get the input panel layout variation of the entry | ||
108 | ]] | ||
109 | } | 95 | } |
110 | values { | 96 | values { |
111 | variation: int; [[Layout variation type.]] | 97 | variation: int; [[Layout variation type.]] |
112 | } | 98 | } |
113 | } | 99 | } |
114 | @property autocapital_type { | 100 | @property autocapital_type { |
101 | [[Set the autocapitalization type on the immodule.]] | ||
115 | set { | 102 | set { |
116 | [[Set the autocapitalization type on the immodule.]] | ||
117 | } | 103 | } |
118 | get { | 104 | get { |
119 | [[Get the autocapitalization type on the immodule.]] | ||
120 | } | 105 | } |
121 | values { | 106 | values { |
122 | autocapital_type: Elm.Autocapital.Type; [[The type of autocapitalization.]] | 107 | autocapital_type: Elm.Autocapital.Type; [[The type of autocapitalization.]] |
123 | } | 108 | } |
124 | } | 109 | } |
125 | @property password_mode { | 110 | @property password_mode { |
126 | set { | 111 | [[Sets the entry to password mode. |
127 | [[Sets the entry to password mode. | ||
128 | 112 | ||
129 | In password mode entries are implicitly single line and the display of | 113 | In password mode entries are implicitly single line and the display of |
130 | any text inside them is replaced with asterisks (*). | 114 | any text inside them is replaced with asterisks (*). |
131 | ]] | 115 | ]] |
116 | set { | ||
132 | } | 117 | } |
133 | get { | 118 | get { |
134 | [[Get whether the entry is set to password mode.]] | ||
135 | } | 119 | } |
136 | values { | 120 | values { |
137 | password: bool; [[If true, password mode is enabled.]] | 121 | password: bool; [[If true, password mode is enabled.]] |
138 | } | 122 | } |
139 | } | 123 | } |
140 | @property input_panel_return_key_disabled { | 124 | @property input_panel_return_key_disabled { |
125 | [[Set the return key on the input panel to be disabled.]] | ||
141 | set { | 126 | set { |
142 | [[Set the return key on the input panel to be disabled.]] | ||
143 | } | 127 | } |
144 | get { | 128 | get { |
145 | [[Get whether the return key on the input panel should be disabled or not.]] | ||
146 | } | 129 | } |
147 | values { | 130 | values { |
148 | disabled: bool; [[The state to put in in: $true for | 131 | disabled: bool; [[The state to put in in: $true for |
@@ -150,71 +133,66 @@ class @beta Efl.Ui.Text extends Efl.Ui.Layout_Base implements Efl.Input.Clickabl | |||
150 | } | 133 | } |
151 | } | 134 | } |
152 | @property prediction_allow { | 135 | @property prediction_allow { |
136 | [[Whether the entry should allow predictive text.]] | ||
153 | set { | 137 | set { |
154 | [[Set whether the entry should allow predictive text.]] | ||
155 | } | 138 | } |
156 | get { | 139 | get { |
157 | [[Get whether the entry allows predictive text.]] | ||
158 | } | 140 | } |
159 | values { | 141 | values { |
160 | prediction: bool; [[Whether the entry should allow predictive text.]] | 142 | prediction: bool; [[Whether the entry should allow predictive text.]] |
161 | } | 143 | } |
162 | } | 144 | } |
163 | @property input_hint { | 145 | @property input_hint { |
146 | [[Sets the input hint which allows input methods to fine-tune their behavior.]] | ||
164 | set { | 147 | set { |
165 | [[Sets the input hint which allows input methods to fine-tune their behavior.]] | ||
166 | } | 148 | } |
167 | get { | 149 | get { |
168 | [[Gets the value of input hint.]] | ||
169 | } | 150 | } |
170 | values { | 151 | values { |
171 | hints: Elm.Input.Hints; [[Input hint.]] | 152 | hints: Elm.Input.Hints; [[Input hint.]] |
172 | } | 153 | } |
173 | } | 154 | } |
174 | @property input_panel_layout { | 155 | @property input_panel_layout { |
156 | [[Set the input panel layout of the entry.]] | ||
175 | set { | 157 | set { |
176 | [[Set the input panel layout of the entry.]] | ||
177 | } | 158 | } |
178 | get { | 159 | get { |
179 | [[Get the input panel layout of the entry.]] | ||
180 | } | 160 | } |
181 | values { | 161 | values { |
182 | layout: Elm.Input.Panel.Layout(Elm.Input.Panel.Layout.invalid); [[Layout type.]] | 162 | layout: Elm.Input.Panel.Layout(Elm.Input.Panel.Layout.invalid); [[Layout type.]] |
183 | } | 163 | } |
184 | } | 164 | } |
185 | @property input_panel_return_key_type { | 165 | @property input_panel_return_key_type { |
186 | set { | 166 | [[Set the "return" key type. This type is used to set string or icon on the "return" key of the input panel. |
187 | [[Set the "return" key type. This type is used to set string or icon on the "return" key of the input panel. | ||
188 | 167 | ||
189 | An input panel displays the string or icon associated with this type. | 168 | An input panel displays the string or icon associated with this type. |
190 | ]] | 169 | ]] |
170 | set { | ||
191 | } | 171 | } |
192 | get { | 172 | get { |
193 | [[Get the "return" key type.]] | ||
194 | } | 173 | } |
195 | values { | 174 | values { |
196 | return_key_type: Elm.Input.Panel.Return_Key.Type; [[The type of "return" key on the input panel.]] | 175 | return_key_type: Elm.Input.Panel.Return_Key.Type; [[The type of "return" key on the input panel.]] |
197 | } | 176 | } |
198 | } | 177 | } |
199 | @property input_panel_enabled { | 178 | @property input_panel_enabled { |
179 | [[Sets the attribute to show the input panel automatically.]] | ||
200 | set { | 180 | set { |
201 | [[Sets the attribute to show the input panel automatically.]] | ||
202 | } | 181 | } |
203 | get { | 182 | get { |
204 | [[Get the attribute to show the input panel automatically.]] | ||
205 | } | 183 | } |
206 | values { | 184 | values { |
207 | enabled: bool; [[If $true, the input panel is appeared when entry is clicked or has a focus.]] | 185 | enabled: bool; [[If $true, the input panel is appeared when entry is clicked or has a focus.]] |
208 | } | 186 | } |
209 | } | 187 | } |
210 | @property input_panel_return_key_autoenabled { | 188 | @property input_panel_return_key_autoenabled { |
211 | set { | 189 | [[Whether the return key on the input panel is disabled automatically when entry has no text. |
212 | [[Set whether the return key on the input panel is disabled automatically when entry has no text. | ||
213 | 190 | ||
214 | If $enabled is $true, the return key on input panel is disabled when the entry has no text. | 191 | If $enabled is $true, the return key on input panel is disabled when the entry has no text. |
215 | The return key on the input panel is automatically enabled when the entry has text. | 192 | The return key on the input panel is automatically enabled when the entry has text. |
216 | The default value is $false. | 193 | The default value is $false. |
217 | ]] | 194 | ]] |
195 | set { | ||
218 | } | 196 | } |
219 | values { | 197 | values { |
220 | enabled: bool; [[If $true, the return key is automatically disabled when the entry has no text.]] | 198 | enabled: bool; [[If $true, the return key is automatically disabled when the entry has no text.]] |
diff --git a/src/lib/elementary/efl_ui_video.eo b/src/lib/elementary/efl_ui_video.eo index c00326ef30..9cc1b43b42 100644 --- a/src/lib/elementary/efl_ui_video.eo +++ b/src/lib/elementary/efl_ui_video.eo | |||
@@ -5,38 +5,33 @@ class @beta Efl.Ui.Video extends Efl.Ui.Layout_Base | |||
5 | [[Efl UI video class]] | 5 | [[Efl UI video class]] |
6 | methods { | 6 | methods { |
7 | @property remember_position { | 7 | @property remember_position { |
8 | set { | 8 | [[Whether the object can remember the last played position. |
9 | [[Set whether the object can remember the last played position. | ||
10 | 9 | ||
11 | Note: This API only serves as indication. System support is | 10 | Note: This API only serves as indication. System support is |
12 | required. | 11 | required. |
13 | ]] | 12 | ]] |
13 | set { | ||
14 | } | 14 | } |
15 | get { | 15 | get { |
16 | [[Set whether the object can remember the last played position. | ||
17 | |||
18 | Note: This API only serves as indication. System support is | ||
19 | required. | ||
20 | ]] | ||
21 | } | 16 | } |
22 | values { | 17 | values { |
23 | remember: bool; [[$true when the object can remember the last position, $false otherwise]] | 18 | remember: bool; [[$true when the object can remember the last position, $false otherwise]] |
24 | } | 19 | } |
25 | } | 20 | } |
26 | @property emotion { | 21 | @property emotion { |
22 | [[The underlying Emotion object.]] | ||
27 | get { | 23 | get { |
28 | [[Get the underlying Emotion object.]] | ||
29 | return: Efl.Canvas.Object; [[The underlying Emotion object.]] | 24 | return: Efl.Canvas.Object; [[The underlying Emotion object.]] |
30 | } | 25 | } |
31 | } | 26 | } |
32 | @property title { | 27 | @property title { |
33 | get { | 28 | [[The title (for instance DVD title) from this emotion object. |
34 | [[Get the title (for instance DVD title) from this emotion object. | ||
35 | 29 | ||
36 | This function is only useful when playing a DVD. | 30 | This function is only useful when playing a DVD. |
37 | 31 | ||
38 | Note: Don't change or free the string returned by this function. | 32 | Note: Don't change or free the string returned by this function. |
39 | ]] | 33 | ]] |
34 | get { | ||
40 | return: string; [[A string containing the title.]] | 35 | return: string; [[A string containing the title.]] |
41 | } | 36 | } |
42 | } | 37 | } |
diff --git a/src/lib/elementary/efl_ui_widget_scrollable_content.eo b/src/lib/elementary/efl_ui_widget_scrollable_content.eo index 2148ddd1de..ff3e774449 100644 --- a/src/lib/elementary/efl_ui_widget_scrollable_content.eo +++ b/src/lib/elementary/efl_ui_widget_scrollable_content.eo | |||
@@ -54,27 +54,18 @@ mixin @beta Efl.Ui.Widget_Scrollable_Content requires Efl.Object | |||
54 | } | 54 | } |
55 | } | 55 | } |
56 | @property scrollable_text { | 56 | @property scrollable_text { |
57 | set { | 57 | [[The text string to be displayed by the given text object. |
58 | [[Sets the text string to be displayed by the given text object. | 58 | The text will use @Efl.Text_Format_Wrap.mixed wrapping, |
59 | The text will use @Efl.Text_Format_Wrap.mixed wrapping, | 59 | and it will be scrollable depending on its size relative to the |
60 | and it will be scrollable depending on its size relative to the | 60 | object's geometry. |
61 | object's geometry. | ||
62 | 61 | ||
63 | See also @.scrollable_text.get. | 62 | When reading, do not free the return value. |
64 | 63 | ||
65 | @since 1.23 | 64 | @since 1.23 |
66 | ]] | 65 | ]] |
66 | set { | ||
67 | } | 67 | } |
68 | get { | 68 | get { |
69 | [[Retrieves the text string currently being displayed by the given | ||
70 | text object. | ||
71 | |||
72 | Do not free() the return value. | ||
73 | |||
74 | See also @.scrollable_text.set. | ||
75 | |||
76 | @since 1.23 | ||
77 | ]] | ||
78 | } | 69 | } |
79 | values { | 70 | values { |
80 | text: string; [[Text string to display on it.]] | 71 | text: string; [[Text string to display on it.]] |
diff --git a/src/lib/elementary/efl_ui_win.eo b/src/lib/elementary/efl_ui_win.eo index 94859d9277..6fa01b8291 100644 --- a/src/lib/elementary/efl_ui_win.eo +++ b/src/lib/elementary/efl_ui_win.eo | |||
@@ -165,11 +165,10 @@ class Efl.Ui.Win extends Efl.Ui.Widget implements Efl.Canvas.Scene, Efl.Access.W | |||
165 | } | 165 | } |
166 | } | 166 | } |
167 | @property keyboard_mode @beta { | 167 | @property keyboard_mode @beta { |
168 | [[The keyboard mode of the window.]] | ||
168 | set { | 169 | set { |
169 | [[Sets the keyboard mode of the window.]] | ||
170 | } | 170 | } |
171 | get { | 171 | get { |
172 | [[Get the keyboard mode of the window.]] | ||
173 | } | 172 | } |
174 | values { | 173 | values { |
175 | mode: Efl.Ui.Win_Keyboard_Mode; [[The mode, one of @Efl.Ui.Win_Keyboard_Mode.]] | 174 | mode: Efl.Ui.Win_Keyboard_Mode; [[The mode, one of @Efl.Ui.Win_Keyboard_Mode.]] |
@@ -205,45 +204,39 @@ class Efl.Ui.Win extends Efl.Ui.Widget implements Efl.Canvas.Scene, Efl.Access.W | |||
205 | } | 204 | } |
206 | } | 205 | } |
207 | @property screen_constrain @beta { | 206 | @property screen_constrain @beta { |
208 | set { | 207 | [[Constrain the maximum width and height of a window to the |
209 | [[Constrain the maximum width and height of a window to the | 208 | width and height of the screen. |
210 | width and height of the screen. | ||
211 | 209 | ||
212 | When $constrain is $true, $obj will never resize larger than | 210 | When $constrain is $true, $obj will never resize larger than |
213 | the screen. | 211 | the screen. |
214 | ]] | 212 | ]] |
213 | set { | ||
215 | } | 214 | } |
216 | get { | 215 | get { |
217 | [[Get the constraints on the maximum width and height of a | ||
218 | window relative to the width and height of the screen. | ||
219 | |||
220 | When this function returns $true, $obj will never resize | ||
221 | larger than the screen. | ||
222 | ]] | ||
223 | } | 216 | } |
224 | values { | 217 | values { |
225 | constrain: bool; [[$true to restrict the window's maximum size.]] | 218 | constrain: bool; [[$true to restrict the window's maximum size.]] |
226 | } | 219 | } |
227 | } | 220 | } |
228 | @property prop_focus_skip @beta { | 221 | @property prop_focus_skip @beta { |
222 | [[Set the window to be skipped by keyboard focus. | ||
223 | |||
224 | This sets the window to be skipped by normal keyboard input. | ||
225 | This means a window manager will be asked not to focus this | ||
226 | window as well as omit it from things like the taskbar, pager, | ||
227 | "alt-tab" list etc. etc. | ||
228 | |||
229 | Call this and enable it on a window BEFORE you show it for | ||
230 | the first time, otherwise it may have no effect. | ||
231 | |||
232 | Use this for windows that have only output information or | ||
233 | might only be interacted with by the mouse or touchscreen, | ||
234 | never for typing. This may have | ||
235 | side-effects like making the window non-accessible in | ||
236 | some cases unless the window is specially handled. Use | ||
237 | this with care. | ||
238 | ]] | ||
229 | set { | 239 | set { |
230 | [[Set the window to be skipped by keyboard focus. | ||
231 | |||
232 | This sets the window to be skipped by normal keyboard input. | ||
233 | This means a window manager will be asked not to focus this | ||
234 | window as well as omit it from things like the taskbar, pager, | ||
235 | "alt-tab" list etc. etc. | ||
236 | |||
237 | Call this and enable it on a window BEFORE you show it for | ||
238 | the first time, otherwise it may have no effect. | ||
239 | |||
240 | Use this for windows that have only output information or | ||
241 | might only be interacted with by the mouse or touchscreen, | ||
242 | never for typing. This may have | ||
243 | side-effects like making the window non-accessible in | ||
244 | some cases unless the window is specially handled. Use | ||
245 | this with care. | ||
246 | ]] | ||
247 | } | 240 | } |
248 | values { | 241 | values { |
249 | skip: bool; [[The skip flag state ($true if it is to be skipped).]] | 242 | skip: bool; [[The skip flag state ($true if it is to be skipped).]] |
@@ -291,29 +284,24 @@ class Efl.Ui.Win extends Efl.Ui.Widget implements Efl.Canvas.Scene, Efl.Access.W | |||
291 | } | 284 | } |
292 | } | 285 | } |
293 | @property icon_object { | 286 | @property icon_object { |
287 | [[A window object's icon. | ||
288 | |||
289 | This sets an image to be used as the icon for the given | ||
290 | window, in the window manager decoration part. The exact | ||
291 | pixel dimensions of the object (not object size) will be | ||
292 | used and the image pixels will be used as-is when this | ||
293 | function is called. If the image object has been updated, | ||
294 | then call this function again to source the image pixels | ||
295 | and place them in the window's icon. Note that only objects of | ||
296 | type @Efl.Canvas.Image or @Efl.Ui.Image are allowed. | ||
297 | ]] | ||
294 | set { | 298 | set { |
295 | [[Set a window object's icon. | ||
296 | |||
297 | This sets an image to be used as the icon for the given | ||
298 | window, in the window manager decoration part. The exact | ||
299 | pixel dimensions of the object (not object size) will be | ||
300 | used and the image pixels will be used as-is when this | ||
301 | function is called. If the image object has been updated, | ||
302 | then call this function again to source the image pixels | ||
303 | and place them in the window's icon. Note that only objects of | ||
304 | type @Efl.Canvas.Image or @Efl.Ui.Image are allowed. | ||
305 | ]] | ||
306 | values { | 299 | values { |
307 | icon: Efl.Canvas.Object; | 300 | icon: Efl.Canvas.Object; |
308 | [[The image object to use for an icon.]] | 301 | [[The image object to use for an icon.]] |
309 | } | 302 | } |
310 | } | 303 | } |
311 | get { | 304 | get { |
312 | [[Get the icon object used for the window. | ||
313 | |||
314 | The object returns is the one marked by @.icon_object.set as | ||
315 | the object to use for the window icon. | ||
316 | ]] | ||
317 | values { | 305 | values { |
318 | icon: const(Efl.Canvas.Object); | 306 | icon: const(Efl.Canvas.Object); |
319 | [[The Evas image object to use for an icon.]] | 307 | [[The Evas image object to use for an icon.]] |
@@ -321,60 +309,55 @@ class Efl.Ui.Win extends Efl.Ui.Widget implements Efl.Canvas.Scene, Efl.Access.W | |||
321 | } | 309 | } |
322 | } | 310 | } |
323 | @property minimized { | 311 | @property minimized { |
312 | [[The minimized state of a window.]] | ||
324 | set { | 313 | set { |
325 | [[Set the minimized state of a window.]] | ||
326 | } | 314 | } |
327 | get { | 315 | get { |
328 | [[Get the minimized state of a window.]] | ||
329 | } | 316 | } |
330 | values { | 317 | values { |
331 | state: bool; [[If $true, the window is minimized.]] | 318 | state: bool; [[If $true, the window is minimized.]] |
332 | } | 319 | } |
333 | } | 320 | } |
334 | @property maximized { | 321 | @property maximized { |
322 | [[The maximized state of a window.]] | ||
335 | set { | 323 | set { |
336 | [[Set the maximized state of a window.]] | ||
337 | } | 324 | } |
338 | get { | 325 | get { |
339 | [[Get the maximized state of a window.]] | ||
340 | } | 326 | } |
341 | values { | 327 | values { |
342 | maximized: bool; [[If $true, the window is maximized.]] | 328 | maximized: bool; [[If $true, the window is maximized.]] |
343 | } | 329 | } |
344 | } | 330 | } |
345 | @property fullscreen { | 331 | @property fullscreen { |
332 | [[The fullscreen state of a window.]] | ||
346 | set { | 333 | set { |
347 | [[Set the fullscreen state of a window.]] | ||
348 | } | 334 | } |
349 | get { | 335 | get { |
350 | [[Get the fullscreen state of a window.]] | ||
351 | } | 336 | } |
352 | values { | 337 | values { |
353 | fullscreen: bool; [[If $true, the window is fullscreen.]] | 338 | fullscreen: bool; [[If $true, the window is fullscreen.]] |
354 | } | 339 | } |
355 | } | 340 | } |
356 | @property sticky @beta { | 341 | @property sticky @beta { |
357 | set { | 342 | [[The sticky state of the window. |
358 | [[Set the sticky state of the window. | ||
359 | 343 | ||
360 | Hints the Window Manager that the window in $obj should be | 344 | Hints the Window Manager that the window in $obj should be |
361 | left fixed at its position even when the virtual desktop | 345 | left fixed at its position even when the virtual desktop |
362 | it's on moves or changes. | 346 | it's on moves or changes. |
363 | ]] | 347 | ]] |
348 | set { | ||
364 | } | 349 | } |
365 | get { | 350 | get { |
366 | [[Get the sticky state of the window.]] | ||
367 | } | 351 | } |
368 | values { | 352 | values { |
369 | sticky: bool; [[If $true, the window's sticky state is enabled.]] | 353 | sticky: bool; [[If $true, the window's sticky state is enabled.]] |
370 | } | 354 | } |
371 | } | 355 | } |
372 | @property urgent @beta { | 356 | @property urgent @beta { |
357 | [[The urgent state of a window.]] | ||
373 | set { | 358 | set { |
374 | [[Set the urgent state of a window.]] | ||
375 | } | 359 | } |
376 | get { | 360 | get { |
377 | [[Get the urgent state of a window.]] | ||
378 | } | 361 | } |
379 | values { | 362 | values { |
380 | urgent: Efl.Ui.Win_Urgent_Mode; | 363 | urgent: Efl.Ui.Win_Urgent_Mode; |
@@ -382,26 +365,24 @@ class Efl.Ui.Win extends Efl.Ui.Widget implements Efl.Canvas.Scene, Efl.Access.W | |||
382 | } | 365 | } |
383 | } | 366 | } |
384 | @property modal @beta { | 367 | @property modal @beta { |
368 | [[The modal state of a window.]] | ||
385 | set { | 369 | set { |
386 | [[Set the modal state of a window.]] | ||
387 | } | 370 | } |
388 | get { | 371 | get { |
389 | [[Get the modal state of a window.]] | ||
390 | } | 372 | } |
391 | values { | 373 | values { |
392 | modal: Efl.Ui.Win_Modal_Mode; [[The mode of a window, one of @Efl.Ui.Win_Modal_Mode.]] | 374 | modal: Efl.Ui.Win_Modal_Mode; [[The mode of a window, one of @Efl.Ui.Win_Modal_Mode.]] |
393 | } | 375 | } |
394 | } | 376 | } |
395 | @property borderless @beta { | 377 | @property borderless @beta { |
396 | set { | 378 | [[The borderless state of a window. |
397 | [[Set the borderless state of a window. | ||
398 | 379 | ||
399 | This function requests the Window Manager not to draw any | 380 | This function requests the Window Manager not to draw any |
400 | decoration around the window. | 381 | decoration around the window. |
401 | ]] | 382 | ]] |
383 | set { | ||
402 | } | 384 | } |
403 | get { | 385 | get { |
404 | [[Get the borderless state of a window.]] | ||
405 | } | 386 | } |
406 | values { | 387 | values { |
407 | borderless: bool; [[If $true, the window is borderless.]] | 388 | borderless: bool; [[If $true, the window is borderless.]] |
@@ -413,17 +394,14 @@ class Efl.Ui.Win extends Efl.Ui.Widget implements Efl.Canvas.Scene, Efl.Access.W | |||
413 | 394 | ||
414 | It is a hint of how the Window Manager should handle it. Unlike | 395 | It is a hint of how the Window Manager should handle it. Unlike |
415 | @.win_type and @.win_name this can be changed at runtime. | 396 | @.win_type and @.win_name this can be changed at runtime. |
397 | |||
398 | The returned string is an internal one and should not be | ||
399 | freed or modified. It will also be invalid if a new role | ||
400 | is set or if the window is destroyed. | ||
416 | ]] | 401 | ]] |
417 | set { | 402 | set { |
418 | [[Set the role of the window.]] | ||
419 | } | 403 | } |
420 | get { | 404 | get { |
421 | [[Get the role of the window. | ||
422 | |||
423 | The returned string is an internal one and should not be | ||
424 | freed or modified. It will also be invalid if a new role | ||
425 | is set or if the window is destroyed. | ||
426 | ]] | ||
427 | } | 405 | } |
428 | values { | 406 | values { |
429 | role: string; [[The role to set.]] | 407 | role: string; [[The role to set.]] |
@@ -522,24 +500,23 @@ class Efl.Ui.Win extends Efl.Ui.Widget implements Efl.Canvas.Scene, Efl.Access.W | |||
522 | } | 500 | } |
523 | } | 501 | } |
524 | @property alpha { | 502 | @property alpha { |
503 | [[The alpha channel state of a window. | ||
504 | |||
505 | If $alpha is true, the alpha channel of the canvas will be | ||
506 | enabled possibly making parts of the window completely or | ||
507 | partially transparent. This is also subject to the underlying | ||
508 | system supporting it, for example a system using a | ||
509 | compositing manager. | ||
510 | |||
511 | Note: Alpha window can be enabled automatically by window | ||
512 | theme style's property. If "alpha" data.item is "1" or | ||
513 | "true" in window style(eg. elm/win/base/default), the window | ||
514 | is switched to alpha automatically without the explicit api | ||
515 | call. | ||
516 | ]] | ||
525 | set { | 517 | set { |
526 | [[Set the alpha channel state of a window. | ||
527 | |||
528 | If $alpha is true, the alpha channel of the canvas will be | ||
529 | enabled possibly making parts of the window completely or | ||
530 | partially transparent. This is also subject to the underlying | ||
531 | system supporting it, for example a system using a | ||
532 | compositing manager. | ||
533 | |||
534 | Note: Alpha window can be enabled automatically by window | ||
535 | theme style's property. If "alpha" data.item is "1" or | ||
536 | "true" in window style(eg. elm/win/base/default), the window | ||
537 | is switched to alpha automatically without the explicit api | ||
538 | call. | ||
539 | ]] | ||
540 | } | 518 | } |
541 | get { | 519 | get { |
542 | [[Get the alpha channel state of a window.]] | ||
543 | } | 520 | } |
544 | values { | 521 | values { |
545 | alpha: bool; [[$true if the window alpha channel is enabled, | 522 | alpha: bool; [[$true if the window alpha channel is enabled, |
@@ -547,19 +524,19 @@ class Efl.Ui.Win extends Efl.Ui.Widget implements Efl.Canvas.Scene, Efl.Access.W | |||
547 | } | 524 | } |
548 | } | 525 | } |
549 | @property stack_id @beta { | 526 | @property stack_id @beta { |
527 | [[Get the stack ID string of the window as an opaque string. | ||
528 | |||
529 | This ID is immutable and can never be modified. It will be | ||
530 | an opaque string that has no specific defined format or | ||
531 | content other than being a string (no character with a | ||
532 | value of 0). | ||
533 | |||
534 | This string is intended for use as a stack master ID to be | ||
535 | use by other windows to make this window part of a stack | ||
536 | of windows to be placed on top of each other as if they are | ||
537 | a series of dialogs or questions one after the other, allowing | ||
538 | you to go back through history.]] | ||
550 | get { | 539 | get { |
551 | [[Get the stack ID string of the window as an opaque string. | ||
552 | |||
553 | This ID is immutable and can never be modified. It will be | ||
554 | an opaque string that has no specific defined format or | ||
555 | content other than being a string (no character with a | ||
556 | value of 0). | ||
557 | |||
558 | This string is intended for use as a stack master ID to be | ||
559 | use by other windows to make this window part of a stack | ||
560 | of windows to be placed on top of each other as if they are | ||
561 | a series of dialogs or questions one after the other, allowing | ||
562 | you to go back through history.]] | ||
563 | } | 540 | } |
564 | values { | 541 | values { |
565 | id: string; [[An opaque string that has no specific format | 542 | id: string; [[An opaque string that has no specific format |
@@ -568,16 +545,15 @@ class Efl.Ui.Win extends Efl.Ui.Widget implements Efl.Canvas.Scene, Efl.Access.W | |||
568 | } | 545 | } |
569 | } | 546 | } |
570 | @property stack_master_id @beta { | 547 | @property stack_master_id @beta { |
571 | set { | 548 | [[The window stack ID to use as the master top-level. |
572 | [[Set the window stack ID to use as the master top-level. | ||
573 | 549 | ||
574 | This sets the ID string to be used as the master top-level | 550 | This sets the ID string to be used as the master top-level |
575 | window as the base of a stack of windows. This must be set | 551 | window as the base of a stack of windows. This must be set |
576 | before the first time the window is shown and should never | 552 | before the first time the window is shown and should never |
577 | be changed afterwards.]] | 553 | be changed afterwards.]] |
554 | set { | ||
578 | } | 555 | } |
579 | get { | 556 | get { |
580 | [[Get the stack master Id that has been set.]] | ||
581 | } | 557 | } |
582 | values { | 558 | values { |
583 | id: string; [[An opaque string that has no specific format, | 559 | id: string; [[An opaque string that has no specific format, |
diff --git a/src/lib/elementary/elm_code_widget.eo b/src/lib/elementary/elm_code_widget.eo index 3e1de99f8a..3de96b1817 100644 --- a/src/lib/elementary/elm_code_widget.eo +++ b/src/lib/elementary/elm_code_widget.eo | |||
@@ -21,26 +21,24 @@ class @beta Elm.Code_Widget extends Efl.Ui.Layout | |||
21 | c_prefix: efl_ui_code_widget; | 21 | c_prefix: efl_ui_code_widget; |
22 | methods { | 22 | methods { |
23 | @property code { | 23 | @property code { |
24 | [[The underlying code object that this widget renders. | ||
25 | This can only be set during construction, once the widget is created the | ||
26 | backing code object cannot be changed.]] | ||
24 | set { | 27 | set { |
25 | [[Set the underlying code object that this widget renders. | ||
26 | This can only be set during construction, once the widget is created the | ||
27 | backing code object cannot be changed.]] | ||
28 | } | 28 | } |
29 | get { | 29 | get { |
30 | [[Get the underlying code object we are rendering]] | ||
31 | } | 30 | } |
32 | values { | 31 | values { |
33 | code: ptr(Elm.Code); [[Our underlying Elm.Code object]] | 32 | code: ptr(Elm.Code); [[Our underlying Elm.Code object]] |
34 | } | 33 | } |
35 | } | 34 | } |
36 | @property font { | 35 | @property font { |
36 | [[Set the font that this widget uses, the font should be a monospaced scalable font. | ||
37 | Passing $NULL will load the default system monospaced font. | ||
38 | When reading, the font name is a copy and should be freed once it is no longer needed.]] | ||
37 | set { | 39 | set { |
38 | [[Set the font that this widget uses, the font should be a monospaced scalable font. | ||
39 | Passing $NULL will load the default system monospaced font.]] | ||
40 | } | 40 | } |
41 | get { | 41 | get { |
42 | [[Get the font currently in use. | ||
43 | The font name is a copy ad should be freed once it is no longer needed]] | ||
44 | } | 42 | } |
45 | values { | 43 | values { |
46 | name: string; [[The name of the font to load]] | 44 | name: string; [[The name of the font to load]] |
@@ -48,24 +46,23 @@ class @beta Elm.Code_Widget extends Efl.Ui.Layout | |||
48 | } | 46 | } |
49 | } | 47 | } |
50 | @property columns { | 48 | @property columns { |
49 | [[The number of columns in the widget currently. | ||
50 | This will be the max of the number of columns to represent the longest line and | ||
51 | the minimum required to fill the visible widget width.]] | ||
51 | get { | 52 | get { |
52 | [[Get the number of columns in the widget currently. | ||
53 | This will be the max of the number of columns to represent the longest line and | ||
54 | the minimum required to fill the visible widget width.]] | ||
55 | } | 53 | } |
56 | values { | 54 | values { |
57 | columns: uint; [[The number of columns required to render the widget]] | 55 | columns: uint; [[The number of columns required to render the widget]] |
58 | } | 56 | } |
59 | } | 57 | } |
60 | @property gravity { | 58 | @property gravity { |
61 | set { | 59 | [[Set how this widget's scroller should respond to new lines being added. |
62 | [[Set how this widget's scroller should respond to new lines being added. | ||
63 | 60 | ||
64 | An x value of 0.0 will maintain the distance from the left edge, 1.0 will ensure the rightmost edge (of the longest line) is respected | 61 | An x value of 0.0 will maintain the distance from the left edge, 1.0 will ensure the rightmost edge (of the longest line) is respected |
65 | With 0.0 for y the view will keep it's position relative to the top whereas 1.0 will scroll downward as lines are added.]] | 62 | With 0.0 for y the view will keep it's position relative to the top whereas 1.0 will scroll downward as lines are added.]] |
63 | set { | ||
66 | } | 64 | } |
67 | get { | 65 | get { |
68 | [[Get the current x and y gravity of the widget's scroller]] | ||
69 | } | 66 | } |
70 | values { | 67 | values { |
71 | x: double; [[The horizontal value of the scroller gravity - valid values are 0.0 and 1.0]] | 68 | x: double; [[The horizontal value of the scroller gravity - valid values are 0.0 and 1.0]] |
@@ -73,11 +70,10 @@ class @beta Elm.Code_Widget extends Efl.Ui.Layout | |||
73 | } | 70 | } |
74 | } | 71 | } |
75 | @property policy { | 72 | @property policy { |
73 | [[The widget's policy for scrollbar visibility.]] | ||
76 | set { | 74 | set { |
77 | [[Set the policy for scrollbar visibility.]] | ||
78 | } | 75 | } |
79 | get { | 76 | get { |
80 | [[Get the widget's policy for scrollbar visibility.]] | ||
81 | } | 77 | } |
82 | values { | 78 | values { |
83 | policy_h: Elm.Code_Widget_Scroller_Policy; [[The horizontal scrollbar visibility policy]] | 79 | policy_h: Elm.Code_Widget_Scroller_Policy; [[The horizontal scrollbar visibility policy]] |
@@ -85,32 +81,28 @@ class @beta Elm.Code_Widget extends Efl.Ui.Layout | |||
85 | } | 81 | } |
86 | } | 82 | } |
87 | @property tabstop { | 83 | @property tabstop { |
88 | set { | 84 | [[The width of a tab stop, used purely for visual layout of tab characters. |
89 | [[Set the width of a tab stop, used purely for visual layout of tab characters. | ||
90 | 85 | ||
91 | Recommended value is between 2 and 8.]] | 86 | Recommended value is between 2 and 8.]] |
87 | set { | ||
92 | } | 88 | } |
93 | get { | 89 | get { |
94 | [[Get the current width of a tab stop. | ||
95 | This is used to determine where characters after a tab should appear in the line.]] | ||
96 | } | 90 | } |
97 | values { | 91 | values { |
98 | tabstop: uint; [[Maximum width of a tab character]] | 92 | tabstop: uint; [[Maximum width of a tab character]] |
99 | } | 93 | } |
100 | } | 94 | } |
101 | @property editable { | 95 | @property editable { |
102 | set { | 96 | [[Whether this widget allows editing. |
103 | [[Set whether this widget allows editing | ||
104 | 97 | ||
105 | If editable then the widget will allow user input to manipulate | 98 | If editable then the widget will allow user input to manipulate |
106 | the underlying Elm.Code_File of this Elm.Code instance. | 99 | the underlying Elm.Code_File of this Elm.Code instance. |
107 | Any other Elm.Code_Widget's connected to this Elm.Code will | 100 | Any other Elm.Code_Widget's connected to this Elm.Code will |
108 | update to reflect the changes.]] | 101 | update to reflect the changes.]] |
102 | set { | ||
109 | } | 103 | } |
110 | get { | 104 | get { |
111 | [[Get the current editable state of this widget | 105 | [[Returns EINA_TRUE if the widget is editable, EINA_FALSE otherwise. |
112 | |||
113 | returns EINA_TRUE if the widget is editable, EINA_FALSE otherwise. | ||
114 | If this widget is not editable the underlying Elm.Code_File could | 106 | If this widget is not editable the underlying Elm.Code_File could |
115 | still be manipulated by a different widget or the filesystem.]] | 107 | still be manipulated by a different widget or the filesystem.]] |
116 | } | 108 | } |
@@ -119,39 +111,36 @@ class @beta Elm.Code_Widget extends Efl.Ui.Layout | |||
119 | } | 111 | } |
120 | } | 112 | } |
121 | @property line_numbers { | 113 | @property line_numbers { |
122 | set { | 114 | [[Whether line numbers should be displayed in the left gutter. |
123 | [[Set whether line numbers should be displayed in the left gutter. | ||
124 | 115 | ||
125 | Passing EINA_TRUE will reserve a space for showing line numbers, | 116 | Passing EINA_TRUE will reserve a space for showing line numbers, |
126 | EINA_FALSE will turn this off.]] | 117 | EINA_FALSE will turn this off.]] |
118 | set { | ||
127 | } | 119 | } |
128 | get { | 120 | get { |
129 | [[Get the status of line number display for this widget.]] | ||
130 | } | 121 | } |
131 | values { | 122 | values { |
132 | line_numbers: bool; [[Whether or not line numbers (or their placeholder) should be shown]] | 123 | line_numbers: bool; [[Whether or not line numbers (or their placeholder) should be shown]] |
133 | } | 124 | } |
134 | } | 125 | } |
135 | @property line_width_marker { | 126 | @property line_width_marker { |
136 | set { | 127 | [[Where the line width market should be shown. |
137 | [[Set where the line width market should be shown. | ||
138 | 128 | ||
139 | Passing a non-zero value will set which line width to mark with a vertical line. | 129 | Passing a non-zero value will set which line width to mark with a vertical line. |
140 | Passing 0 will hide this marker.]] | 130 | Passing 0 will hide this marker.]] |
131 | set { | ||
141 | } | 132 | } |
142 | get { | 133 | get { |
143 | [[Get the position of the line width marker, any positive return indicates where the marker appears.]] | ||
144 | } | 134 | } |
145 | values { | 135 | values { |
146 | line_width_marker: uint; [[Where to display a line width marker, if at all]] | 136 | line_width_marker: uint; [[Where to display a line width marker, if at all]] |
147 | } | 137 | } |
148 | } | 138 | } |
149 | @property show_whitespace { | 139 | @property show_whitespace { |
140 | [[Whether white space should be shown.]] | ||
150 | set { | 141 | set { |
151 | [[Set whether white space should be shown.]] | ||
152 | } | 142 | } |
153 | get { | 143 | get { |
154 | [[Get whether or not white space will be visible.]] | ||
155 | } | 144 | } |
156 | values { | 145 | values { |
157 | show_whitespace: bool; [[Whether or not we show whitespace characters]] | 146 | show_whitespace: bool; [[Whether or not we show whitespace characters]] |
@@ -168,33 +157,30 @@ class @beta Elm.Code_Widget extends Efl.Ui.Layout | |||
168 | } | 157 | } |
169 | } | 158 | } |
170 | @property syntax_enabled { | 159 | @property syntax_enabled { |
160 | [[Whether syntax highlighting should be use for this widget.]] | ||
171 | set { | 161 | set { |
172 | [[Set whether syntax highlighting should be use for this widget.]] | ||
173 | } | 162 | } |
174 | get { | 163 | get { |
175 | [[Get this widget's enabled state for syntax highlighting.]] | ||
176 | } | 164 | } |
177 | values { | 165 | values { |
178 | syntax_enabled: bool; [[Whether or not to enable syntax highlighting]] | 166 | syntax_enabled: bool; [[Whether or not to enable syntax highlighting]] |
179 | } | 167 | } |
180 | } | 168 | } |
181 | @property tab_inserts_spaces { | 169 | @property tab_inserts_spaces { |
170 | [[Whether space characters should be inserted instead of tabs.]] | ||
182 | set { | 171 | set { |
183 | [[Set whether space characters should be inserted instead of tabs.]] | ||
184 | } | 172 | } |
185 | get { | 173 | get { |
186 | [[Get whether or not space characters will be inserted instead of tabs.]] | ||
187 | } | 174 | } |
188 | values { | 175 | values { |
189 | tab_inserts_spaces: bool; [[$true if we should insert space characters instead of a tab when the Tab key is pressed]] | 176 | tab_inserts_spaces: bool; [[$true if we should insert space characters instead of a tab when the Tab key is pressed]] |
190 | } | 177 | } |
191 | } | 178 | } |
192 | @property cursor_position { | 179 | @property cursor_position { |
180 | [[The current location of the text cursor.]] | ||
193 | set { | 181 | set { |
194 | [[Set the current location of the text cursor.]] | ||
195 | } | 182 | } |
196 | get { | 183 | get { |
197 | [[Get the current x and y position of the widget's cursor.]] | ||
198 | } | 184 | } |
199 | values { | 185 | values { |
200 | row: uint; [[The vertical position ov the cursur - the fist row is 1]] | 186 | row: uint; [[The vertical position ov the cursur - the fist row is 1]] |
diff --git a/src/lib/elementary/elm_interface_scrollable.eo b/src/lib/elementary/elm_interface_scrollable.eo index c1240733b7..86725b59bd 100644 --- a/src/lib/elementary/elm_interface_scrollable.eo +++ b/src/lib/elementary/elm_interface_scrollable.eo | |||
@@ -223,7 +223,7 @@ mixin @beta Elm.Interface_Scrollable requires Efl.Ui.Widget extends Efl.Ui.Scrol | |||
223 | } | 223 | } |
224 | } | 224 | } |
225 | @property paging { | 225 | @property paging { |
226 | [[Pagin property]] | 226 | [[Paging property]] |
227 | set { | 227 | set { |
228 | } | 228 | } |
229 | get { | 229 | get { |
@@ -279,31 +279,31 @@ mixin @beta Elm.Interface_Scrollable requires Efl.Ui.Widget extends Efl.Ui.Scrol | |||
279 | } | 279 | } |
280 | } | 280 | } |
281 | @property scroll_up_cb { | 281 | @property scroll_up_cb { |
282 | [[Set the callback to run when the content has been moved up.]] | ||
282 | set { | 283 | set { |
283 | [[Set the callback to run when the content has been moved up.]] | ||
284 | } | 284 | } |
285 | values { | 285 | values { |
286 | scroll_up_cb: Elm_Interface_Scrollable_Cb; [[The callback]] | 286 | scroll_up_cb: Elm_Interface_Scrollable_Cb; [[The callback]] |
287 | } | 287 | } |
288 | } | 288 | } |
289 | @property hbar_drag_cb { | 289 | @property hbar_drag_cb { |
290 | [[Set the callback to run when the horizontal scrollbar is dragged.]] | ||
290 | set { | 291 | set { |
291 | [[Set the callback to run when the horizontal scrollbar is dragged.]] | ||
292 | } | 292 | } |
293 | values { | 293 | values { |
294 | hbar_drag_cb: Elm_Interface_Scrollable_Cb; [[The callback]] | 294 | hbar_drag_cb: Elm_Interface_Scrollable_Cb; [[The callback]] |
295 | } | 295 | } |
296 | } | 296 | } |
297 | @property drag_start_cb { | 297 | @property drag_start_cb { |
298 | [[Set the callback to run when dragging of the contents has started.]] | ||
298 | set { | 299 | set { |
299 | [[Set the callback to run when dragging of the contents has started.]] | ||
300 | } | 300 | } |
301 | values { | 301 | values { |
302 | drag_start_cb: Elm_Interface_Scrollable_Cb; [[The callback]] | 302 | drag_start_cb: Elm_Interface_Scrollable_Cb; [[The callback]] |
303 | } | 303 | } |
304 | } | 304 | } |
305 | @property freeze { | 305 | @property freeze { |
306 | [[Freeze property]] | 306 | [[Freeze property]] |
307 | set { | 307 | set { |
308 | } | 308 | } |
309 | values { | 309 | values { |
@@ -311,48 +311,48 @@ mixin @beta Elm.Interface_Scrollable requires Efl.Ui.Widget extends Efl.Ui.Scrol | |||
311 | } | 311 | } |
312 | } | 312 | } |
313 | @property content_viewport_resize_cb { | 313 | @property content_viewport_resize_cb { |
314 | [[When the viewport is resized, the callback is called.]] | ||
314 | set { | 315 | set { |
315 | [[When the viewport is resized, the callback is called.]] | ||
316 | } | 316 | } |
317 | values { | 317 | values { |
318 | viewport_resize_cb: Elm_Interface_Scrollable_Resize_Cb; [[The callback]] | 318 | viewport_resize_cb: Elm_Interface_Scrollable_Resize_Cb; [[The callback]] |
319 | } | 319 | } |
320 | } | 320 | } |
321 | @property scroll_left_cb { | 321 | @property scroll_left_cb { |
322 | [[Set the callback to run when the content has been moved to the left]] | ||
322 | set { | 323 | set { |
323 | [[Set the callback to run when the content has been moved to the left]] | ||
324 | } | 324 | } |
325 | values { | 325 | values { |
326 | scroll_left_cb: Elm_Interface_Scrollable_Cb; [[The callback]] | 326 | scroll_left_cb: Elm_Interface_Scrollable_Cb; [[The callback]] |
327 | } | 327 | } |
328 | } | 328 | } |
329 | @property vbar_press_cb { | 329 | @property vbar_press_cb { |
330 | [[Set the callback to run when the vertical scrollbar is pressed.]] | ||
330 | set { | 331 | set { |
331 | [[Set the callback to run when the vertical scrollbar is pressed.]] | ||
332 | } | 332 | } |
333 | values { | 333 | values { |
334 | vbar_press_cb: Elm_Interface_Scrollable_Cb; [[The callback]] | 334 | vbar_press_cb: Elm_Interface_Scrollable_Cb; [[The callback]] |
335 | } | 335 | } |
336 | } | 336 | } |
337 | @property hbar_press_cb { | 337 | @property hbar_press_cb { |
338 | [[Set the callback to run when the horizontal scrollbar is pressed.]] | ||
338 | set { | 339 | set { |
339 | [[Set the callback to run when the horizontal scrollbar is pressed.]] | ||
340 | } | 340 | } |
341 | values { | 341 | values { |
342 | hbar_press_cb: Elm_Interface_Scrollable_Cb; [[The callback]] | 342 | hbar_press_cb: Elm_Interface_Scrollable_Cb; [[The callback]] |
343 | } | 343 | } |
344 | } | 344 | } |
345 | @property hbar_unpress_cb { | 345 | @property hbar_unpress_cb { |
346 | [[Set the callback to run when the horizontal scrollbar is unpressed.]] | ||
346 | set { | 347 | set { |
347 | [[Set the callback to run when the horizontal scrollbar is unpressed.]] | ||
348 | } | 348 | } |
349 | values { | 349 | values { |
350 | hbar_unpress_cb: Elm_Interface_Scrollable_Cb; [[The callback]] | 350 | hbar_unpress_cb: Elm_Interface_Scrollable_Cb; [[The callback]] |
351 | } | 351 | } |
352 | } | 352 | } |
353 | @property drag_stop_cb { | 353 | @property drag_stop_cb { |
354 | [[Set the callback to run when dragging of the contents has stopped.]] | ||
354 | set { | 355 | set { |
355 | [[Set the callback to run when dragging of the contents has stopped.]] | ||
356 | } | 356 | } |
357 | values { | 357 | values { |
358 | drag_stop_cb: Elm_Interface_Scrollable_Cb; [[The callback]] | 358 | drag_stop_cb: Elm_Interface_Scrollable_Cb; [[The callback]] |
@@ -367,8 +367,8 @@ mixin @beta Elm.Interface_Scrollable requires Efl.Ui.Widget extends Efl.Ui.Scrol | |||
367 | } | 367 | } |
368 | } | 368 | } |
369 | @property page_change_cb { | 369 | @property page_change_cb { |
370 | [[Set the callback to run when the visible page changes.]] | ||
370 | set { | 371 | set { |
371 | [[Set the callback to run when the visible page changes.]] | ||
372 | } | 372 | } |
373 | values { | 373 | values { |
374 | page_change_cb: Elm_Interface_Scrollable_Cb; [[The callback]] | 374 | page_change_cb: Elm_Interface_Scrollable_Cb; [[The callback]] |
@@ -383,24 +383,24 @@ mixin @beta Elm.Interface_Scrollable requires Efl.Ui.Widget extends Efl.Ui.Scrol | |||
383 | } | 383 | } |
384 | } | 384 | } |
385 | @property animate_start_cb { | 385 | @property animate_start_cb { |
386 | [[Set the callback to run when the scrolling animation has started.]] | ||
386 | set { | 387 | set { |
387 | [[Set the callback to run when the scrolling animation has started.]] | ||
388 | } | 388 | } |
389 | values { | 389 | values { |
390 | animate_start_cb: Elm_Interface_Scrollable_Cb; [[The callback]] | 390 | animate_start_cb: Elm_Interface_Scrollable_Cb; [[The callback]] |
391 | } | 391 | } |
392 | } | 392 | } |
393 | @property scroll_down_cb { | 393 | @property scroll_down_cb { |
394 | [[Set the callback to run when the content has been moved down.]] | ||
394 | set { | 395 | set { |
395 | [[Set the callback to run when the content has been moved down.]] | ||
396 | } | 396 | } |
397 | values { | 397 | values { |
398 | scroll_down_cb: Elm_Interface_Scrollable_Cb; [[The callback]] | 398 | scroll_down_cb: Elm_Interface_Scrollable_Cb; [[The callback]] |
399 | } | 399 | } |
400 | } | 400 | } |
401 | @property page_relative { | 401 | @property page_relative { |
402 | [[Set scroll page size relative to viewport size.]] | ||
402 | set { | 403 | set { |
403 | [[Set scroll page size relative to viewport size.]] | ||
404 | } | 404 | } |
405 | values { | 405 | values { |
406 | h_pagerel: double; [[Page relation horizontal]] | 406 | h_pagerel: double; [[Page relation horizontal]] |
@@ -408,23 +408,23 @@ mixin @beta Elm.Interface_Scrollable requires Efl.Ui.Widget extends Efl.Ui.Scrol | |||
408 | } | 408 | } |
409 | } | 409 | } |
410 | @property scroll_cb { | 410 | @property scroll_cb { |
411 | [[Set the callback to run when the content has been moved.]] | ||
411 | set { | 412 | set { |
412 | [[Set the callback to run when the content has been moved.]] | ||
413 | } | 413 | } |
414 | values { | 414 | values { |
415 | scroll_cb: Elm_Interface_Scrollable_Cb; [[The callback]] | 415 | scroll_cb: Elm_Interface_Scrollable_Cb; [[The callback]] |
416 | } | 416 | } |
417 | } | 417 | } |
418 | @property animate_stop_cb { | 418 | @property animate_stop_cb { |
419 | [[Set the callback to run when the scrolling animation has stopped.]] | ||
419 | set { | 420 | set { |
420 | [[Set the callback to run when the scrolling animation has stopped.]] | ||
421 | } | 421 | } |
422 | values { | 422 | values { |
423 | animate_stop_cb: Elm_Interface_Scrollable_Cb; [[The callback]] | 423 | animate_stop_cb: Elm_Interface_Scrollable_Cb; [[The callback]] |
424 | } | 424 | } |
425 | } | 425 | } |
426 | @property content_min_limit_cb { | 426 | @property content_min_limit_cb { |
427 | [[set the callback to run on minimal limit content]] | 427 | [[set the callback to run on minimal limit content]] |
428 | set { | 428 | set { |
429 | } | 429 | } |
430 | values { | 430 | values { |
@@ -432,15 +432,15 @@ mixin @beta Elm.Interface_Scrollable requires Efl.Ui.Widget extends Efl.Ui.Scrol | |||
432 | } | 432 | } |
433 | } | 433 | } |
434 | @property scroll_right_cb { | 434 | @property scroll_right_cb { |
435 | [[Set the callback to run when the content has been moved to the right.]] | ||
435 | set { | 436 | set { |
436 | [[Set the callback to run when the content has been moved to the right.]] | ||
437 | } | 437 | } |
438 | values { | 438 | values { |
439 | scroll_right_cb: Elm_Interface_Scrollable_Cb; [[The callback]] | 439 | scroll_right_cb: Elm_Interface_Scrollable_Cb; [[The callback]] |
440 | } | 440 | } |
441 | } | 441 | } |
442 | @property scrollable_content { | 442 | @property scrollable_content { |
443 | [[Content property]] | 443 | [[Content property]] |
444 | set { | 444 | set { |
445 | } | 445 | } |
446 | values { | 446 | values { |
@@ -448,55 +448,55 @@ mixin @beta Elm.Interface_Scrollable requires Efl.Ui.Widget extends Efl.Ui.Scrol | |||
448 | } | 448 | } |
449 | } | 449 | } |
450 | @property edge_left_cb { | 450 | @property edge_left_cb { |
451 | [[Set the callback to run when the left edge of the content has been reached.]] | ||
451 | set { | 452 | set { |
452 | [[Set the callback to run when the left edge of the content has been reached.]] | ||
453 | } | 453 | } |
454 | values { | 454 | values { |
455 | edge_left_cb: Elm_Interface_Scrollable_Cb; [[The callback]] | 455 | edge_left_cb: Elm_Interface_Scrollable_Cb; [[The callback]] |
456 | } | 456 | } |
457 | } | 457 | } |
458 | @property vbar_drag_cb { | 458 | @property vbar_drag_cb { |
459 | [[Set the callback to run when the horizontal scrollbar is dragged.]] | ||
459 | set { | 460 | set { |
460 | [[Set the callback to run when the horizontal scrollbar is dragged.]] | ||
461 | } | 461 | } |
462 | values { | 462 | values { |
463 | vbar_drag_cb: Elm_Interface_Scrollable_Cb; [[The callback]] | 463 | vbar_drag_cb: Elm_Interface_Scrollable_Cb; [[The callback]] |
464 | } | 464 | } |
465 | } | 465 | } |
466 | @property vbar_unpress_cb { | 466 | @property vbar_unpress_cb { |
467 | [[Set the callback to run when the horizontal scrollbar is unpressed.]] | ||
467 | set { | 468 | set { |
468 | [[Set the callback to run when the horizontal scrollbar is unpressed.]] | ||
469 | } | 469 | } |
470 | values { | 470 | values { |
471 | vbar_unpress_cb: Elm_Interface_Scrollable_Cb; [[The callback]] | 471 | vbar_unpress_cb: Elm_Interface_Scrollable_Cb; [[The callback]] |
472 | } | 472 | } |
473 | } | 473 | } |
474 | @property edge_bottom_cb { | 474 | @property edge_bottom_cb { |
475 | [[Set the callback to run when the bottom edge of the content has been reached.]] | ||
475 | set { | 476 | set { |
476 | [[Set the callback to run when the bottom edge of the content has been reached.]] | ||
477 | } | 477 | } |
478 | values { | 478 | values { |
479 | edge_bottom_cb: Elm_Interface_Scrollable_Cb; [[The callback]] | 479 | edge_bottom_cb: Elm_Interface_Scrollable_Cb; [[The callback]] |
480 | } | 480 | } |
481 | } | 481 | } |
482 | @property edge_right_cb { | 482 | @property edge_right_cb { |
483 | [[Set the callback to run when the right edge of the content has been reached.]] | ||
483 | set { | 484 | set { |
484 | [[Set the callback to run when the right edge of the content has been reached.]] | ||
485 | } | 485 | } |
486 | values { | 486 | values { |
487 | edge_right_cb: Elm_Interface_Scrollable_Cb; [[The callback]] | 487 | edge_right_cb: Elm_Interface_Scrollable_Cb; [[The callback]] |
488 | } | 488 | } |
489 | } | 489 | } |
490 | @property edge_top_cb { | 490 | @property edge_top_cb { |
491 | [[Set the callback to run when the top edge of the content has been reached.]] | ||
491 | set { | 492 | set { |
492 | [[Set the callback to run when the top edge of the content has been reached.]] | ||
493 | } | 493 | } |
494 | values { | 494 | values { |
495 | edge_top_cb: Elm_Interface_Scrollable_Cb; [[The callback]] | 495 | edge_top_cb: Elm_Interface_Scrollable_Cb; [[The callback]] |
496 | } | 496 | } |
497 | } | 497 | } |
498 | @property objects { | 498 | @property objects { |