summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndy Williams <andy@andywilliams.me>2017-12-22 13:45:48 +0000
committerAndy Williams <andy@andywilliams.me>2017-12-22 13:45:48 +0000
commit6ecad5b873a101c821d337da69bd52d22242325b (patch)
tree8945dab73baf266eba5c84b84f52248428c4ac21
parent9a4eedb078bde1ea15d80ba2f285f7d2dc672c10 (diff)
docs: Update evas canvas eo files for grammar and readability
Author: Nate Drake
-rw-r--r--src/lib/evas/canvas/efl_canvas_filter_internal.eo4
-rw-r--r--src/lib/evas/canvas/efl_canvas_group.eo24
-rw-r--r--src/lib/evas/canvas/efl_canvas_object.eo22
-rw-r--r--src/lib/evas/canvas/efl_canvas_object_event_grabber.eo6
-rw-r--r--src/lib/evas/canvas/efl_canvas_text.eo6
-rw-r--r--src/lib/evas/canvas/efl_gfx_map.eo22
-rw-r--r--src/lib/evas/canvas/efl_vg.eo18
-rw-r--r--src/lib/evas/canvas/evas_box.eo4
-rw-r--r--src/lib/evas/canvas/evas_canvas.eo26
-rw-r--r--src/lib/evas/canvas/evas_canvas3d_node.eo8
-rw-r--r--src/lib/evas/canvas/evas_canvas3d_primitive.eo30
-rw-r--r--src/lib/evas/canvas/evas_canvas3d_scene.eo8
-rw-r--r--src/lib/evas/canvas/evas_canvas3d_texture.eo14
-rw-r--r--src/lib/evas/canvas/evas_table.eo8
14 files changed, 100 insertions, 100 deletions
diff --git a/src/lib/evas/canvas/efl_canvas_filter_internal.eo b/src/lib/evas/canvas/efl_canvas_filter_internal.eo
index f8a21baaf6..0a2c34b547 100644
--- a/src/lib/evas/canvas/efl_canvas_filter_internal.eo
+++ b/src/lib/evas/canvas/efl_canvas_filter_internal.eo
@@ -93,11 +93,11 @@ mixin Efl.Canvas.Filter.Internal (Efl.Gfx.Filter, Efl.Object)
93 b: int; [[Bottom]] 93 b: int; [[Bottom]]
94 x: int; [[X offset]] 94 x: int; [[X offset]]
95 y: int; [[Y offset]] 95 y: int; [[Y offset]]
96 do_async: bool; [[$true when the operation should be done asynchronous, $false otherwise]] 96 do_async: bool; [[$true when the operation should be done asynchronously, $false otherwise]]
97 } 97 }
98 } 98 }
99 filter_dirty @protected @pure_virtual { 99 filter_dirty @protected @pure_virtual {
100 [[Called when the filter changes must trigger a redraw of the object. 100 [[Called when filter changes must trigger a redraw of the object.
101 101
102 Virtual, to be implemented in the parent class. 102 Virtual, to be implemented in the parent class.
103 ]] 103 ]]
diff --git a/src/lib/evas/canvas/efl_canvas_group.eo b/src/lib/evas/canvas/efl_canvas_group.eo
index 4b0477d891..62c6df5bde 100644
--- a/src/lib/evas/canvas/efl_canvas_group.eo
+++ b/src/lib/evas/canvas/efl_canvas_group.eo
@@ -1,28 +1,28 @@
1class Efl.Canvas.Group (Efl.Canvas.Object) 1class Efl.Canvas.Group (Efl.Canvas.Object)
2{ 2{
3 [[A group object is a container of other canvas objects. Its children 3 [[A group object is a container for other canvas objects. Its children
4 move along their parent, are often clipped with a common clipper. 4 move along their parent and are often clipped with a common clipper.
5 This is part of the legacy smart object concept. 5 This is part of the legacy smart object concept.
6 6
7 A group is not necessarily a container (see @Efl.Container), in the 7 A group is not necessarily a container (see @Efl.Container) in the
8 sense that a standard widget may not have any empty slots for content, 8 sense that a standard widget may not have any empty slots for content.
9 but is still a group of low-level canvas objects (clipper, raw objects, 9 However it's still a group of low-level canvas objects (clipper, raw objects,
10 etc...). 10 etc.).
11 ]] 11 ]]
12 legacy_prefix: evas_object_smart; 12 legacy_prefix: evas_object_smart;
13 data: Evas_Smart_Data; 13 data: Evas_Smart_Data;
14 methods { 14 methods {
15 @property group_need_recalculate { 15 @property group_need_recalculate {
16 [[Indicates that the group's layout need to be recalculated. 16 [[Indicates that the group's layout needs to be recalculated.
17 17
18 If this flag is set, then the @.group_calculate function will 18 If this flag is set, then the @.group_calculate function will
19 be called, during rendering phase of the canvas. After that, 19 be called, during rendering phase of the canvas. After that,
20 this flag will be automatically unset. 20 this flag will be automatically unset.
21 21
22 Note: just setting this flag will not make the canvas' whole scene 22 Note: setting this flag alone will not make the canvas' whole scene
23 dirty, by itself, and evas_render() will have no effect. To 23 dirty. Using evas_render() will have no effect. To
24 force that, use @.group_change, that will also call this function 24 force this, use @.group_change, which will also call this function
25 automatically, with $true as parameter. 25 automatically, with the parameter set to $true.
26 26
27 See also @.group_calculate. 27 See also @.group_calculate.
28 ]] 28 ]]
@@ -53,7 +53,7 @@ class Efl.Canvas.Group (Efl.Canvas.Object)
53 legacy: evas_object_smart_calculate; 53 legacy: evas_object_smart_calculate;
54 } 54 }
55 group_members_iterate @const { 55 group_members_iterate @const {
56 [[Returns an iterator over the children of this object, that are 56 [[Returns an iterator over the children of this object, which are
57 canvas objects. 57 canvas objects.
58 58
59 This returns the list of "smart" children. This might be different 59 This returns the list of "smart" children. This might be different
diff --git a/src/lib/evas/canvas/efl_canvas_object.eo b/src/lib/evas/canvas/efl_canvas_object.eo
index 30a39b4be8..7d85781ef5 100644
--- a/src/lib/evas/canvas/efl_canvas_object.eo
+++ b/src/lib/evas/canvas/efl_canvas_object.eo
@@ -68,7 +68,7 @@ abstract Efl.Canvas.Object (Efl.Object, Efl.Gfx, Efl.Gfx.Color, Efl.Gfx.Stack, E
68 Please do not assume that @Efl.Gfx.Render_Op.copy mode can be 68 Please do not assume that @Efl.Gfx.Render_Op.copy mode can be
69 used to "poke" holes in a window (to see through it), as only the 69 used to "poke" holes in a window (to see through it), as only the
70 compositor can ensure that. Copy mode should only be used with 70 compositor can ensure that. Copy mode should only be used with
71 otherwise opaque widgets, or inside non-window surfaces (eg. a 71 otherwise opaque widgets or inside non-window surfaces (eg. a
72 transparent background inside a buffer canvas). 72 transparent background inside a buffer canvas).
73 ]] 73 ]]
74 set { 74 set {
@@ -85,17 +85,17 @@ abstract Efl.Canvas.Object (Efl.Object, Efl.Gfx, Efl.Gfx.Color, Efl.Gfx.Stack, E
85 set { 85 set {
86 [[Set whether an Evas object is to freeze (discard) events. 86 [[Set whether an Evas object is to freeze (discard) events.
87 87
88 If $freeze is $true, it will make events on $obj to be 88 If $freeze is $true, it will force events on $obj to be
89 discarded. Unlike @.pass_events.set, events will not be 89 discarded. Unlike @.pass_events.set, events will not be
90 passed to next lower object. This API can be used for 90 passed to next lower object. This API can be used for
91 blocking events while $obj is on transiting. 91 blocking events while $obj is in transition.
92 92
93 If $freeze is $false, events will be processed on that 93 If $freeze is $false, events will be processed on that
94 object as normal. 94 object as normal.
95 95
96 Warning: If you block only key/mouse up events with this API, 96 Warning: If you block only key/mouse up events with this API,
97 we won't guarantee the state of the object, that only had 97 you can't be sure of the state of any objects that have only
98 key/mouse down events, will be. 98 key/mouse down events.
99 99
100 @since 1.1 100 @since 1.1
101 ]] 101 ]]
@@ -239,8 +239,8 @@ abstract Efl.Canvas.Object (Efl.Object, Efl.Gfx, Efl.Gfx.Color, Efl.Gfx.Stack, E
239 seat_focus_add { 239 seat_focus_add {
240 [[ Add a seat to the focus list. 240 [[ Add a seat to the focus list.
241 241
242 Evas supports that an Efl.Canvas.Object may be focused by multiple seats 242 Evas allows the Efl.Canvas.Object to be focused by multiple seats
243 at the same time. This function adds a new seat to the focus list, in other words, 243 at the same time. This function adds a new seat to the focus list. In other words,
244 after the seat is added to the list this object will now be also focused by this new seat. 244 after the seat is added to the list this object will now be also focused by this new seat.
245 245
246 This function generates an \@ref EFL_CANVAS_OBJECT_EVENT_FOCUS_DEVICE_IN event. 246 This function generates an \@ref EFL_CANVAS_OBJECT_EVENT_FOCUS_DEVICE_IN event.
@@ -319,7 +319,7 @@ abstract Efl.Canvas.Object (Efl.Object, Efl.Gfx, Efl.Gfx.Color, Efl.Gfx.Stack, E
319 } 319 }
320 @property propagate_events { 320 @property propagate_events {
321 set { 321 set {
322 [[Set whether events on a smart object's member should get 322 [[Set whether events on a smart object's member should be
323 propagated up to its parent. 323 propagated up to its parent.
324 324
325 This function has no effect if $obj is not a member of a 325 This function has no effect if $obj is not a member of a
@@ -355,7 +355,7 @@ abstract Efl.Canvas.Object (Efl.Object, Efl.Gfx, Efl.Gfx.Color, Efl.Gfx.Stack, E
355 They will be triggered on the next lower object (that is not 355 They will be triggered on the next lower object (that is not
356 set to pass events), instead (see \@ref evas_object_below_get). 356 set to pass events), instead (see \@ref evas_object_below_get).
357 357
358 If $pass is $false, events will be processed on that object 358 If $pass is $false events will be processed on that object
359 as normal. 359 as normal.
360 360
361 See also @.repeat_events.set, @.propagate_events.set, 361 See also @.repeat_events.set, @.propagate_events.set,
@@ -402,7 +402,7 @@ abstract Efl.Canvas.Object (Efl.Object, Efl.Gfx, Efl.Gfx.Color, Efl.Gfx.Stack, E
402 get { 402 get {
403 [[Return a list of objects currently clipped by $obj. 403 [[Return a list of objects currently clipped by $obj.
404 404
405 This returns the internal list handle that contains all 405 This returns the internal list handle containing all
406 objects clipped by the object $obj. If none are clipped by 406 objects clipped by the object $obj. If none are clipped by
407 it, the call returns $null. This list is only valid until 407 it, the call returns $null. This list is only valid until
408 the clip list is changed and should be fetched again with 408 the clip list is changed and should be fetched again with
@@ -531,7 +531,7 @@ abstract Efl.Canvas.Object (Efl.Object, Efl.Gfx, Efl.Gfx.Color, Efl.Gfx.Stack, E
531 531
532 This flag will be used to indicate to Evas that this object 532 This flag will be used to indicate to Evas that this object
533 should never be rendered on the canvas under any 533 should never be rendered on the canvas under any
534 circurmstances. In particular, this is useful to avoid 534 circumstances. In particular, this is useful to avoid
535 drawing clipper objects (or masks) even when they don't 535 drawing clipper objects (or masks) even when they don't
536 clip any object. This can also be used to replace the old 536 clip any object. This can also be used to replace the old
537 source_visible flag with proxy objects. 537 source_visible flag with proxy objects.
diff --git a/src/lib/evas/canvas/efl_canvas_object_event_grabber.eo b/src/lib/evas/canvas/efl_canvas_object_event_grabber.eo
index 5ad67b6e63..06f586131e 100644
--- a/src/lib/evas/canvas/efl_canvas_object_event_grabber.eo
+++ b/src/lib/evas/canvas/efl_canvas_object_event_grabber.eo
@@ -12,9 +12,9 @@ class Efl.Canvas.Object.Event.Grabber (Efl.Canvas.Group)
12 12
13 Child objects are not modified in any way, unlike other types of smart objects. 13 Child objects are not modified in any way, unlike other types of smart objects.
14 14
15 It is a user error for any child objects to be stacked above the event 15 No child objects should be stacked above the event
16 grabber parent while the event grabber is visible. 16 grabber parent while the grabber is visible.
17 A critical error will be raised if this is detected at any point. 17 A critical error will be raised if this is detected.
18 18
19 @since 1.20 19 @since 1.20
20 ]] 20 ]]
diff --git a/src/lib/evas/canvas/efl_canvas_text.eo b/src/lib/evas/canvas/efl_canvas_text.eo
index 02cad37d00..a021fbacef 100644
--- a/src/lib/evas/canvas/efl_canvas_text.eo
+++ b/src/lib/evas/canvas/efl_canvas_text.eo
@@ -25,8 +25,8 @@ class Efl.Canvas.Text (Efl.Canvas.Object, Efl.Text, Efl.Text.Properties,
25 visible_range_get { 25 visible_range_get {
26 [[Returns the currently visible range. 26 [[Returns the currently visible range.
27 27
28 The given $start and $end cursor act like an out-variables here, 28 The given $start and $end cursor act like out-variables here,
29 as these are set to the positions of the start and the end of the 29 as they are set to the positions of the start and the end of the
30 visible range in the text, respectively. 30 visible range in the text, respectively.
31 31
32 @since 1.18 32 @since 1.18
@@ -54,7 +54,7 @@ class Efl.Canvas.Text (Efl.Canvas.Object, Efl.Text, Efl.Text.Properties,
54 } 54 }
55 @property bidi_delimiters { 55 @property bidi_delimiters {
56 [[BiDi delimiters are used for in-paragraph separation of bidi 56 [[BiDi delimiters are used for in-paragraph separation of bidi
57 segments. This is useful for example in recipients fields of 57 segments. This is useful, for example, in the recipient fields of
58 e-mail clients where bidi oddities can occur when mixing RTL 58 e-mail clients where bidi oddities can occur when mixing RTL
59 and LTR. 59 and LTR.
60 60
diff --git a/src/lib/evas/canvas/efl_gfx_map.eo b/src/lib/evas/canvas/efl_gfx_map.eo
index c679719355..4e6ab03bf7 100644
--- a/src/lib/evas/canvas/efl_gfx_map.eo
+++ b/src/lib/evas/canvas/efl_gfx_map.eo
@@ -80,7 +80,7 @@ mixin Efl.Gfx.Map (Efl.Interface, Efl.Object)
80 This sets alpha flag for map rendering. If the object is a type that 80 This sets alpha flag for map rendering. If the object is a type that
81 has its own alpha settings, then this will take precedence. Only 81 has its own alpha settings, then this will take precedence. Only
82 image objects support this currently (@Efl.Canvas.Image and its 82 image objects support this currently (@Efl.Canvas.Image and its
83 friends). Setting this off stops alpha blending of the map area, 83 friends). Setting this to off stops alpha blending of the map area,
84 and is useful if you know the object and/or all sub-objects is 100% 84 and is useful if you know the object and/or all sub-objects is 100%
85 solid. 85 solid.
86 86
@@ -96,8 +96,8 @@ mixin Efl.Gfx.Map (Efl.Interface, Efl.Object)
96 96
97 This sets/gets the fixed point's coordinate in the map. Note that points 97 This sets/gets the fixed point's coordinate in the map. Note that points
98 describe the outline of a quadrangle and are ordered either clockwise 98 describe the outline of a quadrangle and are ordered either clockwise
99 or counter-clockwise. It is suggested to keep your quadrangles concave and 99 or counter-clockwise. Try to keep your quadrangles concave and
100 non-complex, though these polygon modes may work, they may not render 100 non-complex. Though these polygon modes may work, they may not render
101 a desired set of output. The quadrangle will use points 0 and 1 , 1 and 2, 101 a desired set of output. The quadrangle will use points 0 and 1 , 1 and 2,
102 2 and 3, and 3 and 0 to describe the edges of the quadrangle. 102 2 and 3, and 3 and 0 to describe the edges of the quadrangle.
103 103
@@ -106,7 +106,7 @@ mixin Efl.Gfx.Map (Efl.Interface, Efl.Object)
106 X and Y rendered coordinates. It may be used for calculating fills with 106 X and Y rendered coordinates. It may be used for calculating fills with
107 perspective correct rendering. 107 perspective correct rendering.
108 108
109 Remember all coordinates are canvas global ones like with move and resize 109 Remember all coordinates are canvas global ones as with move and resize
110 in the canvas. 110 in the canvas.
111 111
112 This property can be read to get the 4 points positions on the 112 This property can be read to get the 4 points positions on the
@@ -206,8 +206,8 @@ mixin Efl.Gfx.Map (Efl.Interface, Efl.Object)
206 rotate_3d { 206 rotate_3d {
207 [[Rotate the object around 3 axes in 3D. 207 [[Rotate the object around 3 axes in 3D.
208 208
209 This will rotate in 3D and not just around the "Z" axis as the case 209 This will rotate in 3D, not just around the "Z" axis as is the case
210 with @.rotate. This will rotate around the X, Y and Z axes. The 210 with @.rotate. You can rotate around the X, Y and Z axes. The
211 Z axis points "into" the screen with low values at the screen and 211 Z axis points "into" the screen with low values at the screen and
212 higher values further away. The X axis runs from left to right on 212 higher values further away. The X axis runs from left to right on
213 the screen and the Y axis from top to bottom. 213 the screen and the Y axis from top to bottom.
@@ -271,7 +271,7 @@ mixin Efl.Gfx.Map (Efl.Interface, Efl.Object)
271 } 271 }
272 } 272 }
273 lightning_3d { 273 lightning_3d {
274 [[Apply a lightning effect on the object. 274 [[Apply a lighting effect on the object.
275 275
276 This is used to apply lighting calculations (from a single light 276 This is used to apply lighting calculations (from a single light
277 source) to a given mapped object. The R, G and B values of each 277 source) to a given mapped object. The R, G and B values of each
@@ -310,7 +310,7 @@ mixin Efl.Gfx.Map (Efl.Interface, Efl.Object)
310 mapping between spatial coordinates and screen coordinates. Any points 310 mapping between spatial coordinates and screen coordinates. Any points
311 on this z value will not have their X and Y values modified in the transform. 311 on this z value will not have their X and Y values modified in the transform.
312 Those further away (Z value higher) will shrink into the distance, and 312 Those further away (Z value higher) will shrink into the distance, and
313 those less than this value will expand and become bigger. The $foc value 313 those under this value will expand and become bigger. The $foc value
314 determines the "focal length" of the camera. This is in reality the distance 314 determines the "focal length" of the camera. This is in reality the distance
315 between the camera lens plane itself (at or closer than this rendering 315 between the camera lens plane itself (at or closer than this rendering
316 results are undefined) and the "z0" z value. This allows for some "depth" 316 results are undefined) and the "z0" z value. This allows for some "depth"
@@ -411,12 +411,12 @@ mixin Efl.Gfx.Map (Efl.Interface, Efl.Object)
411 } 411 }
412 } 412 }
413 lightning_3d_absolute { 413 lightning_3d_absolute {
414 [[Apply a lightning effect on the object. 414 [[Apply a lighting effect to the object.
415 415
416 This is used to apply lighting calculations (from a single light 416 This is used to apply lighting calculations (from a single light
417 source) to a given mapped object. The R, G and B values of each 417 source) to a given mapped object. The RGB values of each
418 vertex will be modified to reflect the lighting based on the light 418 vertex will be modified to reflect the lighting based on the light
419 point coordinates, the light color and the ambient color, and at 419 point coordinates, the light color, the ambient color and at
420 what angle the map is facing the light source. A surface should have 420 what angle the map is facing the light source. A surface should have
421 its points be declared in a clockwise fashion if the face is 421 its points be declared in a clockwise fashion if the face is
422 "facing" towards you (as opposed to away from you) as faces have a 422 "facing" towards you (as opposed to away from you) as faces have a
diff --git a/src/lib/evas/canvas/efl_vg.eo b/src/lib/evas/canvas/efl_vg.eo
index ca145301ec..5d41ac229c 100644
--- a/src/lib/evas/canvas/efl_vg.eo
+++ b/src/lib/evas/canvas/efl_vg.eo
@@ -8,17 +8,17 @@ abstract Efl.VG (Efl.Object, Efl.Gfx, Efl.Gfx.Color, Efl.Gfx.Stack, Efl.Duplicat
8 methods { 8 methods {
9 @property name { 9 @property name {
10 set { 10 set {
11 [[Set an unique name from the parent point of view. $null means 11 [[Set an unique name from the parent's point of view. $null means
12 no name. 12 no name.
13 13
14 @since 1.16 14 @since 1.16
15 ]] 15 ]]
16 } 16 }
17 get { 17 get {
18 [[Get an unique name from the parent point of view. 18 [[Get an unique name from the parent's point of view.
19 19
20 $null means no name. When set a parent after the name what 20 $null means no name. When setting a parent after a name has
21 defined, it might be forced back to $null if the parent 21 already been defined, it might be forced back to $null if the parent
22 already has a node of that name. 22 already has a node of that name.
23 23
24 @since 1.16 24 @since 1.16
@@ -47,14 +47,14 @@ abstract Efl.VG (Efl.Object, Efl.Gfx, Efl.Gfx.Color, Efl.Gfx.Stack, Efl.Duplicat
47 } 47 }
48 @property origin { 48 @property origin {
49 set { 49 set {
50 [[Sets the origin position of this node object. 50 [[Sets the origin position of the node object.
51 51
52 This origin position affects to node transformation. 52 This origin position affects node transformation.
53 53
54 @since 1.14]] 54 @since 1.14]]
55 } 55 }
56 get { 56 get {
57 [[Gets the origin position of this node object. 57 [[Gets the origin position of the node object.
58 58
59 @since 1.14]] 59 @since 1.14]]
60 } 60 }
@@ -83,9 +83,9 @@ abstract Efl.VG (Efl.Object, Efl.Gfx, Efl.Gfx.Color, Efl.Gfx.Stack, Efl.Duplicat
83 } 83 }
84 } */ 84 } */
85 bounds_get @pure_virtual { 85 bounds_get @pure_virtual {
86 [[Give the bounding box in screen coordinate as being drawn. 86 [[Give the bounding box in screen coordinates as being drawn.
87 87
88 It will start as the control box until it is refined once the shape 88 It will start as the control box until it is refined, once the shape
89 is computed. 89 is computed.
90 90
91 @since 1.14]] 91 @since 1.14]]
diff --git a/src/lib/evas/canvas/evas_box.eo b/src/lib/evas/canvas/evas_box.eo
index 42b4395d01..7a75da352a 100644
--- a/src/lib/evas/canvas/evas_box.eo
+++ b/src/lib/evas/canvas/evas_box.eo
@@ -615,7 +615,7 @@ class Evas.Box (Efl.Canvas.Group)
615 box. 615 box.
616 616
617 In a flow horizontal box, the box's child elements are placed in 617 In a flow horizontal box, the box's child elements are placed in
618 rows (think of text as an analogy). A row has as much elements as 618 rows (think of text as an analogy). A row has as many elements as
619 can fit into the box's width. The box's overall behavior is 619 can fit into the box's width. The box's overall behavior is
620 controlled by its properties, which are set by the 620 controlled by its properties, which are set by the
621 evas_object_box_{h,v}_{align,padding}_set family of 621 evas_object_box_{h,v}_{align,padding}_set family of
@@ -631,7 +631,7 @@ class Evas.Box (Efl.Canvas.Group)
631 justified horizontally. $align_v controls the vertical alignment 631 justified horizontally. $align_v controls the vertical alignment
632 of the entire set of rows ($0.0 to top, $1.0 to bottom). A 632 of the entire set of rows ($0.0 to top, $1.0 to bottom). A
633 value of $-1.0 to $align_v makes the box to justify the rows 633 value of $-1.0 to $align_v makes the box to justify the rows
634 vertically. The padding between them, in this case, is corrected so 634 vertically. The padding between them in this case is corrected so
635 that the first row touches the top border and the last one touches 635 that the first row touches the top border and the last one touches
636 the bottom border (even if they must overlap). $padding_v has no 636 the bottom border (even if they must overlap). $padding_v has no
637 influence on the layout. 637 influence on the layout.
diff --git a/src/lib/evas/canvas/evas_canvas.eo b/src/lib/evas/canvas/evas_canvas.eo
index ab8627a897..5a51b69d8f 100644
--- a/src/lib/evas/canvas/evas_canvas.eo
+++ b/src/lib/evas/canvas/evas_canvas.eo
@@ -29,8 +29,8 @@ class Evas.Canvas (Efl.Object, Efl.Canvas, Efl.Animator, Efl.Input.Interface,
29 [[Set the default set of flags an event begins with 29 [[Set the default set of flags an event begins with
30 30
31 Events in evas can have an event_flags member. This starts 31 Events in evas can have an event_flags member. This starts
32 out with and initial value (no flags). This lets you set 32 out with an initial value (no flags). This lets you set
33 the default flags that an event begins with to be $flags. 33 the default flags that an event begins with to $flags.
34 34
35 @since 1.2 35 @since 1.2
36 ]] 36 ]]
@@ -102,7 +102,7 @@ class Evas.Canvas (Efl.Object, Efl.Canvas, Efl.Animator, Efl.Input.Interface,
102 @skip called when our rectangle gets focus 102 @skip called when our rectangle gets focus
103 @until } 103 @until }
104 104
105 In this example the $event_info is exactly a pointer to that 105 In this example the $event_info is a pointer to that
106 focused rectangle. See the full @ref Example_Evas_Events "example". 106 focused rectangle. See the full @ref Example_Evas_Events "example".
107 */ 107 */
108 return: Efl.Canvas.Object @warn_unused; [[The object that has focus 108 return: Efl.Canvas.Object @warn_unused; [[The object that has focus
@@ -193,9 +193,9 @@ class Evas.Canvas (Efl.Object, Efl.Canvas, Efl.Animator, Efl.Input.Interface,
193 smart calculations. 193 smart calculations.
194 194
195 Whenever evas performs smart object calculations on the whole 195 Whenever evas performs smart object calculations on the whole
196 canvas it increments a counter by 1. This is the smart object 196 canvas it increments a counter by 1. This function returns
197 calculate counter that this function returns the value of. 197 the value of the smart object calculate counter.
198 It starts at the value of 0 and will increase (and eventually 198 It starts with a value of 0 and will increase (and eventually
199 wrap around to negative values and so on) by 1 every time 199 wrap around to negative values and so on) by 1 every time
200 objects are calculated. You can use this counter to ensure 200 objects are calculated. You can use this counter to ensure
201 you don't re-do calculations withint the same calculation 201 you don't re-do calculations withint the same calculation
@@ -327,7 +327,7 @@ class Evas.Canvas (Efl.Object, Efl.Canvas, Efl.Animator, Efl.Input.Interface,
327 set to 1. 327 set to 1.
328 328
329 Calling this function will return a 32-bit integer with the 329 Calling this function will return a 32-bit integer with the
330 appropriate bits set to 1 that correspond to a mouse button 330 appropriate bits set to 1, which correspond to a mouse button
331 being depressed. This limits Evas to a mouse devices with a 331 being depressed. This limits Evas to a mouse devices with a
332 maximum of 32 buttons, but that is generally in excess of 332 maximum of 32 buttons, but that is generally in excess of
333 any host system's pointing device abilities. 333 any host system's pointing device abilities.
@@ -425,9 +425,9 @@ class Evas.Canvas (Efl.Object, Efl.Canvas, Efl.Animator, Efl.Input.Interface,
425 key_modifier_add { 425 key_modifier_add {
426 [[Adds the $keyname key to the current list of modifier keys. 426 [[Adds the $keyname key to the current list of modifier keys.
427 427
428 Modifiers are keys like shift, alt and ctrl, i.e., keys which 428 Modifiers are keys like shift, alt and ctrl, i.e. keys which
429 are meant to be pressed together with others, altering the 429 are meant to be pressed together with others, altering the
430 behavior of the secondly pressed keys somehow. Evas is so that 430 behavior of the second keys pressed. Evas is so that
431 these keys can be user defined. 431 these keys can be user defined.
432 432
433 This call allows custom modifiers to be added to the Evas system 433 This call allows custom modifiers to be added to the Evas system
@@ -537,7 +537,7 @@ class Evas.Canvas (Efl.Object, Efl.Canvas, Efl.Animator, Efl.Input.Interface,
537 ]] 537 ]]
538 } 538 }
539 focus_out { 539 focus_out {
540 [[Inform to the evas that it lost the focus from the default seat.]] 540 [[Inform the evas that it lost the focus from the default seat.]]
541 } 541 }
542 norender { 542 norender {
543 [[Update the canvas internal objects but not triggering immediate 543 [[Update the canvas internal objects but not triggering immediate
@@ -808,13 +808,13 @@ class Evas.Canvas (Efl.Object, Efl.Canvas, Efl.Animator, Efl.Input.Interface,
808 the given canvas $e. 808 the given canvas $e.
809 809
810 Note: This is a very low level function, which most of Evas' 810 Note: This is a very low level function, which most of Evas'
811 users wouldn't care about. One would use it, for example, to 811 users wouldn't care about. You might use it, for instance, to
812 grab an Evas' canvas update regions and paint them back, using 812 grab an Evas' canvas update regions and paint them back, using
813 the canvas' pixmap, on a displaying system working below Evas. 813 the canvas' pixmap, on a displaying system working below Evas.
814 814
815 Note: Evas is a stateful canvas. If no operations changing its 815 Note: Evas is a stateful canvas. If no operations changing its
816 state took place since the last rendering action, you won't see 816 state took place since the last rendering action, you won't see
817 no changes and this call will be a no-op. 817 any changes and this call will be a no-op.
818 ]] 818 ]]
819 /* FIXME-doc 819 /* FIXME-doc
820 Example code follows. 820 Example code follows.
@@ -945,7 +945,7 @@ class Evas.Canvas (Efl.Object, Efl.Canvas, Efl.Animator, Efl.Input.Interface,
945 [[Make the canvas discard as much data as possible used by the 945 [[Make the canvas discard as much data as possible used by the
946 engine at runtime. 946 engine at runtime.
947 947
948 This function will unload images, delete textures and much more, 948 This function will unload images, delete textures and much more
949 where possible. You may also want to call @.render_idle_flush 949 where possible. You may also want to call @.render_idle_flush
950 immediately prior to this to perhaps discard a little more, 950 immediately prior to this to perhaps discard a little more,
951 though this function should implicitly delete most of what 951 though this function should implicitly delete most of what
diff --git a/src/lib/evas/canvas/evas_canvas3d_node.eo b/src/lib/evas/canvas/evas_canvas3d_node.eo
index f9b18258fc..ca4e155824 100644
--- a/src/lib/evas/canvas/evas_canvas3d_node.eo
+++ b/src/lib/evas/canvas/evas_canvas3d_node.eo
@@ -22,7 +22,7 @@ class Evas.Canvas3D.Node (Evas.Canvas3D.Object)
22 [[Add a member node to the given node. 22 [[Add a member node to the given node.
23 23
24 Nodes can be constructed into N-ary tree structure like other ordinary scene 24 Nodes can be constructed into N-ary tree structure like other ordinary scene
25 graph. Basically a node inherit transforms from its parent. 25 graphs. A node inherit transforms from its parent.
26 26
27 See also @Evas.Canvas3D.Node.parent_get.]] 27 See also @Evas.Canvas3D.Node.parent_get.]]
28 28
@@ -238,7 +238,7 @@ class Evas.Canvas3D.Node (Evas.Canvas3D.Object)
238 [[Set the position inheritance flag of the given node. 238 [[Set the position inheritance flag of the given node.
239 239
240 When inheritance is enabled, a node's world space position is determined by 240 When inheritance is enabled, a node's world space position is determined by
241 adding the parent node's world position and the node's position, otherwise, 241 adding the parent node's world position and the node's position. Otherwise
242 the node's position will be the world space position.]] 242 the node's position will be the world space position.]]
243 } 243 }
244 get { 244 get {
@@ -257,7 +257,7 @@ class Evas.Canvas3D.Node (Evas.Canvas3D.Object)
257 257
258 When inheritance is enabled, a node's world space orientation is determined 258 When inheritance is enabled, a node's world space orientation is determined
259 by multiplying the parent node's world orientation and the node's 259 by multiplying the parent node's world orientation and the node's
260 orientation, otherwise, the node's orientation will be the world space 260 orientation. Otherwise the node's orientation will be the world space
261 orientation.]] 261 orientation.]]
262 } 262 }
263 get { 263 get {
@@ -275,7 +275,7 @@ class Evas.Canvas3D.Node (Evas.Canvas3D.Object)
275 [[Set the scale inheritance flag of the given node. 275 [[Set the scale inheritance flag of the given node.
276 276
277 When inheritance is enabled, a node's world space scale is determined by 277 When inheritance is enabled, a node's world space scale is determined by
278 multiplying the parent node's world scale and the node's scale, otherwise, 278 multiplying the parent node's world scale and the node's scale. Otherwise
279 the node's scale will be the world space scale.]] 279 the node's scale will be the world space scale.]]
280 } 280 }
281 get { 281 get {
diff --git a/src/lib/evas/canvas/evas_canvas3d_primitive.eo b/src/lib/evas/canvas/evas_canvas3d_primitive.eo
index e06f6f50c6..11960f88b9 100644
--- a/src/lib/evas/canvas/evas_canvas3d_primitive.eo
+++ b/src/lib/evas/canvas/evas_canvas3d_primitive.eo
@@ -33,11 +33,11 @@ class Evas.Canvas3D.Primitive (Evas.Canvas3D.Object)
33 33
34 Mode defines which function will be chosen to set data to mesh 34 Mode defines which function will be chosen to set data to mesh
35 on call of evas_canvas3d_mesh_primitive_set. It helps to choose 35 on call of evas_canvas3d_mesh_primitive_set. It helps to choose
36 alternative algorithm for primitive with given form 36 an alternative algorithm for primitives with a given form,
37 (like cone without base or sphere textured in alternative way). 37 such as a cone without a base or sphere textured in alternative way.
38 38
39 Now available next mods of primitives are 39 Mods of primitives are now available
40 witout base (bases) (supported for cylinder and cone) and 40 without base (bases) (supported for cylinder and cone) and
41 with alternative UV (supported by sphere). 41 with alternative UV (supported by sphere).
42 42
43 Default form is EVAS_CANVAS3D_PRIMITIVE_MODE_DEFAULT.]] 43 Default form is EVAS_CANVAS3D_PRIMITIVE_MODE_DEFAULT.]]
@@ -55,11 +55,11 @@ class Evas.Canvas3D.Primitive (Evas.Canvas3D.Object)
55 set { 55 set {
56 [[Set the ratio of the given primitive. 56 [[Set the ratio of the given primitive.
57 57
58 Now ratio uses only in torus as the ratio of the 58 Ratio is used only in torus as the ratio of the
59 major radius and minor radius. For this usage 59 major radius and minor radius. For this usage
60 Available values is from 1.0 to infinity. 60 Available values is from 1.0 to infinity.
61 If ratio for torus has a bad value, 61 If ratio for torus has a bad value,
62 will be used 3.0 as ratio. Like ratio of usual doughnut. 62 3.0 will be used as the ratio.
63 63
64 Default ratio is 3.0.]] 64 Default ratio is 3.0.]]
65 } 65 }
@@ -76,11 +76,11 @@ class Evas.Canvas3D.Primitive (Evas.Canvas3D.Object)
76 set { 76 set {
77 [[Set the precision of the given primitive. 77 [[Set the precision of the given primitive.
78 78
79 Precision uses in all non tabulated primitives and defines 79 Precision is used in all non tabulated primitives and defines
80 precision of created primitives. 80 the precision of created primitives.
81 Available values is from 3 to infinity. 81 Available values range from 3 to infinity.
82 But if value will be more than 100, should be a warning 82 If the value is more than 100, you may see a warning
83 about possibility of incorrect or slow work. 83 about possibility of incorrect values or slow processing.
84 84
85 Default ratio is 10.]] 85 Default ratio is 10.]]
86 } 86 }
@@ -97,14 +97,14 @@ class Evas.Canvas3D.Primitive (Evas.Canvas3D.Object)
97 set { 97 set {
98 [[Set the surface of the given primitive. 98 [[Set the surface of the given primitive.
99 99
100 Surface uses only in surface primitive and defines 100 Surface is used only in surface primitives and defines
101 equation of filling mesh data on call of 101 the equation of filling mesh data on call of
102 evas_canvas3d_mesh_primitive_set. 102 evas_canvas3d_mesh_primitive_set.
103 103
104 It gives possibility to create customers primitives like 104 This allows you to create customers primitives like
105 shell, heart, hyperbolic paraboloid etc. See _shell_func in 105 shell, heart, hyperbolic paraboloid etc. See _shell_func in
106 examples/evas/evas-3d-visual-test.c or _perlin_terrain in 106 examples/evas/evas-3d-visual-test.c or _perlin_terrain in
107 modules/evas/primitives/surfaces/terrain.c as an example of usage. 107 modules/evas/primitives/surfaces/terrain.c for usage examples.
108 108
109 Default surface is $null]] 109 Default surface is $null]]
110 } 110 }
diff --git a/src/lib/evas/canvas/evas_canvas3d_scene.eo b/src/lib/evas/canvas/evas_canvas3d_scene.eo
index 3c8b287b99..4ac2838b5e 100644
--- a/src/lib/evas/canvas/evas_canvas3d_scene.eo
+++ b/src/lib/evas/canvas/evas_canvas3d_scene.eo
@@ -8,8 +8,8 @@ class Evas.Canvas3D.Scene (Evas.Canvas3D.Object)
8 size_set { 8 size_set {
9 [[Set the resolution of a scene. 9 [[Set the resolution of a scene.
10 10
11 A scene should be rendered to be displayed through an image 11 A scene should be rendered to be displayed through image
12 objects. The resolution defines size of the internal surface 12 objects. The resolution defines the size of the internal surface
13 holding the rendered result. 13 holding the rendered result.
14 ]] 14 ]]
15 params { 15 params {
@@ -29,9 +29,9 @@ class Evas.Canvas3D.Scene (Evas.Canvas3D.Object)
29 background_color_set { 29 background_color_set {
30 [[Set the background color of a scene. 30 [[Set the background color of a scene.
31 31
32 Background color defines initial color of pixels before a scene 32 Background color defines the initial color of pixels before a scene
33 is rendered. If you want to display a scene with background evas 33 is rendered. If you want to display a scene with background evas
34 objects are still remaining as if it was the background, set 34 objects as if they're part of the background, set
35 the alpha term to 0.0. 35 the alpha term to 0.0.
36 36
37 Default background color is (0.0, 0.0, 0.0, 0.0). 37 Default background color is (0.0, 0.0, 0.0, 0.0).
diff --git a/src/lib/evas/canvas/evas_canvas3d_texture.eo b/src/lib/evas/canvas/evas_canvas3d_texture.eo
index c6ab979257..22b35f2219 100644
--- a/src/lib/evas/canvas/evas_canvas3d_texture.eo
+++ b/src/lib/evas/canvas/evas_canvas3d_texture.eo
@@ -10,10 +10,10 @@ class Evas.Canvas3D.Texture (Evas.Canvas3D.Object, Efl.File)
10 [[Set the visibility flag of the source evas object of the given 10 [[Set the visibility flag of the source evas object of the given
11 texture. 11 texture.
12 12
13 Recommend to call \@ref evas_object_show on the source object 13 Call \@ref evas_object_show on the source object
14 and control the visibility using this function. 14 and control the visibility using this function.
15 15
16 By default, source object is visible. 16 By default the source object is visible.
17 17
18 See also @.source_set. 18 See also @.source_set.
19 ]] 19 ]]
@@ -31,9 +31,9 @@ class Evas.Canvas3D.Texture (Evas.Canvas3D.Object, Efl.File)
31 set { 31 set {
32 [[Set enable flag to generation texture unit with support atlas. 32 [[Set enable flag to generation texture unit with support atlas.
33 33
34 Use this flag only in case not normalize texture coordinates. 34 Use this flag only when you cannot normalize texture coordinates.
35 35
36 By default, is enabled. 36 By default it is enabled.
37 ]] 37 ]]
38 } 38 }
39 get { 39 get {
@@ -61,7 +61,7 @@ class Evas.Canvas3D.Texture (Evas.Canvas3D.Object, Efl.File)
61 [[Set the data of the given texture from an evas object. 61 [[Set the data of the given texture from an evas object.
62 62
63 Evas 3D support using existing evas object as a texture source. 63 Evas 3D support using existing evas object as a texture source.
64 This feature make it possible using any exisiting evas object 64 This feature make it possible using any existing evas object
65 inside 3D scene. 65 inside 3D scene.
66 66
67 See also @.source_visible.set. 67 See also @.source_visible.set.
@@ -88,8 +88,8 @@ class Evas.Canvas3D.Texture (Evas.Canvas3D.Object, Efl.File)
88 size_get @const { 88 size_get @const {
89 [[Get the size of the given texture. 89 [[Get the size of the given texture.
90 90
91 If the texture has source object, the size of the source object 91 If the texture has a source object, the size of the source object
92 will be returned. Otherwise, the size of the data (or image file) 92 will be returned. Otherwise the size of the data (or image file)
93 will be returned. 93 will be returned.
94 94
95 See also @.data_set, @Efl.File.file.set, @.source_set. 95 See also @.data_set, @Efl.File.file.set, @.source_set.
diff --git a/src/lib/evas/canvas/evas_table.eo b/src/lib/evas/canvas/evas_table.eo
index 9e915387b9..d503e8d482 100644
--- a/src/lib/evas/canvas/evas_table.eo
+++ b/src/lib/evas/canvas/evas_table.eo
@@ -174,8 +174,8 @@ class Evas.Table (Efl.Canvas.Group)
174 @in child: Efl.Canvas.Object; [[The child object to add.]] 174 @in child: Efl.Canvas.Object; [[The child object to add.]]
175 @out col: ushort; [[Pointer to store relative-horizontal position to place child.]] 175 @out col: ushort; [[Pointer to store relative-horizontal position to place child.]]
176 @out row: ushort; [[Pointer to store relative-vertical position to place child.]] 176 @out row: ushort; [[Pointer to store relative-vertical position to place child.]]
177 @out colspan: ushort; [[Pointer to store how many relative-horizontal position to use for this child.]] 177 @out colspan: ushort; [[Pointer to store how many relative-horizontal positions to use for this child.]]
178 @out rowspan: ushort; [[Pointer to store how many relative-vertical position to use for this child.]] 178 @out rowspan: ushort; [[Pointer to store how many relative-vertical positions to use for this child.]]
179 } 179 }
180 } 180 }
181 pack { 181 pack {
@@ -192,8 +192,8 @@ class Evas.Table (Efl.Canvas.Group)
192 @in child: Efl.Canvas.Object @nonull; [[The child object to add.]] 192 @in child: Efl.Canvas.Object @nonull; [[The child object to add.]]
193 @in col: ushort; [[Relative-horizontal position to place child.]] 193 @in col: ushort; [[Relative-horizontal position to place child.]]
194 @in row: ushort; [[Relative-vertical position to place child.]] 194 @in row: ushort; [[Relative-vertical position to place child.]]
195 @in colspan: ushort; [[How many relative-horizontal position to use for this child.]] 195 @in colspan: ushort; [[How many relative-horizontal positions to use for this child.]]
196 @in rowspan: ushort; [[How many relative-vertical position to use for this child.]] 196 @in rowspan: ushort; [[How many relative-vertical positions to use for this child.]]
197 } 197 }
198 } 198 }
199 unpack { 199 unpack {