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 Execute () override
 
- Public Member Functions inherited from svt::RoadmapWizard
 RoadmapWizard (vcl::Window *_pParent)
 
virtual ~RoadmapWizard () override
 
virtual void dispose () override
 
void SetRoadmapHelpId (const OString &_rId)
 
void SetRoadmapInteractive (bool _bInteractive)
 
bool isStateEnabled (WizardState _nState) const
 
virtual bool canAdvance () const override
 
virtual void updateTravelUI () override
 
- Public Member Functions inherited from svt::OWizardMachine
 OWizardMachine (vcl::Window *_pParent, WizardButtonFlags _nButtonFlags)
 
virtual ~OWizardMachine () override
 
void enableButtons (WizardButtonFlags _nWizardButtonFlags, bool _bEnable)
 
void defaultButton (WizardButtonFlags _nWizardButtonFlags)
 
void defaultButton (PushButton *_pNewDefButton)
 
void setTitleBase (const OUString &_rTitleBase)
 
void suspendTraveling (AccessGuard)
 
void resumeTraveling (AccessGuard)
 
bool isTravelingSuspended () const
 
- Public Member Functions inherited from WizardDialog
 WizardDialog (vcl::Window *pParent, const OUString &rID, const OUString &rUIXMLDescription)
 
virtual ~WizardDialog () override
 
virtual void Resize () override
 
virtual void StateChanged (StateChangedType nStateChange) override
 
virtual bool EventNotify (NotifyEvent &rNEvt) override
 
virtual void queue_resize (StateChangedType eReason=StateChangedType::Layout) override
 
bool ShowPrevPage ()
 
bool ShowNextPage ()
 
bool ShowPage (sal_uInt16 nLevel)
 
bool Finish (long nResult=0)
 
sal_uInt16 GetCurLevel () const
 
void AddPage (TabPage *pPage)
 
void RemovePage (TabPage *pPage)
 
void SetPage (sal_uInt16 nLevel, TabPage *pPage)
 
TabPageGetPage (sal_uInt16 nLevel) const
 
void AddButton (Button *pButton, long nOffset=0)
 
void RemoveButton (Button *pButton)
 
void SetPrevButton (PushButton *pButton)
 
void SetNextButton (PushButton *pButton)
 
void SetViewWindow (vcl::Window *pWindow)
 
void SetViewAlign (WindowAlign eAlign)
 
void SetPageSizePixel (const Size &rSize)
 
const SizeGetPageSizePixel () const
 
void SetActivatePageHdl (const Link< WizardDialog *, void > &rLink)
 

Protected Member Functions

virtual VclPtr< TabPagecreatePage (WizardState _nState) override
 
virtual void enterState (WizardState _nState) override
 
virtual OUString getStateDisplayName (WizardState _nState) const override
 
- Protected Member Functions inherited from svt::RoadmapWizard
void declarePath (PathId _nPathId, const WizardPath &_lWizardStates)
 
void describeState (WizardState _nState, const OUString &_rStateDisplayName, RoadmapPageFactory _pPageFactory)
 
void activatePath (PathId _nPathId, bool _bDecideForIt=false)
 
virtual WizardState determineNextState (WizardState _nCurrentState) const override
 
void enableState (WizardState _nState, bool _bEnable=true)
 
bool knowsState (WizardState _nState) const
 
void updateRoadmapItemLabel (WizardState _nState)
 
- Protected Member Functions inherited from svt::OWizardMachine
virtual void ActivatePage () override
 
virtual bool DeactivatePage () override
 
virtual bool prepareLeaveCurrentState (CommitPageReason _eReason)
 
virtual bool leaveState (WizardState _nState)
 
virtual bool onFinish ()
 
bool travelNext ()
 
bool travelPrevious ()
 
void enableAutomaticNextButtonState ()
 
bool isAutomaticNextButtonStateEnabled () const
 
void removePageFromHistory (WizardState nToRemove)
 
void skip ()
 
bool skipUntil (WizardState _nTargetState)
 
bool skipBackwardUntil (WizardState _nTargetState)
 
WizardState getCurrentState () const
 
virtual IWizardPageControllergetPageController (TabPage *_pCurrentPage) const
 
void getStateHistory (::std::vector< WizardState > &_out_rHistory)
 
TabPageGetOrCreatePage (const WizardState i_nState)
 
- Protected Member Functions inherited from WizardDialog
long LogicalCoordinateToPixel (int iCoordinate)
 
void SetLeftAlignedButtonCount (sal_Int16 _nCount)
 
void SetEmptyViewMargin ()
 

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

- Public Types inherited from svt::WizardTypes
enum  CommitPageReason
 
typedef sal_Int16 WizardState
 
- Public Types inherited from svt::RoadmapWizardTypes
typedef sal_Int16 PathId
 
typedef ::std::vector< WizardTypes::WizardStateWizardPath
 
typedef VclPtr< TabPage >(* RoadmapPageFactory) (RoadmapWizard &)
 
- Public Attributes inherited from svt::WizardTypes
 eTravelForward
 
 eTravelBackward
 
 eFinish
 
 eValidate
 
- Protected Attributes inherited from svt::OWizardMachine
VclPtr< OKButtonm_pFinish
 
VclPtr< CancelButtonm_pCancel
 
VclPtr< PushButtonm_pNextPage
 
VclPtr< PushButtonm_pPrevPage
 
VclPtr< HelpButtonm_pHelp
 

Detailed Description

Definition at line 34 of file mailmergewizard.hxx.

Constructor & Destructor Documentation

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

Definition at line 86 of file mailmergewizard.cxx.

Member Function Documentation

VclPtr< TabPage > SwMailMergeWizard::createPage ( WizardState  _nState)
overrideprotectedvirtual
void SwMailMergeWizard::enterState ( WizardState  _nState)
overrideprotectedvirtual
short SwMailMergeWizard::Execute ( )
overridevirtual

Definition at line 243 of file mailmergewizard.cxx.

References RET_CANCEL.

SwMailMergeConfigItem& SwMailMergeWizard::GetConfigItem ( )
inline
const OUString& SwMailMergeWizard::GetReloadDocument ( ) const
inline

Definition at line 69 of file mailmergewizard.hxx.

References sDocumentURL.

sal_uInt16 SwMailMergeWizard::GetRestartPage ( ) const
inline

Definition at line 76 of file mailmergewizard.hxx.

References m_nRestartPage.

OUString SwMailMergeWizard::getStateDisplayName ( WizardState  _nState) const
overrideprotectedvirtual
SwView* SwMailMergeWizard::GetSwView ( )
inline
void SwMailMergeWizard::SetDocumentLoad ( bool  bSet)
inline

Definition at line 72 of file mailmergewizard.hxx.

Referenced by SwMailMergeDocSelectPage::commitPage().

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

Definition at line 68 of file mailmergewizard.hxx.

Referenced by SwMailMergeDocSelectPage::commitPage().

void SwMailMergeWizard::SetRestartPage ( sal_uInt16  nPage)
inline

Definition at line 77 of file mailmergewizard.hxx.

Referenced by SwMailMergeDocSelectPage::commitPage().

bool SwMailMergeWizard::skipUntil ( sal_uInt16  nPage)
inline

Definition at line 79 of file mailmergewizard.hxx.

void SwMailMergeWizard::UpdateRoadmap ( )

Member Data Documentation

bool SwMailMergeWizard::m_bDocumentLoad
private

Definition at line 38 of file mailmergewizard.hxx.

Referenced by UpdateRoadmap().

sal_uInt16 SwMailMergeWizard::m_nRestartPage
private

Definition at line 49 of file mailmergewizard.hxx.

Referenced by enterState(), and GetRestartPage().

SwView* const SwMailMergeWizard::m_pSwView
private

Definition at line 36 of file mailmergewizard.hxx.

Referenced by GetSwView().

OUString const SwMailMergeWizard::m_sAddressBlock
private

Definition at line 44 of file mailmergewizard.hxx.

Referenced by getStateDisplayName().

OUString const SwMailMergeWizard::m_sAddressList
private

Definition at line 45 of file mailmergewizard.hxx.

Referenced by getStateDisplayName().

OUString const SwMailMergeWizard::m_sDocumentType
private

Definition at line 43 of file mailmergewizard.hxx.

Referenced by getStateDisplayName().

OUString const SwMailMergeWizard::m_sGreetingsLine
private

Definition at line 46 of file mailmergewizard.hxx.

Referenced by getStateDisplayName().

OUString const SwMailMergeWizard::m_sLayout
private

Definition at line 47 of file mailmergewizard.hxx.

Referenced by getStateDisplayName().

OUString const SwMailMergeWizard::m_sStarting
private

Definition at line 42 of file mailmergewizard.hxx.

Referenced by getStateDisplayName().

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

Definition at line 37 of file mailmergewizard.hxx.

Referenced by GetReloadDocument().


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