efl_canvas_animation_player: improve docs
Reviewers: segfaultxavi Reviewed By: segfaultxavi Subscribers: cedric, #reviewers, #committers Tags: #efl Differential Revision: https://phab.enlightenment.org/D10250
This commit is contained in:
parent
f3199ba04b
commit
f324e9fc11
|
@ -1,13 +1,19 @@
|
||||||
class @beta Efl.Canvas.Animation_Player extends Efl.Object implements Efl.Player, Efl.Playable
|
class @beta Efl.Canvas.Animation_Player extends Efl.Object implements Efl.Player, Efl.Playable
|
||||||
{
|
{
|
||||||
[[Efl animation object class]]
|
[[Player object for playing canvas animations.
|
||||||
|
|
||||||
|
This player object can be used to play animations on a @.target canvas object.
|
||||||
|
The type of animation depends on the @.animation object.
|
||||||
|
]]
|
||||||
c_prefix: efl_animation_player;
|
c_prefix: efl_animation_player;
|
||||||
methods {
|
methods {
|
||||||
@property animation {
|
@property animation {
|
||||||
set {}
|
[[The animation to play.
|
||||||
get {}
|
|
||||||
|
This animation object will be used to change the visual state of the @.target object.
|
||||||
|
]]
|
||||||
values {
|
values {
|
||||||
animation: Efl.Canvas.Animation;
|
animation: Efl.Canvas.Animation; [[An already-configured animation object.]]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@property auto_del {
|
@property auto_del {
|
||||||
|
@ -22,13 +28,13 @@ class @beta Efl.Canvas.Animation_Player extends Efl.Object implements Efl.Player
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@property target {
|
@property target {
|
||||||
[[Target object property]]
|
[[The canvas object to apply the effects of the @.animation object on.
|
||||||
set {
|
|
||||||
}
|
The @.animation object can change several properties of the $target.
|
||||||
get {
|
You should ensure that nothing else is trying to change them too.
|
||||||
}
|
]]
|
||||||
values {
|
values {
|
||||||
target: Efl.Canvas.Object; [[Target object which is applied animation.]]
|
target: Efl.Canvas.Object; [[Canvas object to animate.]]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in New Issue