/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XIterateContainer.idl,v $
 *
 *  $Revision: 1.3 $
 *
 *  last change: $Author: rt $ $Date: 2005/09/07 20:42:06 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/
#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
