corrected comment

[wxWidgets.git] / include / wx / wizard.h

diff --git a/include/wx/wizard.h b/include/wx/wizard.h
index c67c89de87a785a06a59e3593764fa1a6a848108..3e36959f8d2f60302e2e94b81e0a14714d33f7b2 100644 (file)
--- a/include/wx/wizard.h
+++ b/include/wx/wizard.h
@@ -14,16 +14,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 +44,26 @@ 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);
 
     // 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)
 };
@@ -81,7 +98,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);
@@ -121,6 +138,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
@@ -155,17 +181,25 @@ 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)
+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 "<Back" or "Next>" 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),
+
+#endif // wxUSE_WIZARDDLG
 
 #endif // _WX_WIZARD_H_