sd::slidesorter::cache::CacheContext Class Reference

This interface allows the individualisation of different instances of the PreviewCache. More...

#include <SlsCacheContext.hxx>

Inheritance diagram for sd::slidesorter::cache::CacheContext:

Public Member Functions
virtual	~CacheContext ()
virtual void	NotifyPreviewCreation (CacheKey aKey)=0
	This method is called when the asynchronous creation of a preview has been finished. More...
virtual bool	IsIdle ()=0
	Called to determine whether the system is idle and a preview can be created without annoying the user. More...
virtual bool	IsVisible (CacheKey aKey)=0
	This method is used to determine whether a page is currently visible or not. More...
virtual const SdrPage *	GetPage (CacheKey aKey)=0
	Return the page associated with the given key. More...
virtual std::shared_ptr< std::vector< CacheKey > >	GetEntryList (bool bVisible)=0
	This method is used when the request queue is filled. More...
virtual sal_Int32	GetPriority (CacheKey aKey)=0
	Return the priority that defines the order in which previews are created for different keys/pages. More...
virtual css::uno::Reference< css::uno::XInterface >	GetModel ()=0
	Return the model to which the pages belong for which the called cache manages the previews. More...

Detailed Description

This interface allows the individualisation of different instances of the PreviewCache.

Definition at line 41 of file SlsCacheContext.hxx.

Constructor & Destructor Documentation

~CacheContext()

virtual sd::slidesorter::cache::CacheContext::~CacheContext ( )

inlinevirtual

Definition at line 44 of file SlsCacheContext.hxx.

Member Function Documentation

GetEntryList()

virtual std::shared_ptr< std::vector< CacheKey > > sd::slidesorter::cache::CacheContext::GetEntryList ( bool  bVisible )

pure virtual

This method is used when the request queue is filled.

It asks for the list of visible entries and maybe for the list of not visible entries and creates preview creation requests for them.

Parameters

bVisible

When this is <FALSE> then the implementation can decide whether to allow rendering of previews that are not visible (ahead of time). When not then return an empty pointer or an empty vector.

Implemented in sd::slidesorter::view::ViewCacheContext.

GetModel()

virtual css::uno::Reference< css::uno::XInterface > sd::slidesorter::cache::CacheContext::GetModel ( )

pure virtual

Return the model to which the pages belong for which the called cache manages the previews.

Different caches that belong to the same model but have different preview sizes may access previews of each other in order to create fast previews of the previews.

Implemented in sd::slidesorter::view::ViewCacheContext.

GetPage()

virtual const SdrPage * sd::slidesorter::cache::CacheContext::GetPage ( CacheKey  aKey )

pure virtual

Return the page associated with the given key.

Note that different keys may map to a single page (this may be the case with custom slide shows.)

Implemented in sd::slidesorter::view::ViewCacheContext.

GetPriority()

virtual sal_Int32 sd::slidesorter::cache::CacheContext::GetPriority ( CacheKey  aKey )

pure virtual

Return the priority that defines the order in which previews are created for different keys/pages.

Typically the visible pages come first, then top-down, left-to-right.

Implemented in sd::slidesorter::view::ViewCacheContext.

IsIdle()

virtual bool sd::slidesorter::cache::CacheContext::IsIdle ( )

pure virtual

Called to determine whether the system is idle and a preview can be created without annoying the user.

Implemented in sd::slidesorter::view::ViewCacheContext.

IsVisible()

virtual bool sd::slidesorter::cache::CacheContext::IsVisible ( CacheKey  aKey )

pure virtual

This method is used to determine whether a page is currently visible or not.

It is called when the cache becomes too large and some previews have to be released or scaled down.

Implemented in sd::slidesorter::view::ViewCacheContext.

NotifyPreviewCreation()

virtual void sd::slidesorter::cache::CacheContext::NotifyPreviewCreation ( CacheKey  aKey )

pure virtual

This method is called when the asynchronous creation of a preview has been finished.

Parameters

aKey	The key of the page for which the preview has been created.

Implemented in sd::slidesorter::view::ViewCacheContext.

---

The documentation for this class was generated from the following file:

• SlsCacheContext.hxx