offapi/com/sun/star/animations/XAnimateTransform.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: XAnimateTransform.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_XAnimateTransform_idl__
  31 #define __com_sun_star_animations_XAnimateTransform_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 /** animates a transformation attribute on a target element, thereby allowing
  44     animations to control translation, scaling, rotation and/or skewing.
  45
  46     The member <member>XAnimate::Attributes</member> contains a short from
  47     <const>AnimationTransformType</const>.
  48
  49     Depending on the value in <member>XAnimate::Attributes</member>, the
  50     members <member>XAnimate::From</member>, <member>XAnimate::To</member>,
  51     <member>XAnimate::By</member> or <member>XAnimate::Values</member>
  52     contain the following
  53
  54     <ul>
  55     <li><const>AnimationTransformType::TRANSLATE</const><br>
  56         <type>ValuePair</type> of <i>tx</i> and <i>ty</i></li>
  57     <li><const>AnimationTransformType::SCALE</const><br>
  58         <type>ValuePair</type> of <i>sx</i> and <i>sy</i></li>
  59     <li><const>AnimationTransformType::ROTATE</const><br>
  60         Values for a rotation angle</li>
  61     <li><const>AnimationTransformType::SKEWX</const><br>
  62         Values for a skew-angle</li>
  63     <li><const>AnimationTransformType::SKEWY</const><br>
  64         Values for a skew-angle</li>
  65     </ul>
  66
  67     @see http://www.w3.org/TR/SVG/animate.html#AnimateTransformElement
  68 */
  69 interface XAnimateTransform : XAnimate
  70 {
  71     /**
  72         @see <const>AnimationTransformType</const>
  73     */
  74     [attribute] short TransformType;
  75 };
  76
  77 //=============================================================================
  78
  79 }; }; }; };
  80
  81 #endif
  82