AOO410/main/offapi/com/sun/star/animations/XIterateContainer.idl

/**************************************************************
 * 
 * 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
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 * 
 *************************************************************/


#ifndef __com_sun_star_animations_XIterateContainer_idl__ 
#define __com_sun_star_animations_XIterateContainer_idl__ 

#ifndef __com_sun_star_animations_XTimeContainer_idl__
#include <com/sun/star/animations/XTimeContainer.idl>
#endif

//============================================================================= 
 
 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 iterateable 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 percentage of the containers running time
		before the next iterated content is animated.
	*/
	[attribute] double IterateInterval;
};

//============================================================================= 
 
}; }; }; };  

#endif