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

#include <mailmergewizard.hxx>

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

Public Member Functions

 SwMailMergeWizard (SwView &rView, std::shared_ptr< SwMailMergeConfigItem > const &rConfigItem)
 
virtual ~SwMailMergeWizard () override
 
SwViewGetSwView ()
 
SwMailMergeConfigItemGetConfigItem ()
 
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 OString &_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)
 
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)
 
void suspendTraveling (AccessGuard)
 
void resumeTraveling (AccessGuard)
 
bool isTravelingSuspended () const
 
- Public Member Functions inherited from weld::AssistantController
 AssistantController (weld::Widget *pParent, const OUString &rUIFile, const OString &rDialogId)
 
virtual DialoggetDialog () override
 
virtual ~AssistantController () override
 
- Public Member Functions inherited from weld::DialogController
const DialoggetConstDialog () const
 
void set_title (const OUString &rTitle)
 
OUString get_title () const
 
void set_help_id (const OString &rHelpId)
 
OString get_help_id () const
 
void response (int nResponse)
 
virtual ~DialogController () COVERITY_NOEXCEPT_FALSE
 

Protected Member Functions

virtual std::unique_ptr< BuilderPagecreatePage (WizardState _nState) override
 
virtual void enterState (WizardState _nState) override
 
virtual OUString getStateDisplayName (WizardState _nState) const override
 
- 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
 
- Protected Member Functions inherited from vcl::WizardMachine
virtual void ActivatePage ()
 
virtual bool DeactivatePage ()
 
virtual bool prepareLeaveCurrentState (WizardTypes::CommitPageReason eReason)
 
virtual bool leaveState (WizardTypes::WizardState nState)
 
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 IWizardPageControllergetPageController (BuilderPage *pCurrentPage) const
 
void getStateHistory (std::vector< WizardTypes::WizardState > &out_rHistory)
 
BuilderPageGetOrCreatePage (const WizardTypes::WizardState i_nState)
 

Private Attributes

SwView *const m_pSwView
 
OUString sDocumentURL
 
bool m_bDocumentLoad
 
std::shared_ptr< SwMailMergeConfigItemm_xConfigItem
 
OUString const m_sStarting
 
OUString const m_sDocumentType
 
OUString const m_sAddressBlock
 
OUString const m_sAddressList
 
OUString const m_sGreetingsLine
 
OUString const 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 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 37 of file mailmergewizard.hxx.

Constructor & Destructor Documentation

SwMailMergeWizard::SwMailMergeWizard ( SwView rView,
std::shared_ptr< SwMailMergeConfigItem > const &  rConfigItem 
)
SwMailMergeWizard::~SwMailMergeWizard ( )
overridevirtual

Definition at line 87 of file mailmergewizard.cxx.

Member Function Documentation

std::unique_ptr< BuilderPage > SwMailMergeWizard::createPage ( WizardState  _nState)
overrideprotectedvirtual
void SwMailMergeWizard::enterState ( WizardState  _nState)
overrideprotectedvirtual
SwMailMergeConfigItem& SwMailMergeWizard::GetConfigItem ( )
inline
const OUString& SwMailMergeWizard::GetReloadDocument ( ) const
inline

Definition at line 70 of file mailmergewizard.hxx.

References sDocumentURL.

sal_uInt16 SwMailMergeWizard::GetRestartPage ( ) const
inline

Definition at line 77 of file mailmergewizard.hxx.

References m_nRestartPage.

OUString SwMailMergeWizard::getStateDisplayName ( WizardState  _nState) const
overrideprotectedvirtual
SwView* SwMailMergeWizard::GetSwView ( )
inline
short SwMailMergeWizard::run ( )
overridevirtual

Reimplemented from weld::DialogController.

Definition at line 252 of file mailmergewizard.cxx.

References RET_CANCEL.

void SwMailMergeWizard::SetDocumentLoad ( bool  bSet)
inline

Definition at line 73 of file mailmergewizard.hxx.

Referenced by SwMailMergeDocSelectPage::commitPage().

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

Definition at line 69 of file mailmergewizard.hxx.

Referenced by SwMailMergeDocSelectPage::commitPage().

void SwMailMergeWizard::SetRestartPage ( sal_uInt16  nPage)
inline

Definition at line 78 of file mailmergewizard.hxx.

Referenced by SwMailMergeDocSelectPage::commitPage().

bool SwMailMergeWizard::skipUntil ( sal_uInt16  nPage)
inline

Definition at line 80 of file mailmergewizard.hxx.

void SwMailMergeWizard::UpdateRoadmap ( )

Member Data Documentation

bool SwMailMergeWizard::m_bDocumentLoad
private

Definition at line 41 of file mailmergewizard.hxx.

Referenced by UpdateRoadmap().

sal_uInt16 SwMailMergeWizard::m_nRestartPage
private

Definition at line 52 of file mailmergewizard.hxx.

Referenced by enterState(), and GetRestartPage().

SwView* const SwMailMergeWizard::m_pSwView
private

Definition at line 39 of file mailmergewizard.hxx.

Referenced by GetSwView().

OUString const SwMailMergeWizard::m_sAddressBlock
private

Definition at line 47 of file mailmergewizard.hxx.

Referenced by getStateDisplayName().

OUString const SwMailMergeWizard::m_sAddressList
private

Definition at line 48 of file mailmergewizard.hxx.

Referenced by getStateDisplayName().

OUString const SwMailMergeWizard::m_sDocumentType
private

Definition at line 46 of file mailmergewizard.hxx.

Referenced by getStateDisplayName().

OUString const SwMailMergeWizard::m_sGreetingsLine
private

Definition at line 49 of file mailmergewizard.hxx.

Referenced by getStateDisplayName().

OUString const SwMailMergeWizard::m_sLayout
private

Definition at line 50 of file mailmergewizard.hxx.

Referenced by getStateDisplayName().

OUString const SwMailMergeWizard::m_sStarting
private

Definition at line 45 of file mailmergewizard.hxx.

Referenced by getStateDisplayName().

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

Definition at line 40 of file mailmergewizard.hxx.

Referenced by GetReloadDocument().


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