Language Asturianu (ast) Català (ca) Čeština (cs) Dansk (da) Deutsch (de) English [US] (en-US) Español (es) Esperanto (eo) Eesti keel (et) Euskara (eu) Français (fr) Gàidhlig (gd) Galego (gl) Italiano (it) Lietuvių (lt) Magyar (hu) Nederlands (nl) Norsk (no) Polski (pl) Português [do Brasil] (pt-BR) Português [Europeu] (pt) Română (ro) Slovenčina (sk) Slovenščina (sl) Suomi (fi) Svenska (sv) Yкраїнська (uk) Tiếng Việt (vi) Türkçe (tr) ኦሮሚኛ (om) Հայերեն (hy) Ελληνικά (el) български език (bg) Русский (ru) Cрпски [ћирилицом] (sr) עברית (he) हिन्दी (hi) ភាសាខ្មែរ (km) தமிழ் (ta) ภาษาไทย (th) 简体中文 (zh-CN) 正體中文 (zh-TW) 日本語 (ja) 한국어 (ko)

The Free and Open Productivity Suite

• Product
• Download
• Support
• Blog
• Extensions & Templates
• Get Involved
• Focus Areas
• Native Languages

home » api » docs » common » ref » com » sun » star » drawing

Overview

Module

Use

Devguide

Index

Methods' Summary

Attributes' Summary

Methods' Details

Attributes' Details

---

:: 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

---

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.

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

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