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_XIterateContainer_idl__
28#define __com_sun_star_animations_XIterateContainer_idl__
29
30#ifndef __com_sun_star_animations_XTimeContainer_idl__
31#include <com/sun/star/animations/XTimeContainer.idl>
32#endif
33
34//=============================================================================
35
36 module com {  module sun {  module star {  module animations {
37
38//=============================================================================
39
40/** An iterate container iterates over subitems of a given target object
41	and animates them by subsequently executes the contained effects on them.
42	<br>
43	This could be used to animate a target text word by word or letter by
44	letter.
45*/
46interface XIterateContainer : XTimeContainer
47{
48	/** a target that contains iterateable contents, f.e. a paragraph.
49		<br>
50		See documentation of used animation engine for supported targets.
51	*/
52	[attribute] any Target;
53
54	/** This attribute specifies an optional subitem from the target element
55		that should be animated.
56		<br>
57		A value of zero should always be the default and animate the complete target.
58		<br>
59		See documentation of used animation engine for supported subitems.
60	*/
61	[attribute] short SubItem;
62
63	/** the type of iteration, this depends on the target.
64		<br>
65		See documentation of used animation engine for supported iteration types.
66	*/
67	[attribute] short IterateType;
68
69	/** the time interval in percentage of the containers running time
70		before the next iterated content is animated.
71	*/
72	[attribute] double IterateInterval;
73};
74
75//=============================================================================
76
77}; }; }; };
78
79#endif
80