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