tab dialog for administrating the office wide registered data sources More...

#include <dbwiz.hxx>

Inheritance diagram for dbaui::ODbTypeWizDialog:

Collaboration diagram for dbaui::ODbTypeWizDialog:

Public Member Functions
	ODbTypeWizDialog (weld::Window pParent, SfxItemSet const _pItems, const css::uno::Reference< css::uno::XComponentContext > &_rxORB, const css::uno::Any &_aDataSourceName)
	ctor. More...

virtual	~ODbTypeWizDialog () override

virtual const SfxItemSet *	getOutputSet () const override

virtual SfxItemSet *	getWriteOutputSet () override

virtual css::uno::Reference< css::uno::XComponentContext >	getORB () const override

virtual std::pair< css::uno::Reference< css::sdbc::XConnection >, bool >	createConnection () override

virtual css::uno::Reference< css::sdbc::XDriver >	getDriver () override

virtual OUString	getDatasourceType (const SfxItemSet &_rSet) const override

virtual void	clearPassword () override

virtual void	saveDatasource () override

virtual void	setTitle (const OUString &_sTitle) override

virtual void	enableConfirmSettings (bool _bEnable) override
	enables or disables the user's possibility to confirm the settings More...

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

virtual const SfxItemSet *	getOutputSet () const =0

virtual SfxItemSet *	getWriteOutputSet ()=0

virtual css::uno::Reference< css::uno::XComponentContext >	getORB () const =0

virtual std::pair< css::uno::Reference< css::sdbc::XConnection >, bool >	createConnection ()=0

virtual css::uno::Reference< css::sdbc::XDriver >	getDriver ()=0

virtual OUString	getDatasourceType (const SfxItemSet &_rSet) const =0

virtual void	clearPassword ()=0

virtual void	saveDatasource ()=0

virtual void	setTitle (const OUString &_sTitle)=0

virtual void	enableConfirmSettings (bool _bEnable)=0
	enables or disables the user's possibility to confirm the settings More...

Protected Member Functions
virtual std::unique_ptr< BuilderPage >	createPage (WizardState _nState) override
	to override to create new pages More...

virtual WizardState	determineNextState (WizardState _nCurrentState) const override

virtual bool	leaveState (WizardState _nState) override

virtual ::vcl::IWizardPageController *	getPageController (BuilderPage *pCurrentPage) const override

virtual bool	onFinish () override

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 Member Functions inherited from dbaui::IItemSetHelper
	~IItemSetHelper ()

Protected Member Functions inherited from dbaui::IDatabaseSettingsDialog
	~IDatabaseSettingsDialog ()

Private Member Functions
	DECL_LINK (OnTypeSelected, OGeneralPage &, void)

Private Attributes
std::unique_ptr< ODbDataSourceAdministrationHelper >	m_pImpl

std::unique_ptr< SfxItemSet >	m_pOutSet

::dbaccess::ODsnTypeCollection *	m_pCollection

OUString	m_eType
	the DSN type collection instance More...

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
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

tab dialog for administrating the office wide registered data sources

Definition at line 53 of file dbwiz.hxx.

Constructor & Destructor Documentation

◆ ODbTypeWizDialog()

dbaui::ODbTypeWizDialog::ODbTypeWizDialog	(	weld::Window *	pParent,
		SfxItemSet const *	_pItems,
		const css::uno::Reference< css::uno::XComponentContext > &	_rxORB,
		const css::uno::Any &	_aDataSourceName
	)

ctor.

The itemset given should have been created by <method>createItemSet</method> and should be destroyed after the dialog has been destroyed

Definition at line 58 of file dbwiz.cxx.

◆ ~ODbTypeWizDialog()

dbaui::ODbTypeWizDialog::~ODbTypeWizDialog ( )

overridevirtual

Definition at line 90 of file dbwiz.cxx.

Member Function Documentation

◆ clearPassword()

void dbaui::ODbTypeWizDialog::clearPassword ( )

overridevirtual

Implements dbaui::IDatabaseSettingsDialog.

Definition at line 211 of file dbwiz.cxx.

References m_pImpl.

◆ createConnection()

std::pair< Reference< XConnection >, bool > dbaui::ODbTypeWizDialog::createConnection ( )

overridevirtual

Implements dbaui::IDatabaseSettingsDialog.

Definition at line 191 of file dbwiz.cxx.

References m_pImpl.

◆ createPage()

std::unique_ptr< BuilderPage > dbaui::ODbTypeWizDialog::createPage ( WizardState _nState )

overrideprotectedvirtual

to override to create new pages

Implements vcl::WizardMachine.

Definition at line 216 of file dbwiz.cxx.

◆ DECL_LINK()

dbaui::ODbTypeWizDialog::DECL_LINK	(	OnTypeSelected	,
		OGeneralPage &	,
		void
	)

private

◆ determineNextState()

WizardState dbaui::ODbTypeWizDialog::determineNextState ( WizardState _nCurrentState ) const

overrideprotectedvirtual

Reimplemented from vcl::WizardMachine.

Definition at line 102 of file dbwiz.cxx.

References ADDITIONAL_PAGE_ADO, ADDITIONAL_PAGE_DBASE, ADDITIONAL_PAGE_FLAT, ADDITIONAL_PAGE_LDAP, ADDITIONAL_PAGE_MYSQL_JDBC, ADDITIONAL_PAGE_MYSQL_NATIVE, ADDITIONAL_PAGE_MYSQL_ODBC, ADDITIONAL_PAGE_ODBC, ADDITIONAL_PAGE_ORACLE_JDBC, CONNECTION_PAGE, dbaccess::ODsnTypeCollection::determineType(), dbaccess::DST_ADO, dbaccess::DST_CALC, dbaccess::DST_DBASE, dbaccess::DST_EVOLUTION, dbaccess::DST_EVOLUTION_GROUPWISE, dbaccess::DST_EVOLUTION_LDAP, dbaccess::DST_FLAT, dbaccess::DST_JDBC, dbaccess::DST_KAB, dbaccess::DST_LDAP, dbaccess::DST_MACAB, dbaccess::DST_MOZILLA, dbaccess::DST_MSACCESS, dbaccess::DST_MSACCESS_2007, dbaccess::DST_MYSQL_JDBC, dbaccess::DST_MYSQL_NATIVE, dbaccess::DST_MYSQL_ODBC, dbaccess::DST_ODBC, dbaccess::DST_ORACLE_JDBC, dbaccess::DST_OUTLOOK, dbaccess::DST_OUTLOOKEXP, dbaccess::DST_THUNDERBIRD, dbaccess::DST_WRITER, m_eType, m_pCollection, START_PAGE, and WZS_INVALID_STATE.

◆ enableConfirmSettings()

void dbaui::ODbTypeWizDialog::enableConfirmSettings ( bool _bEnable )

overridevirtual

enables or disables the user's possibility to confirm the settings

In a wizard, disabling this will usually disable the "Finish" button. In a normal tab dialog, this will usually disable the "OK" button.

Implements dbaui::IDatabaseSettingsDialog.

Definition at line 299 of file dbwiz.cxx.

References vcl::WizardMachine::enableButtons().

◆ getDatasourceType()

OUString dbaui::ODbTypeWizDialog::getDatasourceType ( const SfxItemSet & _rSet ) const

overridevirtual

Implements dbaui::IDatabaseSettingsDialog.

Definition at line 206 of file dbwiz.cxx.

References dbaui::ODbDataSourceAdministrationHelper::getDatasourceType().

◆ getDriver()

Reference< XDriver > dbaui::ODbTypeWizDialog::getDriver ( )

overridevirtual

Implements dbaui::IDatabaseSettingsDialog.

Definition at line 201 of file dbwiz.cxx.

References m_pImpl.

◆ getORB()

Reference< XComponentContext > dbaui::ODbTypeWizDialog::getORB ( ) const

overridevirtual

Implements dbaui::IDatabaseSettingsDialog.

Definition at line 196 of file dbwiz.cxx.

References m_pImpl.

Referenced by saveDatasource().

◆ getOutputSet()

const SfxItemSet * dbaui::ODbTypeWizDialog::getOutputSet ( ) const

overridevirtual

Implements dbaui::IItemSetHelper.

Definition at line 181 of file dbwiz.cxx.

References m_pOutSet.

◆ getPageController()

vcl::IWizardPageController * dbaui::ODbTypeWizDialog::getPageController ( BuilderPage * pCurrentPage ) const

overrideprotectedvirtual

Reimplemented from vcl::WizardMachine.

Definition at line 322 of file dbwiz.cxx.

◆ getWriteOutputSet()

SfxItemSet * dbaui::ODbTypeWizDialog::getWriteOutputSet ( )

overridevirtual

Implements dbaui::IItemSetHelper.

Definition at line 186 of file dbwiz.cxx.

References m_pOutSet.

◆ leaveState()

bool dbaui::ODbTypeWizDialog::leaveState ( WizardState _nState )

overrideprotectedvirtual

Reimplemented from vcl::WizardMachine.

Definition at line 286 of file dbwiz.cxx.

References SfxTabPage::FillItemSet(), vcl::WizardMachine::GetPage(), and m_pOutSet.

◆ onFinish()

bool dbaui::ODbTypeWizDialog::onFinish ( )

overrideprotectedvirtual

Reimplemented from vcl::WizardMachine.

Definition at line 328 of file dbwiz.cxx.

References m_pImpl, m_pOutSet, vcl::WizardMachine::onFinish(), and saveDatasource().

◆ saveDatasource()

void dbaui::ODbTypeWizDialog::saveDatasource ( )

overridevirtual

Implements dbaui::IDatabaseSettingsDialog.

Definition at line 310 of file dbwiz.cxx.

References dbaui::DataSourceInfoConverter::convert(), SfxTabPage::FillItemSet(), vcl::WizardMachine::getCurrentState(), getORB(), vcl::WizardMachine::GetPage(), m_eType, m_pCollection, m_pImpl, m_pOutSet, and PROPERTY_URL().

Referenced by onFinish().

◆ setTitle()

void dbaui::ODbTypeWizDialog::setTitle ( const OUString & _sTitle )

overridevirtual

Implements dbaui::IDatabaseSettingsDialog.

Definition at line 294 of file dbwiz.cxx.

References weld::AssistantController::m_xAssistant.

Member Data Documentation

◆ m_eType

OUString dbaui::ODbTypeWizDialog::m_eType

private

the DSN type collection instance

Definition at line 60 of file dbwiz.hxx.

Referenced by determineNextState(), ODbTypeWizDialog(), and saveDatasource().

◆ m_pCollection

::dbaccess::ODsnTypeCollection* dbaui::ODbTypeWizDialog::m_pCollection

private

Definition at line 59 of file dbwiz.hxx.

Referenced by determineNextState(), ODbTypeWizDialog(), and saveDatasource().

◆ m_pImpl

std::unique_ptr<ODbDataSourceAdministrationHelper> dbaui::ODbTypeWizDialog::m_pImpl

private

Definition at line 56 of file dbwiz.hxx.

Referenced by clearPassword(), createConnection(), createPage(), getDriver(), getORB(), ODbTypeWizDialog(), onFinish(), and saveDatasource().

◆ m_pOutSet

std::unique_ptr<SfxItemSet> dbaui::ODbTypeWizDialog::m_pOutSet

private

Definition at line 57 of file dbwiz.hxx.

Referenced by createPage(), getOutputSet(), getWriteOutputSet(), leaveState(), ODbTypeWizDialog(), onFinish(), and saveDatasource().

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

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ODbTypeWizDialog()

◆ ~ODbTypeWizDialog()

Member Function Documentation

◆ clearPassword()

◆ createConnection()

◆ createPage()

◆ DECL_LINK()

◆ determineNextState()

◆ enableConfirmSettings()

◆ getDatasourceType()

◆ getDriver()

◆ getORB()

◆ getOutputSet()

◆ getPageController()

◆ getWriteOutputSet()

◆ leaveState()

◆ onFinish()

◆ saveDatasource()

◆ setTitle()

Member Data Documentation

◆ m_eType

◆ m_pCollection

◆ m_pImpl

◆ m_pOutSet