diff options
Diffstat (limited to 'offapi/com/sun/star/animations/XIterateContainer.idl')
-rw-r--r-- | offapi/com/sun/star/animations/XIterateContainer.idl | 79 |
1 files changed, 79 insertions, 0 deletions
diff --git a/offapi/com/sun/star/animations/XIterateContainer.idl b/offapi/com/sun/star/animations/XIterateContainer.idl new file mode 100644 index 000000000000..f22c5df4f0db --- /dev/null +++ b/offapi/com/sun/star/animations/XIterateContainer.idl @@ -0,0 +1,79 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org 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 version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 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 |