xref: /AOO41X/main/offapi/com/sun/star/animations/XAnimateColor.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_animations_XAnimateColor_idl__
24#define __com_sun_star_animations_XAnimateColor_idl__
25
26#ifndef __com_sun_star_animations_XAnimate_idl__
27#include <com/sun/star/animations/XAnimate.idl>
28#endif
29
30//=============================================================================
31
32 module com {  module sun {  module star {  module animations {
33
34//=============================================================================
35
36/** Interface for animation by defining color changes over time.
37    <br>
38    Only color value will be legal values for the following members
39    <ul>
40    <li><member>XAnimate::Values</member></li>
41    <li><member>XAnimate::From</member></li>
42    <li><member>XAnimate::To</member></li>
43    <li><member>XAnimate::By</member></li>
44    </ul>
45    @see http://www.w3.org/TR/smil20/animation.html#edef-animateColor
46*/
47interface XAnimateColor : XAnimate
48{
49    /** defines the color space which is used to perform the interpolation.
50        <br>
51        @see <const>AnimateColorSpace</const>
52    */
53    [attribute] short ColorInterpolation;
54
55    /** defines the direction which is used to perform the interpolation
56        inside the color space defined with <member>ColorSpace</member>.
57        <br>
58        Values could be <true/> for clockwise and <false/> for counterclockwise.
59
60        This attribute will be ignored for color spaces where this does
61        not make any sense.
62    */
63    [attribute] boolean Direction;
64};
65
66//=============================================================================
67
68}; }; }; };
69
70#endif
71