only formatting changes. s/FALSE/false and s/TRUE/true; remove excessive empty lines...

[wxWidgets.git] / src / generic / wizard.cpp

diff --git a/src/generic/wizard.cpp b/src/generic/wizard.cpp
index 14ecb1d6d6ce352f5a9b91f2d442f0bb84794fd2..03b398e03f21d0d3ed978032d4725eb220b58186 100644 (file)
--- a/src/generic/wizard.cpp
+++ b/src/generic/wizard.cpp
@@ -1,12 +1,16 @@
 ///////////////////////////////////////////////////////////////////////////////
 ///////////////////////////////////////////////////////////////////////////////

-// Name:        generic/wizard.cpp
+// Name:        src/generic/wizard.cpp

 // Purpose:     generic implementation of wxWizard class
 // Author:      Vadim Zeitlin
 // Purpose:     generic implementation of wxWizard class
 // Author:      Vadim Zeitlin

-// Modified by:
+// Modified by: Robert Cavanaugh
+//              1) Added capability for wxWizardPage to accept resources
+//              2) Added "Help" button handler stub
+//              3) Fixed ShowPage() bug on displaying bitmaps
+//              Robert Vazan (sizers)

 // Created:     15.08.99
 // RCS-ID:      $Id$
 // Copyright:   (c) 1999 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
 // Created:     15.08.99
 // RCS-ID:      $Id$
 // Copyright:   (c) 1999 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 ///////////////////////////////////////////////////////////////////////////////
 
 // ============================================================================
 ///////////////////////////////////////////////////////////////////////////////
 
 // ============================================================================


@@ -17,10 +21,6 @@
 // headers
 // ----------------------------------------------------------------------------
 
 // headers
 // ----------------------------------------------------------------------------
 

-#ifdef __GNUG__
-    #pragma implementation ".h"
-#endif
-

 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 


@@ -28,95 +28,89 @@
     #pragma hdrstop
 #endif
 
     #pragma hdrstop
 #endif
 

+#if wxUSE_WIZARDDLG
+

 #ifndef WX_PRECOMP
     #include "wx/dynarray.h"
     #include "wx/intl.h"
     #include "wx/statbmp.h"
 #ifndef WX_PRECOMP
     #include "wx/dynarray.h"
     #include "wx/intl.h"
     #include "wx/statbmp.h"

+    #include "wx/button.h"
+    #include "wx/settings.h"
+    #include "wx/sizer.h"

 #endif //WX_PRECOMP
 
 #include "wx/statline.h"
 
 #endif //WX_PRECOMP
 
 #include "wx/statline.h"
 

+#include "wx/scrolwin.h"

 #include "wx/wizard.h"
 #include "wx/wizard.h"

+#include "wx/dcmemory.h"

 
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------

-// simple types
+// wxWizardSizer

 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 

-WX_DEFINE_ARRAY(wxPanel *, wxArrayPages);
-
-// ----------------------------------------------------------------------------
-// wxWizardGeneric - generic implementation of wxWizard
-// ----------------------------------------------------------------------------
-
-class wxWizardGeneric : public wxWizard
+class wxWizardSizer : public wxSizer

 {
 public:
 {
 public:

-    // ctor
-    wxWizardGeneric(wxWindow *parent,
-                    int id,
-                    const wxString& title,
-                    const wxBitmap& bitmap,
-                    const wxPoint& pos,
-                    const wxSize& size);
+    wxWizardSizer(wxWizard *owner);

 
 

-    // implement base class pure virtuals
-    virtual void AddPage(wxPanel *page);
-    virtual void InsertPage(int nPage, wxPanel *page);
-    virtual bool RunWizard();
-    virtual wxPanel *GetCurrentPage() const;
+    virtual wxSizerItem *Insert(size_t index, wxSizerItem *item);

 
 

-    // implementation only from now on
-    // -------------------------------
+    virtual void RecalcSizes();
+    virtual wxSize CalcMin();

 
 

-    // is the wizard running?
-    bool IsRunning() const { return m_page != -1; }
+    // get the max size of all wizard pages
+    wxSize GetMaxChildSize();

 
 

-    // show the given page calling TransferDataFromWindow - if it returns
-    // FALSE, the old page is not hidden and the function returns FALSE
-    bool ShowPage(size_t page);
+    // return the border which can be either set using wxWizard::SetBorder() or
+    // have default value
+    int GetBorder() const;

 
 

-    // get the current page assuming the wizard is running
-    wxPanel *DoGetCurrentPage() const
-    {
-        wxASSERT_MSG( IsRunning(), _T("no current page!") );
-
-        return m_pages[(size_t)m_page];
-    }
-
-    // place the given page correctly and hide it
-    void DoAddPage(wxPanel *page);
+    // hide the pages which we temporarily "show" when they're added to this
+    // sizer (see Insert())
+    void HidePages();

 
 private:
 
 private:

-    // event handlers
-    void OnCancel(wxCommandEvent& event);
-    void OnBackOrNext(wxCommandEvent& event);
-
-    // wizard dimensions
-    int          m_x, m_y;      // the origin for the pages
-    int          m_width,       // the size of the page itself
-                 m_height;      // (total width is m_width + m_x)
-
-    // wizard state
-    int          m_page;        // the current page or -1
-    wxArrayPages m_pages;       // the array with all wizards pages
+    wxSize SiblingSize(wxSizerItem *child);

 
 

-    // wizard controls
-    wxButton    *m_btnPrev,     // the "<Back" button
-                *m_btnNext;     // the "Next>" or "Finish" button
-
-    DECLARE_EVENT_TABLE()
+    wxWizard *m_owner;
+    wxSize m_childSize;

 };
 
 // ----------------------------------------------------------------------------
 // event tables and such
 // ----------------------------------------------------------------------------
 
 };
 
 // ----------------------------------------------------------------------------
 // event tables and such
 // ----------------------------------------------------------------------------
 

-BEGIN_EVENT_TABLE(wxWizardGeneric, wxDialog)
-    EVT_BUTTON(wxID_CANCEL, OnCancel)
-    EVT_BUTTON(-1, OnBackOrNext)
+DEFINE_EVENT_TYPE(wxEVT_WIZARD_PAGE_CHANGED)
+DEFINE_EVENT_TYPE(wxEVT_WIZARD_PAGE_CHANGING)
+DEFINE_EVENT_TYPE(wxEVT_WIZARD_CANCEL)
+DEFINE_EVENT_TYPE(wxEVT_WIZARD_FINISHED)
+DEFINE_EVENT_TYPE(wxEVT_WIZARD_HELP)
+
+BEGIN_EVENT_TABLE(wxWizard, wxDialog)
+    EVT_BUTTON(wxID_CANCEL, wxWizard::OnCancel)
+    EVT_BUTTON(wxID_BACKWARD, wxWizard::OnBackOrNext)
+    EVT_BUTTON(wxID_FORWARD, wxWizard::OnBackOrNext)
+    EVT_BUTTON(wxID_HELP, wxWizard::OnHelp)
+
+    EVT_WIZARD_PAGE_CHANGED(wxID_ANY, wxWizard::OnWizEvent)
+    EVT_WIZARD_PAGE_CHANGING(wxID_ANY, wxWizard::OnWizEvent)
+    EVT_WIZARD_CANCEL(wxID_ANY, wxWizard::OnWizEvent)
+    EVT_WIZARD_FINISHED(wxID_ANY, wxWizard::OnWizEvent)
+    EVT_WIZARD_HELP(wxID_ANY, wxWizard::OnWizEvent)

 END_EVENT_TABLE()
 
 END_EVENT_TABLE()
 

-IMPLEMENT_ABSTRACT_CLASS(wxWizard, wxDialog)
+IMPLEMENT_DYNAMIC_CLASS(wxWizard, wxDialog)
+
+/*
+    TODO PROPERTIES :
+    wxWizard
+        extstyle
+        title
+*/
+
+IMPLEMENT_ABSTRACT_CLASS(wxWizardPage, wxPanel)
+IMPLEMENT_DYNAMIC_CLASS(wxWizardPageSimple, wxWizardPage)

 IMPLEMENT_DYNAMIC_CLASS(wxWizardEvent, wxNotifyEvent)
 
 // ============================================================================
 IMPLEMENT_DYNAMIC_CLASS(wxWizardEvent, wxNotifyEvent)
 
 // ============================================================================


@@ -124,233 +118,904 @@ IMPLEMENT_DYNAMIC_CLASS(wxWizardEvent, wxNotifyEvent)
 // ============================================================================
 
 // ----------------------------------------------------------------------------
 // ============================================================================
 
 // ----------------------------------------------------------------------------

-// generic wxWizard implementation
+// wxWizardPage

 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 

-wxWizardGeneric::wxWizardGeneric(wxWindow *parent,
-                                 int id,
-                                 const wxString& title,
-                                 const wxBitmap& bitmap,
-                                 const wxPoint& pos,
-                                 const wxSize& size)
+void wxWizardPage::Init()

 {
 {

-    // constants defining the dialog layout
-    // ------------------------------------
+    m_bitmap = wxNullBitmap;
+}

 
 

-    // these constants define the position of the upper left corner of the
-    // bitmap or the page in the wizard
-    static const int X_MARGIN = 10;
-    static const int Y_MARGIN = 10;
+wxWizardPage::wxWizardPage(wxWizard *parent,
+                           const wxBitmap& bitmap)
+{
+    Create(parent, bitmap);
+}

 
 

-    // margin between the bitmap and the panel
-    static const int BITMAP_X_MARGIN = 15;
+bool wxWizardPage::Create(wxWizard *parent,
+                          const wxBitmap& bitmap)
+{
+    if ( !wxPanel::Create(parent, wxID_ANY) )
+        return false;

 
 

-    // margin between the bitmap and the static line
-    static const int BITMAP_Y_MARGIN = 15;
+    m_bitmap = bitmap;

 
 

-    // margin between the static line and the buttons
-    static const int SEPARATOR_LINE_MARGIN = 15;
+    // initially the page is hidden, it's shown only when it becomes current
+    Hide();

 
 

-    // margin between "Next >" and "Cancel" buttons
-    static const int BUTTON_MARGIN = 10;
+    return true;
+}

 
 

-    // default width and height of the page
-    static const int DEFAULT_PAGE_WIDTH = 270;
-    static const int DEFAULT_PAGE_HEIGHT = 290;
+// ----------------------------------------------------------------------------
+// wxWizardPageSimple
+// ----------------------------------------------------------------------------

 
 

-    // init members
-    // ------------
+wxWizardPage *wxWizardPageSimple::GetPrev() const
+{
+    return m_prev;
+}

 
 

-    m_page = -1;
+wxWizardPage *wxWizardPageSimple::GetNext() const
+{
+    return m_next;
+}

 
 

-    // create controls
-    // ---------------
+// ----------------------------------------------------------------------------
+// wxWizardSizer
+// ----------------------------------------------------------------------------

 
 

-    wxSize sizeBtn = wxButton::GetDefaultSize();
+wxWizardSizer::wxWizardSizer(wxWizard *owner)
+             : m_owner(owner),
+               m_childSize(wxDefaultSize)
+{
+}

 
 

-    (void)wxDialog::Create(parent, id, title, pos, size);
+wxSizerItem *wxWizardSizer::Insert(size_t index, wxSizerItem *item)
+{
+    m_owner->m_usingSizer = true;

 
 

-    // the global dialog layout is: a row of buttons at the bottom (aligned to
-    // the right), the static line above them, the bitmap (if any) on the left
-    // of the upper part of the dialog and the panel in the remaining space
-    m_x = X_MARGIN;
-    m_y = Y_MARGIN;
-    if ( bitmap.Ok() )
+    if ( item->IsWindow() )

     {
     {

-        (void)new wxStaticBitmap(this, -1, bitmap, wxPoint(m_x, m_y));
+        // we must pretend that the window is shown as otherwise it wouldn't be
+        // taken into account for the layout -- but avoid really showing it, so
+        // just set the internal flag instead of calling wxWindow::Show()
+        item->GetWindow()->wxWindowBase::Show();
+    }
+
+    return wxSizer::Insert(index, item);
+}

 
 

-        m_x += bitmap.GetWidth() + BITMAP_X_MARGIN;
-        m_height = bitmap.GetHeight();
+void wxWizardSizer::HidePages()
+{
+    for ( wxSizerItemList::compatibility_iterator node = GetChildren().GetFirst();
+          node;
+          node = node->GetNext() )
+    {
+        wxSizerItem * const item = node->GetData();
+        if ( item->IsWindow() )
+            item->GetWindow()->wxWindowBase::Show(false);

     }
     }

-    else
+}
+
+void wxWizardSizer::RecalcSizes()
+{
+    // Effect of this function depends on m_owner->m_page and
+    // it should be called whenever it changes (wxWizard::ShowPage)
+    if ( m_owner->m_page )

     {
     {

-        m_height = DEFAULT_PAGE_HEIGHT;
+        m_owner->m_page->SetSize(wxRect(m_position, m_size));

     }
     }

+}

 
 

-    m_width = DEFAULT_PAGE_WIDTH;
+wxSize wxWizardSizer::CalcMin()
+{
+    return m_owner->GetPageSize();
+}

 
 

-    int x = X_MARGIN;
-    int y = m_y + m_height + BITMAP_Y_MARGIN;
-    (void)new wxStaticLine(this, -1, wxPoint(x, y),
-                           wxSize(m_x + m_width - x, 2));
+wxSize wxWizardSizer::GetMaxChildSize()
+{
+#if !defined(__WXDEBUG__)
+    if ( m_childSize.IsFullySpecified() )
+        return m_childSize;
+#endif

 
 

-    x = m_x + m_width - 3*sizeBtn.x - BUTTON_MARGIN;
-    y += SEPARATOR_LINE_MARGIN;
-    m_btnPrev = new wxButton(this, -1, _("< &Back"), wxPoint(x, y), sizeBtn);
+    wxSize maxOfMin;

 
 

-    x += sizeBtn.x;
-    m_btnNext = new wxButton(this, -1, _("&Next >"), wxPoint(x, y), sizeBtn);
+    for ( wxSizerItemList::compatibility_iterator childNode = m_children.GetFirst();
+          childNode;
+          childNode = childNode->GetNext() )
+    {
+        wxSizerItem *child = childNode->GetData();
+        maxOfMin.IncTo(child->CalcMin());
+        maxOfMin.IncTo(SiblingSize(child));
+    }

 
 

-    x += sizeBtn.x + BUTTON_MARGIN;
-    (void)new wxButton(this, wxID_CANCEL, _("Cancel"), wxPoint(x, y), sizeBtn);
+    // No longer applicable since we may change sizes when size adaptation is done
+#if 0
+#ifdef __WXDEBUG__
+    if ( m_childSize.IsFullySpecified() && m_childSize != maxOfMin )
+    {
+        wxFAIL_MSG( _T("Size changed in wxWizard::GetPageAreaSizer()")
+                    _T("after RunWizard().\n")
+                    _T("Did you forget to call GetSizer()->Fit(this) ")
+                    _T("for some page?")) ;

 
 

-    // position and size the dialog
-    // ----------------------------
+        return m_childSize;
+    }
+#endif // __WXDEBUG__
+#endif

 
 

-    if ( size == wxDefaultSize )
+    if ( m_owner->m_started )

     {
     {

-        SetClientSize(m_x + m_width + X_MARGIN,
-                      m_y + m_height + BITMAP_Y_MARGIN +
-                        SEPARATOR_LINE_MARGIN + sizeBtn.y + Y_MARGIN);
+        m_childSize = maxOfMin;

     }
 
     }
 

-    if ( pos == wxDefaultPosition )
+    return maxOfMin;
+}
+
+int wxWizardSizer::GetBorder() const
+{
+    return m_owner->m_border;
+}
+
+wxSize wxWizardSizer::SiblingSize(wxSizerItem *child)
+{
+    wxSize maxSibling;
+
+    if ( child->IsWindow() )

     {
     {

-        Centre();
+        wxWizardPage *page = wxDynamicCast(child->GetWindow(), wxWizardPage);
+        if ( page )
+        {
+            for ( wxWizardPage *sibling = page->GetNext();
+                  sibling;
+                  sibling = sibling->GetNext() )
+            {
+                if ( sibling->GetSizer() )
+                {
+                    maxSibling.IncTo(sibling->GetSizer()->CalcMin());
+                }
+            }
+        }

     }
     }

+
+    return maxSibling;

 }
 
 }
 

-bool wxWizardGeneric::ShowPage(size_t page)
+// ----------------------------------------------------------------------------
+// generic wxWizard implementation
+// ----------------------------------------------------------------------------
+
+void wxWizard::Init()

 {
 {

-    wxCHECK_MSG( page < m_pages.GetCount(), FALSE,
-                 _T("invalid wizard page index") );
+    m_posWizard = wxDefaultPosition;
+    m_page = (wxWizardPage *)NULL;
+    m_btnPrev = m_btnNext = NULL;
+    m_statbmp = NULL;
+    m_sizerBmpAndPage = NULL;
+    m_sizerPage = NULL;
+    m_border = 5;
+    m_started = false;
+    m_wasModal = false;
+    m_usingSizer = false;
+    m_bitmapBackgroundColour = *wxWHITE;
+    m_bitmapPlacement = 0;
+    m_bitmapMinimumWidth = 115;
+}

 
 

-    wxASSERT_MSG( page != (size_t)m_page, _T("this is useless") );
+bool wxWizard::Create(wxWindow *parent,
+                      int id,
+                      const wxString& title,
+                      const wxBitmap& bitmap,
+                      const wxPoint& pos,
+                      long style)
+{
+    bool result = wxDialog::Create(parent,id,title,pos,wxDefaultSize,style);

 
 

-    size_t last = m_pages.GetCount() - 1;
-    bool mustChangeNextBtnLabel = (size_t)m_page == last || page == last;
+    m_posWizard = pos;
+    m_bitmap = bitmap ;

 
 

-    if ( m_page != -1 )
-    {
-        wxPanel *panel = DoGetCurrentPage();
-        if ( !panel->TransferDataFromWindow() )
-            return FALSE;
+    DoCreateControls();
+
+    return result;
+}

 
 

-        panel->Hide();
+wxWizard::~wxWizard()
+{
+    // normally we don't have to delete this sizer as it's deleted by the
+    // associated window but if we never used it or didn't set it as the window
+    // sizer yet, do delete it manually
+    if ( !m_usingSizer || !m_started )
+        delete m_sizerPage;
+}
+
+void wxWizard::AddBitmapRow(wxBoxSizer *mainColumn)
+{
+    m_sizerBmpAndPage = new wxBoxSizer(wxHORIZONTAL);
+    mainColumn->Add(
+        m_sizerBmpAndPage,
+        1, // Vertically stretchable
+        wxEXPAND // Horizonal stretching, no border
+    );
+    mainColumn->Add(0,5,
+        0, // No vertical stretching
+        wxEXPAND // No border, (mostly useless) horizontal stretching
+    );
+
+#if wxUSE_STATBMP
+    if ( m_bitmap.Ok() )
+    {
+        wxSize bitmapSize(wxDefaultSize);
+        if (GetBitmapPlacement())
+            bitmapSize.x = GetMinimumBitmapWidth();
+
+        m_statbmp = new wxStaticBitmap(this, wxID_ANY, m_bitmap, wxDefaultPosition, bitmapSize);
+        m_sizerBmpAndPage->Add(
+            m_statbmp,
+            0, // No horizontal stretching
+            wxALL, // Border all around, top alignment
+            5 // Border width
+        );
+        m_sizerBmpAndPage->Add(
+            5,0,
+            0, // No horizontal stretching
+            wxEXPAND // No border, (mostly useless) vertical stretching
+        );

     }
     }

+#endif

 
 

-    m_page = page;
-    DoGetCurrentPage()->Show();
+    // Added to m_sizerBmpAndPage later
+    m_sizerPage = new wxWizardSizer(this);
+}

 
 

-    // update the buttons state
-    m_btnPrev->Enable(m_page != 0);
-    if ( mustChangeNextBtnLabel )
+void wxWizard::AddStaticLine(wxBoxSizer *mainColumn)
+{
+#if wxUSE_STATLINE
+    mainColumn->Add(
+        new wxStaticLine(this, wxID_ANY),
+        0, // Vertically unstretchable
+        wxEXPAND | wxALL, // Border all around, horizontally stretchable
+        5 // Border width
+    );
+    mainColumn->Add(0,5,
+        0, // No vertical stretching
+        wxEXPAND // No border, (mostly useless) horizontal stretching
+    );
+#else
+    (void)mainColumn;
+#endif // wxUSE_STATLINE
+}
+
+void wxWizard::AddBackNextPair(wxBoxSizer *buttonRow)
+{
+    wxASSERT_MSG( m_btnNext && m_btnPrev,
+                  _T("You must create the buttons before calling ")
+                  _T("wxWizard::AddBackNextPair") );
+
+    // margin between Back and Next buttons
+#ifdef __WXMAC__
+    static const int BACKNEXT_MARGIN = 10;
+#else
+    static const int BACKNEXT_MARGIN = 0;
+#endif
+
+    wxBoxSizer *backNextPair = new wxBoxSizer(wxHORIZONTAL);
+    buttonRow->Add(
+        backNextPair,
+        0, // No horizontal stretching
+        wxALL, // Border all around
+        5 // Border width
+    );
+
+    backNextPair->Add(m_btnPrev);
+    backNextPair->Add(BACKNEXT_MARGIN,0,
+        0, // No horizontal stretching
+        wxEXPAND // No border, (mostly useless) vertical stretching
+    );
+    backNextPair->Add(m_btnNext);
+}
+
+void wxWizard::AddButtonRow(wxBoxSizer *mainColumn)
+{
+    // the order in which the buttons are created determines the TAB order - at least under MSWindows...
+    // although the 'back' button appears before the 'next' button, a more userfriendly tab order is
+    // to activate the 'next' button first (create the next button before the back button).
+    // The reason is: The user will repeatedly enter information in the wizard pages and then wants to
+    // press 'next'. If a user uses mostly the keyboard, he would have to skip the 'back' button
+    // everytime. This is annoying. There is a second reason: RETURN acts as TAB. If the 'next'
+    // button comes first in the TAB order, the user can enter information very fast using the RETURN
+    // key to TAB to the next entry field and page. This would not be possible, if the 'back' button
+    // was created before the 'next' button.
+
+    bool isPda = (wxSystemSettings::GetScreenType() <= wxSYS_SCREEN_PDA);
+    int buttonStyle = isPda ? wxBU_EXACTFIT : 0;
+
+    wxBoxSizer *buttonRow = new wxBoxSizer(wxHORIZONTAL);
+#ifdef __WXMAC__
+    if (GetExtraStyle() & wxWIZARD_EX_HELPBUTTON)
+        mainColumn->Add(
+            buttonRow,
+            0, // Vertically unstretchable
+            wxGROW|wxALIGN_CENTRE
+            );
+    else
+#endif
+    mainColumn->Add(
+        buttonRow,
+        0, // Vertically unstretchable
+        wxALIGN_RIGHT // Right aligned, no border
+    );
+
+    // Desired TAB order is 'next', 'cancel', 'help', 'back'. This makes the 'back' button the last control on the page.
+    // Create the buttons in the right order...
+    wxButton *btnHelp=0;
+#ifdef __WXMAC__
+    if (GetExtraStyle() & wxWIZARD_EX_HELPBUTTON)
+        btnHelp=new wxButton(this, wxID_HELP, _("&Help"), wxDefaultPosition, wxDefaultSize, buttonStyle);
+#endif
+
+    m_btnNext = new wxButton(this, wxID_FORWARD, _("&Next >"));
+    wxButton *btnCancel=new wxButton(this, wxID_CANCEL, _("&Cancel"), wxDefaultPosition, wxDefaultSize, buttonStyle);
+#ifndef __WXMAC__
+    if (GetExtraStyle() & wxWIZARD_EX_HELPBUTTON)
+        btnHelp=new wxButton(this, wxID_HELP, _("&Help"), wxDefaultPosition, wxDefaultSize, buttonStyle);
+#endif
+    m_btnPrev = new wxButton(this, wxID_BACKWARD, _("< &Back"), wxDefaultPosition, wxDefaultSize, buttonStyle);
+
+    if (btnHelp)

     {
     {

-        m_btnNext->SetLabel((size_t)m_page == last ? _("&Finish")
-                                                   : _("&Next >"));
+        buttonRow->Add(
+            btnHelp,
+            0, // Horizontally unstretchable
+            wxALL, // Border all around, top aligned
+            5 // Border width
+            );
+#ifdef __WXMAC__
+        // Put stretchable space between help button and others
+        buttonRow->Add(0, 0, 1, wxALIGN_CENTRE, 0);
+#endif

     }
 
     }
 

-    return TRUE;
+    AddBackNextPair(buttonRow);
+
+    buttonRow->Add(
+        btnCancel,
+        0, // Horizontally unstretchable
+        wxALL, // Border all around, top aligned
+        5 // Border width
+    );
+}
+
+void wxWizard::DoCreateControls()
+{
+    // do nothing if the controls were already created
+    if ( WasCreated() )
+        return;
+
+    bool isPda = (wxSystemSettings::GetScreenType() <= wxSYS_SCREEN_PDA);
+
+    // Horizontal stretching, and if not PDA, border all around
+    int mainColumnSizerFlags = isPda ? wxEXPAND : wxALL|wxEXPAND ;
+
+    // wxWindow::SetSizer will be called at end
+    wxBoxSizer *windowSizer = new wxBoxSizer(wxVERTICAL);
+
+    wxBoxSizer *mainColumn = new wxBoxSizer(wxVERTICAL);
+    windowSizer->Add(
+        mainColumn,
+        1, // Vertical stretching
+        mainColumnSizerFlags,
+        5 // Border width
+    );
+
+    AddBitmapRow(mainColumn);
+
+    if (!isPda)
+        AddStaticLine(mainColumn);
+
+    AddButtonRow(mainColumn);
+
+    SetSizer(windowSizer);

 }
 
 }
 

-void wxWizardGeneric::DoAddPage(wxPanel *page)
+void wxWizard::SetPageSize(const wxSize& size)

 {
 {

-    page->Hide();
-    page->SetSize(m_x, m_y, m_width, m_height);
+    wxCHECK_RET(!m_started, wxT("wxWizard::SetPageSize after RunWizard"));
+    m_sizePage = size;

 }
 
 }
 

-void wxWizardGeneric::AddPage(wxPanel *page)
+void wxWizard::FitToPage(const wxWizardPage *page)

 {
 {

-    m_pages.Add(page);
+    wxCHECK_RET(!m_started, wxT("wxWizard::FitToPage after RunWizard"));

 
 

-    DoAddPage(page);
+    while ( page )
+    {
+        wxSize size = page->GetBestSize();
+
+        m_sizePage.IncTo(size);
+
+        page = page->GetNext();
+    }

 }
 
 }
 

-void wxWizardGeneric::InsertPage(int nPage, wxPanel *page)
+bool wxWizard::ShowPage(wxWizardPage *page, bool goingForward)

 {
 {

-    m_pages.Insert(page, nPage);
-    if ( nPage < m_page )
+    wxASSERT_MSG( page != m_page, wxT("this is useless") );
+
+    wxSizerFlags flags(1);
+    flags.Border(wxALL, m_border).Expand();
+
+    if ( !m_started )

     {
     {

-        // the indices of all pages after the inserted one are shifted by 1
-        m_page++;
+        if ( m_usingSizer )
+        {
+            m_sizerBmpAndPage->Add(m_sizerPage, flags);
+
+            // now that our layout is computed correctly, hide the pages
+            // artificially shown in wxWizardSizer::Insert() back again
+            m_sizerPage->HidePages();
+        }

     }
 
     }
 

-    DoAddPage(page);
+
+    // remember the old bitmap (if any) to compare with the new one later
+    wxBitmap bmpPrev;
+
+    // check for previous page
+    if ( m_page )
+    {
+        // send the event to the old page
+        wxWizardEvent event(wxEVT_WIZARD_PAGE_CHANGING, GetId(),
+                            goingForward, m_page);
+        if ( m_page->GetEventHandler()->ProcessEvent(event) &&
+             !event.IsAllowed() )
+        {
+            // vetoed by the page
+            return false;
+        }
+
+        m_page->Hide();
+
+        bmpPrev = m_page->GetBitmap();
+
+        if ( !m_usingSizer )
+            m_sizerBmpAndPage->Detach(m_page);
+    }
+
+    // set the new page
+    m_page = page;
+
+    // is this the end?
+    if ( !m_page )
+    {
+        // terminate successfully
+        if ( IsModal() )
+        {
+            EndModal(wxID_OK);
+        }
+        else
+        {
+            SetReturnCode(wxID_OK);
+            Hide();
+        }
+
+        // and notify the user code (this is especially useful for modeless
+        // wizards)
+        wxWizardEvent event(wxEVT_WIZARD_FINISHED, GetId(), false, 0);
+        (void)GetEventHandler()->ProcessEvent(event);
+
+        return true;
+    }
+
+    // position and show the new page
+    (void)m_page->TransferDataToWindow();
+
+    if ( m_usingSizer )
+    {
+        // wxWizardSizer::RecalcSizes wants to be called when m_page changes
+        m_sizerPage->RecalcSizes();
+    }
+    else // pages are not managed by the sizer
+    {
+        m_sizerBmpAndPage->Add(m_page, flags);
+        m_sizerBmpAndPage->SetItemMinSize(m_page, GetPageSize());
+    }
+
+#if wxUSE_STATBMP
+    // update the bitmap if:it changed
+    wxBitmap bmp;
+    if ( m_statbmp )
+    {
+        bmp = m_page->GetBitmap();
+        if ( !bmp.Ok() )
+            bmp = m_bitmap;
+
+        if ( !bmpPrev.Ok() )
+            bmpPrev = m_bitmap;
+
+        if (!GetBitmapPlacement())
+        {
+            if ( !bmp.IsSameAs(bmpPrev) )
+                m_statbmp->SetBitmap(bmp);
+        }
+    }
+#endif // wxUSE_STATBMP
+
+
+    // and update the buttons state
+    m_btnPrev->Enable(HasPrevPage(m_page));
+
+    const bool hasNext = HasNextPage(m_page);
+    const wxString label = hasNext ? _("&Next >") : _("&Finish");
+    if ( label != m_btnNext->GetLabel() )
+        m_btnNext->SetLabel(label);
+
+    m_btnNext->SetDefault();
+
+
+    // send the change event to the new page now
+    wxWizardEvent event(wxEVT_WIZARD_PAGE_CHANGED, GetId(), goingForward, m_page);
+    (void)m_page->GetEventHandler()->ProcessEvent(event);
+
+    // and finally show it
+    m_page->Show();
+    m_page->SetFocus();
+
+    if ( !m_usingSizer )
+        m_sizerBmpAndPage->Layout();
+
+    if ( !m_started )
+    {
+        m_started = true;
+
+        DoWizardLayout();
+    }
+
+    if (GetBitmapPlacement() && m_statbmp)
+    {
+        ResizeBitmap(bmp);
+
+        if ( !bmp.IsSameAs(bmpPrev) )
+            m_statbmp->SetBitmap(bmp);
+
+        if (m_usingSizer)
+            m_sizerPage->RecalcSizes();
+    }
+
+    return true;

 }
 
 }
 

-bool wxWizardGeneric::RunWizard()
+/// Do fit, and adjust to screen size if necessary
+void wxWizard::DoWizardLayout()

 {
 {

-    wxCHECK_MSG( m_pages.GetCount() != 0, FALSE, _T("can't run empty wizard") );
+    if ( wxSystemSettings::GetScreenType() > wxSYS_SCREEN_PDA )
+    {
+        if (CanDoLayoutAdaptation())
+            DoLayoutAdaptation();
+        else
+            GetSizer()->SetSizeHints(this);

 
 

-    // can't return FALSE here because there is no old page
-    (void)ShowPage(0u);
+        if ( m_posWizard == wxDefaultPosition )
+            CentreOnScreen();
+    }
+
+    SetLayoutAdaptationDone(true);
+}
+
+bool wxWizard::RunWizard(wxWizardPage *firstPage)
+{
+    wxCHECK_MSG( firstPage, false, wxT("can't run empty wizard") );
+
+    // can't return false here because there is no old page
+    (void)ShowPage(firstPage, true /* forward */);
+
+    m_wasModal = true;

 
     return ShowModal() == wxID_OK;
 }
 
 
     return ShowModal() == wxID_OK;
 }
 

-wxPanel *wxWizardGeneric::GetCurrentPage() const
+wxWizardPage *wxWizard::GetCurrentPage() const
+{
+    return m_page;
+}
+
+wxSize wxWizard::GetPageSize() const
+{
+    // default width and height of the page
+    int DEFAULT_PAGE_WIDTH,
+        DEFAULT_PAGE_HEIGHT;
+    if ( wxSystemSettings::GetScreenType() <= wxSYS_SCREEN_PDA )
+    {
+        // Make the default page size small enough to fit on screen
+        DEFAULT_PAGE_WIDTH = wxSystemSettings::GetMetric(wxSYS_SCREEN_X) / 2;
+        DEFAULT_PAGE_HEIGHT = wxSystemSettings::GetMetric(wxSYS_SCREEN_Y) / 2;
+    }
+    else // !PDA
+    {
+        DEFAULT_PAGE_WIDTH =
+        DEFAULT_PAGE_HEIGHT = 270;
+    }
+
+    // start with default minimal size
+    wxSize pageSize(DEFAULT_PAGE_WIDTH, DEFAULT_PAGE_HEIGHT);
+
+    // make the page at least as big as specified by user
+    pageSize.IncTo(m_sizePage);
+
+    if ( m_statbmp )
+    {
+        // make the page at least as tall as the bitmap
+        pageSize.IncTo(wxSize(0, m_bitmap.GetHeight()));
+    }
+
+    if ( m_usingSizer )
+    {
+        // make it big enough to contain all pages added to the sizer
+        pageSize.IncTo(m_sizerPage->GetMaxChildSize());
+    }
+
+    return pageSize;
+}
+
+wxSizer *wxWizard::GetPageAreaSizer() const
+{
+    return m_sizerPage;
+}
+
+void wxWizard::SetBorder(int border)

 {
 {

-    return IsRunning() ? DoGetCurrentPage() : (wxPanel *)NULL;
+    wxCHECK_RET(!m_started, wxT("wxWizard::SetBorder after RunWizard"));
+
+    m_border = border;

 }
 
 }
 

-void wxWizardGeneric::OnCancel(wxCommandEvent& WXUNUSED(event))
+void wxWizard::OnCancel(wxCommandEvent& WXUNUSED(eventUnused))

 {
 {

-    wxWizardEvent event(wxEVT_WIZARD_CANCEL, GetId());
-    if ( !GetEventHandler()->ProcessEvent(event) || event.IsAllowed() )
+    // this function probably can never be called when we don't have an active
+    // page, but a small extra check won't hurt
+    wxWindow *win = m_page ? (wxWindow *)m_page : (wxWindow *)this;
+
+    wxWizardEvent event(wxEVT_WIZARD_CANCEL, GetId(), false, m_page);
+    if ( !win->GetEventHandler()->ProcessEvent(event) || event.IsAllowed() )

     {
         // no objections - close the dialog
     {
         // no objections - close the dialog

-        EndModal(wxID_CANCEL);
+        if(IsModal())
+        {
+            EndModal(wxID_CANCEL);
+        }
+        else
+        {
+            SetReturnCode(wxID_CANCEL);
+            Hide();
+        }

     }
     //else: request to Cancel ignored
 }
 
     }
     //else: request to Cancel ignored
 }
 

-void wxWizardGeneric::OnBackOrNext(wxCommandEvent& event)
+void wxWizard::OnBackOrNext(wxCommandEvent& event)

 {
     wxASSERT_MSG( (event.GetEventObject() == m_btnNext) ||
                   (event.GetEventObject() == m_btnPrev),
 {
     wxASSERT_MSG( (event.GetEventObject() == m_btnNext) ||
                   (event.GetEventObject() == m_btnPrev),

-                  _T("unknown button") );
+                  wxT("unknown button") );

 
 

-    int delta = event.GetEventObject() == m_btnNext ? 1 : -1;
-    int page = m_page + delta;
+    wxCHECK_RET( m_page, _T("should have a valid current page") );

 
 

-    wxASSERT_MSG( page >= 0, _T("'Back' button should have been disabled!") );
+    // ask the current page first: notice that we do it before calling
+    // GetNext/Prev() because the data transfered from the controls of the page
+    // may change the value returned by these methods
+    if ( !m_page->Validate() || !m_page->TransferDataFromWindow() )
+    {
+        // the page data is incorrect, don't do anything
+        return;
+    }

 
 

-    if ( (size_t)page == m_pages.GetCount() )
+    bool forward = event.GetEventObject() == m_btnNext;
+
+    wxWizardPage *page;
+    if ( forward )
+    {
+        page = m_page->GetNext();
+    }
+    else // back

     {
     {

-        // check that we have valid data in the last page too
-        if ( m_pages.Last()->TransferDataFromWindow() )
+        page = m_page->GetPrev();
+
+        wxASSERT_MSG( page, wxT("\"<Back\" button should have been disabled") );
+    }
+
+    // just pass to the new page (or maybe not - but we don't care here)
+    (void)ShowPage(page, forward);
+}
+
+void wxWizard::OnHelp(wxCommandEvent& WXUNUSED(event))
+{
+    // this function probably can never be called when we don't have an active
+    // page, but a small extra check won't hurt
+    if(m_page != NULL)
+    {
+        // Create and send the help event to the specific page handler
+        // event data contains the active page so that context-sensitive
+        // help is possible
+        wxWizardEvent eventHelp(wxEVT_WIZARD_HELP, GetId(), true, m_page);
+        (void)m_page->GetEventHandler()->ProcessEvent(eventHelp);
+    }
+}
+
+void wxWizard::OnWizEvent(wxWizardEvent& event)
+{
+    // the dialogs have wxWS_EX_BLOCK_EVENTS style on by default but we want to
+    // propagate wxEVT_WIZARD_XXX to the parent (if any), so do it manually
+    if ( !(GetExtraStyle() & wxWS_EX_BLOCK_EVENTS) )
+    {
+        // the event will be propagated anyhow
+        event.Skip();
+    }
+    else
+    {
+        wxWindow *parent = GetParent();
+
+        if ( !parent || !parent->GetEventHandler()->ProcessEvent(event) )

         {
         {

-            // that's all, folks!
-            EndModal(wxID_OK);
+            event.Skip();

         }
     }
         }
     }

-    else
+
+    if ( ( !m_wasModal ) &&
+         event.IsAllowed() &&
+         ( event.GetEventType() == wxEVT_WIZARD_FINISHED ||
+           event.GetEventType() == wxEVT_WIZARD_CANCEL
+         )
+       )

     {
     {

-        // just pass to the next page (or may be not - but we don't care here)
-        (void)ShowPage(page);
+        Destroy();

     }
 }
 
     }
 }
 

-// ----------------------------------------------------------------------------
-// our public interface
-// ----------------------------------------------------------------------------
-
-/* static */ wxWizard *wxWizard::Create(wxWindow *parent,
-                                        int id,
-                                        const wxString& title,
-                                        const wxBitmap& bitmap,
-                                        const wxPoint& pos,
-                                        const wxSize& size)
+void wxWizard::SetBitmap(const wxBitmap& bitmap)

 {
 {

-    return new wxWizardGeneric(parent, id, title, bitmap, pos, size);
+    m_bitmap = bitmap;
+    if (m_statbmp)
+        m_statbmp->SetBitmap(m_bitmap);

 }
 
 // ----------------------------------------------------------------------------
 // wxWizardEvent
 // ----------------------------------------------------------------------------
 
 }
 
 // ----------------------------------------------------------------------------
 // wxWizardEvent
 // ----------------------------------------------------------------------------
 

-wxWizardEvent::wxWizardEvent(wxEventType type, int id)
+wxWizardEvent::wxWizardEvent(wxEventType type, int id, bool direction, wxWizardPage* page)

              : wxNotifyEvent(type, id)
 {
              : wxNotifyEvent(type, id)
 {

-    m_page = m_pageOld = -1;
+    // Modified 10-20-2001 Robert Cavanaugh
+    // add the active page to the event data
+    m_direction = direction;
+    m_page = page;

 }
 }

+
+/// Do the adaptation
+bool wxWizard::DoLayoutAdaptation()
+{
+    wxWindowList windows;
+    wxWindowList pages;
+
+    // Make all the pages (that use sizers) scrollable
+    for ( wxSizerItemList::compatibility_iterator node = m_sizerPage->GetChildren().GetFirst(); node; node = node->GetNext() )
+    {
+        wxSizerItem * const item = node->GetData();
+        if ( item->IsWindow() )
+        {
+            wxWizardPage* page = wxDynamicCast(item->GetWindow(), wxWizardPage);
+            if (page)
+            {
+                while (page)
+                {
+                    if (!pages.Find(page) && page->GetSizer())
+                    {
+                        // Create a scrolled window and reparent
+                        wxScrolledWindow* scrolledWindow = new wxScrolledWindow(page, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxTAB_TRAVERSAL|wxVSCROLL|wxHSCROLL|wxBORDER_NONE);
+                        wxSizer* oldSizer = page->GetSizer();
+
+                        wxSizer* newSizer = new wxBoxSizer(wxVERTICAL);
+                        newSizer->Add(scrolledWindow,1, wxEXPAND, 0);
+
+                        page->SetSizer(newSizer, false /* don't delete the old sizer */);
+
+                        scrolledWindow->SetSizer(oldSizer);
+
+                        wxStandardDialogLayoutAdapter::DoReparentControls(page, scrolledWindow);
+
+                        pages.Append(page);
+                        windows.Append(scrolledWindow);
+                    }
+                    page = page->GetNext();
+                }
+            }
+        }
+    }
+
+    wxStandardDialogLayoutAdapter::DoFitWithScrolling(this, windows);
+
+    // Size event doesn't get sent soon enough on wxGTK
+    DoLayout();
+    
+    SetLayoutAdaptationDone(true);
+
+    return true;
+}
+
+bool wxWizard::ResizeBitmap(wxBitmap& bmp)
+{
+    if (!GetBitmapPlacement())
+        return false;
+
+    if (bmp.Ok())
+    {
+        wxSize pageSize = m_sizerPage->GetSize();
+        if (pageSize == wxSize(0,0))
+            pageSize = GetPageSize();
+        int bitmapWidth = wxMax(bmp.GetWidth(), GetMinimumBitmapWidth());
+        int bitmapHeight = pageSize.y;
+
+        if (!m_statbmp->GetBitmap().Ok() || m_statbmp->GetBitmap().GetHeight() != bitmapHeight)
+        {
+            wxBitmap bitmap(bitmapWidth, bitmapHeight);
+            {
+                wxMemoryDC dc;
+                dc.SelectObject(bitmap);
+                dc.SetBackground(wxBrush(m_bitmapBackgroundColour));
+                dc.Clear();
+
+                if (GetBitmapPlacement() & wxWIZARD_TILE)
+                {
+                    TileBitmap(wxRect(0, 0, bitmapWidth, bitmapHeight), dc, bmp);
+                }
+                else
+                {
+                    int x, y;
+
+                    if (GetBitmapPlacement() & wxWIZARD_HALIGN_LEFT)
+                        x = 0;
+                    else if (GetBitmapPlacement() & wxWIZARD_HALIGN_RIGHT)
+                        x = bitmapWidth - bmp.GetWidth();
+                    else
+                        x = (bitmapWidth - bmp.GetWidth())/2;
+
+                    if (GetBitmapPlacement() & wxWIZARD_VALIGN_TOP)
+                        y = 0;
+                    else if (GetBitmapPlacement() & wxWIZARD_VALIGN_BOTTOM)
+                        y = bitmapHeight - bmp.GetHeight();
+                    else
+                        y = (bitmapHeight - bmp.GetHeight())/2;
+
+                    dc.DrawBitmap(bmp, x, y, true);
+                    dc.SelectObject(wxNullBitmap);
+                }
+            }
+
+            bmp = bitmap;
+        }
+    }
+
+    return true;
+}
+
+bool wxWizard::TileBitmap(const wxRect& rect, wxDC& dc, const wxBitmap& bitmap)
+{
+    int w = bitmap.GetWidth();
+    int h = bitmap.GetHeight();
+
+    wxMemoryDC dcMem;
+
+    dcMem.SelectObjectAsSource(bitmap);
+
+    int i, j;
+    for (i = rect.x; i < rect.x + rect.width; i += w)
+    {
+        for (j = rect.y; j < rect.y + rect.height; j+= h)
+            dc.Blit(i, j, bitmap.GetWidth(), bitmap.GetHeight(), & dcMem, 0, 0);
+    }
+    dcMem.SelectObject(wxNullBitmap);
+
+    return true;
+}
+
+#endif // wxUSE_WIZARDDLG