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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28 #ifndef __com_sun_star_animations_XAnimate_idl__
  29 #define __com_sun_star_animations_XAnimate_idl__
  30
  31 #include <com/sun/star/animations/XAnimationNode.idl>
  32 #include <com/sun/star/animations/TimeFilterPair.idl>
  33
  34 //=============================================================================
  35
  36  module com {  module sun {  module star {  module animations {
  37
  38 //=============================================================================
  39
  40 /** Interface for generic animation.
  41
  42     @see http://www.w3.org/TR/smil20/animation.html#edef-animate
  43 */
  44 interface XAnimate : XAnimationNode
  45 {
  46     /** This attribute specifies the target element to be animated.
  47         <br>
  48         See documentation of used animation engine for supported targets.
  49     */
  50     [attribute] any Target;
  51
  52     /** This attribute specifies an optional subitem from the target element
  53         that should be animated.
  54         <br>
  55         A value of zero should always be the default and animate the complete target.
  56         <br>
  57         See documentation of used animation engine for supported subitems.
  58     */
  59     [attribute] short SubItem;
  60
  61     /** Specifies the target attribute.
  62
  63         @see http://www.w3.org/TR/smil20/animation.html#adef-attributeName
  64     */
  65     [attribute] string AttributeName;
  66
  67     /** A sequence of one or more values, each of which must be a legal value for
  68         the specified attribute.
  69
  70         @see http://www.w3.org/TR/smil20/animation.html#adef-values
  71     */
  72     [attribute] sequence< any > Values;
  73
  74     /**
  75     */
  76     [attribute] sequence< double > KeyTimes;
  77
  78     /**
  79         @see AnimationValueType
  80     */
  81     [attribute] short ValueType;
  82
  83     /** Specifies the interpolation mode for the animation.
  84         <br>
  85         If the target attribute does not support linear interpolation (e.g. for strings),
  86         or if the values attribute has only one value, the CalcMode attribute is ignored
  87         and discrete interpolation is used.
  88
  89         @see AnimationCalcMode;
  90     */
  91     [attribute] short CalcMode;
  92
  93     /** Controls whether or not the animation is cumulative.
  94
  95         @see http://www.w3.org/TR/smil20/animation.html#adef-accumulate
  96     */
  97     [attribute] boolean Accumulate;
  98
  99     /** Controls whether or not the animation is additive.
 100
 101         @see AnimationAdditiveMode
 102         @see http://www.w3.org/TR/smil20/animation.html#adef-additive
 103     */
 104     [attribute] short Additive;
 105
 106     /** Specifies the starting value of the animation.
 107         <br>
 108         Must be a legal value for the specified attribute.
 109         Ignored if the <member>Values</member> attribute is specified.
 110
 111         @see http://www.w3.org/TR/smil20/animation.html#adef-from
 112     */
 113     [attribute] any From;
 114
 115     /** Specifies the ending value of the animation.
 116         <br>
 117         Must be a legal value for the specified attribute.
 118         Ignored if the <member>Values</member> attribute is specified.
 119
 120         @see http://www.w3.org/TR/smil20/animation.html#adef-to
 121     */
 122     [attribute] any To;
 123
 124     /** Specifies a relative offset value for the animation.
 125         <br>
 126         Must be a legal value of a domain for which addition to the attributeType
 127         domain is defined and which yields a value in the attributeType domain.
 128         Ignored if the values attribute is specified.
 129         Ignored if the <member>Values</member> attribute is specified.
 130
 131         @see http://www.w3.org/TR/smil20/animation.html#adef-by
 132     */
 133     [attribute] any By;
 134
 135     /** todo: timeFilter="0,0; 0.14,0.36; 0.43,0.73; 0.71,0.91; 1.0,1.0" ?
 136     */
 137     [attribute] sequence< TimeFilterPair > TimeFilter;
 138
 139     /** if this string is set, its contents will be parsed as a formula.
 140         All values are used as a parameter for this formula and the computed
 141         result will be used.
 142     */
 143     [attribute] string Formula;
 144 };
 145
 146 //=============================================================================
 147
 148 }; }; }; };
 149
 150 #endif
 151
 152 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */