LibreOffice
LibreOffice 5.0 SDK API Reference
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Attributes | List of all members
XIterateContainer Interface Reference

An iterate container iterates over subitems of a given target object and animates them by subsequently executes the contained effects on them. More...

import "XIterateContainer.idl";

Inheritance diagram for XIterateContainer:
XTimeContainer XAnimationNode XChild XInterface

Public Attributes

any Target
 a target that contains iterable contents, f.e. More...
 
short SubItem
 This attribute specifies an optional subitem from the target element that should be animated. More...
 
short IterateType
 the type of iteration, this depends on the target. More...
 
double IterateInterval
 the time interval in percentage of the containers running time before the next iterated content is animated. More...
 

Additional Inherited Members

- Public Member Functions inherited from XTimeContainer
XAnimationNode insertBefore ([in] XAnimationNode newChild,[in] XAnimationNode refChild) raises ( com::sun::star::lang::IllegalArgumentException, com::sun::star::container::NoSuchElementException, com::sun::star::container::ElementExistException, com::sun::star::lang::WrappedTargetException )
 
XAnimationNode insertAfter ([in] XAnimationNode newChild,[in] XAnimationNode refChild) raises ( com::sun::star::lang::IllegalArgumentException, com::sun::star::container::NoSuchElementException, com::sun::star::container::ElementExistException, com::sun::star::lang::WrappedTargetException )
 
XAnimationNode replaceChild ([in] XAnimationNode newChild,[in] XAnimationNode oldChild) raises ( com::sun::star::lang::IllegalArgumentException, com::sun::star::container::NoSuchElementException, com::sun::star::container::ElementExistException, com::sun::star::lang::WrappedTargetException )
 
XAnimationNode removeChild ([in] XAnimationNode oldChild) raises ( com::sun::star::lang::IllegalArgumentException, com::sun::star::container::NoSuchElementException, com::sun::star::lang::WrappedTargetException )
 
XAnimationNode appendChild ([in] XAnimationNode newChild) raises ( com::sun::star::lang::IllegalArgumentException, com::sun::star::container::ElementExistException, com::sun::star::lang::WrappedTargetException )
 

Detailed Description

An iterate container iterates over subitems of a given target object and animates them by subsequently executes the contained effects on them.


This could be used to animate a target text word by word or letter by letter.

Member Data Documentation

double IterateInterval
attribute

the time interval in percentage of the containers running time before the next iterated content is animated.

short IterateType
attribute

the type of iteration, this depends on the target.


See documentation of used animation engine for supported iteration types.

short SubItem
attribute

This attribute specifies an optional subitem from the target element that should be animated.


A value of zero should always be the default and animate the complete target.
See documentation of used animation engine for supported subitems.

any Target
attribute

a target that contains iterable contents, f.e.

a paragraph.
See documentation of used animation engine for supported targets.


The documentation for this interface was generated from the following file: