X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/1d30a0a132f1f01d8ed3a01c789fc0422b721e79..d642db66a5efc82d374b813022c72ba88bc50839:/include/wx/wizard.h diff --git a/include/wx/wizard.h b/include/wx/wizard.h index db4dbbf752..59fe14f870 100644 --- a/include/wx/wizard.h +++ b/include/wx/wizard.h @@ -1,5 +1,5 @@ /////////////////////////////////////////////////////////////////////////////// -// 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. @@ -7,33 +7,43 @@ // Modified by: Robert Cavanaugh // Added capability to use .WXR resource files in Wizard pages // Added wxWIZARD_HELP event +// Robert Vazan (sizers) // Created: 15.08.99 // RCS-ID: $Id$ // Copyright: (c) 1999 Vadim Zeitlin -// Licence: wxWindows license +// Licence: wxWindows licence /////////////////////////////////////////////////////////////////////////////// #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 WXDLLEXPORT wxWizard; +class WXDLLIMPEXP_FWD_ADV wxWizard; // ---------------------------------------------------------------------------- // wxWizardPage is one of the wizards screen: it must know what are the @@ -43,7 +53,7 @@ class WXDLLEXPORT wxWizard; // used as such (i.e. controls may be placed directly on it &c). // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxWizardPage : public wxPanel +class WXDLLIMPEXP_ADV wxWizardPage : public wxPanel { public: wxWizardPage() { Init(); } @@ -53,12 +63,10 @@ public: // 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 @@ -71,6 +79,27 @@ public: // wxNullBitmap from here - the default one will be used then. virtual wxBitmap GetBitmap() const { return m_bitmap; } +#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(); + } + + virtual bool TransferDataFromWindow() + { + return GetValidator() ? GetValidator()->TransferFromWindow() + : wxPanel::TransferDataFromWindow(); + } + + virtual bool Validate() + { + return GetValidator() ? GetValidator()->Validate(this) + : wxPanel::Validate(); + } +#endif // wxUSE_VALIDATORS + protected: // common part of ctors: void Init(); @@ -78,7 +107,7 @@ protected: wxBitmap m_bitmap; private: - DECLARE_ABSTRACT_CLASS(wxWizardPage) + DECLARE_DYNAMIC_CLASS_NO_COPY(wxWizardPage) }; // ---------------------------------------------------------------------------- @@ -90,37 +119,43 @@ private: // this, you must derive from wxWizardPage directly. // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxWizardPageSimple : public wxWizardPage +class WXDLLIMPEXP_ADV wxWizardPageSimple : public wxWizardPage { public: wxWizardPageSimple() { Init(); } // 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, @@ -146,14 +181,14 @@ private: wxWizardPage *m_prev, *m_next; - DECLARE_DYNAMIC_CLASS(wxWizardPageSimple) + DECLARE_DYNAMIC_CLASS_NO_COPY(wxWizardPageSimple) }; // ---------------------------------------------------------------------------- // wxWizard // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxWizardBase : public wxDialog +class WXDLLIMPEXP_ADV wxWizardBase : public wxDialog { public: /* @@ -161,14 +196,16 @@ public: function taking the following arguments: wxWizard(wxWindow *parent, - int id = -1, + int id = wxID_ANY, const wxString& title = wxEmptyString, const wxBitmap& bitmap = wxNullBitmap, - const wxPoint& pos = wxDefaultPosition); + const wxPoint& pos = wxDefaultPosition, + long style = wxDEFAULT_DIALOG_STYLE); */ + wxWizardBase() { } - // executes the wizard starting from the given page, returns TRUE if it was - // successfully finished, FALSE if user cancelled it + // executes the wizard starting from the given page, returns true if it was + // successfully finished, false if user cancelled it virtual bool RunWizard(wxWizardPage *firstPage) = 0; // get the current page (NULL if RunWizard() isn't running) @@ -179,8 +216,7 @@ public: // itself and will never be less than some predefined fixed size virtual void SetPageSize(const wxSize& size) = 0; - // get the size available for the page: the wizards are not resizeable, so - // this size doesn't change + // get the size available for the page virtual wxSize GetPageSize() const = 0; // set the best size for the wizard, i.e. make it big enough to contain all @@ -192,15 +228,12 @@ public: // default) virtual void FitToPage(const wxWizardPage *firstPage) = 0; - // wxWizard should be created using "new wxWizard" now, not with Create() -#ifdef WXWIN_COMPATIBILITY_2_2 - static wxWizard *Create(wxWindow *parent, - int id = -1, - const wxString& title = wxEmptyString, - const wxBitmap& bitmap = wxNullBitmap, - const wxPoint& pos = wxDefaultPosition, - const wxSize& size = wxDefaultSize); -#endif // WXWIN_COMPATIBILITY_2_2 + // Adding pages to page area sizer enlarges wizard + virtual wxSizer *GetPageAreaSizer() const = 0; + + // Set border around page area. Default is 0 if you add at least one + // page to GetPageAreaSizer and 5 if you don't. + virtual void SetBorder(int border) = 0; // the methods below may be overridden by the derived classes to provide // custom logic for determining the pages order @@ -210,6 +243,16 @@ public: virtual bool HasPrevPage(wxWizardPage *page) { return page->GetPrev() != NULL; } + + /// Override these functions to stop InitDialog from calling TransferDataToWindow + /// for _all_ pages when the wizard starts. Instead 'ShowPage' will call + /// TransferDataToWindow for the first page only. + bool TransferDataToWindow() { return true; } + bool TransferDataFromWindow() { return true; } + bool Validate() { return true; } + +private: + wxDECLARE_NO_COPY_CLASS(wxWizardBase); }; // include the real class declaration @@ -221,59 +264,74 @@ public: // window hierarchy as usual // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxWizardEvent : public wxNotifyEvent +class WXDLLIMPEXP_ADV wxWizardEvent : public wxNotifyEvent { public: wxWizardEvent(wxEventType type = wxEVT_NULL, - int id = -1, - bool direction = TRUE, + int id = wxID_ANY, + bool direction = true, wxWizardPage* page = NULL); - // for EVT_WIZARD_PAGE_CHANGING, return TRUE if we're going forward or - // FALSE otherwise and for EVT_WIZARD_PAGE_CHANGED return TRUE if we came - // from the previous page and FALSE if we returned from the next one + // for EVT_WIZARD_PAGE_CHANGING, return true if we're going forward or + // false otherwise and for EVT_WIZARD_PAGE_CHANGED return true if we came + // from the previous page and false if we returned from the next one // (this function doesn't make sense for CANCEL events) bool GetDirection() const { return m_direction; } 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_DYNAMIC_CLASS_NO_ASSIGN(wxWizardEvent) }; // ---------------------------------------------------------------------------- // macros for handling wxWizardEvents // ---------------------------------------------------------------------------- -BEGIN_DECLARE_EVENT_TYPES() - DECLARE_EVENT_TYPE(wxEVT_WIZARD_PAGE_CHANGED, 900) - DECLARE_EVENT_TYPE(wxEVT_WIZARD_PAGE_CHANGING, 901) - DECLARE_EVENT_TYPE(wxEVT_WIZARD_CANCEL, 902) - DECLARE_EVENT_TYPE(wxEVT_WIZARD_HELP, 903) - DECLARE_EVENT_TYPE(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) \ + wxEVENT_HANDLER_CAST(wxWizardEventFunction, func) + +#define wx__DECLARE_WIZARDEVT(evt, id, fn) \ + wx__DECLARE_EVT1(wxEVT_WIZARD_ ## evt, id, wxWizardEventHandler(fn)) + // notifies that the page has just been changed (can't be vetoed) -#define EVT_WIZARD_PAGE_CHANGED(id, fn) DECLARE_EVENT_TABLE_ENTRY(wxEVT_WIZARD_PAGE_CHANGED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxWizardEventFunction) & fn, (wxObject *)NULL), +#define EVT_WIZARD_PAGE_CHANGED(id, fn) wx__DECLARE_WIZARDEVT(PAGE_CHANGED, id, fn) // the user pressed "" button and the page is going to be // changed - unless the event handler vetoes the event -#define EVT_WIZARD_PAGE_CHANGING(id, fn) DECLARE_EVENT_TABLE_ENTRY(wxEVT_WIZARD_PAGE_CHANGING, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxWizardEventFunction) & fn, (wxObject *)NULL), +#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) DECLARE_EVENT_TABLE_ENTRY(wxEVT_WIZARD_CANCEL, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxWizardEventFunction) & fn, (wxObject *)NULL), +#define EVT_WIZARD_CANCEL(id, fn) wx__DECLARE_WIZARDEVT(CANCEL, id, fn) // the user pressed "Finish" button and the wizard is going to be dismissed - -#define EVT_WIZARD_FINISHED(id, fn) DECLARE_EVENT_TABLE_ENTRY(wxEVT_WIZARD_FINISHED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxWizardEventFunction) & fn, (wxObject *)NULL), +#define EVT_WIZARD_FINISHED(id, fn) wx__DECLARE_WIZARDEVT(FINISHED, id, fn) + +// the user pressed "Help" button +#define EVT_WIZARD_HELP(id, fn) wx__DECLARE_WIZARDEVT(HELP, id, fn) -// the user pressed "Help" button -#define EVT_WIZARD_HELP(id, fn) DECLARE_EVENT_TABLE_ENTRY(wxEVT_WIZARD_HELP, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxWizardEventFunction) & fn, (wxObject *)NULL), +// 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