LibreOffice Module sd (master) 1
Public Member Functions | Protected Member Functions | List of all members
sd::sidebar::PreviewProvider Class Referenceabstract

#include <MasterPageContainerProviders.hxx>

Inheritance diagram for sd::sidebar::PreviewProvider:
[legend]

Public Member Functions

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

Protected Member Functions

 ~PreviewProvider ()
 

Detailed Description

Definition at line 66 of file MasterPageContainerProviders.hxx.

Constructor & Destructor Documentation

◆ ~PreviewProvider()

sd::sidebar::PreviewProvider::~PreviewProvider ( )
inlineprotected

Definition at line 97 of file MasterPageContainerProviders.hxx.

Member Function Documentation

◆ GetCostIndex()

virtual int sd::sidebar::PreviewProvider::GetCostIndex ( )
pure virtual

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.

Implemented in sd::sidebar::PagePreviewProvider, and sd::sidebar::TemplatePreviewProvider.

◆ NeedsPageObject()

virtual bool sd::sidebar::PreviewProvider::NeedsPageObject ( )
pure virtual

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

Implemented in sd::sidebar::PagePreviewProvider, and sd::sidebar::TemplatePreviewProvider.

◆ operator()()

virtual Image sd::sidebar::PreviewProvider::operator() ( int  nWidth,
SdPage pPage,
::sd::PreviewRenderer rRenderer 
)
pure virtual

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.

Implemented in sd::sidebar::PagePreviewProvider, and sd::sidebar::TemplatePreviewProvider.


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