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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_animations_XAnimateTransform_idl__
  28 #define __com_sun_star_animations_XAnimateTransform_idl__
  29
  30 #ifndef __com_sun_star_animations_XAnimate_idl__
  31 #include <com/sun/star/animations/XAnimate.idl>
  32 #endif
  33
  34 //=============================================================================
  35
  36  module com {  module sun {  module star {  module animations {
  37
  38 //=============================================================================
  39
  40 /** animates a transformation attribute on a target element, thereby allowing
  41     animations to control translation, scaling, rotation and/or skewing.
  42
  43     The member <member>XAnimate::Attributes</member> contains a short from
  44     <const>AnimationTransformType</const>.
  45
  46     Depending on the value in <member>XAnimate::Attributes</member>, the
  47     members <member>XAnimate::From</member>, <member>XAnimate::To</member>,
  48     <member>XAnimate::By</member> or <member>XAnimate::Values</member>
  49     contain the following
  50
  51     <ul>
  52     <li><const>AnimationTransformType::TRANSLATE</const><br>
  53         <type>ValuePair</type> of <i>tx</i> and <i>ty</i></li>
  54     <li><const>AnimationTransformType::SCALE</const><br>
  55         <type>ValuePair</type> of <i>sx</i> and <i>sy</i></li>
  56     <li><const>AnimationTransformType::ROTATE</const><br>
  57         Values for a rotation angle</li>
  58     <li><const>AnimationTransformType::SKEWX</const><br>
  59         Values for a skew-angle</li>
  60     <li><const>AnimationTransformType::SKEWY</const><br>
  61         Values for a skew-angle</li>
  62     </ul>
  63
  64     @see http://www.w3.org/TR/SVG/animate.html#AnimateTransformElement
  65 */
  66 interface XAnimateTransform : XAnimate
  67 {
  68     /**
  69         @see <const>AnimationTransformType</const>
  70     */
  71     [attribute] short TransformType;
  72 };
  73
  74 //=============================================================================
  75
  76 }; }; }; };
  77
  78 #endif
  79