summaryrefslogtreecommitdiff
path: root/src/lib/evas/canvas/efl_canvas_object.eo
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 /src/lib/evas/canvas/efl_canvas_object.eo
parent9a4eedb078bde1ea15d80ba2f285f7d2dc672c10 (diff)
docs: Update evas canvas eo files for grammar and readability
Author: Nate Drake
Diffstat (limited to 'src/lib/evas/canvas/efl_canvas_object.eo')
-rw-r--r--src/lib/evas/canvas/efl_canvas_object.eo22
1 files changed, 11 insertions, 11 deletions
diff --git a/src/lib/evas/canvas/efl_canvas_object.eo b/src/lib/evas/canvas/efl_canvas_object.eo
index 30a39b4..7d85781 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.