1999-09-29 18:47:56 -04:00
|
|
|
///////////////////////////////////////////////////////////////////////////////
|
|
|
|
// Name: generic/wizard.h
|
|
|
|
// Purpose: declaration of generic wxWizard class
|
|
|
|
// Author: Vadim Zeitlin
|
2003-07-20 16:48:52 -04:00
|
|
|
// Modified by: Robert Vazan (sizers)
|
1999-09-29 18:47:56 -04:00
|
|
|
// Created: 28.09.99
|
|
|
|
// RCS-ID: $Id$
|
|
|
|
// Copyright: (c) 1999 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
|
2003-03-17 05:34:04 -05:00
|
|
|
// Licence: wxWindows licence
|
1999-09-29 18:47:56 -04:00
|
|
|
///////////////////////////////////////////////////////////////////////////////
|
|
|
|
|
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
// wxWizard
|
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
|
2002-08-31 07:29:13 -04:00
|
|
|
#if defined(__GNUG__) && !defined(__APPLE__)
|
2002-05-22 19:36:20 -04:00
|
|
|
#pragma interface "wizardg.h"
|
|
|
|
#endif
|
|
|
|
|
2000-01-20 21:26:25 -05:00
|
|
|
class WXDLLEXPORT wxButton;
|
|
|
|
class WXDLLEXPORT wxStaticBitmap;
|
2002-05-22 19:36:20 -04:00
|
|
|
class WXDLLEXPORT wxWizardEvent;
|
2003-07-20 16:48:52 -04:00
|
|
|
class WXDLLEXPORT wxBoxSizer;
|
|
|
|
class WXDLLEXPORT wxWizardSizer;
|
2000-01-20 21:26:25 -05:00
|
|
|
|
|
|
|
class WXDLLEXPORT wxWizard : public wxWizardBase
|
1999-09-29 18:47:56 -04:00
|
|
|
{
|
|
|
|
public:
|
|
|
|
// ctor
|
2001-08-17 05:38:19 -04:00
|
|
|
wxWizard() { Init(); }
|
|
|
|
wxWizard(wxWindow *parent,
|
|
|
|
int id = -1,
|
|
|
|
const wxString& title = wxEmptyString,
|
|
|
|
const wxBitmap& bitmap = wxNullBitmap,
|
2003-07-20 16:48:52 -04:00
|
|
|
const wxPoint& pos = wxDefaultPosition,
|
|
|
|
long style = wxDEFAULT_DIALOG_STYLE)
|
2001-08-17 05:38:19 -04:00
|
|
|
{
|
|
|
|
Init();
|
2003-07-20 16:48:52 -04:00
|
|
|
Create(parent, id, title, bitmap, pos, style);
|
2001-08-17 05:38:19 -04:00
|
|
|
}
|
|
|
|
bool Create(wxWindow *parent,
|
1999-09-29 18:47:56 -04:00
|
|
|
int id = -1,
|
|
|
|
const wxString& title = wxEmptyString,
|
|
|
|
const wxBitmap& bitmap = wxNullBitmap,
|
2003-07-20 16:48:52 -04:00
|
|
|
const wxPoint& pos = wxDefaultPosition,
|
|
|
|
long style = wxDEFAULT_DIALOG_STYLE);
|
2001-08-17 05:38:19 -04:00
|
|
|
void Init();
|
1999-09-29 18:47:56 -04:00
|
|
|
|
|
|
|
// implement base class pure virtuals
|
|
|
|
virtual bool RunWizard(wxWizardPage *firstPage);
|
|
|
|
virtual wxWizardPage *GetCurrentPage() const;
|
2000-07-15 15:51:35 -04:00
|
|
|
virtual void SetPageSize(const wxSize& size);
|
1999-11-13 21:22:27 -05:00
|
|
|
virtual wxSize GetPageSize() const;
|
2002-06-21 17:49:28 -04:00
|
|
|
virtual void FitToPage(const wxWizardPage *firstPage);
|
2003-07-20 16:48:52 -04:00
|
|
|
virtual wxSizer *GetPageAreaSizer() const;
|
|
|
|
virtual void SetBorder(int border);
|
1999-09-29 18:47:56 -04:00
|
|
|
|
|
|
|
// implementation only from now on
|
|
|
|
// -------------------------------
|
|
|
|
|
|
|
|
// is the wizard running?
|
|
|
|
bool IsRunning() const { return m_page != NULL; }
|
|
|
|
|
|
|
|
// show the prev/next page, but call TransferDataFromWindow on the current
|
2000-07-15 15:51:35 -04:00
|
|
|
// page first and return FALSE without changing the page if
|
|
|
|
// TransferDataFromWindow() returns FALSE - otherwise, returns TRUE
|
1999-09-29 18:47:56 -04:00
|
|
|
bool ShowPage(wxWizardPage *page, bool goingForward = TRUE);
|
|
|
|
|
2001-08-17 05:38:19 -04:00
|
|
|
// do fill the dialog with controls
|
|
|
|
// this is app-overridable to, for example, set help and tooltip text
|
2002-07-12 10:43:58 -04:00
|
|
|
virtual void DoCreateControls();
|
2001-08-17 05:38:19 -04:00
|
|
|
|
1999-09-29 18:47:56 -04:00
|
|
|
private:
|
2000-07-15 15:51:35 -04:00
|
|
|
// was the dialog really created?
|
|
|
|
bool WasCreated() const { return m_btnPrev != NULL; }
|
|
|
|
|
1999-09-29 18:47:56 -04:00
|
|
|
// event handlers
|
|
|
|
void OnCancel(wxCommandEvent& event);
|
|
|
|
void OnBackOrNext(wxCommandEvent& event);
|
2001-11-02 12:29:38 -05:00
|
|
|
void OnHelp(wxCommandEvent& event);
|
1999-09-29 18:47:56 -04:00
|
|
|
|
2002-05-22 19:36:20 -04:00
|
|
|
void OnWizEvent(wxWizardEvent& event);
|
|
|
|
|
2003-07-20 16:48:52 -04:00
|
|
|
void AddBitmapRow(wxBoxSizer *mainColumn);
|
|
|
|
void AddStaticLine(wxBoxSizer *mainColumn);
|
|
|
|
void AddBackNextPair(wxBoxSizer *buttonRow);
|
|
|
|
void AddButtonRow(wxBoxSizer *mainColumn);
|
|
|
|
|
|
|
|
void FinishLayout();
|
|
|
|
|
|
|
|
wxSize GetManualPageSize() const;
|
|
|
|
|
2000-07-15 15:51:35 -04:00
|
|
|
// the page size requested by user
|
|
|
|
wxSize m_sizePage;
|
|
|
|
|
|
|
|
// the dialog position from the ctor
|
|
|
|
wxPoint m_posWizard;
|
|
|
|
|
1999-09-29 18:47:56 -04:00
|
|
|
// wizard state
|
|
|
|
wxWizardPage *m_page; // the current page or NULL
|
2000-01-20 21:26:25 -05:00
|
|
|
wxBitmap m_bitmap; // the default bitmap to show
|
1999-09-29 18:47:56 -04:00
|
|
|
|
|
|
|
// wizard controls
|
|
|
|
wxButton *m_btnPrev, // the "<Back" button
|
|
|
|
*m_btnNext; // the "Next>" or "Finish" button
|
2000-01-20 21:26:25 -05:00
|
|
|
wxStaticBitmap *m_statbmp; // the control for the bitmap
|
1999-09-29 18:47:56 -04:00
|
|
|
|
2003-07-20 16:48:52 -04:00
|
|
|
// Whether user called SetBorder()
|
|
|
|
bool m_calledSetBorder;
|
|
|
|
// Border around page area sizer requested using SetBorder()
|
|
|
|
int m_border;
|
|
|
|
|
|
|
|
// Whether RunWizard() was called
|
|
|
|
bool m_started;
|
|
|
|
|
|
|
|
// Page area sizer will be inserted here with padding
|
|
|
|
wxBoxSizer *m_sizerBmpAndPage;
|
|
|
|
|
|
|
|
// Actual position and size of pages
|
|
|
|
wxWizardSizer *m_sizerPage;
|
|
|
|
|
|
|
|
friend class wxWizardSizer;
|
|
|
|
|
1999-09-29 18:47:56 -04:00
|
|
|
DECLARE_DYNAMIC_CLASS(wxWizard)
|
|
|
|
DECLARE_EVENT_TABLE()
|
2003-01-02 18:38:11 -05:00
|
|
|
DECLARE_NO_COPY_CLASS(wxWizard)
|
1999-09-29 18:47:56 -04:00
|
|
|
};
|
|
|
|
|