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