offapi/com/sun/star/animations/XAnimateColor.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: XAnimateColor.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_XAnimateColor_idl__
  31 #define __com_sun_star_animations_XAnimateColor_idl__
  32
  33 #ifndef __com_sun_star_animations_XAnimate_idl__
  34 #include <com/sun/star/animations/XAnimate.idl>
  35 #endif
  36
  37 //=============================================================================
  38
  39  module com {  module sun {  module star {  module animations {
  40
  41 //=============================================================================
  42
  43 /** Interface for animation by defining color changes over time.
  44     <br>
  45     Only color value will be legal values for the following members
  46     <ul>
  47     <li><member>XAnimate::Values</member></li>
  48     <li><member>XAnimate::From</member></li>
  49     <li><member>XAnimate::To</member></li>
  50     <li><member>XAnimate::By</member></li>
  51     </ul>
  52     @see http://www.w3.org/TR/smil20/animation.html#edef-animateColor
  53 */
  54 interface XAnimateColor : XAnimate
  55 {
  56     /** defines the color space which is used to perform the interpolation.
  57         <br>
  58         @see <const>AnimateColorSpace</const>
  59     */
  60     [attribute] short ColorInterpolation;
  61
  62     /** defines the direction which is used to perform the interpolation
  63         inside the color space defined with <member>ColorSpace</member>.
  64         <br>
  65         Values could be <true/> for clockwise and <false/> for counterclockwise.
  66
  67         This attribute will be ignored for color spaces where this does
  68         not make any sense.
  69     */
  70     [attribute] boolean Direction;
  71 };
  72
  73 //=============================================================================
  74
  75 }; }; }; };
  76
  77 #endif