<html> <head> <title>Interface XSlidePreviewCache</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="XSlidePreviewCache-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">Attributes' Summary</td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Details</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">drawing</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 XSlidePreviewCache</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>not published</i></dd> <dt><b>Description</b></dt> <dd>A cache of preview bitmaps for the slides of one Impress or Draw document in one size. There may be more than one cache for one document. These are internally connected and for missing previews one cache may take it from another cache and scale it to the desired size. When a preview is not present then it is created asynchronously. On creation all registered listeners are notified. Slides are referenced via their index in an XIndexAccess container in order to allow multiple references to a single slide (custom presentations). </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="#setDocumentSlides">setDocumentSlides</a></td> <td class="imsum_right">Set the set of slides for which the cache will provide the previews. All slides in the given XIndexAccess are required to come from the given model. </td> </tr> <tr> <td class="imsum_left"><a href="#setVisibleRange">setVisibleRange</a></td> <td class="imsum_right">Define which slides are currently visible on the screen and which are not. This information is used for give preview creation for visible slides a higher priority than for those slides that are not visible. </td> </tr> <tr> <td class="imsum_left"><a href="#setPreviewSize">setPreviewSize</a></td> <td class="imsum_right">Define the size of the previews that are managed by the called cache. </td> </tr> <tr> <td class="imsum_left"><a href="#getSlidePreview">getSlidePreview</a></td> <td class="imsum_right">Return a preview for the given slide index. The returned bitmap may be the requested preview, a preview of the preview, i.e. a scaled up or down version, or an empty reference when the preview is not yet present. This call may lead to the asynchronous creation of the requested preview. In that case all registered listeners are notified when the preview has been created. </td> </tr> <tr> <td class="imsum_left"><a href="#addPreviewCreationNotifyListener">addPreviewCreationNotifyListener</a></td> <td class="imsum_right">Register a listener that is called when a preview has been created asynchronously. </td> </tr> <tr> <td class="imsum_left"><a href="#removePreviewCreationNotifyListener">removePreviewCreationNotifyListener</a></td> <td class="imsum_right">Remove a previously registered listener for preview creations. </td> </tr> <tr> <td class="imsum_left"><a href="#pause">pause</a></td> <td class="imsum_right">Stop the asynchronous creation of previews temporarily. Call <method>resume()</method> to restart it. </td> </tr> <tr> <td class="imsum_left"><a href="#resume">resume</a></td> <td class="imsum_right">Resume the asynchronous creation of slide previews. </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="setDocumentSlides" class="membertitle">setDocumentSlides</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>setDocumentSlides</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XIndexAccess.html">XIndexAccess</a></td> <td valign="bottom"> xSlides,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/XInterface.html">XInterface</a></td> <td valign="bottom"> xDocument );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Set the set of slides for which the cache will provide the previews. All slides in the given XIndexAccess are required to come from the given model. </dd> <dt><b>Parameter xSlides</b></dt> <dd>The set of slides for which the called cache will provide the previews. This container defines the indices that are used to look up slides. </dd> <dt><b>Parameter xDocument</b></dt> <dd>The model that contains the slides reference by the xSlides argument. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setVisibleRange" class="membertitle">setVisibleRange</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>setVisibleRange</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> nFirstVisibleSlideIndex,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nLastVisibleSlideIndex );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Define which slides are currently visible on the screen and which are not. This information is used for give preview creation for visible slides a higher priority than for those slides that are not visible. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setPreviewSize" class="membertitle">setPreviewSize</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>setPreviewSize</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../geometry/module-ix.html">geometry</a>::<a href="../geometry/IntegerSize2D.html">IntegerSize2D</a></td> <td valign="bottom"> aSize );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Define the size of the previews that are managed by the called cache. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getSlidePreview" class="membertitle">getSlidePreview</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">::com::sun::star::<a href="../rendering/module-ix.html">rendering</a>::<a href="../rendering/XBitmap.html">XBitmap</a></td> </tr> <tr> <td valign="top"><b>getSlidePreview</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> nSlideIndex,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../rendering/module-ix.html">rendering</a>::<a href="../rendering/XCanvas.html">XCanvas</a></td> <td valign="bottom"> xCanvas )</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/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Return a preview for the given slide index. The returned bitmap may be the requested preview, a preview of the preview, i.e. a scaled up or down version, or an empty reference when the preview is not yet present. This call may lead to the asynchronous creation of the requested preview. In that case all registered listeners are notified when the preview has been created. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="addPreviewCreationNotifyListener" class="membertitle">addPreviewCreationNotifyListener</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>addPreviewCreationNotifyListener</b>(</td> <td valign="top">[in] <a href="XSlidePreviewCacheListener.html">XSlidePreviewCacheListener</a></td> <td valign="bottom"> xListener );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Register a listener that is called when a preview has been created asynchronously. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="removePreviewCreationNotifyListener" class="membertitle">removePreviewCreationNotifyListener</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>removePreviewCreationNotifyListener</b>(</td> <td valign="top">[in] <a href="XSlidePreviewCacheListener.html">XSlidePreviewCacheListener</a></td> <td valign="bottom"> xListener );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Remove a previously registered listener for preview creations. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="pause" class="membertitle">pause</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>pause</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Stop the asynchronous creation of previews temporarily. Call <method>resume()</method> to restart it. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="resume" class="membertitle">resume</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>resume</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Resume the asynchronous creation of slide previews. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</p> </div> <!-- id="adc-idlref" --> </body> </html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
fc480f9d5aabed8eeaffe8ad3401a94c
>
files
>
2857
