offapi/com/sun/star/animations/XAnimate.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: XAnimate.idl,v $
  10  * $Revision: 1.5 $
  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_XAnimate_idl__
  31 #define __com_sun_star_animations_XAnimate_idl__
  32
  33 #ifndef __com_sun_star_animations_XAnimationNode_idl__
  34 #include <com/sun/star/animations/XAnimationNode.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_animations_TimeFilterPair_idl__
  38 #include <com/sun/star/animations/TimeFilterPair.idl>
  39 #endif
  40
  41 //=============================================================================
  42
  43  module com {  module sun {  module star {  module animations {
  44
  45 //=============================================================================
  46
  47 /** Interface for generic animation.
  48
  49     @see http://www.w3.org/TR/smil20/animation.html#edef-animate
  50 */
  51 interface XAnimate : XAnimationNode
  52 {
  53     /** This attribute specifies the target element to be animated.
  54         <br>
  55         See documentation of used animation engine for supported targets.
  56     */
  57     [attribute] any Target;
  58
  59     /** This attribute specifies an optional subitem from the target element
  60         that should be animated.
  61         <br>
  62         A value of zero should always be the default and animate the complete target.
  63         <br>
  64         See documentation of used animation engine for supported subitems.
  65     */
  66     [attribute] short SubItem;
  67
  68     /** Specifies the target attribute.
  69
  70         @see http://www.w3.org/TR/smil20/animation.html#adef-attributeName
  71     */
  72     [attribute] string AttributeName;
  73
  74     /** A sequence of one or more values, each of which must be a legal value for
  75         the specified attribute.
  76
  77         @see http://www.w3.org/TR/smil20/animation.html#adef-values
  78     */
  79     [attribute] sequence< any > Values;
  80
  81     /**
  82     */
  83     [attribute] sequence< double > KeyTimes;
  84
  85     /**
  86         @see AnimationValueType
  87     */
  88     [attribute] short ValueType;
  89
  90     /** Specifies the interpolation mode for the animation.
  91         <br>
  92         If the target attribute does not support linear interpolation (e.g. for strings),
  93         or if the values attribute has only one value, the CalcMode attribute is ignored
  94         and discrete interpolation is used.
  95
  96         @see AnimationCalcMode;
  97     */
  98     [attribute] short CalcMode;
  99
 100     /** Controls whether or not the animation is cumulative.
 101
 102         @see http://www.w3.org/TR/smil20/animation.html#adef-accumulate
 103     */
 104     [attribute] boolean Accumulate;
 105
 106     /** Controls whether or not the animation is additive.
 107
 108         @see AnimationAdditiveMode
 109         @see http://www.w3.org/TR/smil20/animation.html#adef-additive
 110     */
 111     [attribute] short Additive;
 112
 113     /** Specifies the starting value of the animation.
 114         <br>
 115         Must be a legal value for the specified attribute.
 116         Ignored if the <member>Values</member> attribute is specified.
 117
 118         @see http://www.w3.org/TR/smil20/animation.html#adef-from
 119     */
 120     [attribute] any From;
 121
 122     /** Specifies the ending value of the animation.
 123         <br>
 124         Must be a legal value for the specified attribute.
 125         Ignored if the <member>Values</member> attribute is specified.
 126
 127         @see http://www.w3.org/TR/smil20/animation.html#adef-to
 128     */
 129     [attribute] any To;
 130
 131     /** Specifies a relative offset value for the animation.
 132         <br>
 133         Must be a legal value of a domain for which addition to the attributeType
 134         domain is defined and which yields a value in the attributeType domain.
 135         Ignored if the values attribute is specified.
 136         Ignored if the <member>Values</member> attribute is specified.
 137
 138         @see http://www.w3.org/TR/smil20/animation.html#adef-by
 139     */
 140     [attribute] any By;
 141
 142     /** todo: timeFilter="0,0; 0.14,0.36; 0.43,0.73; 0.71,0.91; 1.0,1.0" ?
 143     */
 144     [attribute] sequence< TimeFilterPair > TimeFilter;
 145
 146     /** if this string is set, its contents will be parsed as a formula.
 147         All values are used as a parameter for this formula and the computet
 148         result will be used.
 149     */
 150     [attribute] string Formula;
 151 };
 152
 153 //=============================================================================
 154
 155 }; }; }; };
 156
 157 #endif
 158