///////////////////////////////////////////////////////////////////////////////
-// Name: wizard.h
+// Name: wx/wizard.h
// Purpose: wxWizard class: a GUI control presenting the user with a
// sequence of dialogs which allows to simply perform some task
// Author: Vadim Zeitlin (partly based on work by Ron Kuris and Kevin B.
#ifndef _WX_WIZARD_H_
#define _WX_WIZARD_H_
+#include "wx/defs.h"
+
#if wxUSE_WIZARDDLG
// ----------------------------------------------------------------------------
// headers and other simple declarations
// ----------------------------------------------------------------------------
-#ifndef WX_PRECOMP
- #include "wx/dialog.h" // the base class
- #include "wx/panel.h" // ditto
-
- #include "wx/event.h" // wxEVT_XXX constants
-#endif // WX_PRECOMP
-
+#include "wx/dialog.h" // the base class
+#include "wx/panel.h" // ditto
+#include "wx/event.h" // wxEVT_XXX constants
#include "wx/bitmap.h"
// Extended style to specify a help button
#define wxWIZARD_EX_HELPBUTTON 0x00000010
+// Placement flags
+#define wxWIZARD_VALIGN_TOP 0x01
+#define wxWIZARD_VALIGN_CENTRE 0x02
+#define wxWIZARD_VALIGN_BOTTOM 0x04
+#define wxWIZARD_HALIGN_LEFT 0x08
+#define wxWIZARD_HALIGN_CENTRE 0x10
+#define wxWIZARD_HALIGN_RIGHT 0x20
+#define wxWIZARD_TILE 0x40
+
// forward declarations
-class WXDLLIMPEXP_ADV wxWizard;
+class WXDLLIMPEXP_FWD_ADV wxWizard;
// ----------------------------------------------------------------------------
// wxWizardPage is one of the wizards screen: it must know what are the
// that no other parameters are needed because the wizard will resize and
// reposition the page anyhow
wxWizardPage(wxWizard *parent,
- const wxBitmap& bitmap = wxNullBitmap,
- const wxChar* resource = NULL);
+ const wxBitmap& bitmap = wxNullBitmap);
bool Create(wxWizard *parent,
- const wxBitmap& bitmap = wxNullBitmap,
- const wxChar* resource = NULL);
+ const wxBitmap& bitmap = wxNullBitmap);
// these functions are used by the wizard to show another page when the
// user chooses "Back" or "Next" button
// wxNullBitmap from here - the default one will be used then.
virtual wxBitmap GetBitmap() const { return m_bitmap; }
-#if wxUSE_VALIDATOR
- /// Override the base functions to allow a validator to be assigned to this page.
- bool TransferDataToWindow()
+#if wxUSE_VALIDATORS
+ // Override the base functions to allow a validator to be assigned to this page.
+ virtual bool TransferDataToWindow()
{
- return GetValidator() ? GetValidator()->TransferToWindow() : wxPanel::TransferDataToWindow();
+ return GetValidator() ? GetValidator()->TransferToWindow()
+ : wxPanel::TransferDataToWindow();
}
- bool TransferDataFromWindow()
+
+ virtual bool TransferDataFromWindow()
{
- return GetValidator() ? GetValidator()->TransferFromWindow() : wxPanel::TransferDataFromWindow();
+ return GetValidator() ? GetValidator()->TransferFromWindow()
+ : wxPanel::TransferDataFromWindow();
}
- bool Validate()
+
+ virtual bool Validate()
{
- return GetValidator() ? GetValidator()->Validate(this) : wxPanel::Validate();
+ return GetValidator() ? GetValidator()->Validate(this)
+ : wxPanel::Validate();
}
-#endif // wxUSE_VALIDATOR
+#endif // wxUSE_VALIDATORS
protected:
// common part of ctors:
// ctor takes the previous and next pages
wxWizardPageSimple(wxWizard *parent,
- wxWizardPage *prev = (wxWizardPage *)NULL,
- wxWizardPage *next = (wxWizardPage *)NULL,
- const wxBitmap& bitmap = wxNullBitmap,
- const wxChar* resource = NULL)
+ wxWizardPage *prev = NULL,
+ wxWizardPage *next = NULL,
+ const wxBitmap& bitmap = wxNullBitmap)
{
- Create(parent, prev, next, bitmap, resource);
+ Create(parent, prev, next, bitmap);
}
bool Create(wxWizard *parent = NULL, // let it be default ctor too
- wxWizardPage *prev = (wxWizardPage *)NULL,
- wxWizardPage *next = (wxWizardPage *)NULL,
- const wxBitmap& bitmap = wxNullBitmap,
- const wxChar* resource = NULL)
+ wxWizardPage *prev = NULL,
+ wxWizardPage *next = NULL,
+ const wxBitmap& bitmap = wxNullBitmap)
{
m_prev = prev;
m_next = next;
- return wxWizardPage::Create(parent, bitmap, resource);
+ return wxWizardPage::Create(parent, bitmap);
}
// the pointers may be also set later - but before starting the wizard
void SetPrev(wxWizardPage *prev) { m_prev = prev; }
void SetNext(wxWizardPage *next) { m_next = next; }
- // a convenience function to make the pages follow each other
+ // Convenience functions to make the pages follow each other without having
+ // to call their SetPrev() or SetNext() explicitly.
+ wxWizardPageSimple& Chain(wxWizardPageSimple* next)
+ {
+ SetNext(next);
+ next->SetPrev(this);
+ return *next;
+ }
+
static void Chain(wxWizardPageSimple *first, wxWizardPageSimple *second)
{
wxCHECK_RET( first && second,
// page to GetPageAreaSizer and 5 if you don't.
virtual void SetBorder(int border) = 0;
- // wxWizard should be created using "new wxWizard" now, not with Create()
-#if WXWIN_COMPATIBILITY_2_2
- wxDEPRECATED( static wxWizard *Create(wxWindow *parent,
- int id = wxID_ANY,
- const wxString& title = wxEmptyString,
- const wxBitmap& bitmap = wxNullBitmap,
- const wxPoint& pos = wxDefaultPosition,
- const wxSize& size = wxDefaultSize) );
-#endif // WXWIN_COMPATIBILITY_2_2
-
// the methods below may be overridden by the derived classes to provide
// custom logic for determining the pages order
bool Validate() { return true; }
private:
- DECLARE_NO_COPY_CLASS(wxWizardBase)
+ wxDECLARE_NO_COPY_CLASS(wxWizardBase);
};
// include the real class declaration
wxWizardPage* GetPage() const { return m_page; }
+ virtual wxEvent *Clone() const { return new wxWizardEvent(*this); }
+
private:
bool m_direction;
wxWizardPage* m_page;
- DECLARE_DYNAMIC_CLASS(wxWizardEvent)
- DECLARE_NO_COPY_CLASS(wxWizardEvent)
+ DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxWizardEvent)
};
// ----------------------------------------------------------------------------
// macros for handling wxWizardEvents
// ----------------------------------------------------------------------------
-BEGIN_DECLARE_EVENT_TYPES()
- DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_WIZARD_PAGE_CHANGED, 900)
- DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_WIZARD_PAGE_CHANGING, 901)
- DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_WIZARD_CANCEL, 902)
- DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_WIZARD_HELP, 903)
- DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_WIZARD_FINISHED, 903)
-END_DECLARE_EVENT_TYPES()
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_WIZARD_PAGE_CHANGED, wxWizardEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_WIZARD_PAGE_CHANGING, wxWizardEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_WIZARD_CANCEL, wxWizardEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_WIZARD_HELP, wxWizardEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_WIZARD_FINISHED, wxWizardEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_WIZARD_PAGE_SHOWN, wxWizardEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_ADV, wxEVT_WIZARD_BEFORE_PAGE_CHANGED, wxWizardEvent );
typedef void (wxEvtHandler::*wxWizardEventFunction)(wxWizardEvent&);
#define wxWizardEventHandler(func) \
- (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxWizardEventFunction, &func)
+ wxEVENT_HANDLER_CAST(wxWizardEventFunction, func)
#define wx__DECLARE_WIZARDEVT(evt, id, fn) \
wx__DECLARE_EVT1(wxEVT_WIZARD_ ## evt, id, wxWizardEventHandler(fn))
// changed - unless the event handler vetoes the event
#define EVT_WIZARD_PAGE_CHANGING(id, fn) wx__DECLARE_WIZARDEVT(PAGE_CHANGING, id, fn)
+// Called before GetNext/GetPrev is called, so that the handler can change state that will be
+// used when GetNext/GetPrev is called. PAGE_CHANGING is called too late to influence GetNext/GetPrev.
+#define EVT_WIZARD_BEFORE_PAGE_CHANGED(id, fn) wx__DECLARE_WIZARDEVT(BEFORE_PAGE_CHANGED, id, fn)
+
// the user pressed "Cancel" button and the wizard is going to be dismissed -
// unless the event handler vetoes the event
#define EVT_WIZARD_CANCEL(id, fn) wx__DECLARE_WIZARDEVT(CANCEL, id, fn)
// the user pressed "Help" button
#define EVT_WIZARD_HELP(id, fn) wx__DECLARE_WIZARDEVT(HELP, id, fn)
+// the page was just shown and laid out
+#define EVT_WIZARD_PAGE_SHOWN(id, fn) wx__DECLARE_WIZARDEVT(PAGE_SHOWN, id, fn)
+
#endif // wxUSE_WIZARDDLG
#endif // _WX_WIZARD_H_
projects / wxWidgets.git / blobdiff