summaryrefslogtreecommitdiff
path: root/src/lib/evas/canvas/efl_canvas_object.eo
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/evas/canvas/efl_canvas_object.eo')
-rw-r--r--src/lib/evas/canvas/efl_canvas_object.eo115
1 files changed, 15 insertions, 100 deletions
diff --git a/src/lib/evas/canvas/efl_canvas_object.eo b/src/lib/evas/canvas/efl_canvas_object.eo
index 75f304a..d449c80 100644
--- a/src/lib/evas/canvas/efl_canvas_object.eo
+++ b/src/lib/evas/canvas/efl_canvas_object.eo
@@ -11,10 +11,9 @@ abstract @beta Efl.Canvas.Object extends Efl.Loop_Consumer implements Efl.Gfx.En
11 Efl.Gfx.Mapping, Efl.Ui.I18n, Efl.Canvas.Pointer 11 Efl.Gfx.Mapping, Efl.Ui.I18n, Efl.Canvas.Pointer
12{ 12{
13 [[Efl canvas object abstract class]] 13 [[Efl canvas object abstract class]]
14 legacy_prefix: evas_object;
15 data: Evas_Object_Protected_Data; 14 data: Evas_Object_Protected_Data;
16 methods { 15 methods {
17 @property pointer_mode_by_device { 16 @property pointer_mode_by_device @beta {
18 [[Low-level pointer behaviour by device. 17 [[Low-level pointer behaviour by device.
19 See @.pointer_mode.get and @.pointer_mode.set for more explanation. 18 See @.pointer_mode.get and @.pointer_mode.set for more explanation.
20 @since 1.19 19 @since 1.19
@@ -27,13 +26,11 @@ abstract @beta Efl.Canvas.Object extends Efl.Loop_Consumer implements Efl.Gfx.En
27 } 26 }
28 set { 27 set {
29 return: bool; [[$true if pointer mode was set, $false otherwise]] 28 return: bool; [[$true if pointer mode was set, $false otherwise]]
30 legacy: null;
31 } 29 }
32 get { 30 get {
33 legacy: null;
34 } 31 }
35 } 32 }
36 @property pointer_mode { 33 @property pointer_mode @beta {
37 [[Low-level pointer behaviour. 34 [[Low-level pointer behaviour.
38 35
39 This function has a direct effect on event callbacks related to 36 This function has a direct effect on event callbacks related to
@@ -77,46 +74,14 @@ abstract @beta Efl.Canvas.Object extends Efl.Loop_Consumer implements Efl.Gfx.En
77 transparent background inside a buffer canvas). 74 transparent background inside a buffer canvas).
78 ]] 75 ]]
79 set { 76 set {
80 legacy: null;
81 } 77 }
82 get { 78 get {
83 legacy: null;
84 } 79 }
85 values { 80 values {
86 render_op: Efl.Gfx.Render_Op; [[Blend or copy.]] 81 render_op: Efl.Gfx.Render_Op; [[Blend or copy.]]
87 } 82 }
88 } 83 }
89 @property freeze_events { 84 @property clipper {
90 set {
91 [[Set whether an Evas object is to freeze (discard) events.
92
93 If $freeze is $true, it will force events on $obj to be
94 discarded. Unlike @.pass_events.set, events will not be
95 passed to next lower object. This API can be used for
96 blocking events while $obj is in transition.
97
98 If $freeze is $false, events will be processed on that
99 object as normal.
100
101 Warning: If you block only key/mouse up events with this API,
102 you can't be sure of the state of any objects that have only
103 key/mouse down events.
104
105 @since 1.1
106 ]]
107 }
108 get {
109 [[Determine whether an object is set to freeze (discard) events.
110
111 @since 1.1
112 ]]
113 }
114 values {
115 freeze: bool; [[Pass when $obj is to freeze events ($true)
116 or not ($false).]]
117 }
118 }
119 @property clip {
120 set { 85 set {
121 [[Clip one object to another. 86 [[Clip one object to another.
122 87
@@ -168,7 +133,7 @@ abstract @beta Efl.Canvas.Object extends Efl.Loop_Consumer implements Efl.Gfx.En
168 ]] 133 ]]
169 } 134 }
170 values { 135 values {
171 clip: Efl.Canvas.Object @nonull; [[The object to clip $obj by.]] 136 clipper: Efl.Canvas.Object @nonull; [[The object to clip $obj by.]]
172 } 137 }
173 } 138 }
174 @property repeat_events { 139 @property repeat_events {
@@ -212,10 +177,8 @@ abstract @beta Efl.Canvas.Object extends Efl.Loop_Consumer implements Efl.Gfx.En
212 @.seat_focus_add, @.seat_focus_del. 177 @.seat_focus_add, @.seat_focus_del.
213 ]] 178 ]]
214 set { 179 set {
215 legacy: evas_object_focus_set;
216 } 180 }
217 get { 181 get {
218 legacy: evas_object_focus_get;
219 } 182 }
220 values { 183 values {
221 focus: bool; [[$true when set as focused or $false otherwise.]] 184 focus: bool; [[$true when set as focused or $false otherwise.]]
@@ -227,7 +190,6 @@ abstract @beta Efl.Canvas.Object extends Efl.Loop_Consumer implements Efl.Gfx.En
227 @since 1.19 190 @since 1.19
228 ]] 191 ]]
229 get { 192 get {
230 legacy: null;
231 } 193 }
232 values { 194 values {
233 focus: bool; [[$true if focused by at least one seat or $false otherwise.]] 195 focus: bool; [[$true if focused by at least one seat or $false otherwise.]]
@@ -238,7 +200,6 @@ abstract @beta Efl.Canvas.Object extends Efl.Loop_Consumer implements Efl.Gfx.En
238 params { 200 params {
239 @in seat: Efl.Input.Device; [[The seat to check if the object is focused. Use $null for the default seat.]] 201 @in seat: Efl.Input.Device; [[The seat to check if the object is focused. Use $null for the default seat.]]
240 } 202 }
241 legacy: null;
242 return: bool; [[$true if focused or $false otherwise.]] 203 return: bool; [[$true if focused or $false otherwise.]]
243 } 204 }
244 seat_focus_add { 205 seat_focus_add {
@@ -255,7 +216,6 @@ abstract @beta Efl.Canvas.Object extends Efl.Loop_Consumer implements Efl.Gfx.En
255 params { 216 params {
256 @in seat: Efl.Input.Device; [[The seat that should be added to the focus list. Use $null for the default seat.]] 217 @in seat: Efl.Input.Device; [[The seat that should be added to the focus list. Use $null for the default seat.]]
257 } 218 }
258 legacy: null;
259 return: bool; [[$true if the focus has been set or $false otherwise.]] 219 return: bool; [[$true if the focus has been set or $false otherwise.]]
260 } 220 }
261 seat_focus_del { 221 seat_focus_del {
@@ -266,25 +226,8 @@ abstract @beta Efl.Canvas.Object extends Efl.Loop_Consumer implements Efl.Gfx.En
266 params { 226 params {
267 @in seat: Efl.Input.Device; [[The seat that should be removed from the focus list. Use $null for the default seat.]] 227 @in seat: Efl.Input.Device; [[The seat that should be removed from the focus list. Use $null for the default seat.]]
268 } 228 }
269 legacy: null;
270 return: bool; [[$true if the seat was removed from the focus list or $false otherwise.]] 229 return: bool; [[$true if the seat was removed from the focus list or $false otherwise.]]
271 } 230 }
272 @property is_frame_object {
273 [[If $true the object belongs to the window border decorations.
274
275 This will be $false by default, and should be $false for all objects
276 created by the application, unless swallowed in some very specific
277 parts of the window.
278
279 It is very unlikely that an application needs to call this manually,
280 as the window will handle this feature automatically.
281
282 @since 1.2
283 ]]
284 values {
285 is_frame: bool; [[$true if the object is a frame, $false otherwise]]
286 }
287 }
288 @property precise_is_inside { 231 @property precise_is_inside {
289 set { 232 set {
290 [[Set whether to use precise (usually expensive) point collision 233 [[Set whether to use precise (usually expensive) point collision
@@ -331,15 +274,13 @@ abstract @beta Efl.Canvas.Object extends Efl.Loop_Consumer implements Efl.Gfx.En
331 be propagated on to the smart object of which $obj is a 274 be propagated on to the smart object of which $obj is a
332 member. The default value is $true. 275 member. The default value is $true.
333 276
334 See also @.repeat_events.set, @.pass_events.set, 277 See also @.repeat_events.set, @.pass_events.set.
335 @.freeze_events.set.
336 ]] 278 ]]
337 } 279 }
338 get { 280 get {
339 [[Retrieve whether an Evas object is set to propagate events. 281 [[Retrieve whether an Evas object is set to propagate events.
340 282
341 See also @.repeat_events.get, @.pass_events.get, 283 See also @.repeat_events.get, @.pass_events.get.
342 @.freeze_events.get.
343 ]] 284 ]]
344 } 285 }
345 values { 286 values {
@@ -358,15 +299,13 @@ abstract @beta Efl.Canvas.Object extends Efl.Loop_Consumer implements Efl.Gfx.En
358 If $pass is $false events will be processed on that object 299 If $pass is $false events will be processed on that object
359 as normal. 300 as normal.
360 301
361 See also @.repeat_events.set, @.propagate_events.set, 302 See also @.repeat_events.set, @.propagate_events.set
362 @.freeze_events.set.
363 ]] 303 ]]
364 } 304 }
365 get { 305 get {
366 [[Determine whether an object is set to pass (ignore) events. 306 [[Determine whether an object is set to pass (ignore) events.
367 307
368 See also @.repeat_events.get, @.propagate_events.get, 308 See also @.repeat_events.get, @.propagate_events.get.
369 @.freeze_events.get.
370 ]] 309 ]]
371 /* FIXME-doc 310 /* FIXME-doc
372 Example: 311 Example:
@@ -398,7 +337,7 @@ abstract @beta Efl.Canvas.Object extends Efl.Loop_Consumer implements Efl.Gfx.En
398 $false otherwise.]] 337 $false otherwise.]]
399 } 338 }
400 } 339 }
401 @property clipees { 340 @property clipped_objects {
402 get { 341 get {
403 [[Return a list of objects currently clipped by $obj. 342 [[Return a list of objects currently clipped by $obj.
404 343
@@ -413,9 +352,8 @@ abstract @beta Efl.Canvas.Object extends Efl.Loop_Consumer implements Efl.Gfx.En
413 anymore after that point. Any use of the list after this 352 anymore after that point. Any use of the list after this
414 may have undefined results, possibly leading to crashes. 353 may have undefined results, possibly leading to crashes.
415 354
416 See also @.clip. 355 See also @.clipper.
417 ]] 356 ]]
418 legacy: null;
419 return: iterator<Efl.Canvas.Object> @warn_unused; [[An iterator over the 357 return: iterator<Efl.Canvas.Object> @warn_unused; [[An iterator over the
420 list of objects clipped by $obj.]] 358 list of objects clipped by $obj.]]
421 } 359 }
@@ -430,7 +368,6 @@ abstract @beta Efl.Canvas.Object extends Efl.Loop_Consumer implements Efl.Gfx.En
430 @since 1.18 368 @since 1.18
431 ]] 369 ]]
432 get { 370 get {
433 legacy: evas_object_smart_parent_get;
434 } 371 }
435 values { 372 values {
436 parent: Efl.Canvas.Object; [[The parent smart object of $obj or $null.]] 373 parent: Efl.Canvas.Object; [[The parent smart object of $obj or $null.]]
@@ -446,12 +383,10 @@ abstract @beta Efl.Canvas.Object extends Efl.Loop_Consumer implements Efl.Gfx.En
446 dir: Efl.Text_Bidirectional_Type; [[Paragraph direction for the given object.]] 383 dir: Efl.Text_Bidirectional_Type; [[Paragraph direction for the given object.]]
447 } 384 }
448 } 385 }
449 clipees_has @const { 386 clipped_objects_count @const {
450 [[Test if any object is clipped by $obj. 387 [[Returns the number of objects clipped by $obj
451
452 @since 1.8
453 ]] 388 ]]
454 return: bool @warn_unused; [[$true if any object is clipped by $obj, $false otherwise]] 389 return: uint @warn_unused; [[The number of objects clipped by $obj]]
455 } 390 }
456 key_grab { 391 key_grab {
457 /* FIXME: can't reference Eolian object, .eo file not being installed */ 392 /* FIXME: can't reference Eolian object, .eo file not being installed */
@@ -488,7 +423,6 @@ abstract @beta Efl.Canvas.Object extends Efl.Loop_Consumer implements Efl.Gfx.En
488 @in exclusive: bool; [[Request that the $obj is the only object 423 @in exclusive: bool; [[Request that the $obj is the only object
489 receiving the $keyname events.]] 424 receiving the $keyname events.]]
490 } 425 }
491 legacy: null;
492 } 426 }
493 key_ungrab { 427 key_ungrab {
494 [[Removes the grab on $keyname key events by $obj. 428 [[Removes the grab on $keyname key events by $obj.
@@ -507,7 +441,6 @@ abstract @beta Efl.Canvas.Object extends Efl.Loop_Consumer implements Efl.Gfx.En
507 not not be present to trigger 441 not not be present to trigger
508 the event.]] 442 the event.]]
509 } 443 }
510 legacy: null;
511 } 444 }
512 @property no_render { 445 @property no_render {
513 get { 446 get {
@@ -519,7 +452,6 @@ abstract @beta Efl.Canvas.Object extends Efl.Loop_Consumer implements Efl.Gfx.En
519 452
520 @since 1.15 453 @since 1.15
521 ]] 454 ]]
522 legacy: null;
523 } 455 }
524 set { 456 set {
525 [[Disable all rendering on the canvas. 457 [[Disable all rendering on the canvas.
@@ -540,7 +472,6 @@ abstract @beta Efl.Canvas.Object extends Efl.Loop_Consumer implements Efl.Gfx.En
540 472
541 @since 1.15 473 @since 1.15
542 ]] 474 ]]
543 legacy: null;
544 } 475 }
545 values { 476 values {
546 enable: bool; [[Enable "no-render" mode.]] 477 enable: bool; [[Enable "no-render" mode.]]
@@ -561,7 +492,6 @@ abstract @beta Efl.Canvas.Object extends Efl.Loop_Consumer implements Efl.Gfx.En
561 492
562 If $e is not a valid object, the return value is undefined. 493 If $e is not a valid object, the return value is undefined.
563 ]] 494 ]]
564 legacy: null;
565 } 495 }
566 keys { 496 keys {
567 pos: Eina.Position2D; [[The position in pixels.]] 497 pos: Eina.Position2D; [[The position in pixels.]]
@@ -570,20 +500,6 @@ abstract @beta Efl.Canvas.Object extends Efl.Loop_Consumer implements Efl.Gfx.En
570 return: bool; [[$true if the coords are inside the object, $false otherwise]] 500 return: bool; [[$true if the coords are inside the object, $false otherwise]]
571 } 501 }
572 } 502 }
573 @property event_animation {
574 [[Set the $animation which starts when the given $desc happens to the object.]]
575 get { legacy: null; }
576 set { legacy: null; }
577 keys {
578 @cref desc: Efl.Event_Description;
579 [[The event description for which the given $animation is set.]]
580 }
581 values {
582 animation: Efl.Canvas.Animation;
583 [[The animation which starts when the given $desc
584 happens to the object.]]
585 }
586 }
587 } 503 }
588 implements { 504 implements {
589 Efl.Object.constructor; 505 Efl.Object.constructor;
@@ -591,6 +507,8 @@ abstract @beta Efl.Canvas.Object extends Efl.Loop_Consumer implements Efl.Gfx.En
591 Efl.Object.invalidate; 507 Efl.Object.invalidate;
592 Efl.Object.destructor; 508 Efl.Object.destructor;
593 Efl.Object.provider_find; 509 Efl.Object.provider_find;
510 Efl.Object.event_freeze;
511 Efl.Object.event_thaw;
594 Efl.Object.debug_name_override; 512 Efl.Object.debug_name_override;
595 Efl.Gfx.Entity.visible { get; set; } 513 Efl.Gfx.Entity.visible { get; set; }
596 Efl.Gfx.Color.color { get; set; } 514 Efl.Gfx.Color.color { get; set; }
@@ -619,9 +537,6 @@ abstract @beta Efl.Canvas.Object extends Efl.Loop_Consumer implements Efl.Gfx.En
619 Efl.Canvas.Pointer.pointer_inside { get; } 537 Efl.Canvas.Pointer.pointer_inside { get; }
620 } 538 }
621 events { 539 events {
622 anim_started: Efl.Canvas.Object_Animation_Event; [[Animation is started.]]
623 anim_running: Efl.Canvas.Object_Animation_Event; [[Animation is running.]]
624 anim_ended: Efl.Canvas.Object_Animation_Event; [[Animation is ended.]]
625 animator,tick: Efl.Event_Animator_Tick; [[Animator tick synchronized with screen vsync if possible.]] 540 animator,tick: Efl.Event_Animator_Tick; [[Animator tick synchronized with screen vsync if possible.]]
626 } 541 }
627} 542}