summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorXavi Artigas <xavierartigas@yahoo.es>2020-03-17 11:39:41 +0100
committerXavi Artigas <xavierartigas@yahoo.es>2020-03-17 11:39:41 +0100
commit84e561f4dddfa5896304197e0e54ba6b701d7e73 (patch)
treedd864b66976c34251e4aba7b3340d51c7216ed7c
parent60f8495d809c3e140ce53d1fb185d96e5e58e608 (diff)
docs: Improve Spotlight.Animation_Manager docs
-rw-r--r--src/lib/elementary/efl_ui_spotlight_animation_manager.eo55
1 files changed, 33 insertions, 22 deletions
diff --git a/src/lib/elementary/efl_ui_spotlight_animation_manager.eo b/src/lib/elementary/efl_ui_spotlight_animation_manager.eo
index c82d9666a0..da402113c6 100644
--- a/src/lib/elementary/efl_ui_spotlight_animation_manager.eo
+++ b/src/lib/elementary/efl_ui_spotlight_animation_manager.eo
@@ -1,51 +1,62 @@
1class @beta Efl.Ui.Spotlight.Animation_Manager extends Efl.Ui.Spotlight.Manager 1class @beta Efl.Ui.Spotlight.Animation_Manager extends Efl.Ui.Spotlight.Manager
2{ 2{
3 [[A spotlight manager that uses animation objects to react to different @Efl.Ui.Spotlight.Manager.switch_to situations. 3 [[A spotlight manager that uses animation objects to react to different @Efl.Ui.Spotlight.Manager.switch_to
4 situations.
4 5
5 Animations are played forward when they are on the $to argument, they are played backward when they are on the $from argument. 6 Animations are played forward when they are on the $to argument and they are played backward when they are on the
7 $from argument.
6 8
7 Pop animations are always played backwards, Push animations are always played forward. 9 Pop animations are always played backwards, Push animations are always played forward.
8 Reason for this is, the reusability. You should be able to pass in 1 animation to all sitatuations, which should cover the turn arround effect that "moving in" and "moving out" has. This means, when you have a alpha channel animation, the pop animation can be the same as the jump-in and out animation, and both will look like fading out. 10 The reason for this is reusability: you can use the same animation in all situations and this covers the
9 11 inverted effect that "moving in" and "moving out" has.
10 12 For example, when you have an alpha channel animation, the Pop animation can be the same as the Jump-In and Out
13 animation, and both will look like fading out.
11 ]] 14 ]]
12 c_prefix: efl_ui_spotlight_manager_animation; 15 c_prefix: efl_ui_spotlight_manager_animation;
13 methods { 16 methods {
14 @property push_setup{ 17 @property push_setup {
15 [[Animation that is used to animate the $to argument of a switch_to request when the passed $reason is push. 18 [[Animation that is used to animate the $to argument of a @Efl.Ui.Spotlight.Manager.switch_to request when
16 19 the passed $reason is @Efl.Ui.Spotlight.Manager_Switch_Reason.push.
17 20
18 If these animations are $null, then the $in and $out animation of @.jump_setup will be taken instead. 21 If these animations are $null, then the $in and $out animation of @.jump_setup will be used instead.
19 ]] 22 ]]
20 values { 23 values {
21 in : Efl.Canvas.Animation; [[The animation to play, the implementation will take an additional reference]] 24 in : Efl.Canvas.Animation; [[The animation to play, the implementation will take an additional reference]]
22 out : Efl.Canvas.Animation; [[The animation to play, the implementation will take an additional reference. Can be the same as $in.]] 25 out : Efl.Canvas.Animation; [[The animation to play, the implementation will take an additional reference.
26 Can be the same as $in.]]
23 } 27 }
24 set { } 28 set {}
25 } 29 }
26 @property pop_setup{
27 [[Animation that is used to animate the $from argument of a switch_to request when the passed $reason is pop.
28 30
29 Note: this animations is always played backwards, see the class documentation for the reasoning. 31 @property pop_setup {
32 [[Animation that is used to animate the $from argument of a @Efl.Ui.Spotlight.Manager.switch_to request when
33 the passed $reason is @Efl.Ui.Spotlight.Manager_Switch_Reason.pop.
30 34
31 If these animations are $null, then the $in and $out animation of @.jump_setup will be taken instead. 35 Note: These animations are always played backwards, see the class documentation for the reasoning.
36
37 If these animations are $null, then the $in and $out animation of @.jump_setup will be used instead.
32 ]] 38 ]]
33 values { 39 values {
34 in : Efl.Canvas.Animation; [[The animation to play, the implementation will take an additional reference]] 40 in : Efl.Canvas.Animation; [[The animation to play, the implementation will take an additional reference]]
35 out : Efl.Canvas.Animation; [[The animation to play, the implementation will take an additional reference. Can be the same as $in.]] 41 out : Efl.Canvas.Animation; [[The animation to play, the implementation will take an additional reference.
42 Can be the same as $in.]]
36 } 43 }
37 set { } 44 set {}
38 } 45 }
39 @property jump_setup{
40 [[Set the animation objects you want to play on a jump in or jump out.
41 46
42 When a switch to request is issued, two arguments are getting animated. The $from object, and the $to objects. The $from object will be playing the out animation. The $pop object will be playing the in animation. 47 @property jump_setup {
48 [[Sets the animation objects you want to play on a jump in or jump out.
49
50 When a @Efl.Ui.Spotlight.Manager.switch_to request is issued, two arguments are getting animated.
51 The $from object, and the $to object. The $from object will play the $out animation whereas the $to object
52 will play the $in animation.
43 53
44 The out animation will always be played backwards, this is to support passing the same animation object to both parameters. (A fade animation will fade in the new object, and fade out the old object). 54 The $out animation will always be played backwards. See the class documentation for the reasoning.
45 ]] 55 ]]
46 values { 56 values {
47 in : Efl.Canvas.Animation; [[The animation to play, the implementation will take an additional reference]] 57 in : Efl.Canvas.Animation; [[The animation to play, the implementation will take an additional reference]]
48 out : Efl.Canvas.Animation; [[The animation to play, the implementation will take an additional reference. Can be the same as $in.]] 58 out : Efl.Canvas.Animation; [[The animation to play, the implementation will take an additional reference.
59 Can be the same as $in.]]
49 } 60 }
50 set { 61 set {
51 62