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

Provide master page objects for template documents for which only the URL is given. More...

#include <MasterPageContainerProviders.hxx>

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

Public Member Functions

 TemplatePageObjectProvider (OUString sURL)
 
virtual ~TemplatePageObjectProvider ()
 
virtual SdPageoperator() (SdDrawDocument *pDocument) override
 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 () override
 An abstract value for the expected cost of providing a master page object. More...
 
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...
 

Private Member Functions

::sd::DrawDocShellLoadDocument (const OUString &sFileName)
 

Private Attributes

OUString msURL
 
SfxObjectShellLock mxDocumentShell
 

Additional Inherited Members

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

Detailed Description

Provide master page objects for template documents for which only the URL is given.

Definition at line 117 of file MasterPageContainerProviders.hxx.

Constructor & Destructor Documentation

◆ TemplatePageObjectProvider()

sd::sidebar::TemplatePageObjectProvider::TemplatePageObjectProvider ( OUString  sURL)
explicit

Definition at line 102 of file MasterPageContainerProviders.cxx.

◆ ~TemplatePageObjectProvider()

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

Definition at line 121 of file MasterPageContainerProviders.hxx.

Member Function Documentation

◆ GetCostIndex()

int sd::sidebar::TemplatePageObjectProvider::GetCostIndex ( )
overridevirtual

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.

Implements sd::sidebar::PageObjectProvider.

Definition at line 153 of file MasterPageContainerProviders.cxx.

◆ LoadDocument()

sd::DrawDocShell * sd::sidebar::TemplatePageObjectProvider::LoadDocument ( const OUString &  sFileName)
private

◆ operator()()

SdPage * sd::sidebar::TemplatePageObjectProvider::operator() ( SdDrawDocument pDocument)
overridevirtual

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.

Implements sd::sidebar::PageObjectProvider.

Definition at line 107 of file MasterPageContainerProviders.cxx.

References DBG_UNHANDLED_EXCEPTION, sd::DrawDocShell::GetDoc(), SdDrawDocument::GetMasterSdPage(), LoadDocument(), msURL, mxDocumentShell, SdPage::SetPrecious(), and Standard.

Member Data Documentation

◆ msURL

OUString sd::sidebar::TemplatePageObjectProvider::msURL
private

Definition at line 126 of file MasterPageContainerProviders.hxx.

Referenced by operator()().

◆ mxDocumentShell

SfxObjectShellLock sd::sidebar::TemplatePageObjectProvider::mxDocumentShell
private

Definition at line 127 of file MasterPageContainerProviders.hxx.

Referenced by LoadDocument(), and operator()().


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