offapi/com/sun/star/animations/XTargetPropertiesCreator.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: XTargetPropertiesCreator.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_XTargetPropertiesCreator_idl__
  31 #define __com_sun_star_animations_XTargetPropertiesCreator_idl__
  32
  33 #ifndef __com_sun_star_animations_TargetProperties_idl__
  34 #include <com/sun/star/animations/TargetProperties.idl>
  35 #endif
  36 #ifndef __com_sun_star_animations_XAnimationNode_idl__
  37 #include <com/sun/star/animations/XAnimationNode.idl>
  38 #endif
  39
  40 //=============================================================================
  41
  42  module com {  module sun {  module star {  module animations {
  43
  44 //=============================================================================
  45
  46 /** Factory interface to generate properties for all animated targets.<p>
  47
  48     Depending on mode and content of a SMIL animation tree, animation
  49     targets can have global properties different from the target's
  50     default. The most prominent example for such a difference is shape
  51     visibility: when a shape is to become visible in the course of a
  52     SMIL animation, it naturally has to be initially invisible for
  53     that effect to have any visible impact.<p>
  54
  55     This factory interface is able to generate sequences of global
  56     properties for all targets referenced in a given SMIL animation
  57     tree.
  58  */
  59 interface XTargetPropertiesCreator : ::com::sun::star::uno::XInterface
  60 {
  61     /** Determine a sequence of global target properties.<p>
  62
  63         This method generates a sequence of TargetProperties in effect
  64         before the given SMIL animations start. These properties
  65         should be applied to the given animation targets, to achieve
  66         correct playback of the SMIL animations.<p>
  67
  68         @param rootNode
  69         Root node of the SMIL animation tree.
  70      */
  71     sequence< TargetProperties > createInitialTargetProperties( [in] XAnimationNode rootNode );
  72
  73 };
  74
  75 //=============================================================================
  76
  77 service TargetPropertiesCreator: XTargetPropertiesCreator;
  78
  79 }; }; }; };
  80
  81 #endif