X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/c7de4135b619a045593a42dcbb1d1e8a7858cdcc..449110cd746414d5f77db428babe20b84720c73a:/include/wx/wizard.h?ds=sidebyside

diff --git a/include/wx/wizard.h b/include/wx/wizard.h
index 3fa787cc25..d61b12e3a4 100644
--- a/include/wx/wizard.h
+++ b/include/wx/wizard.h
@@ -10,7 +10,7 @@
 // Created:     15.08.99
 // RCS-ID:      $Id$
 // Copyright:   (c) 1999 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_WIZARD_H_
@@ -29,6 +29,8 @@
     #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
 
@@ -47,8 +49,6 @@ class WXDLLEXPORT 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
@@ -74,6 +74,9 @@ public:
     virtual wxBitmap GetBitmap() const { return m_bitmap; }
 
 protected:
+    // common part of ctors:
+    void Init();
+
     wxBitmap m_bitmap;
 
 private:
@@ -93,11 +96,6 @@ class WXDLLEXPORT 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,12 +137,19 @@ 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_NO_COPY_CLASS(wxWizardPageSimple)
 };
 
 // ----------------------------------------------------------------------------
@@ -154,13 +159,16 @@ private:
 class WXDLLEXPORT 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);
+    /*
+       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);
+    */
 
     // executes the wizard starting from the given page, returns TRUE if it was
     // successfully finished, FALSE if user cancelled it
@@ -177,6 +185,34 @@ public:
     // get the size available for the page: the wizards are not resizeable, so
     // this size doesn't change
     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;
+
+    // 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
+
+    // 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; }
 };
 
 // include the real class declaration
@@ -209,6 +245,7 @@ private:
     wxWizardPage*    m_page;
 
     DECLARE_DYNAMIC_CLASS(wxWizardEvent)
+    DECLARE_NO_COPY_CLASS(wxWizardEvent)
 };
 
 // ----------------------------------------------------------------------------
@@ -220,6 +257,7 @@ BEGIN_DECLARE_EVENT_TYPES()
     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&);
@@ -235,6 +273,9 @@ typedef void (wxEvtHandler::*wxWizardEventFunction)(wxWizardEvent&);
 // 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),
 
+// 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),