LibreOffice Module sw (master) 1
Public Member Functions | Private Member Functions | Private Attributes | List of all members
SwMailMergeWizard Class Referencefinal

#include <mailmergewizard.hxx>

Inheritance diagram for SwMailMergeWizard:
[legend]
Collaboration diagram for SwMailMergeWizard:
[legend]

Public Member Functions

 SwMailMergeWizard (SwView &rView, std::shared_ptr< SwMailMergeConfigItem > xConfigItem)
 
virtual ~SwMailMergeWizard () override
 
SwView * GetSwView ()
 
SwMailMergeConfigItem & GetConfigItem ()
 
void SetReloadDocument (const OUString &rURL)
 
const OUString & GetReloadDocument () const
 
void SetDocumentLoad (bool bSet)
 
void UpdateRoadmap ()
 
sal_uInt16 GetRestartPage () const
 
void SetRestartPage (sal_uInt16 nPage)
 
bool skipUntil (sal_uInt16 nPage)
 
virtual short run () override
 
- 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 OUString getStateDisplayName (WizardState _nState) const override
 

Private Attributes

SwView * m_pSwView
 
OUString m_sDocumentURL
 
bool m_bDocumentLoad
 
std::shared_ptr< SwMailMergeConfigItem > m_xConfigItem
 
OUString m_sStarting
 
OUString m_sDocumentType
 
OUString m_sAddressBlock
 
OUString m_sAddressList
 
OUString m_sGreetingsLine
 
OUString m_sLayout
 
sal_uInt16 m_nRestartPage
 

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 36 of file mailmergewizard.hxx.

Constructor & Destructor Documentation

◆ SwMailMergeWizard()

SwMailMergeWizard::SwMailMergeWizard ( SwView &  rView,
std::shared_ptr< SwMailMergeConfigItem >  xConfigItem 
)

Definition at line 37 of file mailmergewizard.cxx.

References vcl::WizardMachine::ActivatePage(), vcl::RoadmapWizardMachine::declarePath(), vcl::WizardMachine::defaultButton(), vcl::WizardMachine::enableButtons(), HID_MM_NEXT_PAGE, HID_MM_PREV_PAGE, weld::AssistantController::m_xAssistant, m_xConfigItem, vcl::WizardMachine::m_xFinish, vcl::WizardMachine::m_xNextPage, vcl::WizardMachine::m_xPrevPage, MM_ADDRESSBLOCKPAGE, MM_DOCUMENTSELECTPAGE, MM_GREETINGSPAGE, MM_LAYOUTPAGE, MM_OUTPUTTYPETPAGE, vcl::WizardMachine::setTitleBase(), SwResId(), and UpdateRoadmap().

◆ ~SwMailMergeWizard()

SwMailMergeWizard::~SwMailMergeWizard ( )
overridevirtual

Definition at line 83 of file mailmergewizard.cxx.

Member Function Documentation

◆ createPage()

std::unique_ptr< BuilderPage > SwMailMergeWizard::createPage ( WizardState  _nState)
overrideprivatevirtual

Implements vcl::WizardMachine.

Definition at line 87 of file mailmergewizard.cxx.

References getStateDisplayName(), weld::AssistantController::m_xAssistant, MM_ADDRESSBLOCKPAGE, MM_DOCUMENTSELECTPAGE, MM_GREETINGSPAGE, MM_LAYOUTPAGE, MM_OUTPUTTYPETPAGE, and vcl::RoadmapWizardMachine::SetRoadmapHelpId().

◆ enterState()

void SwMailMergeWizard::enterState ( WizardState  _nState)
overrideprivatevirtual

Reimplemented from vcl::RoadmapWizardMachine.

Definition at line 128 of file mailmergewizard.cxx.

References vcl::WizardMachine::enableButtons(), vcl::RoadmapWizardMachine::enterState(), SwView::GetDataSourceName(), GetSwView(), SwView::IsDataSourceAvailable(), m_nRestartPage, weld::AssistantController::m_xAssistant, m_xConfigItem, MM_ADDRESSBLOCKPAGE, MM_DOCUMENTSELECTPAGE, MM_LAYOUTPAGE, RET_REMOVE_TARGET, and UpdateRoadmap().

◆ GetConfigItem()

SwMailMergeConfigItem & SwMailMergeWizard::GetConfigItem ( )
inline

Definition at line 65 of file mailmergewizard.hxx.

References m_xConfigItem.

Referenced by SwMailMergeAddressBlockPage::Activate(), SwMailMergeLayoutPage::Activate(), SwMailMergeAddressBlockPage::canAdvance(), SwMailMergeAddressBlockPage::commitPage(), SwMailMergeLayoutPage::commitPage(), SwMailMergeAddressBlockPage::InsertDataHdl(), SwAddressListDialog::SwAddressListDialog(), SwMailMergeDocSelectPage::SwMailMergeDocSelectPage(), and SwMailMergeOutputTypePage::SwMailMergeOutputTypePage().

◆ GetReloadDocument()

const OUString & SwMailMergeWizard::GetReloadDocument ( ) const
inline

Definition at line 68 of file mailmergewizard.hxx.

References m_sDocumentURL.

◆ GetRestartPage()

sal_uInt16 SwMailMergeWizard::GetRestartPage ( ) const
inline

Definition at line 75 of file mailmergewizard.hxx.

References m_nRestartPage.

◆ getStateDisplayName()

OUString SwMailMergeWizard::getStateDisplayName ( WizardState  _nState) const
overrideprivatevirtual

Reimplemented from vcl::RoadmapWizardMachine.

Definition at line 170 of file mailmergewizard.cxx.

References m_sAddressBlock, m_sAddressList, m_sDocumentType, m_sGreetingsLine, m_sLayout, m_sStarting, m_xConfigItem, MM_ADDRESSBLOCKPAGE, MM_DOCUMENTSELECTPAGE, MM_GREETINGSPAGE, MM_LAYOUTPAGE, and MM_OUTPUTTYPETPAGE.

Referenced by createPage(), and UpdateRoadmap().

◆ GetSwView()

SwView * SwMailMergeWizard::GetSwView ( )
inline

Definition at line 64 of file mailmergewizard.hxx.

References m_pSwView.

Referenced by SwMailMergeLayoutPage::commitPage(), enterState(), and SwMailMergeLayoutPage::SwMailMergeLayoutPage().

◆ run()

short SwMailMergeWizard::run ( )
overridevirtual

Reimplemented from weld::DialogController.

Definition at line 257 of file mailmergewizard.cxx.

References RET_CANCEL.

◆ SetDocumentLoad()

void SwMailMergeWizard::SetDocumentLoad ( bool  bSet)
inline

Definition at line 71 of file mailmergewizard.hxx.

References m_bDocumentLoad.

Referenced by SwMailMergeDocSelectPage::commitPage().

◆ SetReloadDocument()

void SwMailMergeWizard::SetReloadDocument ( const OUString &  rURL)
inline

Definition at line 67 of file mailmergewizard.hxx.

References m_sDocumentURL.

Referenced by SwMailMergeDocSelectPage::commitPage().

◆ SetRestartPage()

void SwMailMergeWizard::SetRestartPage ( sal_uInt16  nPage)
inline

Definition at line 76 of file mailmergewizard.hxx.

References m_nRestartPage.

Referenced by SwMailMergeDocSelectPage::commitPage().

◆ skipUntil()

bool SwMailMergeWizard::skipUntil ( sal_uInt16  nPage)
inline

Definition at line 78 of file mailmergewizard.hxx.

◆ UpdateRoadmap()

void SwMailMergeWizard::UpdateRoadmap ( )

Definition at line 190 of file mailmergewizard.cxx.

References vcl::OWizardPage::commitPage(), vcl::WizardMachine::enableButtons(), vcl::RoadmapWizardMachine::enableState(), vcl::WizardMachine::GetPage(), getStateDisplayName(), m_bDocumentLoad, weld::AssistantController::m_xAssistant, m_xConfigItem, MM_ADDRESSBLOCKPAGE, MM_DOCUMENTSELECTPAGE, MM_GREETINGSPAGE, MM_LAYOUTPAGE, and MM_OUTPUTTYPETPAGE.

Referenced by enterState(), and SwMailMergeWizard().

Member Data Documentation

◆ m_bDocumentLoad

bool SwMailMergeWizard::m_bDocumentLoad
private

Definition at line 40 of file mailmergewizard.hxx.

Referenced by SetDocumentLoad(), and UpdateRoadmap().

◆ m_nRestartPage

sal_uInt16 SwMailMergeWizard::m_nRestartPage
private

Definition at line 51 of file mailmergewizard.hxx.

Referenced by enterState(), GetRestartPage(), and SetRestartPage().

◆ m_pSwView

SwView* SwMailMergeWizard::m_pSwView
private

Definition at line 38 of file mailmergewizard.hxx.

Referenced by GetSwView().

◆ m_sAddressBlock

OUString SwMailMergeWizard::m_sAddressBlock
private

Definition at line 46 of file mailmergewizard.hxx.

Referenced by getStateDisplayName().

◆ m_sAddressList

OUString SwMailMergeWizard::m_sAddressList
private

Definition at line 47 of file mailmergewizard.hxx.

Referenced by getStateDisplayName().

◆ m_sDocumentType

OUString SwMailMergeWizard::m_sDocumentType
private

Definition at line 45 of file mailmergewizard.hxx.

Referenced by getStateDisplayName().

◆ m_sDocumentURL

OUString SwMailMergeWizard::m_sDocumentURL
private

Definition at line 39 of file mailmergewizard.hxx.

Referenced by GetReloadDocument(), and SetReloadDocument().

◆ m_sGreetingsLine

OUString SwMailMergeWizard::m_sGreetingsLine
private

Definition at line 48 of file mailmergewizard.hxx.

Referenced by getStateDisplayName().

◆ m_sLayout

OUString SwMailMergeWizard::m_sLayout
private

Definition at line 49 of file mailmergewizard.hxx.

Referenced by getStateDisplayName().

◆ m_sStarting

OUString SwMailMergeWizard::m_sStarting
private

Definition at line 44 of file mailmergewizard.hxx.

Referenced by getStateDisplayName().

◆ m_xConfigItem

std::shared_ptr<SwMailMergeConfigItem> SwMailMergeWizard::m_xConfigItem
private

Definition at line 42 of file mailmergewizard.hxx.

Referenced by enterState(), GetConfigItem(), getStateDisplayName(), SwMailMergeWizard(), and UpdateRoadmap().

The documentation for this class was generated from the following files:
Generated on Sun Jul 30 2023 04:31:22 for LibreOffice Module sw (master) by doxygen 1.9.3