X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/3ee583347463a8a85fbdecacdfff6ede1b059bd3..c8e1af672f46e93ae2fe6d7f9d5b35a3d8d49c16:/include/wx/wizard.h?ds=sidebyside diff --git a/include/wx/wizard.h b/include/wx/wizard.h index e2a578c2a3..9bf871e1e3 100644 --- a/include/wx/wizard.h +++ b/include/wx/wizard.h @@ -7,10 +7,11 @@ // 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_ @@ -29,11 +30,13 @@ #include "wx/event.h" // wxEVT_XXX constants #endif // WX_PRECOMP +#include "wx/bitmap.h" + // Extended style to specify a help button #define wxWIZARD_EX_HELPBUTTON 0x00000010 // forward declarations -class WXDLLEXPORT wxWizard; +class WXDLLIMPEXP_ADV wxWizard; // ---------------------------------------------------------------------------- // wxWizardPage is one of the wizards screen: it must know what are the @@ -43,12 +46,10 @@ 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(); } - // common part of ctors: - void Init(); // ctor accepts an optional bitmap which will be used for this page instead // of the default one for this wizard (should be of the same size). Notice @@ -73,11 +74,30 @@ public: // 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() + { + return GetValidator() ? GetValidator()->TransferToWindow() : wxPanel::TransferDataToWindow(); + } + bool TransferDataFromWindow() + { + return GetValidator() ? GetValidator()->TransferFromWindow() : wxPanel::TransferDataFromWindow(); + } + bool Validate() + { + return GetValidator() ? GetValidator()->Validate(this) : wxPanel::Validate(); + } +#endif // wxUSE_VALIDATOR + protected: + // common part of ctors: + void Init(); + wxBitmap m_bitmap; private: - DECLARE_ABSTRACT_CLASS(wxWizardPage) + DECLARE_DYNAMIC_CLASS_NO_COPY(wxWizardPage) }; // ---------------------------------------------------------------------------- @@ -89,15 +109,10 @@ private: // this, you must derive from wxWizardPage directly. // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxWizardPageSimple : public wxWizardPage +class WXDLLIMPEXP_ADV wxWizardPageSimple : public wxWizardPage { public: wxWizardPageSimple() { Init(); } - // common part of ctors: - void Init() - { - m_prev = m_next = NULL; - } // ctor takes the previous and next pages wxWizardPageSimple(wxWizard *parent, @@ -139,31 +154,42 @@ public: virtual wxWizardPage *GetNext() const; private: + // common part of ctors: + void Init() + { + m_prev = m_next = NULL; + } + // pointers are private, the derived classes shouldn't mess with them - // just derive from wxWizardPage directly to implement different behaviour 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: - // create the wizard control - static wxWizard *Create(wxWindow *parent, - int id = -1, - const wxString& title = wxEmptyString, - const wxBitmap& bitmap = wxNullBitmap, - const wxPoint& pos = wxDefaultPosition, - const wxSize& size = wxDefaultSize); - - // executes the wizard starting from the given page, returns TRUE if it was - // successfully finished, FALSE if user cancelled it + /* + The derived class (i.e. the real wxWizard) has a ctor and Create() + function taking the following arguments: + + wxWizard(wxWindow *parent, + int id = wxID_ANY, + const wxString& title = wxEmptyString, + const wxBitmap& bitmap = wxNullBitmap, + 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 virtual bool RunWizard(wxWizardPage *firstPage) = 0; // get the current page (NULL if RunWizard() isn't running) @@ -174,8 +200,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 @@ -186,6 +211,42 @@ public: // may be useful if not all pages are accessible from the first one by // default) virtual void FitToPage(const wxWizardPage *firstPage) = 0; + + // 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; + + // 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 + + virtual bool HasNextPage(wxWizardPage *page) + { return page->GetNext() != NULL; } + + 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: + DECLARE_NO_COPY_CLASS(wxWizardBase) }; // include the real class declaration @@ -197,17 +258,17 @@ 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; } @@ -218,6 +279,7 @@ private: wxWizardPage* m_page; DECLARE_DYNAMIC_CLASS(wxWizardEvent) + DECLARE_NO_COPY_CLASS(wxWizardEvent) }; // ---------------------------------------------------------------------------- @@ -225,27 +287,31 @@ private: // ---------------------------------------------------------------------------- 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_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() typedef void (wxEvtHandler::*wxWizardEventFunction)(wxWizardEvent&); // 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) DECLARE_EVENT_TABLE_ENTRY(wxEVT_WIZARD_PAGE_CHANGED, id, wxID_ANY, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxWizardEventFunction, & fn ), (wxObject *)NULL), // 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) DECLARE_EVENT_TABLE_ENTRY(wxEVT_WIZARD_PAGE_CHANGING, id, wxID_ANY, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxWizardEventFunction, & fn ), (wxObject *)NULL), // 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) DECLARE_EVENT_TABLE_ENTRY(wxEVT_WIZARD_CANCEL, id, wxID_ANY, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxWizardEventFunction, & fn ), (wxObject *)NULL), + +// 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, wxID_ANY, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxWizardEventFunction, & fn ), (wxObject *)NULL), -// 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 user pressed "Help" button +#define EVT_WIZARD_HELP(id, fn) DECLARE_EVENT_TABLE_ENTRY(wxEVT_WIZARD_HELP, id, wxID_ANY, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxWizardEventFunction, & fn ), (wxObject *)NULL), #endif // wxUSE_WIZARDDLG