Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: drawing ::

interface XSlidePreviewCache
Description
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).

Methods' Summary
setDocumentSlides 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.  
setVisibleRange 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.  
setPreviewSize Define the size of the previews that are managed by the called cache.  
getSlidePreview 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.  
addPreviewCreationNotifyListener Register a listener that is called when a preview has been created asynchronously.  
removePreviewCreationNotifyListener Remove a previously registered listener for preview creations.  
pause Stop the asynchronous creation of previews temporarily. Call resume() to restart it.  
resume Resume the asynchronous creation of slide previews.  
Methods' Details
setDocumentSlides
void
setDocumentSlides( [in] ::com::sun::star::container::XIndexAccess  xSlides,
[in] ::com::sun::star::uno::XInterface  xDocument );

Description
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.
Parameter xSlides
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.
Parameter xDocument
The model that contains the slides reference by the xSlides argument.
setVisibleRange
void
setVisibleRange( [in] long  nFirstVisibleSlideIndex,
[in] long  nLastVisibleSlideIndex );

Description
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.
setPreviewSize
void
setPreviewSize( [in] ::com::sun::star::geometry::IntegerSize2D  aSize );

Description
Define the size of the previews that are managed by the called cache.
getSlidePreview
::com::sun::star::rendering::XBitmap
getSlidePreview( [in] long  nSlideIndex,
[in] ::com::sun::star::rendering::XCanvas  xCanvas )
raises( ::com::sun::star::lang::IllegalArgumentException );

Description
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.
addPreviewCreationNotifyListener
void
addPreviewCreationNotifyListener( [in] XSlidePreviewCacheListener  xListener );

Description
Register a listener that is called when a preview has been created asynchronously.
removePreviewCreationNotifyListener
void
removePreviewCreationNotifyListener( [in] XSlidePreviewCacheListener  xListener );

Description
Remove a previously registered listener for preview creations.
pause
void
pause();

Description
Stop the asynchronous creation of previews temporarily. Call resume() to restart it.
resume
void
resume();

Description
Resume the asynchronous creation of slide previews.
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.