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