]> git.saurik.com Git - wxWidgets.git/blob - include/wx/wizard.h
cleanup
[wxWidgets.git] / include / wx / wizard.h
1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: wizard.h
3 // Purpose: wxWizard class: a GUI control presenting the user with a
4 // sequence of dialogs which allows to simply perform some task
5 // Author: Vadim Zeitlin (partly based on work by Ron Kuris and Kevin B.
6 // Smith)
7 // Modified by: Robert Cavanaugh
8 // Added capability to use .WXR resource files in Wizard pages
9 // Added wxWIZARD_HELP event
10 // Robert Vazan (sizers)
11 // Created: 15.08.99
12 // RCS-ID: $Id$
13 // Copyright: (c) 1999 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
14 // Licence: wxWindows licence
15 ///////////////////////////////////////////////////////////////////////////////
16
17 #ifndef _WX_WIZARD_H_
18 #define _WX_WIZARD_H_
19
20 #include "wx/defs.h"
21
22 #if wxUSE_WIZARDDLG
23
24 // ----------------------------------------------------------------------------
25 // headers and other simple declarations
26 // ----------------------------------------------------------------------------
27
28 #include "wx/dialog.h" // the base class
29 #include "wx/panel.h" // ditto
30 #include "wx/event.h" // wxEVT_XXX constants
31 #include "wx/bitmap.h"
32
33 // Extended style to specify a help button
34 #define wxWIZARD_EX_HELPBUTTON 0x00000010
35
36 // forward declarations
37 class WXDLLIMPEXP_FWD_ADV wxWizard;
38
39 // ----------------------------------------------------------------------------
40 // wxWizardPage is one of the wizards screen: it must know what are the
41 // following and preceding pages (which may be NULL for the first/last page).
42 //
43 // Other than GetNext/Prev() functions, wxWizardPage is just a panel and may be
44 // used as such (i.e. controls may be placed directly on it &c).
45 // ----------------------------------------------------------------------------
46
47 class WXDLLIMPEXP_ADV wxWizardPage : public wxPanel
48 {
49 public:
50 wxWizardPage() { Init(); }
51
52 // ctor accepts an optional bitmap which will be used for this page instead
53 // of the default one for this wizard (should be of the same size). Notice
54 // that no other parameters are needed because the wizard will resize and
55 // reposition the page anyhow
56 wxWizardPage(wxWizard *parent,
57 const wxBitmap& bitmap = wxNullBitmap);
58
59 bool Create(wxWizard *parent,
60 const wxBitmap& bitmap = wxNullBitmap);
61
62 // these functions are used by the wizard to show another page when the
63 // user chooses "Back" or "Next" button
64 virtual wxWizardPage *GetPrev() const = 0;
65 virtual wxWizardPage *GetNext() const = 0;
66
67 // default GetBitmap() will just return m_bitmap which is ok in 99% of
68 // cases - override this method if you want to create the bitmap to be used
69 // dynamically or to do something even more fancy. It's ok to return
70 // wxNullBitmap from here - the default one will be used then.
71 virtual wxBitmap GetBitmap() const { return m_bitmap; }
72
73 #if wxUSE_VALIDATORS
74 // Override the base functions to allow a validator to be assigned to this page.
75 virtual bool TransferDataToWindow()
76 {
77 return GetValidator() ? GetValidator()->TransferToWindow()
78 : wxPanel::TransferDataToWindow();
79 }
80
81 virtual bool TransferDataFromWindow()
82 {
83 return GetValidator() ? GetValidator()->TransferFromWindow()
84 : wxPanel::TransferDataFromWindow();
85 }
86
87 virtual bool Validate()
88 {
89 return GetValidator() ? GetValidator()->Validate(this)
90 : wxPanel::Validate();
91 }
92 #endif // wxUSE_VALIDATORS
93
94 protected:
95 // common part of ctors:
96 void Init();
97
98 wxBitmap m_bitmap;
99
100 private:
101 DECLARE_DYNAMIC_CLASS_NO_COPY(wxWizardPage)
102 };
103
104 // ----------------------------------------------------------------------------
105 // wxWizardPageSimple just returns the pointers given to the ctor and is useful
106 // to create a simple wizard where the order of pages never changes.
107 //
108 // OTOH, it is also possible to dynamicly decide which page to return (i.e.
109 // depending on the user's choices) as the wizard sample shows - in order to do
110 // this, you must derive from wxWizardPage directly.
111 // ----------------------------------------------------------------------------
112
113 class WXDLLIMPEXP_ADV wxWizardPageSimple : public wxWizardPage
114 {
115 public:
116 wxWizardPageSimple() { Init(); }
117
118 // ctor takes the previous and next pages
119 wxWizardPageSimple(wxWizard *parent,
120 wxWizardPage *prev = (wxWizardPage *)NULL,
121 wxWizardPage *next = (wxWizardPage *)NULL,
122 const wxBitmap& bitmap = wxNullBitmap)
123 {
124 Create(parent, prev, next, bitmap);
125 }
126
127 bool Create(wxWizard *parent = NULL, // let it be default ctor too
128 wxWizardPage *prev = (wxWizardPage *)NULL,
129 wxWizardPage *next = (wxWizardPage *)NULL,
130 const wxBitmap& bitmap = wxNullBitmap)
131 {
132 m_prev = prev;
133 m_next = next;
134 return wxWizardPage::Create(parent, bitmap);
135 }
136
137 // the pointers may be also set later - but before starting the wizard
138 void SetPrev(wxWizardPage *prev) { m_prev = prev; }
139 void SetNext(wxWizardPage *next) { m_next = next; }
140
141 // a convenience function to make the pages follow each other
142 static void Chain(wxWizardPageSimple *first, wxWizardPageSimple *second)
143 {
144 wxCHECK_RET( first && second,
145 wxT("NULL passed to wxWizardPageSimple::Chain") );
146
147 first->SetNext(second);
148 second->SetPrev(first);
149 }
150
151 // base class pure virtuals
152 virtual wxWizardPage *GetPrev() const;
153 virtual wxWizardPage *GetNext() const;
154
155 private:
156 // common part of ctors:
157 void Init()
158 {
159 m_prev = m_next = NULL;
160 }
161
162 // pointers are private, the derived classes shouldn't mess with them -
163 // just derive from wxWizardPage directly to implement different behaviour
164 wxWizardPage *m_prev,
165 *m_next;
166
167 DECLARE_DYNAMIC_CLASS_NO_COPY(wxWizardPageSimple)
168 };
169
170 // ----------------------------------------------------------------------------
171 // wxWizard
172 // ----------------------------------------------------------------------------
173
174 class WXDLLIMPEXP_ADV wxWizardBase : public wxDialog
175 {
176 public:
177 /*
178 The derived class (i.e. the real wxWizard) has a ctor and Create()
179 function taking the following arguments:
180
181 wxWizard(wxWindow *parent,
182 int id = wxID_ANY,
183 const wxString& title = wxEmptyString,
184 const wxBitmap& bitmap = wxNullBitmap,
185 const wxPoint& pos = wxDefaultPosition,
186 long style = wxDEFAULT_DIALOG_STYLE);
187 */
188 wxWizardBase() { }
189
190 // executes the wizard starting from the given page, returns true if it was
191 // successfully finished, false if user cancelled it
192 virtual bool RunWizard(wxWizardPage *firstPage) = 0;
193
194 // get the current page (NULL if RunWizard() isn't running)
195 virtual wxWizardPage *GetCurrentPage() const = 0;
196
197 // set the min size which should be available for the pages: a
198 // wizard will take into account the size of the bitmap (if any)
199 // itself and will never be less than some predefined fixed size
200 virtual void SetPageSize(const wxSize& size) = 0;
201
202 // get the size available for the page
203 virtual wxSize GetPageSize() const = 0;
204
205 // set the best size for the wizard, i.e. make it big enough to contain all
206 // of the pages starting from the given one
207 //
208 // this function may be called several times and possible with different
209 // pages in which case it will only increase the page size if needed (this
210 // may be useful if not all pages are accessible from the first one by
211 // default)
212 virtual void FitToPage(const wxWizardPage *firstPage) = 0;
213
214 // Adding pages to page area sizer enlarges wizard
215 virtual wxSizer *GetPageAreaSizer() const = 0;
216
217 // Set border around page area. Default is 0 if you add at least one
218 // page to GetPageAreaSizer and 5 if you don't.
219 virtual void SetBorder(int border) = 0;
220
221 // the methods below may be overridden by the derived classes to provide
222 // custom logic for determining the pages order
223
224 virtual bool HasNextPage(wxWizardPage *page)
225 { return page->GetNext() != NULL; }
226
227 virtual bool HasPrevPage(wxWizardPage *page)
228 { return page->GetPrev() != NULL; }
229
230 /// Override these functions to stop InitDialog from calling TransferDataToWindow
231 /// for _all_ pages when the wizard starts. Instead 'ShowPage' will call
232 /// TransferDataToWindow for the first page only.
233 bool TransferDataToWindow() { return true; }
234 bool TransferDataFromWindow() { return true; }
235 bool Validate() { return true; }
236
237 private:
238 DECLARE_NO_COPY_CLASS(wxWizardBase)
239 };
240
241 // include the real class declaration
242 #include "wx/generic/wizard.h"
243
244 // ----------------------------------------------------------------------------
245 // wxWizardEvent class represents an event generated by the wizard: this event
246 // is first sent to the page itself and, if not processed there, goes up the
247 // window hierarchy as usual
248 // ----------------------------------------------------------------------------
249
250 class WXDLLIMPEXP_ADV wxWizardEvent : public wxNotifyEvent
251 {
252 public:
253 wxWizardEvent(wxEventType type = wxEVT_NULL,
254 int id = wxID_ANY,
255 bool direction = true,
256 wxWizardPage* page = NULL);
257
258 // for EVT_WIZARD_PAGE_CHANGING, return true if we're going forward or
259 // false otherwise and for EVT_WIZARD_PAGE_CHANGED return true if we came
260 // from the previous page and false if we returned from the next one
261 // (this function doesn't make sense for CANCEL events)
262 bool GetDirection() const { return m_direction; }
263
264 wxWizardPage* GetPage() const { return m_page; }
265
266 private:
267 bool m_direction;
268 wxWizardPage* m_page;
269
270 DECLARE_DYNAMIC_CLASS(wxWizardEvent)
271 DECLARE_NO_COPY_CLASS(wxWizardEvent)
272 };
273
274 // ----------------------------------------------------------------------------
275 // macros for handling wxWizardEvents
276 // ----------------------------------------------------------------------------
277
278 BEGIN_DECLARE_EVENT_TYPES()
279 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_WIZARD_PAGE_CHANGED, 900)
280 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_WIZARD_PAGE_CHANGING, 901)
281 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_WIZARD_CANCEL, 902)
282 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_WIZARD_HELP, 903)
283 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_WIZARD_FINISHED, 903)
284 END_DECLARE_EVENT_TYPES()
285
286 typedef void (wxEvtHandler::*wxWizardEventFunction)(wxWizardEvent&);
287
288 #define wxWizardEventHandler(func) \
289 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxWizardEventFunction, &func)
290
291 #define wx__DECLARE_WIZARDEVT(evt, id, fn) \
292 wx__DECLARE_EVT1(wxEVT_WIZARD_ ## evt, id, wxWizardEventHandler(fn))
293
294 // notifies that the page has just been changed (can't be vetoed)
295 #define EVT_WIZARD_PAGE_CHANGED(id, fn) wx__DECLARE_WIZARDEVT(PAGE_CHANGED, id, fn)
296
297 // the user pressed "<Back" or "Next>" button and the page is going to be
298 // changed - unless the event handler vetoes the event
299 #define EVT_WIZARD_PAGE_CHANGING(id, fn) wx__DECLARE_WIZARDEVT(PAGE_CHANGING, id, fn)
300
301 // the user pressed "Cancel" button and the wizard is going to be dismissed -
302 // unless the event handler vetoes the event
303 #define EVT_WIZARD_CANCEL(id, fn) wx__DECLARE_WIZARDEVT(CANCEL, id, fn)
304
305 // the user pressed "Finish" button and the wizard is going to be dismissed -
306 #define EVT_WIZARD_FINISHED(id, fn) wx__DECLARE_WIZARDEVT(FINISHED, id, fn)
307
308 // the user pressed "Help" button
309 #define EVT_WIZARD_HELP(id, fn) wx__DECLARE_WIZARDEVT(HELP, id, fn)
310
311 #endif // wxUSE_WIZARDDLG
312
313 #endif // _WX_WIZARD_H_