svt::uno::WizardShell Class Reference

#include <wizardshell.hxx>

Inheritance diagram for svt::uno::WizardShell:

Collaboration diagram for svt::uno::WizardShell:

Public Member Functions
	WizardShell (weld::Window *pParent, const css::uno::Reference< css::ui::dialogs::XWizardController > &i_rController, const css::uno::Sequence< css::uno::Sequence< sal_Int16 > > &i_rPaths)
virtual short	run () override
virtual std::unique_ptr< BuilderPage >	createPage (WizardState i_nState) override
virtual void	enterState (WizardState i_nState) override
virtual bool	leaveState (WizardState i_nState) override
virtual OUString	getStateDisplayName (WizardState i_nState) const override
virtual bool	canAdvance () const override
virtual bool	onFinish () override
virtual vcl::IWizardPageController *	getPageController (BuilderPage *pCurrentPage) const override
bool	advanceTo (const sal_Int16 i_nPageId)
bool	goBackTo (const sal_Int16 i_nPageId)
void	activatePath (const sal_Int16 i_nPathID, const bool i_bFinal)
css::uno::Reference< css::ui::dialogs::XWizardPage >	getCurrentWizardPage () const
sal_Int16	getCurrentPage () const
void	enablePage (const sal_Int16 i_PageID, const bool i_Enable)
bool	knowsPage (const sal_Int16 i_nPageID) const
Public Member Functions inherited from vcl::RoadmapWizardMachine
	RoadmapWizardMachine (weld::Window *_pParent)
virtual	~RoadmapWizardMachine () override
void	SetRoadmapHelpId (const OUString &_rId)
bool	isStateEnabled (WizardTypes::WizardState nState) const
virtual bool	canAdvance () const override
virtual void	updateTravelUI () override
Public Member Functions inherited from vcl::WizardMachine
	WizardMachine (weld::Window *_pParent, WizardButtonFlags _nButtonFlags)
virtual	~WizardMachine () override
bool	Finish (short nResult=RET_CANCEL)
bool	ShowPage (WizardTypes::WizardState nState)
bool	ShowNextPage ()
bool	ShowPrevPage ()
void	AddPage (std::unique_ptr< BuilderPage > xPage)
void	RemovePage (const BuilderPage *pPage)
void	SetPage (WizardTypes::WizardState nLevel, std::unique_ptr< BuilderPage > xPage)
BuilderPage *	GetPage (WizardTypes::WizardState eState) const
void	enableButtons (WizardButtonFlags _nWizardButtonFlags, bool _bEnable)
void	defaultButton (WizardButtonFlags _nWizardButtonFlags)
void	defaultButton (weld::Button *_pNewDefButton)
void	setTitleBase (const OUString &_rTitleBase)
virtual bool	canAdvance () const
virtual void	updateTravelUI ()
void	suspendTraveling (AccessGuard)
void	resumeTraveling (AccessGuard)
bool	isTravelingSuspended () const
Public Member Functions inherited from weld::AssistantController
	AssistantController (weld::Widget *pParent, const OUString &rUIFile, const OUString &rDialogId)
virtual Dialog *	getDialog () override
virtual	~AssistantController () override
Public Member Functions inherited from weld::DialogController
virtual Dialog *	getDialog ()=0
const Dialog *	getConstDialog () const
virtual short	run ()
void	set_title (const OUString &rTitle)
OUString	get_title () const
void	set_help_id (const OUString &rHelpId)
OUString	get_help_id () const
void	response (int nResponse)
virtual	~DialogController () COVERITY_NOEXCEPT_FALSE

Static Public Member Functions
static sal_Int16	convertCommitReasonToTravelType (const CommitPageReason i_eReason)
Static Public Member Functions inherited from weld::DialogController
static bool	runAsync (const std::shared_ptr< DialogController > &rController, const std::function< void(sal_Int32)> &)

Private Types
typedef std::map< BuilderPage *, PWizardPageController >	Page2ControllerMap

Private Member Functions
sal_Int16	impl_stateToPageId (const WizardState i_nState) const
WizardState	impl_pageIdToState (const sal_Int16 i_nPageId) const
PWizardPageController	impl_getController (BuilderPage *i_pPage) const
virtual OUString	getPageIdentForState (WizardState nState) const override
virtual WizardState	getStateFromPageIdent (const OUString &rIdent) const override
void	activatePath (RoadmapWizardTypes::PathId _nPathId, bool _bDecideForIt=false)

Private Attributes
const css::uno::Reference< css::ui::dialogs::XWizardController >	m_xController
const sal_Int16	m_nFirstPageID
Page2ControllerMap	m_aPageControllers

Additional Inherited Members
Protected Member Functions inherited from vcl::RoadmapWizardMachine
void	declarePath (RoadmapWizardTypes::PathId _nPathId, const RoadmapWizardTypes::WizardPath &_lWizardStates)
void	activatePath (RoadmapWizardTypes::PathId _nPathId, bool _bDecideForIt=false)
virtual WizardTypes::WizardState	determineNextState (WizardTypes::WizardState nCurrentState) const override
void	enableState (WizardTypes::WizardState nState, bool _bEnable=true)
bool	knowsState (WizardTypes::WizardState nState) const
virtual void	enterState (WizardTypes::WizardState nState) override
virtual OUString	getStateDisplayName (WizardTypes::WizardState nState) const
Protected Member Functions inherited from vcl::WizardMachine
virtual void	ActivatePage ()
virtual bool	DeactivatePage ()
virtual std::unique_ptr< BuilderPage >	createPage (WizardTypes::WizardState _nState)=0
virtual void	enterState (WizardTypes::WizardState _nState)
virtual bool	prepareLeaveCurrentState (WizardTypes::CommitPageReason eReason)
virtual bool	leaveState (WizardTypes::WizardState nState)
virtual WizardTypes::WizardState	determineNextState (WizardTypes::WizardState nCurrentState) const
virtual bool	onFinish ()
bool	travelNext ()
bool	travelPrevious ()
void	enableAutomaticNextButtonState ()
bool	isAutomaticNextButtonStateEnabled () const
void	removePageFromHistory (WizardTypes::WizardState nToRemove)
void	skip ()
bool	skipUntil (WizardTypes::WizardState nTargetState)
bool	skipBackwardUntil (WizardTypes::WizardState nTargetState)
WizardTypes::WizardState	getCurrentState () const
virtual IWizardPageController *	getPageController (BuilderPage *pCurrentPage) const
void	getStateHistory (std::vector< WizardTypes::WizardState > &out_rHistory)
virtual OUString	getPageIdentForState (WizardTypes::WizardState nState) const
virtual WizardTypes::WizardState	getStateFromPageIdent (const OUString &rIdent) const
BuilderPage *	GetOrCreatePage (const WizardTypes::WizardState i_nState)
Protected Attributes inherited from vcl::WizardMachine
BuilderPage *	m_pCurTabPage
std::unique_ptr< weld::Button >	m_xFinish
std::unique_ptr< weld::Button >	m_xCancel
std::unique_ptr< weld::Button >	m_xNextPage
std::unique_ptr< weld::Button >	m_xPrevPage
std::unique_ptr< weld::Button >	m_xHelp
Protected Attributes inherited from weld::AssistantController
std::unique_ptr< weld::Builder >	m_xBuilder
std::unique_ptr< weld::Assistant >	m_xAssistant

Detailed Description

Definition at line 41 of file wizardshell.hxx.

Member Typedef Documentation

Page2ControllerMap

typedef std::map<BuilderPage*, PWizardPageController> svt::uno::WizardShell::Page2ControllerMap

private

Definition at line 120 of file wizardshell.hxx.

Constructor & Destructor Documentation

WizardShell()

svt::uno::WizardShell::WizardShell	(	weld::Window *	pParent,
		const css::uno::Reference< css::ui::dialogs::XWizardController > &	i_rController,
		const css::uno::Sequence< css::uno::Sequence< sal_Int16 > > &	i_rPaths
	)

Definition at line 54 of file wizardshell.cxx.

References vcl::RoadmapWizardMachine::declarePath(), vcl::WizardMachine::enableAutomaticNextButtonState(), ENSURE_OR_THROW, vcl::WizardMachine::GetOrCreatePage(), i, impl_pageIdToState(), weld::AssistantController::m_xAssistant, m_xController, and nPageId.

Member Function Documentation

activatePath() [1/2]

void svt::uno::WizardShell::activatePath ( const sal_Int16  i_nPathID, const bool  i_bFinal  )

inline

Definition at line 76 of file wizardshell.hxx.

References vcl::RoadmapWizardMachine::activatePath().

activatePath() [2/2]

void vcl::RoadmapWizardMachine::activatePath ( RoadmapWizardTypes::PathId  _nPathId, bool  _bDecideForIt = false  )

private

advanceTo()

bool svt::uno::WizardShell::advanceTo ( const sal_Int16  i_nPageId )

inline

Definition at line 65 of file wizardshell.hxx.

References impl_pageIdToState(), and vcl::WizardMachine::skipUntil().

canAdvance()

bool svt::uno::WizardShell::canAdvance ( ) const

overridevirtual

Reimplemented from vcl::RoadmapWizardMachine.

Definition at line 232 of file wizardshell.cxx.

References vcl::RoadmapWizardMachine::canAdvance(), DBG_UNHANDLED_EXCEPTION, Exception, and m_xController.

convertCommitReasonToTravelType()

sal_Int16 svt::uno::WizardShell::convertCommitReasonToTravelType ( const CommitPageReason  i_eReason )

static

Definition at line 96 of file wizardshell.cxx.

References vcl::WizardTypes::eFinish, vcl::WizardTypes::eTravelBackward, and vcl::WizardTypes::eTravelForward.

Referenced by svt::uno::WizardPageController::commitPage().

createPage()

std::unique_ptr< BuilderPage > svt::uno::WizardShell::createPage ( WizardState  i_nState )

overridevirtual

Implements vcl::WizardMachine.

Definition at line 194 of file wizardshell.cxx.

References ENSURE_OR_RETURN, impl_stateToPageId(), m_aPageControllers, weld::AssistantController::m_xAssistant, m_xController, and nPageId.

enablePage()

void svt::uno::WizardShell::enablePage	(	const sal_Int16	i_PageID,
		const bool	i_Enable
	)

Definition at line 174 of file wizardshell.cxx.

References vcl::RoadmapWizardMachine::enableState(), and impl_pageIdToState().

enterState()

void svt::uno::WizardShell::enterState ( WizardState  i_nState )

overridevirtual

Reimplemented from vcl::RoadmapWizardMachine.

Definition at line 117 of file wizardshell.cxx.

References DBG_UNHANDLED_EXCEPTION, vcl::RoadmapWizardMachine::enterState(), Exception, impl_stateToPageId(), and m_xController.

getCurrentPage()

sal_Int16 svt::uno::WizardShell::getCurrentPage ( ) const

inline

Definition at line 84 of file wizardshell.hxx.

References vcl::WizardMachine::getCurrentState(), and impl_stateToPageId().

getCurrentWizardPage()

Reference< XWizardPage > svt::uno::WizardShell::getCurrentWizardPage

(

)

const

Definition at line 164 of file wizardshell.cxx.

References ENSURE_OR_RETURN, vcl::WizardMachine::getCurrentState(), vcl::WizardMachine::GetPage(), and impl_getController().

getPageController()

vcl::IWizardPageController * svt::uno::WizardShell::getPageController ( BuilderPage *  pCurrentPage ) const

overridevirtual

Reimplemented from vcl::WizardMachine.

Definition at line 211 of file wizardshell.cxx.

References impl_getController().

getPageIdentForState()

OUString svt::uno::WizardShell::getPageIdentForState ( WizardState  nState ) const

overrideprivatevirtual

Reimplemented from vcl::WizardMachine.

Definition at line 86 of file wizardshell.cxx.

References impl_stateToPageId(), and nState.

getStateDisplayName()

OUString svt::uno::WizardShell::getStateDisplayName ( WizardState  i_nState ) const

overridevirtual

Reimplemented from vcl::RoadmapWizardMachine.

Definition at line 216 of file wizardshell.cxx.

References DBG_UNHANDLED_EXCEPTION, Exception, impl_stateToPageId(), and m_xController.

getStateFromPageIdent()

WizardState svt::uno::WizardShell::getStateFromPageIdent ( const OUString &  rIdent ) const

overrideprivatevirtual

Reimplemented from vcl::WizardMachine.

Definition at line 91 of file wizardshell.cxx.

References impl_pageIdToState().

goBackTo()

bool svt::uno::WizardShell::goBackTo ( const sal_Int16  i_nPageId )

inline

Definition at line 69 of file wizardshell.hxx.

References impl_pageIdToState(), and vcl::WizardMachine::skipBackwardUntil().

impl_getController()

PWizardPageController svt::uno::WizardShell::impl_getController ( BuilderPage *  i_pPage ) const

private

Definition at line 156 of file wizardshell.cxx.

References ENSURE_OR_RETURN, m_aPageControllers, and pos.

Referenced by getCurrentWizardPage(), and getPageController().

impl_pageIdToState()

WizardState svt::uno::WizardShell::impl_pageIdToState ( const sal_Int16  i_nPageId ) const

inlineprivate

Definition at line 102 of file wizardshell.hxx.

References m_nFirstPageID.

Referenced by advanceTo(), enablePage(), getStateFromPageIdent(), goBackTo(), knowsPage(), and WizardShell().

impl_stateToPageId()

sal_Int16 svt::uno::WizardShell::impl_stateToPageId ( const WizardState  i_nState ) const

inlineprivate

Definition at line 97 of file wizardshell.hxx.

References m_nFirstPageID.

Referenced by createPage(), enterState(), getCurrentPage(), getPageIdentForState(), getStateDisplayName(), and leaveState().

knowsPage()

bool svt::uno::WizardShell::knowsPage ( const sal_Int16  i_nPageID ) const

inline

Definition at line 91 of file wizardshell.hxx.

References impl_pageIdToState(), and vcl::RoadmapWizardMachine::knowsState().

leaveState()

bool svt::uno::WizardShell::leaveState ( WizardState  i_nState )

overridevirtual

Reimplemented from vcl::WizardMachine.

Definition at line 135 of file wizardshell.cxx.

References DBG_UNHANDLED_EXCEPTION, Exception, impl_stateToPageId(), vcl::WizardMachine::leaveState(), and m_xController.

onFinish()

bool svt::uno::WizardShell::onFinish ( )

overridevirtual

Reimplemented from vcl::WizardMachine.

Definition at line 248 of file wizardshell.cxx.

References DBG_UNHANDLED_EXCEPTION, Exception, m_xController, and vcl::WizardMachine::onFinish().

run()

short svt::uno::WizardShell::run ( )

overridevirtual

Reimplemented from weld::DialogController.

Definition at line 80 of file wizardshell.cxx.

References vcl::WizardMachine::ActivatePage(), and weld::DialogController::run().

Member Data Documentation

m_aPageControllers

Page2ControllerMap svt::uno::WizardShell::m_aPageControllers

private

Definition at line 124 of file wizardshell.hxx.

Referenced by createPage(), and impl_getController().

m_nFirstPageID

const sal_Int16 svt::uno::WizardShell::m_nFirstPageID

private

Definition at line 123 of file wizardshell.hxx.

Referenced by impl_pageIdToState(), and impl_stateToPageId().

m_xController

const css::uno::Reference< css::ui::dialogs::XWizardController > svt::uno::WizardShell::m_xController

private

Definition at line 122 of file wizardshell.hxx.

Referenced by canAdvance(), createPage(), enterState(), getStateDisplayName(), leaveState(), onFinish(), and WizardShell().

---

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

• wizardshell.hxx
• wizardshell.cxx