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