LibreOffice Module vcl (master)  1
wizdlg.hxx
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3  * This file is part of the LibreOffice project.
4  *
5  * This Source Code Form is subject to the terms of the Mozilla Public
6  * License, v. 2.0. If a copy of the MPL was not distributed with this
7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8  *
9  * This file incorporates work covered by the following license notice:
10  *
11  * Licensed to the Apache Software Foundation (ASF) under one or more
12  * contributor license agreements. See the NOTICE file distributed
13  * with this work for additional information regarding copyright
14  * ownership. The ASF licenses this file to you under the Apache
15  * License, Version 2.0 (the "License"); you may not use this file
16  * except in compliance with the License. You may obtain a copy of
17  * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18  */
19 
20 #ifndef INCLUDED_VCL_WIZDLG_HXX
21 #define INCLUDED_VCL_WIZDLG_HXX
22 
23 #include <memory>
24 #include <vcl/toolkit/button.hxx>
25 #include <vcl/toolkit/dialog.hxx>
26 #include <vcl/roadmapwizard.hxx>
27 #include <vcl/tabpage.hxx>
28 
30 {
33 };
34 
35 namespace vcl
36 {
37  struct RoadmapWizardImpl;
38  class RoadmapWizard;
39 
40  namespace RoadmapWizardTypes
41  {
42  typedef VclPtr<TabPage> (* RoadmapPageFactory)( RoadmapWizard& );
43  };
44 
45  //= RoadmapWizard
46 
65  class RoadmapWizard : public Dialog
66  {
67  private:
76  sal_uInt16 mnCurLevel;
77  sal_Int16 mnLeftAlignCount;
79 
80  DECL_LINK( ImplHandleWizardLayoutTimerHdl, Timer*, void );
81 
82  // IMPORTANT:
83  // traveling pages should not be done by calling these base class member, some mechanisms of this class
84  // here (e.g. committing page data) depend on having full control over page traveling.
85  // So use the travelXXX methods if you need to travel
86 
87  protected:
88  tools::Long LogicalCoordinateToPixel(int iCoordinate);
93  void SetLeftAlignedButtonCount( sal_Int16 _nCount );
94 
95  void CalcAndSetSize();
96 
97  public:
103 
104  private:
105  std::unique_ptr<WizardMachineImplData> m_xWizardImpl;
106  // hold members in this structure to allow keeping compatible when members are added
107  std::unique_ptr<RoadmapWizardImpl> m_xRoadmapImpl;
108 
109  public:
110  RoadmapWizard(vcl::Window* pParent, WinBits nStyle = WB_STDDIALOG, InitFlag eFlag = InitFlag::Default);
111  virtual ~RoadmapWizard( ) override;
112  virtual void dispose() override;
113 
114  virtual void Resize() override;
115  virtual void StateChanged( StateChangedType nStateChange ) override;
116  virtual bool EventNotify( NotifyEvent& rNEvt ) override;
117 
118  void ActivatePage();
119 
120  virtual void queue_resize(StateChangedType eReason = StateChangedType::Layout) override;
121 
122  bool ShowPage( sal_uInt16 nLevel );
123  bool Finish( tools::Long nResult = 0 );
124  sal_uInt16 GetCurLevel() const { return mnCurLevel; }
125 
126  void AddPage( TabPage* pPage );
127  void RemovePage( TabPage* pPage );
128  void SetPage( sal_uInt16 nLevel, TabPage* pPage );
129  TabPage* GetPage( sal_uInt16 nLevel ) const;
130 
131  void AddButton( Button* pButton, tools::Long nOffset = 0 );
132  void RemoveButton( Button* pButton );
133 
134  void SetPageSizePixel( const Size& rSize ) { maPageSize = rSize; }
135  const Size& GetPageSizePixel() const { return maPageSize; }
136 
138  void enableButtons(WizardButtonFlags _nWizardButtonFlags, bool _bEnable);
139 
141  bool canAdvance() const;
142 
143  void SetRoadmapHelpId( const OString& _rId );
144 
145  void InsertRoadmapItem(int nIndex, const OUString& rLabel, int nId, bool bEnabled);
146  void DeleteRoadmapItems();
147  int GetCurrentRoadmapItemID() const;
148  void SelectRoadmapItemByID(int nId, bool bGrabFocus = true);
149  void SetItemSelectHdl( const Link<LinkParamNone*,void>& _rHdl );
150  void ShowRoadmap(bool bShow);
151 
152  FactoryFunction GetUITestFactory() const override;
153 
154  protected:
155 
158 
160  void enterState(WizardTypes::WizardState _nState);
161 
173 
183 
185  bool travelNext();
186 
188  bool travelPrevious();
189 
196 
200 
215  bool skipUntil(WizardTypes::WizardState nTargetState);
216 
233  bool skipBackwardUntil(WizardTypes::WizardState nTargetState);
234 
240 
241  static IWizardPageController* getPageController( TabPage* _pCurrentPage );
242 
250  OUString getStateDisplayName(WizardTypes::WizardState nState) const;
251 
252  private:
253  DECL_LINK( OnRoadmapItemSelected, LinkParamNone*, void );
254 
258  void implUpdateRoadmap( );
259 
260  public:
262  {
264  private:
266  };
267 
268  void suspendTraveling( AccessGuard );
269  void resumeTraveling( AccessGuard );
270  bool isTravelingSuspended() const;
271 
272  protected:
274 
275  private:
276  void ImplCalcSize( Size& rSize );
277  void ImplPosCtrls();
278  void ImplPosTabPage();
279  void ImplShowTabPage( TabPage* pPage );
280  TabPage* ImplGetPage( sal_uInt16 nLevel ) const;
281 
282 
283  DECL_LINK(OnNextPage, Button*, void);
284  DECL_LINK(OnPrevPage, Button*, void);
285  DECL_LINK(OnFinish, Button*, void);
286 
287  void implUpdateTitle();
288  void implConstruct( const WizardButtonFlags _nButtonFlags );
289  };
290 
293  {
294  public:
296  : m_pOWizard(&rWizard)
297  {
298  m_pOWizard->suspendTraveling(RoadmapWizard::AccessGuard());
299  }
300 
302  {
303  if (m_pOWizard)
304  m_pOWizard->resumeTraveling(RoadmapWizard::AccessGuard());
305  }
306 
307  private:
309  };
310 
311 } // namespace vcl
312 
313 #endif
314 
315 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
virtual void queue_resize(StateChangedType eReason=StateChangedType::Layout) override
wizard for a roadmap
Definition: wizdlg.hxx:65
void resumeTraveling(AccessGuard)
void ShowRoadmap(bool bShow)
VclPtr< vcl::Window > mpViewWindow
Definition: wizdlg.hxx:75
sal_uInt16 mnCurLevel
Definition: wizdlg.hxx:76
void removePageFromHistory(WizardTypes::WizardState nToRemove)
removes a page from the history.
std::unique_ptr< WizardMachineImplData > m_xWizardImpl
Definition: wizdlg.hxx:105
long Long
void ImplCalcSize(Size &rSize)
std::function< std::unique_ptr< UIObject >vcl::Window *)> FactoryFunction
void SetItemSelectHdl(const Link< LinkParamNone *, void > &_rHdl)
sal_Int16 mnLeftAlignCount
Definition: wizdlg.hxx:77
RoadmapWizard(vcl::Window *pParent, WinBits nStyle=WB_STDDIALOG, InitFlag eFlag=InitFlag::Default)
ImplWizPageData * mpFirstPage
Definition: wizdlg.hxx:70
bool skipUntil(WizardTypes::WizardState nTargetState)
skips one or more states, until a given state is reached
TabPage * GetOrCreatePage(const WizardTypes::WizardState i_nState)
WizardButtonFlags
Definition: vclenum.hxx:278
StateChangedType
Definition: window.hxx:317
sal_Int64 WinBits
WizardTypes::WizardState getCurrentState() const
returns the current state of the machine
Definition: wizdlg.hxx:239
VclPtr< RoadmapWizard > m_pOWizard
Definition: wizdlg.hxx:308
VclPtr< TabPage > mpPage
Definition: wizdlg.hxx:32
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.
ImplWizPageData * mpNext
Definition: wizdlg.hxx:31
VclPtr< TabPage > mpCurTabPage
Definition: wizdlg.hxx:72
void RemoveButton(Button *pButton)
VclPtr< TabPage > createPage(WizardTypes::WizardState nState)
to override to create new pages
sal_uInt16 GetCurLevel() const
Definition: wizdlg.hxx:124
ImplWizButtonData * mpFirstBtn
Definition: wizdlg.hxx:71
Use given parent or get a default one using GetDefaultParent(...)
TabPage * GetPage(sal_uInt16 nLevel) const
VclPtr< PushButton > m_pNextPage
Definition: wizdlg.hxx:100
DECL_LINK(ImplHandleWizardLayoutTimerHdl, Timer *, void)
sal_Int16 WizardState
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
Definition: wizdlg.hxx:135
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
Definition: wizdlg.hxx:74
virtual void Resize() override
bool isTravelingSuspended() const
virtual void StateChanged(StateChangedType nStateChange) override
void suspendTraveling(AccessGuard)
InitFlag
Definition: dialog.hxx:44
helper class to temporarily suspend any traveling in the wizard
Definition: wizdlg.hxx:292
VclPtr< PushButton > mpPrevBtn
Definition: wizdlg.hxx:73
std::unique_ptr< RoadmapWizardImpl > m_xRoadmapImpl
Definition: wizdlg.hxx:107
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
Definition: wizdlg.hxx:99
void SetPageSizePixel(const Size &rSize)
Definition: wizdlg.hxx:134
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)
Definition: timer.hxx:26
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
Definition: wizdlg.hxx:101
bool mbEmptyViewMargin
Definition: wizdlg.hxx:78
TabPage * ImplGetPage(sal_uInt16 nLevel) const
RoadmapWizardTravelSuspension(RoadmapWizard &rWizard)
Definition: wizdlg.hxx:295
static IWizardPageController * getPageController(TabPage *_pCurrentPage)
VclPtr< OKButton > m_pFinish
Definition: wizdlg.hxx:98
VclPtr< HelpButton > m_pHelp
Definition: wizdlg.hxx:102
bool isAutomaticNextButtonStateEnabled() const
enables the automatic enabled/disabled state of the "Next" button
An idle is a timer to be scheduled immediately.
Definition: idle.hxx:34
Idle maWizardLayoutIdle
Definition: wizdlg.hxx:68
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