sd::sidebar::MasterPageContainerFiller Class Reference

Fill a MasterPageContainer with information about the available master pages. More...

#include <MasterPageContainerFiller.hxx>

Inheritance diagram for sd::sidebar::MasterPageContainerFiller:

Collaboration diagram for sd::sidebar::MasterPageContainerFiller:

Classes
class	ContainerAdapter

Public Member Functions
	MasterPageContainerFiller (ContainerAdapter &rContainerAdapter)
virtual	~MasterPageContainerFiller ()
virtual void	RunNextStep () override
	Run the next step of the task. More...
virtual bool	HasNextStep () override
	Return <TRUE> when there is at least one more step to execute. More...
virtual void	RunNextStep ()=0
	Run the next step of the task. More...
virtual bool	HasNextStep ()=0
	Return <TRUE> when there is at least one more step to execute. More...

Private Types
enum	State {   INITIALIZE_TEMPLATE_SCANNER ,   SCAN_TEMPLATE ,   ADD_TEMPLATE ,   ERROR ,   DONE }

Private Member Functions
State	ScanTemplate ()
State	AddTemplate ()

Private Attributes
ContainerAdapter &	mrContainerAdapter
enum sd::sidebar::MasterPageContainerFiller::State	meState
::std::unique_ptr< TemplateScanner >	mpScannerTask
const TemplateEntry *	mpLastAddedEntry
int	mnIndex

Additional Inherited Members
Protected Member Functions inherited from sd::tools::AsynchronousTask
	~AsynchronousTask ()

Detailed Description

Fill a MasterPageContainer with information about the available master pages.

These are provided by one default page and from the existing Impress templates. This is done asynchronously.

Definition at line 39 of file MasterPageContainerFiller.hxx.

Member Enumeration Documentation

State

enum sd::sidebar::MasterPageContainerFiller::State

private

Enumerator
INITIALIZE_TEMPLATE_SCANNER
SCAN_TEMPLATE
ADD_TEMPLATE
ERROR
DONE

Definition at line 74 of file MasterPageContainerFiller.hxx.

Constructor & Destructor Documentation

MasterPageContainerFiller()

sd::sidebar::MasterPageContainerFiller::MasterPageContainerFiller ( ContainerAdapter &  rContainerAdapter )

explicit

Definition at line 31 of file MasterPageContainerFiller.cxx.

References sd::sidebar::MasterPageContainer::DEFAULT, mnIndex, mrContainerAdapter, and sd::sidebar::MasterPageContainerFiller::ContainerAdapter::PutMasterPage().

~MasterPageContainerFiller()

sd::sidebar::MasterPageContainerFiller::~MasterPageContainerFiller ( )

virtual

Definition at line 53 of file MasterPageContainerFiller.cxx.

Member Function Documentation

AddTemplate()

MasterPageContainerFiller::State sd::sidebar::MasterPageContainerFiller::AddTemplate ( )

private

Definition at line 138 of file MasterPageContainerFiller.cxx.

References mnIndex, mpLastAddedEntry, mrContainerAdapter, sd::TemplateEntry::msPath, sd::TemplateEntry::msTitle, sd::sidebar::MasterPageContainerFiller::ContainerAdapter::PutMasterPage(), SCAN_TEMPLATE, sd::sidebar::MasterPageContainer::TEMPLATE, and sd::sidebar::MasterPageDescriptor::URLCLASS_USER.

Referenced by RunNextStep().

HasNextStep()

bool sd::sidebar::MasterPageContainerFiller::HasNextStep ( )

overridevirtual

Return <TRUE> when there is at least one more step to execute.

When the task has been executed completely then <FALSE> is returned.

Implements sd::tools::AsynchronousTask.

Definition at line 98 of file MasterPageContainerFiller.cxx.

References DONE, ERROR, and meState.

RunNextStep()

void sd::sidebar::MasterPageContainerFiller::RunNextStep ( )

overridevirtual

Run the next step of the task.

After HasNextStep() returns false this method should ignore further calls.

Implements sd::tools::AsynchronousTask.

Definition at line 57 of file MasterPageContainerFiller.cxx.

References ADD_TEMPLATE, AddTemplate(), DONE, ERROR, sd::sidebar::MasterPageContainerFiller::ContainerAdapter::FillingDone(), INITIALIZE_TEMPLATE_SCANNER, meState, mpScannerTask, mrContainerAdapter, SCAN_TEMPLATE, and ScanTemplate().

ScanTemplate()

MasterPageContainerFiller::State sd::sidebar::MasterPageContainerFiller::ScanTemplate ( )

private

Definition at line 111 of file MasterPageContainerFiller.cxx.

References ADD_TEMPLATE, DONE, ERROR, mpLastAddedEntry, mpScannerTask, and SCAN_TEMPLATE.

Referenced by RunNextStep().

Member Data Documentation

meState

enum sd::sidebar::MasterPageContainerFiller::State sd::sidebar::MasterPageContainerFiller::meState

private

Referenced by HasNextStep(), and RunNextStep().

mnIndex

int sd::sidebar::MasterPageContainerFiller::mnIndex

private

Definition at line 84 of file MasterPageContainerFiller.hxx.

Referenced by AddTemplate().

mpLastAddedEntry

const TemplateEntry* sd::sidebar::MasterPageContainerFiller::mpLastAddedEntry

private

Definition at line 83 of file MasterPageContainerFiller.hxx.

Referenced by AddTemplate(), and ScanTemplate().

mpScannerTask

::std::unique_ptr<TemplateScanner> sd::sidebar::MasterPageContainerFiller::mpScannerTask

private

Definition at line 82 of file MasterPageContainerFiller.hxx.

Referenced by RunNextStep(), and ScanTemplate().

mrContainerAdapter

ContainerAdapter& sd::sidebar::MasterPageContainerFiller::mrContainerAdapter

private

Definition at line 72 of file MasterPageContainerFiller.hxx.

Referenced by AddTemplate(), MasterPageContainerFiller(), and RunNextStep().

---

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

• MasterPageContainerFiller.hxx
• MasterPageContainerFiller.cxx