Provide previews for template documents by loading the thumbnails from the documents. More...

#include <MasterPageContainerProviders.hxx>

Inheritance diagram for sd::sidebar::TemplatePreviewProvider:

Collaboration diagram for sd::sidebar::TemplatePreviewProvider:

Public Member Functions
	TemplatePreviewProvider (OUString sURL)

virtual	~TemplatePreviewProvider ()

virtual Image	operator() (int nWidth, SdPage *pPage, ::sd::PreviewRenderer &rRenderer) override
	Create a preview image in the specified width. More...

virtual int	GetCostIndex () override
	Return a value that indicates how expensive the creation of a preview image is. More...

virtual bool	NeedsPageObject () override
	Return whether the page object passed is necessary to create a preview. More...

virtual Image	operator() (int nWidth, SdPage *pPage, ::sd::PreviewRenderer &rRenderer)=0
	Create a preview image in the specified width. More...

virtual int	GetCostIndex ()=0
	Return a value that indicates how expensive the creation of a preview image is. More...

virtual bool	NeedsPageObject ()=0
	Return whether the page object passed is necessary to create a preview. More...

Private Attributes
OUString	msURL

Additional Inherited Members
Protected Member Functions inherited from sd::sidebar::PreviewProvider
	~PreviewProvider ()

Detailed Description

Provide previews for template documents by loading the thumbnails from the documents.

Definition at line 134 of file MasterPageContainerProviders.hxx.

Constructor & Destructor Documentation

◆ TemplatePreviewProvider()

sd::sidebar::TemplatePreviewProvider::TemplatePreviewProvider ( OUString sURL )

explicit

Definition at line 77 of file MasterPageContainerProviders.cxx.

◆ ~TemplatePreviewProvider()

virtual sd::sidebar::TemplatePreviewProvider::~TemplatePreviewProvider ( )

inlinevirtual

Definition at line 138 of file MasterPageContainerProviders.hxx.

Member Function Documentation

◆ GetCostIndex()

int sd::sidebar::TemplatePreviewProvider::GetCostIndex ( )

overridevirtual

Return a value that indicates how expensive the creation of a preview image is.

The higher the returned value the more expensive is the preview creation. Return 0 when the preview is already present and can be returned immediately.

Implements sd::sidebar::PreviewProvider.

Definition at line 90 of file MasterPageContainerProviders.cxx.

◆ NeedsPageObject()

bool sd::sidebar::TemplatePreviewProvider::NeedsPageObject ( )

overridevirtual

Return whether the page object passed is necessary to create a preview.

Implements sd::sidebar::PreviewProvider.

Definition at line 95 of file MasterPageContainerProviders.cxx.

◆ operator()()

Image sd::sidebar::TemplatePreviewProvider::operator()	(	int	nWidth,
		SdPage *	pPage,
		::sd::PreviewRenderer &	rRenderer
	)

overridevirtual

Create a preview image in the specified width.

Parameters

nWidth	Requested width of the preview. The calling method can cope with other sizes as well but the resulting image quality is better when the returned image has the requested size.
pPage	Page object for which a preview is requested. This may be NULL when the page object is expensive to get and the PreviewProvider does not need this object (NeedsPageObject() returns false.)
rRenderer	This PreviewRenderer may be used by the PreviewProvider to create a preview image.