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