summaryrefslogtreecommitdiff
path: root/src/lib/evas/canvas/efl_canvas_object.eo
diff options
context:
space:
mode:
authorXavi Artigas <xavierartigas@yahoo.es>2018-11-28 13:33:46 +0100
committerDaniel Kolesa <d.kolesa@samsung.com>2018-11-28 13:33:46 +0100
commit05682eed7d572874928424af82fba819790c4228 (patch)
treee95f5777ba237b378c2ceb166ce6657a6214e2fd /src/lib/evas/canvas/efl_canvas_object.eo
parentc602c075cada6eb56158d398c27f57b522bafdc7 (diff)
eo-docs: Remove Doxygen tags from efl*.eo files
Summary: - Replace '\@ref name' with '@name' - Remove unused \@internal tag This tag affects text AFTER it, and there is no text after it. - Remove \@note tag Replaced with a simple NOTE: text, since eolian does not have an equivalent tag. - Remove spurious \@Efl... tags They should really be @Efl... - Remove \@p tags There is no eolian equivalent, and a simpler $ suffices in this case. Fixes T7482 Reviewers: q66 Reviewed By: q66 Subscribers: cedric, #reviewers, #committers Tags: #efl Maniphest Tasks: T7482 Differential Revision: https://phab.enlightenment.org/D7372
Diffstat (limited to 'src/lib/evas/canvas/efl_canvas_object.eo')
-rw-r--r--src/lib/evas/canvas/efl_canvas_object.eo23
1 files changed, 6 insertions, 17 deletions
diff --git a/src/lib/evas/canvas/efl_canvas_object.eo b/src/lib/evas/canvas/efl_canvas_object.eo
index af5599c..6be3fcd 100644
--- a/src/lib/evas/canvas/efl_canvas_object.eo
+++ b/src/lib/evas/canvas/efl_canvas_object.eo
@@ -140,7 +140,7 @@ abstract Efl.Canvas.Object (Efl.Loop_Consumer, Efl.Gfx.Entity, Efl.Gfx.Color, Ef
140 140
141 The visibility of an object affects the objects that are 141 The visibility of an object affects the objects that are
142 clipped by it, so if the object clipping others is not shown 142 clipped by it, so if the object clipping others is not shown
143 (as in \@ref evas_object_show), the objects clipped by it will 143 (as in @Efl.Gfx.Entity.visible), the objects clipped by it will
144 not be shown either. 144 not be shown either.
145 145
146 If $obj was being clipped by another object when this function 146 If $obj was being clipped by another object when this function
@@ -173,7 +173,7 @@ abstract Efl.Canvas.Object (Efl.Loop_Consumer, Efl.Gfx.Entity, Efl.Gfx.Color, Ef
173 173
174 If $repeat is $true, it will make events on $obj to also be 174 If $repeat is $true, it will make events on $obj to also be
175 repeated for the next lower object in the objects' stack (see 175 repeated for the next lower object in the objects' stack (see
176 see \@ref evas_object_below_get). 176 see @Efl.Gfx.Stack.below).
177 177
178 If $repeat is $false, events occurring on $obj will be 178 If $repeat is $false, events occurring on $obj will be
179 processed only on it. 179 processed only on it.
@@ -244,10 +244,7 @@ abstract Efl.Canvas.Object (Efl.Loop_Consumer, Efl.Gfx.Entity, Efl.Gfx.Color, Ef
244 at the same time. This function adds a new seat to the focus list. In other words, 244 at the same time. This function adds a new seat to the focus list. In other words,
245 after the seat is added to the list this object will now be also focused by this new seat. 245 after the seat is added to the list this object will now be also focused by this new seat.
246 246
247 This function generates an \@ref EFL_CANVAS_OBJECT_EVENT_FOCUS_DEVICE_IN event. 247 Note: The old focus APIs still work, however they will only act on the default seat.
248
249 \@note The old focus APIs ( \@ref evas_object_focus_get, \@ref evas_object_focus_set,
250 @.key_grab) will still work, however they will only act on the default seat.
251 248
252 @since 1.19 249 @since 1.19
253 ]] 250 ]]
@@ -260,8 +257,6 @@ abstract Efl.Canvas.Object (Efl.Loop_Consumer, Efl.Gfx.Entity, Efl.Gfx.Color, Ef
260 seat_focus_del { 257 seat_focus_del {
261 [[ Remove a seat from the focus list. 258 [[ Remove a seat from the focus list.
262 259
263 Removing an seat from the focus list is an unfocus operation, thus it will generate an
264 \@ref EFL_CANVAS_OBJECT_EVENT_FOCUS_DEVICE_OUT event.
265 @since 1.19 260 @since 1.19
266 ]] 261 ]]
267 params { 262 params {
@@ -354,7 +349,7 @@ abstract Efl.Canvas.Object (Efl.Loop_Consumer, Efl.Gfx.Entity, Efl.Gfx.Color, Ef
354 349
355 If $pass is $true, it will make events on $obj to be ignored. 350 If $pass is $true, it will make events on $obj to be ignored.
356 They will be triggered on the next lower object (that is not 351 They will be triggered on the next lower object (that is not
357 set to pass events), instead (see \@ref evas_object_below_get). 352 set to pass events), instead (see @Efl.Gfx.Stack.below).
358 353
359 If $pass is $false events will be processed on that object 354 If $pass is $false events will be processed on that object
360 as normal. 355 as normal.
@@ -463,16 +458,13 @@ abstract Efl.Canvas.Object (Efl.Loop_Consumer, Efl.Gfx.Entity, Efl.Gfx.Color, Ef
463 events for the given keys. 458 events for the given keys.
464 459
465 $keyname is a platform dependent symbolic name for the key 460 $keyname is a platform dependent symbolic name for the key
466 pressed (see \@ref Evas_Keys for more information). 461 pressed.
467 462
468 $modifiers and $not_modifiers are bit masks of all the 463 $modifiers and $not_modifiers are bit masks of all the
469 modifiers that must and mustn't, respectively, be pressed along 464 modifiers that must and mustn't, respectively, be pressed along
470 with $keyname key in order to trigger this new key grab. 465 with $keyname key in order to trigger this new key grab.
471 Modifiers can be things such as Shift and Ctrl as well as 466 Modifiers can be things such as Shift and Ctrl as well as
472 user defined types via \@ref evas_key_modifier_add. Retrieve 467 user defined types via @Evas.Canvas.key_modifier_add.
473 them with \@ref evas_key_modifier_mask_get or use 0 for empty
474 masks.
475
476 $exclusive will make the given object the only one permitted to 468 $exclusive will make the given object the only one permitted to
477 grab the given key. If given $true, subsequent calls on this 469 grab the given key. If given $true, subsequent calls on this
478 function with different $obj arguments will fail, unless the key 470 function with different $obj arguments will fail, unless the key
@@ -480,9 +472,6 @@ abstract Efl.Canvas.Object (Efl.Loop_Consumer, Efl.Gfx.Entity, Efl.Gfx.Color, Ef
480 472
481 Warning: Providing impossible modifier sets creates undefined 473 Warning: Providing impossible modifier sets creates undefined
482 behavior. 474 behavior.
483
484 See also @.key_ungrab, @.key_focus.get, @.key_focus.set,
485 \@ref evas_focus_get, \@ref evas_key_modifier_add.
486 ]] 475 ]]
487 return: bool @warn_unused; [[$true if the call succeeded, $false otherwise.]] 476 return: bool @warn_unused; [[$true if the call succeeded, $false otherwise.]]
488 params { 477 params {