<html> <head> <title>Interface XAnimatedImages</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="XAnimatedImages-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"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub"><a href="#AttributesSummary" class="navisub">Attributes' Summary</a></td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></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">awt</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 XAnimatedImages</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td><dl> <dt><b>Base Interfaces</b></dt> <dd><pre style="font-family:monospace;"><strong>XAnimatedImages</strong> ┗ ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XContainer.html">XContainer</a> </pre></dd> <dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle"> <tr> <td class="imsum_left">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XContainer.html">XContainer</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>allows other components to observer the insertion, removal, and replacement of image sets </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>allows administrating a set of images, to be displayed as animated seres. </dd> <dd><p>Components implementing this interface maintain a variable number of image sets. Components displaying those images will choose the best-fitting image set depending on the available space, and possibly other restrictions.</p> </dd> <dt><b>Since </b></dt> <dd>OOo 3.4 </dd> </dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#getImageSetCount">getImageSetCount</a></td> <td class="imsum_right">returns the number of images sets maintained by the component. </td> </tr> <tr> <td class="imsum_left"><a href="#getImageSet">getImageSet</a></td> <td class="imsum_right">returns the URLs of the image set with the given index </td> </tr> <tr> <td class="imsum_left"><a href="#insertImageSet">insertImageSet</a></td> <td class="imsum_right">sets the URLs of the image set with the given index </td> </tr> <tr> <td class="imsum_left"><a href="#replaceImageSet">replaceImageSet</a></td> <td class="imsum_right">replaces the image set given by index with a new one </td> </tr> <tr> <td class="imsum_left"><a href="#removeImageSet">removeImageSet</a></td> <td class="imsum_right">removes the image set with the given index </td> </tr> </table> <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="#StepTime">StepTime</a></td> <td class="imsum_right">specifies the time in milliseconds between two animation steps. </td> </tr> <tr> <td class="imsum_left"><a href="#AutoRepeat">AutoRepeat</a></td> <td class="imsum_right">specifies whether the animation should start over with the first image of the image series when the last image has been played. </td> </tr> <tr> <td class="imsum_left"><a href="#ScaleMode">ScaleMode</a></td> <td class="imsum_right">controls the way the images are scaled up or down, when the available space is larger or smaller than what is needed for them. </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="getImageSetCount" class="membertitle">getImageSetCount</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">long</td> </tr> <tr> <td valign="top"><b>getImageSetCount</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the number of images sets maintained by the component. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getImageSet" class="membertitle">getImageSet</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">sequence< string ></td> </tr> <tr> <td valign="top"><b>getImageSet</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> i_index )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IndexOutOfBoundsException.html">IndexOutOfBoundsException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the URLs of the image set with the given index </dd> <dt><b>Parameter i_index</b></dt> <dd>the index of the set those image URLs are to be retrieved. Must be greater than or equal to <code>0</code>, and smaller than the value returned by <a href="#getImageSetCount">getImageSetCount</a>. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::lang::IndexOutOfBoundsException if the <code>i_index</code> is not a valid index. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="insertImageSet" class="membertitle">insertImageSet</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>insertImageSet</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> i_index,</td> </tr> <tr> <td/><td valign="top">[in] sequence< string ></td> <td valign="bottom"> i_imageURLs )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IndexOutOfBoundsException.html">IndexOutOfBoundsException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>sets the URLs of the image set with the given index </dd> <dt><b>Parameter i_index</b></dt> <dd>the index at which a new image set should be inserted. Must be greater than or equal to <code>0</code>, and smaller than or equal to the value returned by <a href="#getImageSetCount">getImageSetCount</a>. </dd> <dt><b>Parameter i_imageURLs</b></dt> <dd>the URLs for the images for the given set. Will be resolved using a ::com::sun::star::<a href="../graphic/module-ix.html">graphic</a>::<a href="../graphic/GraphicProvider.html">GraphicProvider</a>. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::lang::IndexOutOfBoundsException if the <code>i_index</code> is not a valid index. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="replaceImageSet" class="membertitle">replaceImageSet</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>replaceImageSet</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> i_index,</td> </tr> <tr> <td/><td valign="top">[in] sequence< string ></td> <td valign="bottom"> i_imageURLs )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IndexOutOfBoundsException.html">IndexOutOfBoundsException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>replaces the image set given by index with a new one </dd> <dt><b>Parameter i_index</b></dt> <dd>the index of the set those image URLs are to be replaced. Must be greater than or equal to <code>0</code>, and smaller than the value returned by <a href="#getImageSetCount">getImageSetCount</a>. </dd> <dt><b>Parameter i_imageURLs</b></dt> <dd>the URLs for the images for the given set. Will be resolved using a ::com::sun::star::<a href="../graphic/module-ix.html">graphic</a>::<a href="../graphic/GraphicProvider.html">GraphicProvider</a>. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::lang::IndexOutOfBoundsException if the <code>i_index</code> is not a valid index. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="removeImageSet" class="membertitle">removeImageSet</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>removeImageSet</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> i_index )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IndexOutOfBoundsException.html">IndexOutOfBoundsException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>removes the image set with the given index </dd> <dt><b>Parameter i_index</b></dt> <dd>the index of the set to remove. Must be greater than or equal to <code>0</code>, and smaller than the value returned by <a href="#getImageSetCount">getImageSetCount</a>. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::lang::IndexOutOfBoundsException if the <code>i_index</code> is not a valid index. </dd> </dl> </td> </tr> </table> </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="StepTime" class="membertitle">StepTime</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>long <b>StepTime</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the time in milliseconds between two animation steps. </dd> <dd><p>This is the minimum time, the actual value might be longer due to system load. The default value will be 100 ms.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="AutoRepeat" class="membertitle">AutoRepeat</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>AutoRepeat</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies whether the animation should start over with the first image of the image series when the last image has been played. </dd> <dd><p>The default value for this attribute is <b>true</b>.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ScaleMode" class="membertitle">ScaleMode</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>short <b>ScaleMode</b><dl> <dd>set raises (::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a>);</dd> </dl> <hr> <dl> <dt><b>Description</b></dt> <dd>controls the way the images are scaled up or down, when the available space is larger or smaller than what is needed for them. </dd> <dd><p>Allowed values are those from the <a href="ImageScaleMode.html">ImageScaleMode</a> constants group.</p> </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>
