LibreOffice Module extensions (master) 1
Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
dbp::OControlWizard Class Referenceabstract

#include <controlwizard.hxx>

Inheritance diagram for dbp::OControlWizard:
[legend]
Collaboration diagram for dbp::OControlWizard:
[legend]

Public Member Functions

 OControlWizard (weld::Window *_pParent, const css::uno::Reference< css::beans::XPropertySet > &_rxObjectModel, const css::uno::Reference< css::uno::XComponentContext > &_rxContext)
 
virtual ~OControlWizard () override
 
const css::uno::Reference< css::uno::XComponentContext > & getComponentContext () const
 
const OControlWizardContextgetContext () const
 
bool updateContext (const OAccessRegulator &)
 
void setFormConnection (const OAccessRegulator &, const css::uno::Reference< css::sdbc::XConnection > &_rxConn, bool _bAutoDispose)
 
css::uno::Reference< css::sdbc::XConnection > getFormConnection (const OAccessRegulator &) const
 
css::uno::Reference< css::task::XInteractionHandler > getInteractionHandler (weld::Window *_pWindow) const
 returns the com.sun.star.task.InteractionHandler More...
 
bool travelNext ()
 
- 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)
 
BuilderPageGetPage (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 DialoggetDialog () override
 
virtual ~AssistantController () override
 
- Public Member Functions inherited from weld::DialogController
virtual DialoggetDialog ()=0
 
const DialoggetConstDialog () 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
 

Protected Member Functions

void initControlSettings (OControlWizardSettings *_pSettings)
 
void commitControlSettings (OControlWizardSettings const *_pSettings)
 
bool needDatasourceSelection ()
 
css::uno::Reference< css::sdbc::XConnection > getFormConnection () const
 
virtual bool approveControl (sal_Int16 _nClassId)=0
 
virtual short run () override
 
- Protected Member Functions inherited from vcl::WizardMachine
virtual void ActivatePage ()
 
virtual bool DeactivatePage ()
 
virtual std::unique_ptr< BuilderPagecreatePage (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
 
BuilderPageGetOrCreatePage (const WizardTypes::WizardState i_nState)
 

Private Member Functions

bool initContext ()
 
void implGetDSContext ()
 
void implDetermineForm ()
 
void implDeterminePage ()
 
void implDetermineShape ()
 

Private Attributes

OControlWizardContext m_aContext
 
css::uno::Reference< css::uno::XComponentContext > m_xContext
 

Additional Inherited Members

- Static Public Member Functions inherited from weld::DialogController
static bool runAsync (const std::shared_ptr< DialogController > &rController, const std::function< void(sal_Int32)> &)
 
- Protected Attributes inherited from vcl::WizardMachine
BuilderPagem_pCurTabPage
 
std::unique_ptr< weld::Buttonm_xFinish
 
std::unique_ptr< weld::Buttonm_xCancel
 
std::unique_ptr< weld::Buttonm_xNextPage
 
std::unique_ptr< weld::Buttonm_xPrevPage
 
std::unique_ptr< weld::Buttonm_xHelp
 
- Protected Attributes inherited from weld::AssistantController
std::unique_ptr< weld::Builderm_xBuilder
 
std::unique_ptr< weld::Assistantm_xAssistant
 

Detailed Description

Definition at line 86 of file controlwizard.hxx.

Constructor & Destructor Documentation

◆ OControlWizard()

dbp::OControlWizard::OControlWizard ( weld::Window _pParent,
const css::uno::Reference< css::beans::XPropertySet > &  _rxObjectModel,
const css::uno::Reference< css::uno::XComponentContext > &  _rxContext 
)

◆ ~OControlWizard()

dbp::OControlWizard::~OControlWizard ( )
overridevirtual

Definition at line 220 of file controlwizard.cxx.

Member Function Documentation

◆ approveControl()

virtual bool dbp::OControlWizard::approveControl ( sal_Int16  _nClassId)
protectedpure virtual

Implemented in dbp::OGridWizard, dbp::OGroupBoxWizard, and dbp::OListComboWizard.

Referenced by run().

◆ commitControlSettings()

void dbp::OControlWizard::commitControlSettings ( OControlWizardSettings const *  _pSettings)
protected

◆ getComponentContext()

const css::uno::Reference< css::uno::XComponentContext > & dbp::OControlWizard::getComponentContext ( ) const
inline

Definition at line 106 of file controlwizard.hxx.

References m_xContext.

Referenced by dbp::OGroupBoxWizard::onFinish().

◆ getContext()

const OControlWizardContext & dbp::OControlWizard::getContext ( ) const
inline

◆ getFormConnection() [1/2]

Reference< XConnection > dbp::OControlWizard::getFormConnection ( ) const
protected

◆ getFormConnection() [2/2]

Reference< XConnection > dbp::OControlWizard::getFormConnection ( const OAccessRegulator ) const

Definition at line 373 of file controlwizard.cxx.

References getFormConnection().

Referenced by dbp::OControlWizardPage::getFormConnection().

◆ getInteractionHandler()

Reference< XInteractionHandler > dbp::OControlWizard::getInteractionHandler ( weld::Window _pWindow) const

returns the com.sun.star.task.InteractionHandler

Parameters
_pWindowThe window will be used when an error message has to be shown.

Definition at line 428 of file controlwizard.cxx.

References Exception, m_xContext, ShowServiceNotAvailableError(), and u.

Referenced by dbp::OTableSelectionPage::implFillTables(), and initContext().

◆ implDetermineForm()

void dbp::OControlWizard::implDetermineForm ( )
private

◆ implDeterminePage()

void dbp::OControlWizard::implDeterminePage ( )
private

◆ implDetermineShape()

void dbp::OControlWizard::implDetermineShape ( )
private

◆ implGetDSContext()

void dbp::OControlWizard::implGetDSContext ( )
private

◆ initContext()

bool dbp::OControlWizard::initContext ( )
private

◆ initControlSettings()

void dbp::OControlWizard::initControlSettings ( OControlWizardSettings _pSettings)
protected

◆ needDatasourceSelection()

bool dbp::OControlWizard::needDatasourceSelection ( )
protected

◆ run()

short dbp::OControlWizard::run ( )
overrideprotectedvirtual

◆ setFormConnection()

void dbp::OControlWizard::setFormConnection ( const OAccessRegulator ,
const css::uno::Reference< css::sdbc::XConnection > &  _rxConn,
bool  _bAutoDispose 
)

◆ travelNext()

bool vcl::WizardMachine::travelNext ( )

◆ updateContext()

bool dbp::OControlWizard::updateContext ( const OAccessRegulator )

Definition at line 423 of file controlwizard.cxx.

References initContext().

Referenced by dbp::OControlWizardPage::updateContext().

Member Data Documentation

◆ m_aContext

OControlWizardContext dbp::OControlWizard::m_aContext
private

◆ m_xContext

css::uno::Reference< css::uno::XComponentContext > dbp::OControlWizard::m_xContext
private

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