summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/animations/XIterateContainer.idl
blob: 4c01e0b6efc3b6b6739ee49bd52557063bc1f88c (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
/* -*- 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 .
 */


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


/** An iterate container iterates over subitems of a given target object
    and animates them by subsequently executes the contained effects on them.
    <br>
    This could be used to animate a target text word by word or letter by
    letter.
*/
interface XIterateContainer : XTimeContainer
{
    /** a target that contains iterable contents, f.e. a paragraph.
        <br>
        See documentation of used animation engine for supported targets.
    */
    [attribute] any Target;

    /** This attribute specifies an optional subitem from the target element
        that should be animated.
        <br>
        A value of zero should always be the default and animate the complete target.
        <br>
        See documentation of used animation engine for supported subitems.
    */
    [attribute] short SubItem;

    /** the type of iteration, this depends on the target.
        <br>
        See documentation of used animation engine for supported iteration types.
    */
    [attribute] short IterateType;

    /** the time interval in second before the next iterated content is animated.
    */
    [attribute] double IterateInterval;
};


}; }; }; };

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