LibreOffice Module sd (master) 1
Public Member Functions | List of all members
sd::sidebar::PagePreviewProvider Class Reference

Provide previews of existing page objects by rendering them. More...

#include <MasterPageContainerProviders.hxx>

Inheritance diagram for sd::sidebar::PagePreviewProvider:
[legend]
Collaboration diagram for sd::sidebar::PagePreviewProvider:
[legend]

Public Member Functions

 PagePreviewProvider ()
 
virtual ~PagePreviewProvider ()
 
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...
 

Additional Inherited Members

- Protected Member Functions inherited from sd::sidebar::PreviewProvider
 ~PreviewProvider ()
 

Detailed Description

Provide previews of existing page objects by rendering them.

Definition at line 102 of file MasterPageContainerProviders.hxx.

Constructor & Destructor Documentation

◆ PagePreviewProvider()

sd::sidebar::PagePreviewProvider::PagePreviewProvider ( )

Definition at line 42 of file MasterPageContainerProviders.cxx.

◆ ~PagePreviewProvider()

virtual sd::sidebar::PagePreviewProvider::~PagePreviewProvider ( )
inlinevirtual

Definition at line 106 of file MasterPageContainerProviders.hxx.

Member Function Documentation

◆ GetCostIndex()

int sd::sidebar::PagePreviewProvider::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 65 of file MasterPageContainerProviders.cxx.

◆ NeedsPageObject()

bool sd::sidebar::PagePreviewProvider::NeedsPageObject ( )
overridevirtual

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

Implements sd::sidebar::PreviewProvider.

Definition at line 70 of file MasterPageContainerProviders.cxx.

◆ operator()()

Image sd::sidebar::PagePreviewProvider::operator() ( int  nWidth,
SdPage pPage,
::sd::PreviewRenderer rRenderer 
)
overridevirtual

Create a preview image in the specified width.

Parameters
nWidthRequested 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.
pPagePage 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.)
rRendererThis PreviewRenderer may be used by the PreviewProvider to create a preview image.

Implements sd::sidebar::PreviewProvider.

Definition at line 46 of file MasterPageContainerProviders.cxx.

References sd::PreviewRenderer::RenderPage().


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