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