]>
Commit | Line | Data |
---|---|---|
1 | /////////////////////////////////////////////////////////////////////////////// | |
2 | // Name: wx/generic/wizard.h | |
3 | // Purpose: declaration of generic wxWizard class | |
4 | // Author: Vadim Zeitlin | |
5 | // Modified by: Robert Vazan (sizers) | |
6 | // Created: 28.09.99 | |
7 | // RCS-ID: $Id$ | |
8 | // Copyright: (c) 1999 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr> | |
9 | // Licence: wxWindows licence | |
10 | /////////////////////////////////////////////////////////////////////////////// | |
11 | ||
12 | #ifndef _WX_GENERIC_WIZARD_H_ | |
13 | #define _WX_GENERIC_WIZARD_H_ | |
14 | ||
15 | // ---------------------------------------------------------------------------- | |
16 | // wxWizard | |
17 | // ---------------------------------------------------------------------------- | |
18 | ||
19 | class WXDLLEXPORT wxButton; | |
20 | class WXDLLEXPORT wxStaticBitmap; | |
21 | class WXDLLIMPEXP_ADV wxWizardEvent; | |
22 | class WXDLLEXPORT wxBoxSizer; | |
23 | class WXDLLIMPEXP_ADV wxWizardSizer; | |
24 | ||
25 | class WXDLLIMPEXP_ADV wxWizard : public wxWizardBase | |
26 | { | |
27 | public: | |
28 | // ctor | |
29 | wxWizard() { Init(); } | |
30 | wxWizard(wxWindow *parent, | |
31 | int id = wxID_ANY, | |
32 | const wxString& title = wxEmptyString, | |
33 | const wxBitmap& bitmap = wxNullBitmap, | |
34 | const wxPoint& pos = wxDefaultPosition, | |
35 | long style = wxDEFAULT_DIALOG_STYLE) | |
36 | { | |
37 | Init(); | |
38 | Create(parent, id, title, bitmap, pos, style); | |
39 | } | |
40 | bool Create(wxWindow *parent, | |
41 | int id = wxID_ANY, | |
42 | const wxString& title = wxEmptyString, | |
43 | const wxBitmap& bitmap = wxNullBitmap, | |
44 | const wxPoint& pos = wxDefaultPosition, | |
45 | long style = wxDEFAULT_DIALOG_STYLE); | |
46 | void Init(); | |
47 | virtual ~wxWizard(); | |
48 | ||
49 | // implement base class pure virtuals | |
50 | virtual bool RunWizard(wxWizardPage *firstPage); | |
51 | virtual wxWizardPage *GetCurrentPage() const; | |
52 | virtual void SetPageSize(const wxSize& size); | |
53 | virtual wxSize GetPageSize() const; | |
54 | virtual void FitToPage(const wxWizardPage *firstPage); | |
55 | virtual wxSizer *GetPageAreaSizer() const; | |
56 | virtual void SetBorder(int border); | |
57 | ||
58 | // implementation only from now on | |
59 | // ------------------------------- | |
60 | ||
61 | // is the wizard running? | |
62 | bool IsRunning() const { return m_page != NULL; } | |
63 | ||
64 | // show the prev/next page, but call TransferDataFromWindow on the current | |
65 | // page first and return false without changing the page if | |
66 | // TransferDataFromWindow() returns false - otherwise, returns true | |
67 | bool ShowPage(wxWizardPage *page, bool goingForward = true); | |
68 | ||
69 | // do fill the dialog with controls | |
70 | // this is app-overridable to, for example, set help and tooltip text | |
71 | virtual void DoCreateControls(); | |
72 | ||
73 | protected: | |
74 | // for compatibility only, doesn't do anything any more | |
75 | void FinishLayout() { } | |
76 | ||
77 | private: | |
78 | // was the dialog really created? | |
79 | bool WasCreated() const { return m_btnPrev != NULL; } | |
80 | ||
81 | // event handlers | |
82 | void OnCancel(wxCommandEvent& event); | |
83 | void OnBackOrNext(wxCommandEvent& event); | |
84 | void OnHelp(wxCommandEvent& event); | |
85 | ||
86 | void OnWizEvent(wxWizardEvent& event); | |
87 | ||
88 | void AddBitmapRow(wxBoxSizer *mainColumn); | |
89 | void AddStaticLine(wxBoxSizer *mainColumn); | |
90 | void AddBackNextPair(wxBoxSizer *buttonRow); | |
91 | void AddButtonRow(wxBoxSizer *mainColumn); | |
92 | ||
93 | // the page size requested by user | |
94 | wxSize m_sizePage; | |
95 | ||
96 | // the dialog position from the ctor | |
97 | wxPoint m_posWizard; | |
98 | ||
99 | // wizard state | |
100 | wxWizardPage *m_page; // the current page or NULL | |
101 | wxBitmap m_bitmap; // the default bitmap to show | |
102 | ||
103 | // wizard controls | |
104 | wxButton *m_btnPrev, // the "<Back" button | |
105 | *m_btnNext; // the "Next>" or "Finish" button | |
106 | wxStaticBitmap *m_statbmp; // the control for the bitmap | |
107 | ||
108 | // Border around page area sizer requested using SetBorder() | |
109 | int m_border; | |
110 | ||
111 | // Whether RunWizard() was called | |
112 | bool m_started; | |
113 | ||
114 | // Whether was modal (modeless has to be destroyed on finish or cancel) | |
115 | bool m_wasModal; | |
116 | ||
117 | // True if pages are laid out using the sizer | |
118 | bool m_usingSizer; | |
119 | ||
120 | // Page area sizer will be inserted here with padding | |
121 | wxBoxSizer *m_sizerBmpAndPage; | |
122 | ||
123 | // Actual position and size of pages | |
124 | wxWizardSizer *m_sizerPage; | |
125 | ||
126 | friend class wxWizardSizer; | |
127 | ||
128 | DECLARE_DYNAMIC_CLASS(wxWizard) | |
129 | DECLARE_EVENT_TABLE() | |
130 | DECLARE_NO_COPY_CLASS(wxWizard) | |
131 | }; | |
132 | ||
133 | #endif // _WX_GENERIC_WIZARD_H_ |