LibreOffice
LibreOffice 5.3 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...
 
- Public Attributes inherited from XAnimationNode
short Type
 a value from AnimationNodeType. More...
 
any Begin
 a sequence of values that define the beginning of this element
Begin is More...
 
any Duration
 defines the length of the simple duration. More...
 
any End
 a sequence of values that define the ending of this element
End is More...
 
any EndSync
 controls the implicit duration of time containers, as a function of the children. More...
 
any RepeatCount
 the number of iterations of the simple duration. More...
 
any RepeatDuration
 the total duration for repeat. More...
 
short Fill
 the attribute that specify the behavior how an element should be extended beyond the active duration by freezing the final state of the element. More...
 
short FillDefault
 the default value for the fill behavior for this element and all descendants. More...
 
short Restart
 defines the restart behavior of this element. More...
 
short RestartDefault
 defines the default restart behavior for this element and all descendants. More...
 
double Acceleration
 defines the acceleration for this element. More...
 
double Decelerate
 defines the deceleration for this element. More...
 
boolean AutoReverse
 defines the auto reverse settings for this element. More...
 
sequence
< ::com::sun::star::beans::NamedValue
UserData
 

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 )
 
- Public Member Functions inherited from XChild
com::sun::star::uno::XInterface getParent ()
 grants access to the object containing this content. More...
 
void setParent ([in] com::sun::star::uno::XInterface Parent) raises ( com::sun::star::lang::NoSupportException )
 sets the parent to this object. More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 

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: