include/wx/generic/wizard.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        generic/wizard.h
   3 // Purpose:     declaration of generic wxWizard class
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     28.09.99
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 1999 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
   9 // Licence:     wxWindows license
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 // ----------------------------------------------------------------------------
  13 // wxWizard
  14 // ----------------------------------------------------------------------------
  15
  16 class WXDLLEXPORT wxButton;
  17 class WXDLLEXPORT wxStaticBitmap;
  18
  19 class WXDLLEXPORT wxWizard : public wxWizardBase
  20 {
  21 public:
  22     // ctor
  23     wxWizard(wxWindow *parent = NULL,
  24              int id = -1,
  25              const wxString& title = wxEmptyString,
  26              const wxBitmap& bitmap = wxNullBitmap,
  27              const wxPoint& pos = wxDefaultPosition,
  28              const wxSize& size = wxDefaultSize);
  29
  30     // implement base class pure virtuals
  31     virtual bool RunWizard(wxWizardPage *firstPage);
  32     virtual wxWizardPage *GetCurrentPage() const;
  33     virtual wxSize GetPageSize() const;
  34
  35     // implementation only from now on
  36     // -------------------------------
  37
  38     // is the wizard running?
  39     bool IsRunning() const { return m_page != NULL; }
  40
  41     // show the prev/next page, but call TransferDataFromWindow on the current
  42     // page first and return FALSE without changing the page if it returns
  43     // FALSE
  44     bool ShowPage(wxWizardPage *page, bool goingForward = TRUE);
  45
  46 private:
  47     // event handlers
  48     void OnCancel(wxCommandEvent& event);
  49     void OnBackOrNext(wxCommandEvent& event);
  50
  51     // wizard dimensions
  52     int          m_x, m_y;      // the origin for the pages
  53     int          m_width,       // the size of the page itself
  54                  m_height;      // (total width is m_width + m_x)
  55
  56     // wizard state
  57     wxWizardPage *m_page;       // the current page or NULL
  58     wxBitmap      m_bitmap;     // the default bitmap to show
  59
  60     // wizard controls
  61     wxButton    *m_btnPrev,     // the "<Back" button
  62                 *m_btnNext;     // the "Next>" or "Finish" button
  63     wxStaticBitmap *m_statbmp;  // the control for the bitmap
  64
  65     DECLARE_DYNAMIC_CLASS(wxWizard)
  66     DECLARE_EVENT_TABLE()
  67 };
  68