include/wx/wizard.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wizard.h
   3 // Purpose:     wxWizard class: a GUI control presenting the user with a
   4 //              sequence of dialogs which allows to simply perform some task
   5 // Author:      Vadim Zeitlin (partly based on work by Ron Kuris and Kevin B.
   6 //              Smith)
   7 // Modified by:
   8 // Created:     15.08.99
   9 // RCS-ID:      $Id$
  10 // Copyright:   (c) 1999 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
  11 // Licence:     wxWindows license
  12 ///////////////////////////////////////////////////////////////////////////////
  13
  14 #ifndef _WX_WIZARD_H_
  15 #define _WX_WIZARD_H_
  16
  17 #if wxUSE_WIZARDDLG
  18
  19 // ----------------------------------------------------------------------------
  20 // headers and other simple declarations
  21 // ----------------------------------------------------------------------------
  22
  23 #ifndef WX_PRECOMP
  24     #include "wx/dialog.h"      // the base class
  25     #include "wx/panel.h"       // ditto
  26
  27     #include "wx/event.h"       // wxEVT_XXX constants
  28 #endif // WX_PRECOMP
  29
  30 // Extended style to specify a help button
  31 #define wxWIZARD_EX_HELPBUTTON   0x00000010
  32
  33 // forward declarations
  34 class WXDLLEXPORT wxWizard;
  35
  36 // ----------------------------------------------------------------------------
  37 // wxWizardPage is one of the wizards screen: it must know what are the
  38 // following and preceding pages (which may be NULL for the first/last page).
  39 //
  40 // Other than GetNext/Prev() functions, wxWizardPage is just a panel and may be
  41 // used as such (i.e. controls may be placed directly on it &c).
  42 // ----------------------------------------------------------------------------
  43
  44 class WXDLLEXPORT wxWizardPage : public wxPanel
  45 {
  46 public:
  47     // ctor accepts an optional bitmap which will be used for this page instead
  48     // of the default one for this wizard (should be of the same size). Notice
  49     // that no other parameters are needed because the wizard will resize and
  50     // reposition the page anyhow
  51     wxWizardPage(wxWizard *parent, const wxBitmap& bitmap = wxNullBitmap);
  52
  53     // these functions are used by the wizard to show another page when the
  54     // user chooses "Back" or "Next" button
  55     virtual wxWizardPage *GetPrev() const = 0;
  56     virtual wxWizardPage *GetNext() const = 0;
  57
  58     // default GetBitmap() will just return m_bitmap which is ok in 99% of
  59     // cases - override this method if you want to create the bitmap to be used
  60     // dynamically or to do something even more fancy. It's ok to return
  61     // wxNullBitmap from here - the default one will be used then.
  62     virtual wxBitmap GetBitmap() const { return m_bitmap; }
  63
  64 protected:
  65     wxBitmap m_bitmap;
  66
  67 private:
  68     DECLARE_ABSTRACT_CLASS(wxWizardPage)
  69 };
  70
  71 // ----------------------------------------------------------------------------
  72 // wxWizardPageSimple just returns the pointers given to the ctor and is useful
  73 // to create a simple wizard where the order of pages never changes.
  74 //
  75 // OTOH, it is also possible to dynamicly decide which page to return (i.e.
  76 // depending on the user's choices) as the wizard sample shows - in order to do
  77 // this, you must derive from wxWizardPage directly.
  78 // ----------------------------------------------------------------------------
  79
  80 class WXDLLEXPORT wxWizardPageSimple : public wxWizardPage
  81 {
  82 public:
  83     // ctor takes the previous and next pages
  84     wxWizardPageSimple(wxWizard *parent = NULL, // let it be default ctor too
  85                        wxWizardPage *prev = (wxWizardPage *)NULL,
  86                        wxWizardPage *next = (wxWizardPage *)NULL)
  87         : wxWizardPage(parent)
  88     {
  89         m_prev = prev;
  90         m_next = next;
  91     }
  92
  93     // the pointers may be also set later - but before starting the wizard
  94     void SetPrev(wxWizardPage *prev) { m_prev = prev; }
  95     void SetNext(wxWizardPage *next) { m_next = next; }
  96
  97     // a convenience function to make the pages follow each other
  98     static void Chain(wxWizardPageSimple *first, wxWizardPageSimple *second)
  99     {
 100         wxCHECK_RET( first && second,
 101                      wxT("NULL passed to wxWizardPageSimple::Chain") );
 102
 103         first->SetNext(second);
 104         second->SetPrev(first);
 105     }
 106
 107     // base class pure virtuals
 108     virtual wxWizardPage *GetPrev() const;
 109     virtual wxWizardPage *GetNext() const;
 110
 111 private:
 112     // pointers are private, the derived classes shouldn't mess with them -
 113     // just derive from wxWizardPage directly to implement different behaviour
 114     wxWizardPage *m_prev,
 115                  *m_next;
 116
 117     DECLARE_DYNAMIC_CLASS(wxWizardPageSimple)
 118 };
 119
 120 // ----------------------------------------------------------------------------
 121 // wxWizard
 122 // ----------------------------------------------------------------------------
 123
 124 class WXDLLEXPORT wxWizardBase : public wxDialog
 125 {
 126 public:
 127     // create the wizard control
 128     static wxWizard *Create(wxWindow *parent,
 129                             int id = -1,
 130                             const wxString& title = wxEmptyString,
 131                             const wxBitmap& bitmap = wxNullBitmap,
 132                             const wxPoint& pos = wxDefaultPosition,
 133                             const wxSize& size = wxDefaultSize);
 134
 135     // executes the wizard starting from the given page, returns TRUE if it was
 136     // successfully finished, FALSE if user cancelled it
 137     virtual bool RunWizard(wxWizardPage *firstPage) = 0;
 138
 139     // get the current page (NULL if RunWizard() isn't running)
 140     virtual wxWizardPage *GetCurrentPage() const = 0;
 141
 142     // set the min size which should be available for the pages: a
 143     // wizard will take into account the size of the bitmap (if any)
 144     // itself and will never be less than some predefined fixed size
 145     virtual void SetPageSize(const wxSize& size) = 0;
 146
 147     // get the size available for the page: the wizards are not resizeable, so
 148     // this size doesn't change
 149     virtual wxSize GetPageSize() const = 0;
 150 };
 151
 152 // include the real class declaration
 153 #include "wx/generic/wizard.h"
 154
 155 // ----------------------------------------------------------------------------
 156 // wxWizardEvent class represents an event generated by the wizard: this event
 157 // is first sent to the page itself and, if not processed there, goes up the
 158 // window hierarchy as usual
 159 // ----------------------------------------------------------------------------
 160
 161 class WXDLLEXPORT wxWizardEvent : public wxNotifyEvent
 162 {
 163 public:
 164     wxWizardEvent(wxEventType type = wxEVT_NULL,
 165                   int id = -1,
 166                   bool direction = TRUE);
 167
 168     // for EVT_WIZARD_PAGE_CHANGING, return TRUE if we're going forward or
 169     // FALSE otherwise and for EVT_WIZARD_PAGE_CHANGED return TRUE if we came
 170     // from the previous page and FALSE if we returned from the next one
 171     // (this function doesn't make sense for CANCEL events)
 172     bool GetDirection() const { return m_direction; }
 173
 174 private:
 175     bool m_direction;
 176
 177     DECLARE_DYNAMIC_CLASS(wxWizardEvent)
 178 };
 179
 180 // ----------------------------------------------------------------------------
 181 // macros for handling wxWizardEvents
 182 // ----------------------------------------------------------------------------
 183
 184 BEGIN_DECLARE_EVENT_TYPES()
 185     DECLARE_EVENT_TYPE(wxEVT_WIZARD_PAGE_CHANGED, 900)
 186     DECLARE_EVENT_TYPE(wxEVT_WIZARD_PAGE_CHANGING, 901)
 187     DECLARE_EVENT_TYPE(wxEVT_WIZARD_CANCEL, 902)
 188 END_DECLARE_EVENT_TYPES()
 189
 190 typedef void (wxEvtHandler::*wxWizardEventFunction)(wxWizardEvent&);
 191
 192 // notifies that the page has just been changed (can't be vetoed)
 193 #define EVT_WIZARD_PAGE_CHANGED(id, fn) DECLARE_EVENT_TABLE_ENTRY(wxEVT_WIZARD_PAGE_CHANGED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxWizardEventFunction) & fn, (wxObject *)NULL),
 194
 195 // the user pressed "<Back" or "Next>" button and the page is going to be
 196 // changed - unless the event handler vetoes the event
 197 #define EVT_WIZARD_PAGE_CHANGING(id, fn) DECLARE_EVENT_TABLE_ENTRY(wxEVT_WIZARD_PAGE_CHANGING, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxWizardEventFunction) & fn, (wxObject *)NULL),
 198
 199 // the user pressed "Cancel" button and the wizard is going to be dismissed -
 200 // unless the event handler vetoes the event
 201 #define EVT_WIZARD_CANCEL(id, fn) DECLARE_EVENT_TABLE_ENTRY(wxEVT_WIZARD_CANCEL, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxWizardEventFunction) & fn, (wxObject *)NULL),
 202
 203 #endif // wxUSE_WIZARDDLG
 204
 205 #endif // _WX_WIZARD_H_