#include <abspilot.hxx>

Inheritance diagram for abp::OAddressBookSourcePilot:

Collaboration diagram for abp::OAddressBookSourcePilot:

Public Member Functions
	OAddressBookSourcePilot (weld::Window *_pParent, const css::uno::Reference< css::uno::XComponentContext > &_rxORB)
	ctor More...

virtual short	run () override

const css::uno::Reference< css::uno::XComponentContext > &	getORB () const
	get the service factory which was used to create the dialog More...

AddressSettings &	getSettings ()

const AddressSettings &	getSettings () const

const ODataSource &	getDataSource () const

bool	connectToDataSource (bool _bForceReConnect)

void	travelNext ()

void	typeSelectionChanged (AddressSourceType _eType)
	to be called when the selected type changed More...

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

Private Member Functions
virtual std::unique_ptr< BuilderPage >	createPage (WizardState _nState) override

virtual void	enterState (WizardState _nState) override

virtual bool	prepareLeaveCurrentState (CommitPageReason _eReason) override

virtual bool	onFinish () override

virtual OUString	getStateDisplayName (WizardState _nState) const override

void	implCreateDataSource ()
	creates a new data source of the type indicated by m_aSettings More...

void	implDoAutoFieldMapping ()
	does an automatic field mapping (possible for all types except AST_OTHER) More...

void	implDefaultTableName ()
	guesses a default for the table name, if no valid table is selected More...

bool	needAdminInvokationPage () const
	check if with the current settings, we would need to invoke he administration dialog for more details about the data source More...

bool	needManualFieldMapping () const
	checks if we need a manual (user-guided) field mapping More...

void	implCleanup ()

void	implCommitAll ()

void	impl_updateRoadmap (AddressSourceType _eType)

Static Private Member Functions
static bool	needAdminInvokationPage (AddressSourceType _eType)

static bool	needManualFieldMapping (AddressSourceType _eType)

static bool	needTableSelection (AddressSourceType _eType)
	determines whether the given address book type does provide one table only More...

Private Attributes
css::uno::Reference< css::uno::XComponentContext >	m_xORB

AddressSettings	m_aSettings

ODataSource	m_aNewDataSource

AddressSourceType	m_eNewDataSourceType

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 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 32 of file abspilot.hxx.

Constructor & Destructor Documentation

◆ OAddressBookSourcePilot()

abp::OAddressBookSourcePilot::OAddressBookSourcePilot	(	weld::Window *	_pParent,
		const css::uno::Reference< css::uno::XComponentContext > &	_rxORB
	)

ctor

Definition at line 55 of file abspilot.cxx.

References vcl::WizardMachine::ActivatePage(), abp::AST_EVOLUTION, abp::AST_MACAB, abp::AST_OTHER, abp::AddressSettings::bEmbedDataSource, abp::AddressSettings::bIgnoreNoTable, abp::AddressSettings::bRegisterDataSource, vcl::RoadmapWizardMachine::declarePath(), vcl::WizardMachine::defaultButton(), vcl::WizardMachine::enableButtons(), abp::AddressSettings::eType, HID_ABSPILOT, HID_ABSPILOT_CANCEL, HID_ABSPILOT_FINISH, HID_ABSPILOT_NEXT, HID_ABSPILOT_PREVIOUS, m_aSettings, weld::AssistantController::m_xAssistant, vcl::WizardMachine::m_xCancel, vcl::WizardMachine::m_xFinish, vcl::WizardMachine::m_xHelp, vcl::WizardMachine::m_xNextPage, vcl::WizardMachine::m_xPrevPage, compmodule::ModuleRes(), PATH_COMPLETE, PATH_NO_FIELDS, PATH_NO_SETTINGS, PATH_NO_SETTINGS_NO_FIELDS, abp::AddressSettings::sDataSourceName, vcl::WizardMachine::setTitleBase(), STATE_FINAL_CONFIRM, STATE_INVOKE_ADMIN_DIALOG, STATE_MANUAL_FIELD_MAPPING, STATE_SELECT_ABTYPE, STATE_TABLE_SELECTION, typeSelectionChanged(), and UID_ABSPILOT_HELP.

Member Function Documentation

◆ connectToDataSource()

bool abp::OAddressBookSourcePilot::connectToDataSource ( bool _bForceReConnect )

Definition at line 351 of file abspilot.cxx.

References abp::ODataSource::connect(), DBG_ASSERT, abp::ODataSource::disconnect(), abp::ODataSource::isConnected(), abp::ODataSource::isValid(), m_aNewDataSource, and weld::AssistantController::m_xAssistant.

Referenced by abp::AdminDialogInvokationPage::implTryConnect(), and prepareLeaveCurrentState().

◆ createPage()

std::unique_ptr< BuilderPage > abp::OAddressBookSourcePilot::createPage ( WizardState _nState )

overrideprivatevirtual

Implements vcl::WizardMachine.

Definition at line 362 of file abspilot.cxx.

References getStateDisplayName(), weld::AssistantController::m_xAssistant, STATE_FINAL_CONFIRM, STATE_INVOKE_ADMIN_DIALOG, STATE_MANUAL_FIELD_MAPPING, STATE_SELECT_ABTYPE, and STATE_TABLE_SELECTION.

◆ enterState()

void abp::OAddressBookSourcePilot::enterState ( WizardState _nState )

overrideprivatevirtual

Reimplemented from vcl::RoadmapWizardMachine.

Definition at line 190 of file abspilot.cxx.

References vcl::RoadmapWizardMachine::enterState(), vcl::WizardMachine::GetPage(), impl_updateRoadmap(), implDefaultTableName(), implDoAutoFieldMapping(), needManualFieldMapping(), STATE_FINAL_CONFIRM, STATE_SELECT_ABTYPE, and STATE_TABLE_SELECTION.

◆ getDataSource()

const ODataSource & abp::OAddressBookSourcePilot::getDataSource ( ) const

inline

Definition at line 55 of file abspilot.hxx.

References m_aNewDataSource.

Referenced by abp::AdminDialogInvokationPage::canAdvance(), implDefaultTableName(), abp::AdminDialogInvokationPage::implUpdateErrorMessage(), and abp::TableSelectionPage::initializePage().

◆ getORB()

const css::uno::Reference< css::uno::XComponentContext > & abp::OAddressBookSourcePilot::getORB ( ) const

inline

get the service factory which was used to create the dialog

Definition at line 51 of file abspilot.hxx.

References m_xORB.

Referenced by abp::FinalPage::FinalPage(), abp::AddressBookSourcePage::getORB(), implCommitAll(), implCreateDataSource(), implDoAutoFieldMapping(), onFinish(), and abp::TypeSelectionPage::TypeSelectionPage().

◆ getSettings() [1/2]

AddressSettings & abp::OAddressBookSourcePilot::getSettings ( )

inline

Definition at line 52 of file abspilot.hxx.

References m_aSettings.

Referenced by abp::AddressBookSourcePage::getSettings(), implDefaultTableName(), and prepareLeaveCurrentState().

◆ getSettings() [2/2]

const AddressSettings & abp::OAddressBookSourcePilot::getSettings ( ) const

inline

Definition at line 53 of file abspilot.hxx.

References m_aSettings.

◆ getStateDisplayName()

OUString abp::OAddressBookSourcePilot::getStateDisplayName ( WizardState _nState ) const

overrideprivatevirtual

Reimplemented from vcl::RoadmapWizardMachine.

Definition at line 120 of file abspilot.cxx.

References DBG_ASSERT, compmodule::ModuleRes(), sDisplayName, STATE_FINAL_CONFIRM, STATE_INVOKE_ADMIN_DIALOG, STATE_MANUAL_FIELD_MAPPING, STATE_SELECT_ABTYPE, and STATE_TABLE_SELECTION.

Referenced by createPage().

◆ impl_updateRoadmap()

void abp::OAddressBookSourcePilot::impl_updateRoadmap ( AddressSourceType _eType )

private

Definition at line 396 of file abspilot.cxx.

References abp::AddressSettings::bIgnoreNoTable, vcl::RoadmapWizardMachine::enableState(), abp::ODataSource::hasTable(), abp::ODataSource::isConnected(), m_aNewDataSource, m_aSettings, needAdminInvokationPage(), needManualFieldMapping(), needTableSelection(), abp::AddressSettings::sSelectedTable, STATE_FINAL_CONFIRM, STATE_INVOKE_ADMIN_DIALOG, STATE_MANUAL_FIELD_MAPPING, and STATE_TABLE_SELECTION.

Referenced by enterState(), prepareLeaveCurrentState(), and typeSelectionChanged().

◆ implCleanup()

void abp::OAddressBookSourcePilot::implCleanup ( )

private

Definition at line 163 of file abspilot.cxx.

References abp::ODataSource::isValid(), m_aNewDataSource, and abp::ODataSource::remove().

Referenced by run().

◆ implCommitAll()

void abp::OAddressBookSourcePilot::implCommitAll ( )

private

Definition at line 142 of file abspilot.cxx.

References abp::AddressSettings::aFieldMapping, abp::AddressSettings::bRegisterDataSource, abp::ODataSource::getName(), getORB(), m_aNewDataSource, m_aSettings, abp::ODataSource::registerDataSource(), abp::ODataSource::rename(), abp::AddressSettings::sDataSourceName, abp::AddressSettings::sRegisteredDataSourceName, abp::AddressSettings::sSelectedTable, abp::ODataSource::store(), abp::fieldmapping::writeTemplateAddressFieldMapping(), and abp::addressconfig::writeTemplateAddressSource().

Referenced by onFinish().

◆ implCreateDataSource()

void abp::OAddressBookSourcePilot::implCreateDataSource ( )

private

creates a new data source of the type indicated by m_aSettings

If another data source has been created before, this one is deleted.

Definition at line 299 of file abspilot.cxx.

Referenced by prepareLeaveCurrentState().

◆ implDefaultTableName()

void abp::OAddressBookSourcePilot::implDefaultTableName ( )

private

guesses a default for the table name, if no valid table is selected

Definition at line 269 of file abspilot.cxx.

References abp::AST_EVOLUTION, abp::AST_EVOLUTION_GROUPWISE, abp::AST_EVOLUTION_LDAP, abp::AST_THUNDERBIRD, eType, getDataSource(), getSettings(), abp::ODataSource::getTableNames(), and abp::AddressSettings::sSelectedTable.

Referenced by enterState().

◆ implDoAutoFieldMapping()

void abp::OAddressBookSourcePilot::implDoAutoFieldMapping ( )

private

does an automatic field mapping (possible for all types except AST_OTHER)

Definition at line 292 of file abspilot.cxx.

References abp::AddressSettings::aFieldMapping, DBG_ASSERT, abp::fieldmapping::defaultMapping(), getORB(), m_aSettings, and needManualFieldMapping().

Referenced by enterState().

◆ needAdminInvokationPage() [1/2]

bool abp::OAddressBookSourcePilot::needAdminInvokationPage ( ) const

inlineprivate

check if with the current settings, we would need to invoke he administration dialog for more details about the data source

Definition at line 90 of file abspilot.hxx.

References abp::AddressSettings::eType, m_aSettings, and needAdminInvokationPage().

Referenced by impl_updateRoadmap(), needAdminInvokationPage(), prepareLeaveCurrentState(), and typeSelectionChanged().

◆ needAdminInvokationPage() [2/2]

static bool abp::OAddressBookSourcePilot::needAdminInvokationPage ( AddressSourceType _eType )

inlinestaticprivate

Definition at line 85 of file abspilot.hxx.

References abp::AST_OTHER.

◆ needManualFieldMapping() [1/2]

bool abp::OAddressBookSourcePilot::needManualFieldMapping ( ) const

inlineprivate

checks if we need a manual (user-guided) field mapping

Definition at line 102 of file abspilot.hxx.

References abp::AddressSettings::eType, m_aSettings, and needManualFieldMapping().

Referenced by enterState(), impl_updateRoadmap(), implDoAutoFieldMapping(), needManualFieldMapping(), and typeSelectionChanged().

◆ needManualFieldMapping() [2/2]

static bool abp::OAddressBookSourcePilot::needManualFieldMapping ( AddressSourceType _eType )

inlinestaticprivate

Definition at line 95 of file abspilot.hxx.

References abp::AST_EVOLUTION, abp::AST_EVOLUTION_GROUPWISE, abp::AST_EVOLUTION_LDAP, abp::AST_KAB, and abp::AST_OTHER.

◆ needTableSelection()

static bool abp::OAddressBookSourcePilot::needTableSelection ( AddressSourceType _eType )

inlinestaticprivate

determines whether the given address book type does provide one table only

Definition at line 108 of file abspilot.hxx.

References abp::AST_KAB.

Referenced by impl_updateRoadmap().

◆ onFinish()

bool abp::OAddressBookSourcePilot::onFinish ( )

overrideprivatevirtual

Reimplemented from vcl::WizardMachine.

Definition at line 178 of file abspilot.cxx.

References getORB(), implCommitAll(), abp::addressconfig::markPilotSuccess(), and vcl::WizardMachine::onFinish().

◆ prepareLeaveCurrentState()

bool abp::OAddressBookSourcePilot::prepareLeaveCurrentState ( CommitPageReason _eReason )

overrideprivatevirtual

◆ run()

short abp::OAddressBookSourcePilot::run ( )

overridevirtual

Reimplemented from weld::DialogController.

Definition at line 169 of file abspilot.cxx.

References implCleanup(), and weld::DialogController::run().

◆ travelNext()

void abp::OAddressBookSourcePilot::travelNext ( )

inline

Definition at line 59 of file abspilot.hxx.

References vcl::WizardMachine::travelNext().

Referenced by abp::AdminDialogInvokationPage::implTryConnect().

◆ typeSelectionChanged()

void abp::OAddressBookSourcePilot::typeSelectionChanged ( AddressSourceType _eType )

to be called when the selected type changed

Definition at line 424 of file abspilot.cxx.

References vcl::RoadmapWizardMachine::activatePath(), abp::AddressSettings::bIgnoreNoTable, abp::ODataSource::disconnect(), impl_updateRoadmap(), m_aNewDataSource, m_aSettings, needAdminInvokationPage(), needManualFieldMapping(), PATH_COMPLETE, PATH_NO_FIELDS, PATH_NO_SETTINGS, and PATH_NO_SETTINGS_NO_FIELDS.

Referenced by OAddressBookSourcePilot().

Member Data Documentation

◆ m_aNewDataSource

ODataSource abp::OAddressBookSourcePilot::m_aNewDataSource

private

Definition at line 38 of file abspilot.hxx.

Referenced by connectToDataSource(), getDataSource(), impl_updateRoadmap(), implCleanup(), implCommitAll(), implCreateDataSource(), prepareLeaveCurrentState(), and typeSelectionChanged().

◆ m_aSettings

AddressSettings abp::OAddressBookSourcePilot::m_aSettings

private

Definition at line 36 of file abspilot.hxx.

Referenced by getSettings(), impl_updateRoadmap(), implCommitAll(), implCreateDataSource(), implDoAutoFieldMapping(), needAdminInvokationPage(), needManualFieldMapping(), OAddressBookSourcePilot(), prepareLeaveCurrentState(), and typeSelectionChanged().

◆ m_eNewDataSourceType

AddressSourceType abp::OAddressBookSourcePilot::m_eNewDataSourceType

private

Definition at line 39 of file abspilot.hxx.

Referenced by implCreateDataSource().

◆ m_xORB

css::uno::Reference< css::uno::XComponentContext > abp::OAddressBookSourcePilot::m_xORB

private

Definition at line 35 of file abspilot.hxx.

Referenced by getORB().

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

Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OAddressBookSourcePilot()

Member Function Documentation

◆ connectToDataSource()

◆ createPage()

◆ enterState()

◆ getDataSource()

◆ getORB()

◆ getSettings() [1/2]

◆ getSettings() [2/2]

◆ getStateDisplayName()

◆ impl_updateRoadmap()

◆ implCleanup()

◆ implCommitAll()

◆ implCreateDataSource()

◆ implDefaultTableName()

◆ implDoAutoFieldMapping()

◆ needAdminInvokationPage() [1/2]

◆ needAdminInvokationPage() [2/2]

◆ needManualFieldMapping() [1/2]

◆ needManualFieldMapping() [2/2]

◆ needTableSelection()

◆ onFinish()

◆ prepareLeaveCurrentState()

◆ run()

◆ travelNext()

◆ typeSelectionChanged()

Member Data Documentation

◆ m_aNewDataSource

◆ m_aSettings

◆ m_eNewDataSourceType

◆ m_xORB