summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/animations/XTargetPropertiesCreator.idl
blob: b5d782aa3feadf7ee7ece4769f6d738751556a8f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef __com_sun_star_animations_XTargetPropertiesCreator_idl__
#define __com_sun_star_animations_XTargetPropertiesCreator_idl__

#include <com/sun/star/animations/TargetProperties.idl>
#include <com/sun/star/animations/XAnimationNode.idl>


 module com {  module sun {  module star {  module animations {


/** Factory interface to generate properties for all animated targets.<p>

    Depending on mode and content of a SMIL animation tree, animation
    targets can have global properties different from the target's
    default. The most prominent example for such a difference is shape
    visibility: when a shape is to become visible in the course of a
    SMIL animation, it naturally has to be initially invisible for
    that effect to have any visible impact.<p>

    This factory interface is able to generate sequences of global
    properties for all targets referenced in a given SMIL animation
    tree.
 */
interface XTargetPropertiesCreator : ::com::sun::star::uno::XInterface
{
    /** Determine a sequence of global target properties.<p>

        This method generates a sequence of TargetProperties in effect
        before the given SMIL animations start. These properties
        should be applied to the given animation targets, to achieve
        correct playback of the SMIL animations.<p>

        @param rootNode
        Root node of the SMIL animation tree.
     */
    sequence< TargetProperties > createInitialTargetProperties( [in] XAnimationNode rootNode );

};


}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */