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: Robert Cavanaugh
   8 //              Added capability to use .WXR resource files in Wizard pages
   9 //              Added wxWIZARD_HELP event
  10 //              Robert Vazan (sizers)
  11 // Created:     15.08.99
  12 // RCS-ID:      $Id$
  13 // Copyright:   (c) 1999 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
  14 // Licence:     wxWindows licence
  15 ///////////////////////////////////////////////////////////////////////////////
  16
  17 #ifndef _WX_WIZARD_H_
  18 #define _WX_WIZARD_H_
  19
  20 #if wxUSE_WIZARDDLG
  21
  22 // ----------------------------------------------------------------------------
  23 // headers and other simple declarations
  24 // ----------------------------------------------------------------------------
  25
  26 #ifndef WX_PRECOMP
  27     #include "wx/dialog.h"      // the base class
  28     #include "wx/panel.h"       // ditto
  29
  30     #include "wx/event.h"       // wxEVT_XXX constants
  31 #endif // WX_PRECOMP
  32
  33 #include "wx/bitmap.h"
  34
  35 // Extended style to specify a help button
  36 #define wxWIZARD_EX_HELPBUTTON   0x00000010
  37
  38 // forward declarations
  39 class WXDLLIMPEXP_ADV wxWizard;
  40
  41 // ----------------------------------------------------------------------------
  42 // wxWizardPage is one of the wizards screen: it must know what are the
  43 // following and preceding pages (which may be NULL for the first/last page).
  44 //
  45 // Other than GetNext/Prev() functions, wxWizardPage is just a panel and may be
  46 // used as such (i.e. controls may be placed directly on it &c).
  47 // ----------------------------------------------------------------------------
  48
  49 class WXDLLIMPEXP_ADV wxWizardPage : public wxPanel
  50 {
  51 public:
  52     wxWizardPage() { Init(); }
  53
  54     // ctor accepts an optional bitmap which will be used for this page instead
  55     // of the default one for this wizard (should be of the same size). Notice
  56     // that no other parameters are needed because the wizard will resize and
  57     // reposition the page anyhow
  58     wxWizardPage(wxWizard *parent,
  59                  const wxBitmap& bitmap = wxNullBitmap,
  60                  const wxChar* resource = NULL);
  61
  62     bool Create(wxWizard *parent,
  63                 const wxBitmap& bitmap = wxNullBitmap,
  64                 const wxChar* resource = NULL);
  65
  66     // these functions are used by the wizard to show another page when the
  67     // user chooses "Back" or "Next" button
  68     virtual wxWizardPage *GetPrev() const = 0;
  69     virtual wxWizardPage *GetNext() const = 0;
  70
  71     // default GetBitmap() will just return m_bitmap which is ok in 99% of
  72     // cases - override this method if you want to create the bitmap to be used
  73     // dynamically or to do something even more fancy. It's ok to return
  74     // wxNullBitmap from here - the default one will be used then.
  75     virtual wxBitmap GetBitmap() const { return m_bitmap; }
  76
  77     /// Override the base functions to allow a validator to be assigned to this page.
  78     bool TransferDataToWindow()
  79     {
  80         return GetValidator() ? GetValidator()->TransferToWindow() : wxPanel::TransferDataToWindow();
  81     }
  82     bool TransferDataFromWindow()
  83     {
  84         return GetValidator() ? GetValidator()->TransferFromWindow() : wxPanel::TransferDataFromWindow();
  85     }
  86     bool Validate()
  87     {
  88         return GetValidator() ? GetValidator()->Validate(this) : wxPanel::Validate();
  89     }
  90
  91 protected:
  92     // common part of ctors:
  93     void Init();
  94
  95     wxBitmap m_bitmap;
  96
  97 private:
  98     DECLARE_DYNAMIC_CLASS_NO_COPY(wxWizardPage)
  99 };
 100
 101 // ----------------------------------------------------------------------------
 102 // wxWizardPageSimple just returns the pointers given to the ctor and is useful
 103 // to create a simple wizard where the order of pages never changes.
 104 //
 105 // OTOH, it is also possible to dynamicly decide which page to return (i.e.
 106 // depending on the user's choices) as the wizard sample shows - in order to do
 107 // this, you must derive from wxWizardPage directly.
 108 // ----------------------------------------------------------------------------
 109
 110 class WXDLLIMPEXP_ADV wxWizardPageSimple : public wxWizardPage
 111 {
 112 public:
 113     wxWizardPageSimple() { Init(); }
 114
 115     // ctor takes the previous and next pages
 116     wxWizardPageSimple(wxWizard *parent,
 117                        wxWizardPage *prev = (wxWizardPage *)NULL,
 118                        wxWizardPage *next = (wxWizardPage *)NULL,
 119                        const wxBitmap& bitmap = wxNullBitmap,
 120                        const wxChar* resource = NULL)
 121     {
 122         Create(parent, prev, next, bitmap, resource);
 123     }
 124
 125     bool Create(wxWizard *parent = NULL, // let it be default ctor too
 126                 wxWizardPage *prev = (wxWizardPage *)NULL,
 127                 wxWizardPage *next = (wxWizardPage *)NULL,
 128                 const wxBitmap& bitmap = wxNullBitmap,
 129                 const wxChar* resource = NULL)
 130     {
 131         m_prev = prev;
 132         m_next = next;
 133         return wxWizardPage::Create(parent, bitmap, resource);
 134     }
 135
 136     // the pointers may be also set later - but before starting the wizard
 137     void SetPrev(wxWizardPage *prev) { m_prev = prev; }
 138     void SetNext(wxWizardPage *next) { m_next = next; }
 139
 140     // a convenience function to make the pages follow each other
 141     static void Chain(wxWizardPageSimple *first, wxWizardPageSimple *second)
 142     {
 143         wxCHECK_RET( first && second,
 144                      wxT("NULL passed to wxWizardPageSimple::Chain") );
 145
 146         first->SetNext(second);
 147         second->SetPrev(first);
 148     }
 149
 150     // base class pure virtuals
 151     virtual wxWizardPage *GetPrev() const;
 152     virtual wxWizardPage *GetNext() const;
 153
 154 private:
 155     // common part of ctors:
 156     void Init()
 157     {
 158         m_prev = m_next = NULL;
 159     }
 160
 161     // pointers are private, the derived classes shouldn't mess with them -
 162     // just derive from wxWizardPage directly to implement different behaviour
 163     wxWizardPage *m_prev,
 164                  *m_next;
 165
 166     DECLARE_DYNAMIC_CLASS_NO_COPY(wxWizardPageSimple)
 167 };
 168
 169 // ----------------------------------------------------------------------------
 170 // wxWizard
 171 // ----------------------------------------------------------------------------
 172
 173 class WXDLLIMPEXP_ADV wxWizardBase : public wxDialog
 174 {
 175 public:
 176     /*
 177        The derived class (i.e. the real wxWizard) has a ctor and Create()
 178        function taking the following arguments:
 179
 180         wxWizard(wxWindow *parent,
 181                  int id = -1,
 182                  const wxString& title = wxEmptyString,
 183                  const wxBitmap& bitmap = wxNullBitmap,
 184                  const wxPoint& pos = wxDefaultPosition,
 185                  long style = wxDEFAULT_DIALOG_STYLE);
 186     */
 187     wxWizardBase() { }
 188
 189     // executes the wizard starting from the given page, returns TRUE if it was
 190     // successfully finished, FALSE if user cancelled it
 191     virtual bool RunWizard(wxWizardPage *firstPage) = 0;
 192
 193     // get the current page (NULL if RunWizard() isn't running)
 194     virtual wxWizardPage *GetCurrentPage() const = 0;
 195
 196     // set the min size which should be available for the pages: a
 197     // wizard will take into account the size of the bitmap (if any)
 198     // itself and will never be less than some predefined fixed size
 199     virtual void SetPageSize(const wxSize& size) = 0;
 200
 201     // get the size available for the page
 202     virtual wxSize GetPageSize() const = 0;
 203
 204     // set the best size for the wizard, i.e. make it big enough to contain all
 205     // of the pages starting from the given one
 206     //
 207     // this function may be called several times and possible with different
 208     // pages in which case it will only increase the page size if needed (this
 209     // may be useful if not all pages are accessible from the first one by
 210     // default)
 211     virtual void FitToPage(const wxWizardPage *firstPage) = 0;
 212
 213     // Adding pages to page area sizer enlarges wizard
 214     virtual wxSizer *GetPageAreaSizer() const = 0;
 215
 216     // Set border around page area. Default is 0 if you add at least one
 217     // page to GetPageAreaSizer and 5 if you don't.
 218     virtual void SetBorder(int border) = 0;
 219
 220     // wxWizard should be created using "new wxWizard" now, not with Create()
 221 #if WXWIN_COMPATIBILITY_2_2
 222     static wxWizard *Create(wxWindow *parent,
 223                             int id = -1,
 224                             const wxString& title = wxEmptyString,
 225                             const wxBitmap& bitmap = wxNullBitmap,
 226                             const wxPoint& pos = wxDefaultPosition,
 227                             const wxSize& size = wxDefaultSize);
 228 #endif // WXWIN_COMPATIBILITY_2_2
 229
 230     // the methods below may be overridden by the derived classes to provide
 231     // custom logic for determining the pages order
 232
 233     virtual bool HasNextPage(wxWizardPage *page)
 234         { return page->GetNext() != NULL; }
 235
 236     virtual bool HasPrevPage(wxWizardPage *page)
 237         { return page->GetPrev() != NULL; }
 238
 239     /// Override these functions to stop InitDialog from calling TransferDataToWindow
 240     /// for _all_ pages when the wizard starts. Instead 'ShowPage' will call
 241     /// TransferDataToWindow for the first page only.
 242     bool TransferDataToWindow() { return true; }
 243     bool TransferDataFromWindow() { return true; }
 244     bool Validate() { return true; }
 245
 246 private:
 247     DECLARE_NO_COPY_CLASS(wxWizardBase)
 248 };
 249
 250 // include the real class declaration
 251 #include "wx/generic/wizard.h"
 252
 253 // ----------------------------------------------------------------------------
 254 // wxWizardEvent class represents an event generated by the wizard: this event
 255 // is first sent to the page itself and, if not processed there, goes up the
 256 // window hierarchy as usual
 257 // ----------------------------------------------------------------------------
 258
 259 class WXDLLIMPEXP_ADV wxWizardEvent : public wxNotifyEvent
 260 {
 261 public:
 262     wxWizardEvent(wxEventType type = wxEVT_NULL,
 263                   int id = -1,
 264                   bool direction = TRUE,
 265                   wxWizardPage* page = NULL);
 266
 267     // for EVT_WIZARD_PAGE_CHANGING, return TRUE if we're going forward or
 268     // FALSE otherwise and for EVT_WIZARD_PAGE_CHANGED return TRUE if we came
 269     // from the previous page and FALSE if we returned from the next one
 270     // (this function doesn't make sense for CANCEL events)
 271     bool GetDirection() const { return m_direction; }
 272
 273     wxWizardPage*   GetPage() const { return m_page; }
 274
 275 private:
 276     bool m_direction;
 277     wxWizardPage*    m_page;
 278
 279     DECLARE_DYNAMIC_CLASS(wxWizardEvent)
 280     DECLARE_NO_COPY_CLASS(wxWizardEvent)
 281 };
 282
 283 // ----------------------------------------------------------------------------
 284 // macros for handling wxWizardEvents
 285 // ----------------------------------------------------------------------------
 286
 287 BEGIN_DECLARE_EVENT_TYPES()
 288     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_WIZARD_PAGE_CHANGED, 900)
 289     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_WIZARD_PAGE_CHANGING, 901)
 290     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_WIZARD_CANCEL, 902)
 291     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_WIZARD_HELP, 903)
 292     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_WIZARD_FINISHED, 903)
 293 END_DECLARE_EVENT_TYPES()
 294
 295 typedef void (wxEvtHandler::*wxWizardEventFunction)(wxWizardEvent&);
 296
 297 // notifies that the page has just been changed (can't be vetoed)
 298 #define EVT_WIZARD_PAGE_CHANGED(id, fn) DECLARE_EVENT_TABLE_ENTRY(wxEVT_WIZARD_PAGE_CHANGED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxWizardEventFunction) & fn, (wxObject *)NULL),
 299
 300 // the user pressed "<Back" or "Next>" button and the page is going to be
 301 // changed - unless the event handler vetoes the event
 302 #define EVT_WIZARD_PAGE_CHANGING(id, fn) DECLARE_EVENT_TABLE_ENTRY(wxEVT_WIZARD_PAGE_CHANGING, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxWizardEventFunction) & fn, (wxObject *)NULL),
 303
 304 // the user pressed "Cancel" button and the wizard is going to be dismissed -
 305 // unless the event handler vetoes the event
 306 #define EVT_WIZARD_CANCEL(id, fn) DECLARE_EVENT_TABLE_ENTRY(wxEVT_WIZARD_CANCEL, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxWizardEventFunction) & fn, (wxObject *)NULL),
 307
 308 // the user pressed "Finish" button and the wizard is going to be dismissed -
 309 #define EVT_WIZARD_FINISHED(id, fn) DECLARE_EVENT_TABLE_ENTRY(wxEVT_WIZARD_FINISHED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxWizardEventFunction) & fn, (wxObject *)NULL),
 310
 311 // the user pressed "Help" button
 312 #define EVT_WIZARD_HELP(id, fn) DECLARE_EVENT_TABLE_ENTRY(wxEVT_WIZARD_HELP, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxWizardEventFunction) & fn, (wxObject *)NULL),
 313
 314 #endif // wxUSE_WIZARDDLG
 315
 316 #endif // _WX_WIZARD_H_