20 #ifndef INCLUDED_VCL_WIZDLG_HXX
21 #define INCLUDED_VCL_WIZDLG_HXX
37 struct RoadmapWizardImpl;
40 namespace RoadmapWizardTypes
112 virtual void dispose()
override;
114 virtual void Resize()
override;
145 void InsertRoadmapItem(
int nIndex,
const OUString& rLabel,
int nId,
bool bEnabled);
virtual void queue_resize(StateChangedType eReason=StateChangedType::Layout) override
void resumeTraveling(AccessGuard)
void ShowRoadmap(bool bShow)
VclPtr< vcl::Window > mpViewWindow
void removePageFromHistory(WizardTypes::WizardState nToRemove)
removes a page from the history.
std::unique_ptr< WizardMachineImplData > m_xWizardImpl
void ImplCalcSize(Size &rSize)
~RoadmapWizardTravelSuspension()
std::function< std::unique_ptr< UIObject >vcl::Window *)> FactoryFunction
void SetItemSelectHdl(const Link< LinkParamNone *, void > &_rHdl)
sal_Int16 mnLeftAlignCount
RoadmapWizard(vcl::Window *pParent, WinBits nStyle=WB_STDDIALOG, InitFlag eFlag=InitFlag::Default)
ImplWizPageData * mpFirstPage
bool skipUntil(WizardTypes::WizardState nTargetState)
skips one or more states, until a given state is reached
TabPage * GetOrCreatePage(const WizardTypes::WizardState i_nState)
WizardTypes::WizardState getCurrentState() const
returns the current state of the machine
VclPtr< RoadmapWizard > m_pOWizard
FactoryFunction GetUITestFactory() const override
virtual void dispose() override
This is intended to be used to clear any locally held references to other Window-subclass objects...
tools::Long LogicalCoordinateToPixel(int iCoordinate)
void SetLeftAlignedButtonCount(sal_Int16 _nCount)
sets the number of buttons which should be left-aligned.
VclPtr< TabPage > mpCurTabPage
void RemoveButton(Button *pButton)
VclPtr< TabPage > createPage(WizardTypes::WizardState nState)
to override to create new pages
sal_uInt16 GetCurLevel() const
ImplWizButtonData * mpFirstBtn
Use given parent or get a default one using GetDefaultParent(...)
TabPage * GetPage(sal_uInt16 nLevel) const
VclPtr< PushButton > m_pNextPage
DECL_LINK(ImplHandleWizardLayoutTimerHdl, Timer *, void)
OUString getStateDisplayName(WizardTypes::WizardState nState) const
returns a human readable name for a given state
bool Finish(tools::Long nResult=0)
WizardTypes::WizardState determineNextState(WizardTypes::WizardState nCurrentState) const
determine the next state to travel from the given one
virtual bool EventNotify(NotifyEvent &rNEvt) override
const Size & GetPageSizePixel() const
void AddButton(Button *pButton, tools::Long nOffset=0)
void implUpdateRoadmap()
updates the roadmap control to show the given path, as far as possible (modulo conflicts with other p...
VclPtr< PushButton > mpNextBtn
virtual void Resize() override
bool isTravelingSuspended() const
virtual void StateChanged(StateChangedType nStateChange) override
void suspendTraveling(AccessGuard)
void DeleteRoadmapItems()
helper class to temporarily suspend any traveling in the wizard
VclPtr< PushButton > mpPrevBtn
std::unique_ptr< RoadmapWizardImpl > m_xRoadmapImpl
void SetRoadmapHelpId(const OString &_rId)
bool travelNext()
travel to the next state
void RemovePage(TabPage *pPage)
void implConstruct(const WizardButtonFlags _nButtonFlags)
bool travelPrevious()
travel to the previous state
VclPtr< CancelButton > m_pCancel
void SetPageSizePixel(const Size &rSize)
void SelectRoadmapItemByID(int nId, bool bGrabFocus=true)
void ImplShowTabPage(TabPage *pPage)
void enterState(WizardTypes::WizardState _nState)
will be called when a new page is about to be displayed
void AddPage(TabPage *pPage)
bool skipBackwardUntil(WizardTypes::WizardState nTargetState)
moves back one or more states, until a given state is reached
int GetCurrentRoadmapItemID() const
bool ShowPage(sal_uInt16 nLevel)
void enableButtons(WizardButtonFlags _nWizardButtonFlags, bool _bEnable)
enable (or disable) buttons
void InsertRoadmapItem(int nIndex, const OUString &rLabel, int nId, bool bEnabled)
VclPtr< PushButton > m_pPrevPage
TabPage * ImplGetPage(sal_uInt16 nLevel) const
RoadmapWizardTravelSuspension(RoadmapWizard &rWizard)
static IWizardPageController * getPageController(TabPage *_pCurrentPage)
VclPtr< OKButton > m_pFinish
VclPtr< HelpButton > m_pHelp
bool isAutomaticNextButtonStateEnabled() const
enables the automatic enabled/disabled state of the "Next" button
An idle is a timer to be scheduled immediately.
void SetPage(sal_uInt16 nLevel, TabPage *pPage)
virtual ~RoadmapWizard() override
bool prepareLeaveCurrentState(WizardTypes::CommitPageReason eReason)
will be called when the current state is about to be left for the given reason
bool canAdvance() const
determines whether there is a next state to which we can advance