offapi/com/sun/star/animations/XAnimationNode.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21  module com {  module sun {  module star {  module animations {
  22
  23
  24 interface XAnimationNode : ::com::sun::star::container::XChild
  25 {
  26     /**  a value from AnimationNodeType.
  27
  28         @see http://www.w3.org/TR/smil20/smil-timing.html#adef-timeContainer
  29     */
  30     [readonly, attribute] short Type;
  31
  32     /** a sequence of values that define the beginning of this element
  33         <br>
  34         #Begin is
  35             <ul>
  36             <li>`double` describes the element begin as an offset in seconds from an implicit syncbase.
  37                 The definition of the implicit syncbase depends upon the element's parent time container.
  38                 The offset is measured in parent simple time.</li>
  39             <li>Event describes an event and an optional offset that determine the
  40                 element begin. The element begin is defined relative to the time that the event
  41                 is raised.</li>
  42             <li>Timing::INDEFINITE the begin of the element will be determined by an
  43                 external event to the element.</li>
  44             <li>sequence&lt;any&gt; a sequence of values described above if more than
  45                 one begin value is defined for this element.</li>
  46             <li>`VOID` if no begin behavior is defined for this element.</li>
  47             </ul>
  48
  49         @see http://www.w3.org/TR/smil20/smil-timing.html#adef-begin
  50     */
  51     [attribute] any Begin;
  52
  53     /** defines the length of the simple duration.
  54         <br>
  55         #Duration is
  56             <ul>
  57             <li>`double` specifies the length of the simple duration in seconds.</li>
  58             <li>Timing::INDEFINITE specifies the simple duration as indefinite.</li>
  59             <li>Timing::MEDIA specifies the simple duration as the intrinsic media duration. This is only valid for elements that define media.</li>
  60             <li>`VOID` the simple duration for the element is defined to be the implicit duration of the element.</li>
  61             </ul>
  62
  63         @see http://www.w3.org/TR/smil20/smil-timing.html#adef-dur
  64     */
  65     [attribute] any Duration;
  66
  67     /** a sequence of values that define the ending of this element
  68         <br>
  69         #End is
  70             <ul>
  71             <li>`double` describes the element end as an offset in seconds from an implicit syncbase.
  72                 The definition of the implicit syncbase depends upon the element's parent time container.
  73                 The offset is measured in parent simple time.</li>
  74             <li>Event describes an event and an optional offset that determine the
  75                 element end. The element end is defined relative to the time that the event
  76                 is raised.</li>
  77             <li>Timing::INDEFINITE the end of the element will be determined by an
  78                 external event to the element.</li>
  79             <li>sequence&lt;any&gt; a sequence of values described above if more than
  80                 one begin value is defined for this element.</li>
  81             <li>`VOID` if no end behavior is defined for this element.</li>
  82             </ul>
  83
  84         @see http://www.w3.org/TR/smil20/smil-timing.html#adef-end
  85     */
  86     [attribute] any End;
  87
  88     /** controls the implicit duration of time containers,
  89         as a function of the children.
  90         <br>
  91         The EndSync attribute is only valid for
  92         par and excl time container elements, and media elements with timed
  93         children (e.g. animate or area elements).
  94
  95         #EndSync is
  96             either a `short` constant from EndSync,
  97             an interface reference to a child XTimeContainer
  98             or `VOID`.
  99
 100         @see http://www.w3.org/TR/smil20/smil-timing.html#adef-endsync
 101     */
 102     [attribute] any EndSync;
 103
 104     /** the number of iterations of the simple duration.
 105         <br>
 106         #RepeatCount is
 107             <ul>
 108             <li>`double`
 109                 this is a numeric value that specifies the number of iterations.
 110                 It can include partial iterations expressed as fraction values.
 111                 A fractional value describes a portion of the simple duration.
 112                 Values must be greater than 0.</li>
 113             <li>Timing::INDEFINITE the element is defined to repeat indefinitely
 114                 (subject to the constraints of the parent time container).</li>
 115             <li>`VOID`
 116                 no repeat count is defined for this element.</li>
 117             </ul>
 118
 119         @see EndSync
 120         @see http://www.w3.org/TR/smil20/smil-timing.html#adef-repeatCount
 121     */
 122     [attribute] any RepeatCount;
 123
 124     /** the total duration for repeat.
 125         <br>
 126         #RepeatDuration is
 127             <ul>
 128             <li>`double`
 129                 specifies the duration in element active time
 130                 to repeat the simple duration in seconds.</li>
 131             <li>Timing::INDEFINITE the element is defined to repeat indefinitely
 132                 (subject to the constraints of the parent time container).</li>
 133             <li>`VOID`
 134                 No repeat duration is defined for this element. </li>
 135             </ul>
 136
 137         @see http://www.w3.org/TR/smil20/smil-timing.html#adef-repeatDur
 138     */
 139     [attribute] any RepeatDuration;
 140
 141     /** the attribute that specify the behavior how an element
 142         should be extended beyond the active duration by freezing the final
 143         state of the element.
 144         <br>
 145         #Fill is
 146             a value from AnimationFill.
 147
 148         @see Fill
 149         @see http://www.w3.org/TR/smil20/smil-timing.html#adef-fill
 150     */
 151     [attribute] short Fill;
 152
 153     /** the default value for the fill behavior for this element and all
 154         descendants.
 155         <br>
 156         #FillDefault is
 157             <ul>
 158             <li>The values AnimationFill::REMOVE, AnimationFill::FREEZE,
 159             AnimationFill::HOLD, AnimationFill::TRANSITION and AnimationFill::AUTO
 160             specify that the element fill behavior is the respective value.</li>
 161             <li>The value AnimationFill::INHERIT specifies that the value of this attribute
 162             (and of the fill behavior) are inherited from the #FillDefault value of the parent
 163             element. If there is no parent element, the value is AnimationFill::AUTO.</li>
 164             </ul>
 165
 166         @see Fill
 167         @see http://www.w3.org/TR/smil20/smil-timing.html#adef-fillDefault
 168     */
 169     [attribute] short FillDefault;
 170
 171     /** defines the restart behavior of this element.
 172         <br>
 173         #Restart is
 174             a `short` value from AnimationRestart.
 175
 176         @see AnimationRestart
 177         @see http://www.w3.org/TR/smil20/smil-timing.html#adef-restart
 178     */
 179     [attribute] short Restart;
 180
 181     /** defines the default restart behavior for this element and all descendants.
 182
 183         @returns
 184             a value from Restart.
 185
 186         @see AnimationRestart
 187         @see http://www.w3.org/TR/smil20/smil-timing.html#adef-restartDefault
 188     */
 189     [attribute] short RestartDefault;
 190
 191     /** defines the acceleration for this element.
 192         <br>
 193         Element time will accelerate from a rate of 0 at the beginning up
 194         to a run rate, over the course of the specified proportion of the
 195         simple duration.
 196
 197         #Acceleration is
 198             a value between 0 (no acceleration) and 1 (acceleration until end
 199             of the elements duration).
 200
 201         @see http://www.w3.org/TR/smil20/smil-timemanip.html#adef-accelerate
 202     */
 203     [attribute] double Acceleration;
 204
 205     /** defines the deceleration for this element.
 206         Element time will deceleration from a run rate to a rate of 0 at the
 207         ending, over the course of the specified proportion of the
 208         simple duration.
 209
 210         #Decelerate is
 211             a value between 0 (no deceleration) and 1 (deceleration from beginning
 212             of the elements duration).
 213
 214         @see http://www.w3.org/TR/smil20/smil-timemanip.html#adef-decelerate
 215     */
 216     [attribute] double Decelerate;
 217
 218     /** defines the auto reverse settings for this element.
 219
 220         #AutoReverse is
 221             <ul>
 222             <li>`FALSE` if the animation is played normal.</li>
 223             <li>`TRUE` if the animation is played forwards and then backwards. This doubles the duration</li>
 224             </ul>
 225
 226         @see http://www.w3.org/TR/smil20/smil-timemanip.html#adef-autoReverse
 227     */
 228     [attribute] boolean AutoReverse;
 229
 230     [attribute] sequence< ::com::sun::star::beans::NamedValue > UserData;
 231 };
 232
 233
 234 }; }; }; };
 235
 236 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */