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

Interface for a provider of page objects. More...

#include <MasterPageContainerProviders.hxx>

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

Public Member Functions

virtual SdPageoperator() (SdDrawDocument *pDocument)=0
 Return a master page either by returning an already existing one, by creating a new page, or by loading a document. More...
 
virtual int GetCostIndex ()=0
 An abstract value for the expected cost of providing a master page object. More...
 

Protected Member Functions

 ~PageObjectProvider ()
 

Detailed Description

Interface for a provider of page objects.

It is used by the MasterPageDescriptor to create master page objects on demand.

Definition at line 42 of file MasterPageContainerProviders.hxx.

Constructor & Destructor Documentation

◆ ~PageObjectProvider()

sd::sidebar::PageObjectProvider::~PageObjectProvider ( )
inlineprotected

Definition at line 63 of file MasterPageContainerProviders.hxx.

Member Function Documentation

◆ GetCostIndex()

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

An abstract value for the expected cost of providing a master page object.

Returns
A value of 0 represents for the lowest cost, i.e. an almost immediate return. Positive values stand for higher costs. Negative values are not supported.

Implemented in sd::sidebar::TemplatePageObjectProvider, sd::sidebar::DefaultPageObjectProvider, and sd::sidebar::ExistingPageProvider.

◆ operator()()

virtual SdPage * sd::sidebar::PageObjectProvider::operator() ( SdDrawDocument pDocument)
pure virtual

Return a master page either by returning an already existing one, by creating a new page, or by loading a document.

Parameters
pDocumentThe document of the MasterPageContainer. It may be used to create new pages.

Implemented in sd::sidebar::TemplatePageObjectProvider, sd::sidebar::DefaultPageObjectProvider, and sd::sidebar::ExistingPageProvider.


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