// Name: generic/wizard.cpp
// 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>
-// Licence: wxWindows license
+// Licence: wxWindows licence
///////////////////////////////////////////////////////////////////////////////
// ============================================================================
// headers
// ----------------------------------------------------------------------------
-#ifdef __GNUG__
- #pragma implementation ".h"
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
+ #pragma implementation "wizardg.h"
#endif
// For compilers that support precompilation, includes "wx.h".
#pragma hdrstop
#endif
+#if wxUSE_WIZARDDLG
+
#ifndef WX_PRECOMP
#include "wx/dynarray.h"
#include "wx/intl.h"
#include "wx/statbmp.h"
+ #include "wx/button.h"
#endif //WX_PRECOMP
#include "wx/statline.h"
+#include "wx/sizer.h"
#include "wx/wizard.h"
// ----------------------------------------------------------------------------
-// simple types
-// ----------------------------------------------------------------------------
-
-WX_DEFINE_ARRAY(wxPanel *, wxArrayPages);
-
-// ----------------------------------------------------------------------------
-// wxWizardGeneric - generic implementation of wxWizard
+// wxWizardSizer
// ----------------------------------------------------------------------------
-class wxWizardGeneric : public wxWizard
+class wxWizardSizer : public wxSizer
{
public:
- // ctor
- wxWizardGeneric(wxWindow *parent,
- int id,
- const wxString& title,
- const wxBitmap& bitmap,
- const wxPoint& pos,
- const wxSize& size);
-
- // implement base class pure virtuals
- virtual void AddPage(wxPanel *page);
- virtual void InsertPage(int nPage, wxPanel *page);
- virtual bool RunWizard();
- virtual wxPanel *GetCurrentPage() const;
-
- // implementation only from now on
- // -------------------------------
-
- // is the wizard running?
- bool IsRunning() const { return m_page != -1; }
-
- // 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);
-
- // get the current page assuming the wizard is running
- wxPanel *DoGetCurrentPage() const
- {
- wxASSERT_MSG( IsRunning(), _T("no current page!") );
+ wxWizardSizer(wxWizard *owner);
- return m_pages[(size_t)m_page];
- }
-
- // place the given page correctly and hide it
- void DoAddPage(wxPanel *page);
+ void RecalcSizes();
+ wxSize CalcMin();
+ wxSize GetMaxChildSize();
+ int Border() const;
+
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
-
- // wizard controls
- wxButton *m_btnPrev, // the "<Back" button
- *m_btnNext; // the "Next>" or "Finish" button
-
- DECLARE_EVENT_TABLE()
+ wxSize SiblingSize(wxSizerItem *child);
+
+ wxWizard *m_owner;
+ bool m_childSizeValid;
+ wxSize m_childSize;
};
// ----------------------------------------------------------------------------
// event tables and such
// ----------------------------------------------------------------------------
-BEGIN_EVENT_TABLE(wxWizardGeneric, wxDialog)
- EVT_BUTTON(wxID_CANCEL, wxWizardGeneric::OnCancel)
- EVT_BUTTON(-1, wxWizardGeneric::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(-1, wxWizard::OnWizEvent)
+ EVT_WIZARD_PAGE_CHANGING(-1, wxWizard::OnWizEvent)
+ EVT_WIZARD_CANCEL(-1, wxWizard::OnWizEvent)
+ EVT_WIZARD_FINISHED(-1, wxWizard::OnWizEvent)
+ EVT_WIZARD_HELP(-1, wxWizard::OnWizEvent)
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)
// ============================================================================
// ============================================================================
// ----------------------------------------------------------------------------
-// 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,
+ const wxChar *resource)
+{
+ Create(parent, bitmap, resource);
+}
- // margin between the bitmap and the panel
- static const int BITMAP_X_MARGIN = 15;
+bool wxWizardPage::Create(wxWizard *parent,
+ const wxBitmap& bitmap,
+ const wxChar *resource)
+{
+ if ( !wxPanel::Create(parent, -1) )
+ return FALSE;
- // margin between the bitmap and the static line
- static const int BITMAP_Y_MARGIN = 15;
+ if ( resource != NULL )
+ {
+#if wxUSE_WX_RESOURCES
+#if 0
+ if ( !LoadFromResource(this, resource) )
+ {
+ wxFAIL_MSG(wxT("wxWizardPage LoadFromResource failed!!!!"));
+ }
+#endif
+#endif // wxUSE_RESOURCES
+ }
- // margin between the static line and the buttons
- static const int SEPARATOR_LINE_MARGIN = 15;
+ m_bitmap = bitmap;
- // margin between "Next >" and "Cancel" buttons
- static const int BUTTON_MARGIN = 10;
+ // initially the page is hidden, it's shown only when it becomes current
+ Hide();
- // default width and height of the page
- static const int DEFAULT_PAGE_WIDTH = 270;
- static const int DEFAULT_PAGE_HEIGHT = 290;
+ return TRUE;
+}
+
+// ----------------------------------------------------------------------------
+// wxWizardPageSimple
+// ----------------------------------------------------------------------------
+
+wxWizardPage *wxWizardPageSimple::GetPrev() const
+{
+ return m_prev;
+}
+
+wxWizardPage *wxWizardPageSimple::GetNext() const
+{
+ return m_next;
+}
+
+// ----------------------------------------------------------------------------
+// wxWizardSizer
+// ----------------------------------------------------------------------------
- // init members
- // ------------
+wxWizardSizer::wxWizardSizer(wxWizard *owner)
+ : m_owner(owner)
+{
+ m_childSizeValid = false;
+}
- m_page = -1;
+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_owner->m_page->SetSize(m_position.x,m_position.y, m_size.x,m_size.y);
+ }
+}
- // create controls
- // ---------------
+wxSize wxWizardSizer::CalcMin()
+{
+ return m_owner->GetPageSize();
+}
- wxSize sizeBtn = wxButton::GetDefaultSize();
+wxSize wxWizardSizer::GetMaxChildSize()
+{
+#if !defined(__WXDEBUG__)
+ if ( m_childSizeValid )
+ return m_childSize;
+#endif
- (void)wxDialog::Create(parent, id, title, pos, size);
+ wxSize maxOfMin;
+ wxSizerItemList::compatibility_iterator childNode;
- // 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() )
+ for(childNode = m_children.GetFirst(); childNode;
+ childNode = childNode->GetNext())
{
- (void)new wxStaticBitmap(this, -1, bitmap, wxPoint(m_x, m_y));
+ wxSizerItem *child = childNode->GetData();
+ maxOfMin.IncTo(child->CalcMin());
+ maxOfMin.IncTo(SiblingSize(child));
+ }
- m_x += bitmap.GetWidth() + BITMAP_X_MARGIN;
- m_height = bitmap.GetHeight();
+#ifdef __WXDEBUG__
+ if ( m_childSizeValid && 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?")) ;
+
+ return m_childSize;
}
- else
+#endif // __WXDEBUG__
+
+ if ( m_owner->m_started )
{
- m_height = DEFAULT_PAGE_HEIGHT;
+ m_childSizeValid = true;
+ m_childSize = maxOfMin;
}
+
+ return maxOfMin;
+}
- m_width = DEFAULT_PAGE_WIDTH;
+int wxWizardSizer::Border() const
+{
+ if ( m_owner->m_calledSetBorder )
+ return m_owner->m_border;
- 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));
+ return m_children.IsEmpty() ? 5 : 0;
+}
- 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 wxWizardSizer::SiblingSize(wxSizerItem *child)
+{
+ wxSize maxSibling;
+
+ if ( child->IsWindow() )
+ {
+ 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;
+}
- x += sizeBtn.x;
- m_btnNext = new wxButton(this, -1, _("&Next >"), wxPoint(x, y), sizeBtn);
+// ----------------------------------------------------------------------------
+// generic wxWizard implementation
+// ----------------------------------------------------------------------------
- x += sizeBtn.x + BUTTON_MARGIN;
- (void)new wxButton(this, wxID_CANCEL, _("Cancel"), wxPoint(x, y), sizeBtn);
+void wxWizard::Init()
+{
+ m_posWizard = wxDefaultPosition;
+ m_page = (wxWizardPage *)NULL;
+ m_btnPrev = m_btnNext = NULL;
+ m_statbmp = NULL;
+ m_sizerBmpAndPage = NULL;
+ m_sizerPage = NULL;
+ m_calledSetBorder = false;
+ m_border = 0;
+ m_started = false;
+}
- // position and size the dialog
- // ----------------------------
+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);
+
+ m_posWizard = pos;
+ m_bitmap = bitmap ;
+
+ DoCreateControls();
+
+ return result;
+}
- if ( size == wxDefaultSize )
+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() )
{
- SetClientSize(m_x + m_width + X_MARGIN,
- m_y + m_height + BITMAP_Y_MARGIN +
- SEPARATOR_LINE_MARGIN + sizeBtn.y + Y_MARGIN);
+ m_statbmp = new wxStaticBitmap(this, -1, m_bitmap);
+ 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
+
+ // Added to m_sizerBmpAndPage in FinishLayout
+ m_sizerPage = new wxWizardSizer(this);
+}
+
+void wxWizard::AddStaticLine(wxBoxSizer *mainColumn)
+{
+#if wxUSE_STATLINE
+ mainColumn->Add(
+ new wxStaticLine(this, -1),
+ 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.
+
+ wxBoxSizer *buttonRow = new wxBoxSizer(wxHORIZONTAL);
+ 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...
+ m_btnNext = new wxButton(this, wxID_FORWARD, _("&Next >"));
+ wxButton *btnCancel=new wxButton(this, wxID_CANCEL, _("&Cancel"));
+ wxButton *btnHelp=0;
+ if (GetExtraStyle() & wxWIZARD_EX_HELPBUTTON)
+ btnHelp=new wxButton(this, wxID_HELP, _("&Help"));
+ m_btnPrev = new wxButton(this, wxID_BACKWARD, _("< &Back"));
+
+ if (btnHelp)
+ buttonRow->Add(
+ btnHelp,
+ 0, // Horizontally unstretchable
+ wxALL, // Border all around, top aligned
+ 5 // Border width
+ );
+
+ AddBackNextPair(buttonRow);
+
+ buttonRow->Add(
+ btnCancel,
+ 0, // Horizontally unstretchable
+ wxALL, // Border all around, top aligned
+ 5 // Border width
+ );
+}
- if ( pos == wxDefaultPosition )
+void wxWizard::DoCreateControls()
+{
+ // do nothing if the controls were already created
+ if ( WasCreated() )
+ return;
+
+ // wxWindow::SetSizer will be called at end
+ wxBoxSizer *windowSizer = new wxBoxSizer(wxVERTICAL);
+
+ wxBoxSizer *mainColumn = new wxBoxSizer(wxVERTICAL);
+ windowSizer->Add(
+ mainColumn,
+ 1, // Vertical stretching
+ wxALL | wxEXPAND, // Border all around, horizontal stretching
+ 5 // Border width
+ );
+
+ AddBitmapRow(mainColumn);
+ AddStaticLine(mainColumn);
+ AddButtonRow(mainColumn);
+
+ // wxWindow::SetSizer should be followed by wxWindow::Fit, but
+ // this is done in FinishLayout anyway so why duplicate it
+ SetSizer(windowSizer);
+}
+
+void wxWizard::SetPageSize(const wxSize& size)
+{
+ wxCHECK_RET(!m_started,wxT("wxWizard::SetPageSize after RunWizard"));
+ m_sizePage = size;
+}
+
+void wxWizard::FinishLayout()
+{
+ m_sizerBmpAndPage->Add(
+ m_sizerPage,
+ 1, // Horizontal stretching
+ wxEXPAND | wxALL, // Vertically stretchable
+ m_sizerPage->Border()
+ );
+
+ GetSizer()->SetSizeHints(this);
+ if ( m_posWizard == wxDefaultPosition )
+ CentreOnScreen();
+}
+
+void wxWizard::FitToPage(const wxWizardPage *page)
+{
+ wxCHECK_RET(!m_started,wxT("wxWizard::FitToPage after RunWizard"));
+
+ while ( page )
{
- Centre();
+ wxSize size = page->GetBestSize();
+
+ m_sizePage.IncTo(size);
+
+ page = page->GetNext();
}
}
-bool wxWizardGeneric::ShowPage(size_t page)
+bool wxWizard::ShowPage(wxWizardPage *page, bool goingForward)
{
- wxCHECK_MSG( page < m_pages.GetCount(), FALSE,
- _T("invalid wizard page index") );
+ wxASSERT_MSG( page != m_page, wxT("this is useless") );
- wxASSERT_MSG( page != (size_t)m_page, _T("this is useless") );
+ // we'll use this to decide whether we have to change the label of this
+ // button or not (initially the label is "Next")
+ bool btnLabelWasNext = TRUE;
- size_t last = m_pages.GetCount() - 1;
- bool mustChangeNextBtnLabel = (size_t)m_page == last || page == last;
+ // Modified 10-20-2001 Robert Cavanaugh.
+ // Fixed bug for displaying a new bitmap
+ // in each *consecutive* page
- if ( m_page != -1 )
+ // flag to indicate if this page uses a new bitmap
+ bool bmpIsDefault = TRUE;
+
+ // use these labels to determine if we need to change the bitmap
+ // for this page
+ wxBitmap bmpPrev, bmpCur;
+
+ // check for previous page
+ if ( m_page )
{
- wxPanel *panel = DoGetCurrentPage();
- if ( !panel->TransferDataFromWindow() )
+ // 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();
- panel->Hide();
+ btnLabelWasNext = HasNextPage(m_page);
+
+ // Get the bitmap of the previous page (if it exists)
+ if ( m_page->GetBitmap().Ok() )
+ {
+ bmpPrev = m_page->GetBitmap();
+ }
}
+ // set the new page
m_page = page;
- DoGetCurrentPage()->Show();
- // update the buttons state
- m_btnPrev->Enable(m_page != 0);
- if ( mustChangeNextBtnLabel )
+ // is this the end?
+ if ( !m_page )
+ {
+ // terminate successfully
+ EndModal(wxID_OK);
+
+ // 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();
+
+ // wxWizardSizer::RecalcSizes wants to be called when m_page changes
+ m_sizerPage->RecalcSizes();
+
+ // check if bitmap needs to be updated
+ // update default flag as well
+ if ( m_page->GetBitmap().Ok() )
+ {
+ bmpCur = m_page->GetBitmap();
+ bmpIsDefault = FALSE;
+ }
+
+#if wxUSE_STATBMP
+ // change the bitmap if:
+ // 1) a default bitmap was selected in constructor
+ // 2) this page was constructed with a bitmap
+ // 3) this bitmap is not the previous bitmap
+ if ( m_statbmp && (bmpCur != bmpPrev) )
+ {
+ wxBitmap bmp;
+ if ( bmpIsDefault )
+ bmp = m_bitmap;
+ else
+ bmp = m_page->GetBitmap();
+ m_statbmp->SetBitmap(bmp);
+ }
+#endif
+
+ // and update the buttons state
+ m_btnPrev->Enable(HasPrevPage(m_page));
+
+ bool hasNext = HasNextPage(m_page);
+ if ( btnLabelWasNext != hasNext )
{
- m_btnNext->SetLabel((size_t)m_page == last ? _("&Finish")
- : _("&Next >"));
+ // need to update
+ if (btnLabelWasNext)
+ m_btnNext->SetLabel(_("&Finish"));
+ else
+ m_btnNext->SetLabel(_("&Next >"));
}
+ m_btnNext->SetDefault();
+ // nothing to do: the label was already correct
+
+ // 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();
return TRUE;
}
-void wxWizardGeneric::DoAddPage(wxPanel *page)
+bool wxWizard::RunWizard(wxWizardPage *firstPage)
{
- page->Hide();
- page->SetSize(m_x, m_y, m_width, m_height);
+ wxCHECK_MSG( firstPage, FALSE, wxT("can't run empty wizard") );
+
+ // Set before FinishLayout to enable wxWizardSizer::GetMaxChildSize
+ m_started = true;
+
+ // This cannot be done sooner, because user can change layout options
+ // up to this moment
+ FinishLayout();
+
+ // can't return FALSE here because there is no old page
+ (void)ShowPage(firstPage, TRUE /* forward */);
+
+ return ShowModal() == wxID_OK;
}
-void wxWizardGeneric::AddPage(wxPanel *page)
+wxWizardPage *wxWizard::GetCurrentPage() const
{
- m_pages.Add(page);
-
- DoAddPage(page);
+ return m_page;
}
-void wxWizardGeneric::InsertPage(int nPage, wxPanel *page)
+wxSize wxWizard::GetPageSize() const
{
- m_pages.Insert(page, nPage);
- if ( nPage < m_page )
- {
- // the indices of all pages after the inserted one are shifted by 1
- m_page++;
- }
-
- DoAddPage(page);
+ wxSize pageSize(GetManualPageSize());
+ pageSize.IncTo(m_sizerPage->GetMaxChildSize());
+ return pageSize;
}
-bool wxWizardGeneric::RunWizard()
+wxSizer *wxWizard::GetPageAreaSizer() const
{
- wxCHECK_MSG( m_pages.GetCount() != 0, FALSE, _T("can't run empty wizard") );
+ return m_sizerPage;
+}
- // can't return FALSE here because there is no old page
- (void)ShowPage(0u);
+void wxWizard::SetBorder(int border)
+{
+ wxCHECK_RET(!m_started,wxT("wxWizard::SetBorder after RunWizard"));
- return ShowModal() == wxID_OK;
+ m_calledSetBorder = true;
+ m_border = border;
}
-wxPanel *wxWizardGeneric::GetCurrentPage() const
+wxSize wxWizard::GetManualPageSize() const
{
- return IsRunning() ? DoGetCurrentPage() : (wxPanel *)NULL;
+ // default width and height of the page
+ static const int DEFAULT_PAGE_WIDTH = 270;
+ static const int DEFAULT_PAGE_HEIGHT = 290;
+
+ wxSize totalPageSize(DEFAULT_PAGE_WIDTH,DEFAULT_PAGE_HEIGHT);
+
+ totalPageSize.IncTo(m_sizePage);
+
+ if ( m_statbmp )
+ {
+ totalPageSize.IncTo(wxSize(0, m_bitmap.GetHeight()));
+ }
+
+ return totalPageSize;
}
-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
EndModal(wxID_CANCEL);
//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),
- _T("unknown button") );
+ wxT("unknown button") );
- int delta = event.GetEventObject() == m_btnNext ? 1 : -1;
- int page = m_page + delta;
+ // 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 && (!m_page->Validate() || !m_page->TransferDataFromWindow()) )
+ {
+ // the page data is incorrect, don't do anything
+ return;
+ }
- wxASSERT_MSG( page >= 0, _T("'Back' button should have been disabled!") );
+ bool forward = event.GetEventObject() == m_btnNext;
- if ( (size_t)page == m_pages.GetCount() )
+ wxWizardPage *page;
+ if ( forward )
{
- // check that we have valid data in the last page too
- if ( m_pages.Last()->TransferDataFromWindow() )
- {
- // that's all, folks!
- EndModal(wxID_OK);
- }
+ page = m_page->GetNext();
}
- else
+ else // back
{
- // just pass to the next page (or may be not - but we don't care here)
- (void)ShowPage(page);
+ page = m_page->GetPrev();
+
+ wxASSERT_MSG( page, wxT("\"<Back\" button should have been disabled") );
+ }
+
+ // just pass to the new page (or may be 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();
+ return;
+ }
+
+ wxWindow *parent = GetParent();
+
+ if ( !parent || !parent->GetEventHandler()->ProcessEvent(event) )
+ {
+ event.Skip();
}
}
// our public interface
// ----------------------------------------------------------------------------
-/* static */ wxWizard *wxWizard::Create(wxWindow *parent,
- int id,
- const wxString& title,
- const wxBitmap& bitmap,
- const wxPoint& pos,
- const wxSize& size)
+#if WXWIN_COMPATIBILITY_2_2
+
+/* static */
+wxWizard *wxWizardBase::Create(wxWindow *parent,
+ int id,
+ const wxString& title,
+ const wxBitmap& bitmap,
+ const wxPoint& pos,
+ const wxSize& WXUNUSED(size))
{
- return new wxWizardGeneric(parent, id, title, bitmap, pos, size);
+ return new wxWizard(parent, id, title, bitmap, pos);
}
+#endif // WXWIN_COMPATIBILITY_2_2
+
// ----------------------------------------------------------------------------
// wxWizardEvent
// ----------------------------------------------------------------------------
-wxWizardEvent::wxWizardEvent(wxEventType type, int id)
+wxWizardEvent::wxWizardEvent(wxEventType type, int id, bool direction, wxWizardPage* page)
: 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;
}
+
+#endif // wxUSE_WIZARDDLG
projects / wxWidgets.git / blobdiff