:: 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
- 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
- Description
- Define the size of the previews that are managed by the called
cache.
|
|
getSlidePreview
- 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
- Description
- Register a listener that is called when a preview has been created
asynchronously.
|
|
removePreviewCreationNotifyListener
- Description
- Remove a previously registered listener for preview creations.
|
|
pause
- Description
- Stop the asynchronous creation of previews temporarily.
Call resume() to restart it.
|
|
resume
- Description
- Resume the asynchronous creation of slide previews.
|
|
Top of Page
Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.