LibreOffice Module vcl (master)  1
Public Member Functions | Protected Member Functions | List of all members
vcl::OWizardPage Class Reference

#include <wizardmachine.hxx>

Inheritance diagram for vcl::OWizardPage:
[legend]
Collaboration diagram for vcl::OWizardPage:
[legend]

Public Member Functions

 OWizardPage (weld::Container *pPage, weld::DialogController *pController, const OUString &rUIXMLDescription, const OString &rID)
 
virtual ~OWizardPage () override
 
virtual void initializePage () override
 
virtual bool commitPage (WizardTypes::CommitPageReason _eReason) override
 
virtual bool canAdvance () const override
 determines whether or not it is allowed to advance to a next page More...
 
- Public Member Functions inherited from BuilderPage
 BuilderPage (weld::Widget *pParent, weld::DialogController *pController, const OUString &rUIXMLDescription, const OString &rID)
 
virtual ~BuilderPage () COVERITY_NOEXCEPT_FALSE
 
void SetPageTitle (const OUString &rPageTitle)
 
const OUString & GetPageTitle () const
 
virtual void Deactivate ()
 
OString GetHelpId () const
 

Protected Member Functions

virtual void Activate () override
 
void updateDialogTravelUI ()
 updates the travel-related UI elements of the OWizardMachine we live in (if any) More...
 
- Protected Member Functions inherited from vcl::IWizardPageController
 ~IWizardPageController ()
 

Additional Inherited Members

- Protected Attributes inherited from BuilderPage
weld::DialogControllerm_pDialogController
 
std::unique_ptr< weld::Builderm_xBuilder
 
std::unique_ptr< weld::Containerm_xContainer
 

Detailed Description

Definition at line 80 of file wizardmachine.hxx.

Constructor & Destructor Documentation

vcl::OWizardPage::OWizardPage ( weld::Container pPage,
weld::DialogController pController,
const OUString &  rUIXMLDescription,
const OString &  rID 
)

Definition at line 40 of file wizardmachine.cxx.

vcl::OWizardPage::~OWizardPage ( )
overridevirtual

Definition at line 45 of file wizardmachine.cxx.

Member Function Documentation

void vcl::OWizardPage::Activate ( )
overrideprotectedvirtual

Reimplemented from BuilderPage.

Definition at line 53 of file wizardmachine.cxx.

References BuilderPage::Activate(), and updateDialogTravelUI().

bool vcl::OWizardPage::canAdvance ( ) const
overridevirtual

determines whether or not it is allowed to advance to a next page

You should make this dependent on the current state of the page only, not on states on other pages of the whole dialog.

The default implementation always returns <TRUE>.

Implements vcl::IWizardPageController.

Definition at line 66 of file wizardmachine.cxx.

bool vcl::OWizardPage::commitPage ( WizardTypes::CommitPageReason  _eReason)
overridevirtual

Implements vcl::IWizardPageController.

Definition at line 71 of file wizardmachine.cxx.

void vcl::OWizardPage::initializePage ( )
overridevirtual

Implements vcl::IWizardPageController.

Definition at line 49 of file wizardmachine.cxx.

void vcl::OWizardPage::updateDialogTravelUI ( )
protected

updates the travel-related UI elements of the OWizardMachine we live in (if any)

If the parent of the tab page is an OWizardMachine, then updateTravelUI at this instance is called. Otherwise, nothing happens.

Definition at line 59 of file wizardmachine.cxx.

References BuilderPage::m_pDialogController, and vcl::RoadmapWizardMachine::updateTravelUI().

Referenced by Activate().


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