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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XAnimationNode.idl,v $
  10  * $Revision: 1.4 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_animations_XAnimationNode_idl__
  31 #define __com_sun_star_animations_XAnimationNode_idl__
  32
  33 #ifndef __com_sun_star_container_XChild_idl__
  34 #include <com/sun/star/container/XChild.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_beans_NamedValue_idl__
  38 #include <com/sun/star/beans/NamedValue.idl>
  39 #endif
  40
  41 //=============================================================================
  42
  43  module com {  module sun {  module star {  module animations {
  44
  45 //=============================================================================
  46
  47 /**
  48 */
  49 interface XAnimationNode : ::com::sun::star::container::XChild
  50 {
  51     /**  a value from <const>AnimationNodeType</const>.
  52
  53         @see http://www.w3.org/TR/smil20/smil-timing.html#adef-timeContainer
  54     */
  55     [readonly, attribute] short Type;
  56
  57     /** a sequnece of values that define the begining of this element
  58         <br>
  59         <member>Begin</member> is
  60             <ul>
  61             <li><atom>double</atom> describes the element begin as an offset in seconds from an implicit syncbase.
  62                 The definition of the implicit syncbase depends upon the element's parent time container.
  63                 The offset is measured in parent simple time.</li>
  64             <li><type>Event</type> describes an event and an optional offset that determine the
  65                 element begin. The element begin is defined relative to the time that the event
  66                 is raised.</li>
  67             <li><const>Timing::INDEFINITE</const> the begin of the element will be determined by an
  68                 external event to the element.</li>
  69             <li><type>sequence&lt;any&gt;</type> a sequence of values described above if more than
  70                 one begin value is defined for this element.</li>
  71             <li><void/> if no begin behaviour is defined for this element.</li>
  72             </ul>
  73
  74         @see http://www.w3.org/TR/smil20/smil-timing.html#adef-begin
  75     */
  76     [attribute] any Begin;
  77
  78     /** defines the length of the simple duration.
  79         <br>
  80         <member>Duration</member> is
  81             <ul>
  82             <li><atom>double</atom> specifies the length of the simple duration in seconds.</li>
  83             <li><const>Timing::INDEFINITE</const> specifies the simple duration as indefinite.</li>
  84             <li><const>Timing::MEDIA</const> specifies the simple duration as the intrinsic media duration. This is only valid for elements that define media.</li>
  85             <li><void/> the simple duration for the element is defined to be the implicit duration of the element.</li>
  86             </ul>
  87
  88         @see http://www.w3.org/TR/smil20/smil-timing.html#adef-dur
  89     */
  90     [attribute] any Duration;
  91
  92     /** a sequnece of values that define the ending of this element
  93         <br>
  94         <member>End</member> is
  95             <ul>
  96             <li><atom>double</atom> describes the element end as an offset in seconds from an implicit syncbase.
  97                 The definition of the implicit syncbase depends upon the element's parent time container.
  98                 The offset is measured in parent simple time.</li>
  99             <li><type>Event</type> describes an event and an optional offset that determine the
 100                 element end. The element end is defined relative to the time that the event
 101                 is raised.</li>
 102             <li><const>Timing::INDEFINITE</const> the end of the element will be determined by an
 103                 external event to the element.</li>
 104             <li><type>sequence&lt;any&gt;</type> a sequence of values described above if more than
 105                 one begin value is defined for this element.</li>
 106             <li><void/> if no end behaviour is defined for this element.</li>
 107             </ul>
 108
 109         @see http://www.w3.org/TR/smil20/smil-timing.html#adef-end
 110     */
 111     [attribute] any End;
 112
 113     /** controls the implicit duration of time containers,
 114         as a function of the children.
 115         <br>
 116         The endsync attribute is only valid for
 117         par and excl time container elements, and media elements with timed
 118         children (e.g. animate or area elements).
 119
 120         <member>EndSync</member> is
 121             eiter a <atom>short</atom> constant from <const>EndSync</const>,
 122             an interface reference to a child <type>XTimeContainer</type>
 123             or <void/>.
 124
 125         @see http://www.w3.org/TR/smil20/smil-timing.html#adef-endsync
 126     */
 127     [attribute] any EndSync;
 128
 129     /** the number of iterations of the simple duration.
 130         <br>
 131         <member>RepeatCount</member> is
 132             <ul>
 133             <li><atom>double</atom>
 134                 this is a numeric value that specifies the number of iterations.
 135                 It can include partial iterations expressed as fraction values.
 136                 A fractional value describes a portion of the simple duration.
 137                 Values must be greater than 0.</li>
 138             <li><const>Timing::INDEFINITE</const> the element is defined to repeat indefinitely
 139                 (subject to the constraints of the parent time container).</li>
 140             <li><void/>
 141                 no repeat count is defined for this element.</li>
 142             </ul>
 143
 144         @see <const>EndSync</const>
 145         @see http://www.w3.org/TR/smil20/smil-timing.html#adef-repeatCount
 146     */
 147     [attribute] any RepeatCount;
 148
 149     /** the total duration for repeat.
 150         <br>
 151         <member>RepeatDuration</member> is
 152             <ul>
 153             <li><atom>double</atom>
 154                 specifies the duration in element active time
 155                 to repeat the simple duration in seconds.</li>
 156             <li><const>Timing::INDEFINITE</const> the element is defined to repeat indefinitely
 157                 (subject to the constraints of the parent time container).</li>
 158             <li><void/>
 159                 No repeat duration is defined for this element. </li>
 160             </ul>
 161
 162         @see http://www.w3.org/TR/smil20/smil-timing.html#adef-repeatDur
 163     */
 164     [attribute] any RepeatDuration;
 165
 166     /** the attribute that specify the behaviour how an element
 167         should be extended beyond the active duration by freezing the final
 168         state of the element.
 169         <br>
 170         <member>Fill</member> is
 171             a value from <const>AnimationFill</const>.
 172
 173         @see <const>Fill</const>
 174         @see http://www.w3.org/TR/smil20/smil-timing.html#adef-fill
 175     */
 176     [attribute] short Fill;
 177
 178     /** the default value for the fill behavior for this element and all
 179         descendents.
 180         <br>
 181         <member>FillDefault</member> is
 182             <ul>
 183             <li>The values <const>AnimationFill::REMOVE</const>, <const>AnimationFill::FREEZE</const>,
 184             <const>AnimationFill::HOLD</const>, <const>AnimationFill::TRANSITION</const> and <const>AnimationFill::AUTO</const>
 185             specify that the element fill behavior is the respective value.</li>
 186             <li>The value <const>AnimationFill::INHERIT</const> specifies that the value of this attribute
 187             (and of the fill behavior) are inherited from the <member>FillDefault</member> value of the parent
 188             element. If there is no parent element, the value is <const>AnimationFill::AUTO</const>.</li>
 189             </ul>
 190
 191         @see <const>Fill</const>
 192         @see http://www.w3.org/TR/smil20/smil-timing.html#adef-fillDefault
 193     */
 194     [attribute] short FillDefault;
 195
 196     /** defines the restart behaviour of this element.
 197         <br>
 198         <member>Restart</member> is
 199             a <atom>short</atom> value from <const>AnimationRestart</const>.
 200
 201         @see <const>AnimationRestart</const>
 202         @see http://www.w3.org/TR/smil20/smil-timing.html#adef-restart
 203     */
 204     [attribute] short Restart;
 205
 206     /** defines the default restart behaviour for this element and all descendents.
 207
 208         @returns
 209             a value from <const>Restart</const>.
 210
 211         @see <const>AnimationRestart</const>
 212         @see http://www.w3.org/TR/smil20/smil-timing.html#adef-restartDefault
 213     */
 214     [attribute] short RestartDefault;
 215
 216     /** defines the acceleration for this element.
 217         <br>
 218         Element time will accelerate from a rate of 0 at the beginning up
 219         to a run rate, over the course of the specified proportion of the
 220         simple duration.
 221
 222         <member>Acceleration</member> is
 223             a value between 0 (no acceleration) and 1 (acceleration until end
 224             of the elements duration).
 225
 226         @see http://www.w3.org/TR/smil20/smil-timemanip.html#adef-accelerate
 227     */
 228     [attribute] double Acceleration;
 229
 230     /** defines the deceleration for this element.
 231         Element time will deceleration from a run rate to a rate of 0 at the
 232         ending, over the course of the specified proportion of the
 233         simple duration.
 234
 235         <member>Decelerate</member> is
 236             a value between 0 (no deceleration) and 1 (deceleration from beginning
 237             of the elements duration).
 238
 239         @see http://www.w3.org/TR/smil20/smil-timemanip.html#adef-decelerate
 240     */
 241     [attribute] double Decelerate;
 242
 243     /** defines the auto reverse settings for this element.
 244
 245         <member>AutoRevers</member> is
 246             <ul>
 247             <li><false/> if the animation is played normal.</li>
 248             <li><true/> if the animation is played forwards and then backwards. This doubles the duration</li>
 249             </ul>
 250
 251         @see http://www.w3.org/TR/smil20/smil-timemanip.html#adef-autoReverse
 252     */
 253     [attribute] boolean AutoReverse;
 254
 255     /**
 256     */
 257     [attribute] sequence< ::com::sun::star::beans::NamedValue > UserData;
 258 };
 259
 260 //=============================================================================
 261
 262 }; }; }; };
 263
 264 #endif