1*d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4*d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5*d1766043SAndrew Rist * distributed with this work for additional information
6*d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9*d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10*d1766043SAndrew Rist *
11*d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12*d1766043SAndrew Rist *
13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14*d1766043SAndrew Rist * software distributed under the License is distributed on an
15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17*d1766043SAndrew Rist * specific language governing permissions and limitations
18*d1766043SAndrew Rist * under the License.
19*d1766043SAndrew Rist *
20*d1766043SAndrew Rist *************************************************************/
21*d1766043SAndrew Rist
22*d1766043SAndrew Rist
23cdf0e10cSrcweir#ifndef __com_sun_star_animations_XIterateContainer_idl__
24cdf0e10cSrcweir#define __com_sun_star_animations_XIterateContainer_idl__
25cdf0e10cSrcweir
26cdf0e10cSrcweir#ifndef __com_sun_star_animations_XTimeContainer_idl__
27cdf0e10cSrcweir#include <com/sun/star/animations/XTimeContainer.idl>
28cdf0e10cSrcweir#endif
29cdf0e10cSrcweir
30cdf0e10cSrcweir//=============================================================================
31cdf0e10cSrcweir
32cdf0e10cSrcweir module com {  module sun {  module star {  module animations {
33cdf0e10cSrcweir
34cdf0e10cSrcweir//=============================================================================
35cdf0e10cSrcweir
36cdf0e10cSrcweir/** An iterate container iterates over subitems of a given target object
37cdf0e10cSrcweir	and animates them by subsequently executes the contained effects on them.
38cdf0e10cSrcweir	<br>
39cdf0e10cSrcweir	This could be used to animate a target text word by word or letter by
40cdf0e10cSrcweir	letter.
41cdf0e10cSrcweir*/
42cdf0e10cSrcweirinterface XIterateContainer : XTimeContainer
43cdf0e10cSrcweir{
44cdf0e10cSrcweir	/** a target that contains iterateable contents, f.e. a paragraph.
45cdf0e10cSrcweir		<br>
46cdf0e10cSrcweir		See documentation of used animation engine for supported targets.
47cdf0e10cSrcweir	*/
48cdf0e10cSrcweir	[attribute] any Target;
49cdf0e10cSrcweir
50cdf0e10cSrcweir	/** This attribute specifies an optional subitem from the target element
51cdf0e10cSrcweir		that should be animated.
52cdf0e10cSrcweir		<br>
53cdf0e10cSrcweir		A value of zero should always be the default and animate the complete target.
54cdf0e10cSrcweir		<br>
55cdf0e10cSrcweir		See documentation of used animation engine for supported subitems.
56cdf0e10cSrcweir	*/
57cdf0e10cSrcweir	[attribute] short SubItem;
58cdf0e10cSrcweir
59cdf0e10cSrcweir	/** the type of iteration, this depends on the target.
60cdf0e10cSrcweir		<br>
61cdf0e10cSrcweir		See documentation of used animation engine for supported iteration types.
62cdf0e10cSrcweir	*/
63cdf0e10cSrcweir	[attribute] short IterateType;
64cdf0e10cSrcweir
65cdf0e10cSrcweir	/** the time interval in percentage of the containers running time
66cdf0e10cSrcweir		before the next iterated content is animated.
67cdf0e10cSrcweir	*/
68cdf0e10cSrcweir	[attribute] double IterateInterval;
69cdf0e10cSrcweir};
70cdf0e10cSrcweir
71cdf0e10cSrcweir//=============================================================================
72cdf0e10cSrcweir
73cdf0e10cSrcweir}; }; }; };
74cdf0e10cSrcweir
75cdf0e10cSrcweir#endif
76