A few tweaks and cleanups

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

diff --git a/include/wx/wizard.h b/include/wx/wizard.h
index d80d8ba8fe708e87ade94362c57c866073151835..b402cd5fea61a7692588ec59c7227124d9855555 100644 (file)
--- 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 <zeitlin@dptmaths.ens-cachan.fr>
@@ -22,10 +24,14 @@
 
 #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;
 
@@ -44,7 +50,9 @@ public:
     // 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, const wxBitmap& bitmap = wxNullBitmap);
+    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
@@ -79,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;
@@ -159,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
@@ -167,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)
 };
@@ -181,6 +195,7 @@ 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&);
@@ -196,6 +211,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 "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_