<html>
<head>
<title>Interface XIterateContainer</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../idl.css">
</head>
<body>
<div id="adc-idlref">
<a name="_top_"> </a><table class="navimain" border="0" cellpadding="3">
<tr>
<td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td>
<td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td>
<td class="navimain"><a href="XIterateContainer-xref.html" class="navimain">Use</a></td>
<td class="navimainnone">Devguide</td>
<td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td>
</tr>
</table>
<table class="navisub" border="0" cellpadding="0">
<tr>
<td class="navisub">Methods' Summary</td>
<td class="navisub"><a href="#AttributesSummary" class="navisub">Attributes' Summary</a></td>
<td class="navisub">Methods' Details</td>
<td class="navisub"><a href="#AttributesDetails" class="navisub">Attributes' Details</a></td>
</tr>
</table>
<hr>
<table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;">
<tr>
<td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">animations</a> :: </p>
</td>
</tr>
<tr>
<td class="title"><table class="title-table" width="99%">
<tr>
<td width="25%" class="title2">unpublished </td>
<td width="50%" class="title">interface XIterateContainer</td>
<td width="*"/></tr>
</table>
</td>
</tr>
<tr>
<td><dl>
<dt><b>Base Interfaces</b></dt>
<dd><pre style="font-family:monospace;"><strong>XIterateContainer</strong>
┗ <a href="XTimeContainer.html">XTimeContainer</a>
┗ <a href="XAnimationNode.html">XAnimationNode</a>
┗ ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XChild.html">XChild</a>
</pre></dd>
<dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle">
<tr>
<td class="imsum_left"><a href="XTimeContainer.html">XTimeContainer</a></td>
<td class="imsum_right"><dl>
<dt>(referenced interface's summary:)</dt>
<dd>Supported modules
</dd>
</dl>
</td>
</tr>
</table>
</dd>
</dl>
</td>
</tr>
<tr>
<td><dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>not published</i></dd>
<dt><b>Description</b></dt>
<dd>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.
</dd>
</dl>
</td>
</tr>
</table>
<hr>
<a name="AttributesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Attributes' Summary</td>
</tr>
<tr>
<td class="imsum_left"><a href="#Target">Target</a></td>
<td class="imsum_right">a target that contains iterable contents, f.e. a paragraph.
<br>
See documentation of used animation engine for supported targets.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#SubItem">SubItem</a></td>
<td class="imsum_right">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.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#IterateType">IterateType</a></td>
<td class="imsum_right">the type of iteration, this depends on the target.
<br>
See documentation of used animation engine for supported iteration types.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#IterateInterval">IterateInterval</a></td>
<td class="imsum_right">the time interval in percentage of the containers running time
before the next iterated content is animated.
</td>
</tr>
</table>
<a name="AttributesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle">Attributes' Details</td>
</tr>
<tr>
<td class="imdetail"><a name="Target" class="membertitle">Target</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>any <b>Target</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>a target that contains iterable contents, f.e. a paragraph.
<br>
See documentation of used animation engine for supported targets.
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="SubItem" class="membertitle">SubItem</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>short <b>SubItem</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>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.
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="IterateType" class="membertitle">IterateType</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>short <b>IterateType</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>the type of iteration, this depends on the target.
<br>
See documentation of used animation engine for supported iteration types.
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="IterateInterval" class="membertitle">IterateInterval</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>double <b>IterateInterval</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>the time interval in percentage of the containers running time
before the next iterated content is animated.
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
</table>
<a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2000, 2012 LibreOffice contributors and/or their affiliates. All rights reserved.</p><p class="copyright" align="center">LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.</p><p class="copyright" align="center">The Document Foundation acknowledges all community members, please find more info <a href="http://www.libreoffice.org/about-us/credits/" target="_blank">at our website</a>.<p> </p><p class="copyright" align="center"><a href="http://www.libreoffice.org/privacy" target="_blank">Privacy Policy</a> | <a href="http://www.libreoffice.org/imprint" target="_blank">Impressum (Legal Info)</a> | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (<a href="http://www.libreoffice.org/download/license/" target="_blank">LGPLv3</a>). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our <a href="http://wiki.documentfoundation.org/TradeMark_Policy" target="_blank">trademark policy</a>.</p>
</div> <!-- id="adc-idlref" -->
</body>
</html>
