X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/223d09f6b523aac674ef9b72a883dfa8d37c5d4e..24fe8dc7f8f5426de2fb748b97c79e52b60db89d:/include/wx/wizard.h diff --git a/include/wx/wizard.h b/include/wx/wizard.h index d51020e07d..b402cd5fea 100644 --- a/include/wx/wizard.h +++ b/include/wx/wizard.h @@ -4,7 +4,9 @@ // sequence of dialogs which allows to simply perform some task // Author: Vadim Zeitlin (partly based on work by Ron Kuris and Kevin B. // Smith) -// Modified by: +// Modified by: Robert Cavanaugh +// Added capability to use .WXR resource files in Wizard pages +// Added wxWIZARD_HELP event // Created: 15.08.99 // RCS-ID: $Id$ // Copyright: (c) 1999 Vadim Zeitlin @@ -14,16 +16,22 @@ #ifndef _WX_WIZARD_H_ #define _WX_WIZARD_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 +// Extended style to specify a help button +#define wxWIZARD_EX_HELPBUTTON 0x00000010 + // forward declarations class WXDLLEXPORT wxWizard; @@ -38,15 +46,28 @@ class WXDLLEXPORT wxWizard; class WXDLLEXPORT wxWizardPage : public wxPanel { public: - // ctor: no other parameters are needed because the wizard will resize and + // 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 + // that no other parameters are needed because the wizard will resize and // reposition the page anyhow - wxWizardPage(wxWizard *parent); + wxWizardPage(wxWizard *parent, + const wxBitmap& bitmap = wxNullBitmap, + const wxChar* resource = NULL); // these functions are used by the wizard to show another page when the // user chooses "Back" or "Next" button virtual wxWizardPage *GetPrev() const = 0; virtual wxWizardPage *GetNext() const = 0; + // default GetBitmap() will just return m_bitmap which is ok in 99% of + // cases - override this method if you want to create the bitmap to be used + // dynamically or to do something even more fancy. It's ok to return + // wxNullBitmap from here - the default one will be used then. + virtual wxBitmap GetBitmap() const { return m_bitmap; } + +protected: + wxBitmap m_bitmap; + private: DECLARE_ABSTRACT_CLASS(wxWizardPage) }; @@ -66,8 +87,10 @@ public: // ctor takes the previous and next pages wxWizardPageSimple(wxWizard *parent = NULL, // let it be default ctor too wxWizardPage *prev = (wxWizardPage *)NULL, - wxWizardPage *next = (wxWizardPage *)NULL) - : wxWizardPage(parent) + wxWizardPage *next = (wxWizardPage *)NULL, + const wxBitmap& bitmap = wxNullBitmap, + const wxChar* resource = NULL) + : wxWizardPage(parent, bitmap, resource) { m_prev = prev; m_next = next; @@ -121,6 +144,15 @@ public: // get the current page (NULL if RunWizard() isn't running) virtual wxWizardPage *GetCurrentPage() const = 0; + + // set the min size which should be available for the pages: a + // wizard will take into account the size of the bitmap (if any) + // 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 + virtual wxSize GetPageSize() const = 0; }; // include the real class declaration @@ -137,7 +169,8 @@ class WXDLLEXPORT wxWizardEvent : public wxNotifyEvent public: wxWizardEvent(wxEventType type = wxEVT_NULL, int id = -1, - bool direction = TRUE); + 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 @@ -145,8 +178,11 @@ public: // (this function doesn't make sense for CANCEL events) bool GetDirection() const { return m_direction; } + wxWizardPage* GetPage() const { return m_page; } + private: bool m_direction; + wxWizardPage* m_page; DECLARE_DYNAMIC_CLASS(wxWizardEvent) }; @@ -155,17 +191,29 @@ private: // 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) +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) { 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, -1, (wxObjectEventFunction) (wxEventFunction) (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) { 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, -1, (wxObjectEventFunction) (wxEventFunction) (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) { 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, -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, -1, (wxObjectEventFunction) (wxEventFunction) (wxWizardEventFunction) & fn, (wxObject *)NULL), + +#endif // wxUSE_WIZARDDLG #endif // _WX_WIZARD_H_