X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/74b31181b345aaaef0c967cc5707bef72ce0a405..8ec1974ea170256698381cc47dd1dcd6cb494433:/include/wx/wizard.h diff --git a/include/wx/wizard.h b/include/wx/wizard.h index 10f124d7dc..1220ddbe2a 100644 --- a/include/wx/wizard.h +++ b/include/wx/wizard.h @@ -4,28 +4,39 @@ // 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 +// 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_ +#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/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 @@ -35,20 +46,42 @@ 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: - // ctor: no other parameters are needed because the wizard will resize and + wxWizardPage() { 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 + // 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); + + bool Create(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: + // common part of ctors: + void Init(); + + wxBitmap m_bitmap; + private: - DECLARE_ABSTRACT_CLASS(wxWizardPage) + DECLARE_DYNAMIC_CLASS_NO_COPY(wxWizardPage) }; // ---------------------------------------------------------------------------- @@ -60,17 +93,30 @@ 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 = NULL, // let it be default ctor too + wxWizardPageSimple(wxWizard *parent, wxWizardPage *prev = (wxWizardPage *)NULL, - wxWizardPage *next = (wxWizardPage *)NULL) - : wxWizardPage(parent) + wxWizardPage *next = (wxWizardPage *)NULL, + const wxBitmap& bitmap = wxNullBitmap, + const wxChar* resource = NULL) + { + Create(parent, prev, next, bitmap, resource); + } + + 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) { m_prev = prev; m_next = next; + return wxWizardPage::Create(parent, bitmap, resource); } // the pointers may be also set later - but before starting the wizard @@ -81,7 +127,7 @@ public: static void Chain(wxWizardPageSimple *first, wxWizardPageSimple *second) { wxCHECK_RET( first && second, - _T("NULL passed to wxWizardPageSimple::Chain") ); + wxT("NULL passed to wxWizardPageSimple::Chain") ); first->SetNext(second); second->SetPrev(first); @@ -92,35 +138,92 @@ 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 + /* + The derived class (i.e. the real wxWizard) has a ctor and Create() + function taking the following arguments: + + wxWizard(wxWindow *parent, + int id = -1, + 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) + 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 + virtual wxSize GetPageSize() const = 0; + + // set the best size for the wizard, i.e. make it big enough to contain all + // of the pages starting from the given one + // + // this function may be called several times and possible with different + // pages in which case it will only increase the page size if needed (this + // 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() +#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 - // 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; + // the methods below may be overridden by the derived classes to provide + // custom logic for determining the pages order - // get the current page (NULL if RunWizard() isn't running) - virtual wxWizardPage *GetCurrentPage() const = 0; + virtual bool HasNextPage(wxWizardPage *page) + { return page->GetNext() != NULL; } + + virtual bool HasPrevPage(wxWizardPage *page) + { return page->GetPrev() != NULL; } + +private: + DECLARE_NO_COPY_CLASS(wxWizardBase) }; // include the real class declaration @@ -132,12 +235,13 @@ 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); + 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,27 +249,47 @@ 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) + DECLARE_NO_COPY_CLASS(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() + 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 "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), + +// 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_