// 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
// Created: 15.08.99
// RCS-ID: $Id$
// Copyright: (c) 1999 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
// ----------------------------------------------------------------------------
#ifdef __GNUG__
- #pragma implementation ".h"
+ #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"
WX_DEFINE_ARRAY(wxPanel *, wxArrayPages);
// ----------------------------------------------------------------------------
-// wxWizardGeneric - generic implementation of wxWizard
+// event tables and such
// ----------------------------------------------------------------------------
-class wxWizardGeneric : public wxWizard
-{
-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!") );
+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_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_HELP(-1, wxWizard::OnWizEvent)
+END_EVENT_TABLE()
- return m_pages[(size_t)m_page];
- }
+IMPLEMENT_DYNAMIC_CLASS(wxWizard, wxDialog)
+IMPLEMENT_ABSTRACT_CLASS(wxWizardPage, wxPanel)
+IMPLEMENT_DYNAMIC_CLASS(wxWizardPageSimple, wxWizardPage)
+IMPLEMENT_DYNAMIC_CLASS(wxWizardEvent, wxNotifyEvent)
- // place the given page correctly and hide it
- void DoAddPage(wxPanel *page);
+// ============================================================================
+// implementation
+// ============================================================================
-private:
- // event handlers
- void OnCancel(wxCommandEvent& event);
- void OnBackOrNext(wxCommandEvent& event);
+// ----------------------------------------------------------------------------
+// wxWizardPage
+// ----------------------------------------------------------------------------
- // 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)
+void wxWizardPage::Init()
+{
+ m_bitmap = wxNullBitmap;
+}
- // wizard state
- int m_page; // the current page or -1
- wxArrayPages m_pages; // the array with all wizards pages
+wxWizardPage::wxWizardPage(wxWizard *parent,
+ const wxBitmap& bitmap,
+ const wxChar *resource)
+{
+ Create(parent, bitmap, resource);
+}
- // wizard controls
- wxButton *m_btnPrev, // the "<Back" button
- *m_btnNext; // the "Next>" or "Finish" button
+bool wxWizardPage::Create(wxWizard *parent,
+ const wxBitmap& bitmap,
+ const wxChar *resource)
+{
+ if ( !wxPanel::Create(parent, -1) )
+ return FALSE;
- DECLARE_EVENT_TABLE()
-};
+ if ( resource != NULL )
+ {
+#if wxUSE_WX_RESOURCES
+ if ( !LoadFromResource(this, resource) )
+ {
+ wxFAIL_MSG(wxT("wxWizardPage LoadFromResource failed!!!!"));
+ }
+#endif // wxUSE_RESOURCES
+ }
-// ----------------------------------------------------------------------------
-// event tables and such
-// ----------------------------------------------------------------------------
+ m_bitmap = bitmap;
-BEGIN_EVENT_TABLE(wxWizardGeneric, wxDialog)
- EVT_BUTTON(wxID_CANCEL, wxWizardGeneric::OnCancel)
- EVT_BUTTON(-1, wxWizardGeneric::OnBackOrNext)
-END_EVENT_TABLE()
+ // initially the page is hidden, it's shown only when it becomes current
+ Hide();
-IMPLEMENT_ABSTRACT_CLASS(wxWizard, wxDialog)
-IMPLEMENT_DYNAMIC_CLASS(wxWizardEvent, wxNotifyEvent)
+ return TRUE;
+}
-// ============================================================================
-// implementation
-// ============================================================================
+// ----------------------------------------------------------------------------
+// wxWizardPageSimple
+// ----------------------------------------------------------------------------
+wxWizardPage *wxWizardPageSimple::GetPrev() const
+{
+ return m_prev;
+}
+
+wxWizardPage *wxWizardPageSimple::GetNext() const
+{
+ return m_next;
+}
// ----------------------------------------------------------------------------
// generic wxWizard implementation
// ----------------------------------------------------------------------------
-wxWizardGeneric::wxWizardGeneric(wxWindow *parent,
- int id,
- const wxString& title,
- const wxBitmap& bitmap,
- const wxPoint& pos,
- const wxSize& size)
+void wxWizard::Init()
+{
+ m_posWizard = wxDefaultPosition;
+ m_page = (wxWizardPage *)NULL;
+ m_btnPrev = m_btnNext = NULL;
+ m_statbmp = NULL;
+}
+
+bool wxWizard::Create(wxWindow *parent,
+ int id,
+ const wxString& title,
+ const wxBitmap& bitmap,
+ const wxPoint& pos)
{
+ m_posWizard = pos;
+ m_bitmap = bitmap ;
+
+ // just create the dialog itself here, the controls will be created in
+ // DoCreateControls() called later when we know our final size
+ m_page = (wxWizardPage *)NULL;
+ m_btnPrev = m_btnNext = NULL;
+ m_statbmp = NULL;
+
+ return wxDialog::Create(parent, id, title, pos);
+}
+
+void wxWizard::DoCreateControls()
+{
+ // do nothing if the controls were already created
+ if ( WasCreated() )
+ return;
+
// constants defining the dialog layout
// ------------------------------------
// margin between "Next >" and "Cancel" buttons
static const int BUTTON_MARGIN = 10;
+ // margin between Back and Next buttons
+#ifdef __WXMAC__
+ static const int BACKNEXT_MARGIN = 10;
+#else
+ static const int BACKNEXT_MARGIN = 0;
+#endif
+
// default width and height of the page
static const int DEFAULT_PAGE_WIDTH = 270;
static const int DEFAULT_PAGE_HEIGHT = 290;
- // init members
- // ------------
-
- m_page = -1;
-
// create controls
// ---------------
wxSize sizeBtn = wxButton::GetDefaultSize();
- (void)wxDialog::Create(parent, id, title, pos, size);
-
// 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() )
+
+ int defaultHeight;
+ if ( m_bitmap.Ok() )
{
- (void)new wxStaticBitmap(this, -1, bitmap, wxPoint(m_x, m_y));
+ m_statbmp = new wxStaticBitmap(this, -1, m_bitmap, wxPoint(m_x, m_y));
- m_x += bitmap.GetWidth() + BITMAP_X_MARGIN;
- m_height = bitmap.GetHeight();
+ m_x += m_bitmap.GetWidth() + BITMAP_X_MARGIN;
+
+ defaultHeight = m_bitmap.GetHeight();
}
else
{
- m_height = DEFAULT_PAGE_HEIGHT;
+ m_statbmp = (wxStaticBitmap *)NULL;
+
+ defaultHeight = DEFAULT_PAGE_HEIGHT;
}
- m_width = DEFAULT_PAGE_WIDTH;
+ // use default size if none given and also make sure that the dialog is
+ // not less than the default size
+ m_height = m_sizePage.y == -1 ? defaultHeight : m_sizePage.y;
+ m_width = m_sizePage.x == -1 ? DEFAULT_PAGE_WIDTH : m_sizePage.x;
+ if ( m_height < defaultHeight )
+ m_height = defaultHeight;
+ if ( m_width < DEFAULT_PAGE_WIDTH )
+ m_width = DEFAULT_PAGE_WIDTH;
int x = X_MARGIN;
int y = m_y + m_height + BITMAP_Y_MARGIN;
-
-#if wxUSE_STATLINE
+
+#if wxUSE_STATLINE
(void)new wxStaticLine(this, -1, wxPoint(x, y),
wxSize(m_x + m_width - x, 2));
-#endif
-
- x = m_x + m_width - 3*sizeBtn.x - BUTTON_MARGIN;
+#endif // wxUSE_STATLINE
+
+ x = m_x + m_width - 3*sizeBtn.x - BUTTON_MARGIN - BACKNEXT_MARGIN;
y += SEPARATOR_LINE_MARGIN;
- m_btnPrev = new wxButton(this, -1, _("< &Back"), wxPoint(x, y), sizeBtn);
+
+ if (GetExtraStyle() & wxWIZARD_EX_HELPBUTTON)
+ {
+ x -= sizeBtn.x;
+ x -= BUTTON_MARGIN ;
+
+ (void)new wxButton(this, wxID_HELP, _("&Help"), wxPoint(x, y), sizeBtn);
+ x += sizeBtn.x;
+ x += BUTTON_MARGIN ;
+ }
+
+ m_btnPrev = new wxButton(this, wxID_BACKWARD, _("< &Back"), wxPoint(x, y), sizeBtn);
x += sizeBtn.x;
- m_btnNext = new wxButton(this, -1, _("&Next >"), wxPoint(x, y), sizeBtn);
+ x += BACKNEXT_MARGIN;
+
+ m_btnNext = new wxButton(this, wxID_FORWARD, _("&Next >"), wxPoint(x, y), sizeBtn);
x += sizeBtn.x + BUTTON_MARGIN;
- (void)new wxButton(this, wxID_CANCEL, _("Cancel"), wxPoint(x, y), sizeBtn);
+ (void)new wxButton(this, wxID_CANCEL, _("&Cancel"), wxPoint(x, y), sizeBtn);
// position and size the dialog
// ----------------------------
- if ( size == wxDefaultSize )
+ SetClientSize(m_x + m_width + X_MARGIN,
+ m_y + m_height + BITMAP_Y_MARGIN +
+ SEPARATOR_LINE_MARGIN + sizeBtn.y + Y_MARGIN);
+
+ if ( m_posWizard == wxDefaultPosition )
{
- SetClientSize(m_x + m_width + X_MARGIN,
- m_y + m_height + BITMAP_Y_MARGIN +
- SEPARATOR_LINE_MARGIN + sizeBtn.y + Y_MARGIN);
+ CentreOnScreen();
}
+}
+
+void wxWizard::SetPageSize(const wxSize& size)
+{
+ // otherwise it will have no effect now as it's too late...
+ wxASSERT_MSG( !WasCreated(), _T("should be called before RunWizard()!") );
+
+ m_sizePage = size;
+}
- if ( pos == wxDefaultPosition )
+void wxWizard::FitToPage(const wxWizardPage *page)
+{
+ // otherwise it will have no effect now as it's too late...
+ wxASSERT_MSG( !WasCreated(), _T("should be called before RunWizard()!") );
+
+ wxSize sizeMax;
+ while ( page )
{
- Centre();
+ wxSize size = page->GetBestSize();
+
+ if ( size.x > sizeMax.x )
+ sizeMax.x = size.x;
+
+ if ( size.y > sizeMax.y )
+ sizeMax.y = size.y;
+
+ page = page->GetNext();
}
+
+ if ( sizeMax.x > m_sizePage.x )
+ m_sizePage.x = sizeMax.x;
+
+ if ( sizeMax.y > m_sizePage.y )
+ m_sizePage.y = sizeMax.y;
}
-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") );
+
+ // 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;
- wxASSERT_MSG( page != (size_t)m_page, _T("this is useless") );
+ // Modified 10-20-2001 Robert Cavanaugh.
+ // Fixed bug for displaying a new bitmap
+ // in each *consecutive* page
- size_t last = m_pages.GetCount() - 1;
- bool mustChangeNextBtnLabel = (size_t)m_page == last || page == last;
+ // flag to indicate if this page uses a new bitmap
+ bool bmpIsDefault = TRUE;
- if ( m_page != -1 )
+ // 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 = m_page->GetNext() != (wxWizardPage *)NULL;
+
+ // 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 )
{
- m_btnNext->SetLabel((size_t)m_page == last ? _("&Finish")
- : _("&Next >"));
+ // terminate successfully
+ EndModal(wxID_OK);
+ return TRUE;
}
- return TRUE;
-}
+ // position and show the new page
+ (void)m_page->TransferDataToWindow();
+ m_page->SetSize(m_x, m_y, m_width, m_height);
-void wxWizardGeneric::DoAddPage(wxPanel *page)
-{
- page->Hide();
- page->SetSize(m_x, m_y, m_width, m_height);
-}
+ // check if bitmap needs to be updated
+ // update default flag as well
+ if ( m_page->GetBitmap().Ok() )
+ {
+ bmpCur = m_page->GetBitmap();
+ bmpIsDefault = FALSE;
+ }
-void wxWizardGeneric::AddPage(wxPanel *page)
-{
- m_pages.Add(page);
+ // 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);
+ }
- DoAddPage(page);
-}
+ // and update the buttons state
+ m_btnPrev->Enable(m_page->GetPrev() != (wxWizardPage *)NULL);
-void wxWizardGeneric::InsertPage(int nPage, wxPanel *page)
-{
- m_pages.Insert(page, nPage);
- if ( nPage < m_page )
+ bool hasNext = m_page->GetNext() != (wxWizardPage *)NULL;
+ if ( btnLabelWasNext != hasNext )
{
- // the indices of all pages after the inserted one are shifted by 1
- m_page++;
+ // need to update
+ if (btnLabelWasNext)
+ m_btnNext->SetLabel(_("&Finish"));
+ else
+ m_btnNext->SetLabel(_("&Next >"));
}
+ // 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();
- DoAddPage(page);
+ return TRUE;
}
-bool wxWizardGeneric::RunWizard()
+bool wxWizard::RunWizard(wxWizardPage *firstPage)
{
- wxCHECK_MSG( m_pages.GetCount() != 0, FALSE, _T("can't run empty wizard") );
+ wxCHECK_MSG( firstPage, FALSE, wxT("can't run empty wizard") );
+
+ DoCreateControls();
// can't return FALSE here because there is no old page
- (void)ShowPage(0u);
+ (void)ShowPage(firstPage, TRUE /* forward */);
return ShowModal() == wxID_OK;
}
-wxPanel *wxWizardGeneric::GetCurrentPage() const
+wxWizardPage *wxWizard::GetCurrentPage() const
+{
+ return m_page;
+}
+
+wxSize wxWizard::GetPageSize() const
{
- return IsRunning() ? DoGetCurrentPage() : (wxPanel *)NULL;
+ // make sure that the controls are created because otherwise m_width and
+ // m_height would be both still -1
+ wxConstCast(this, wxWizard)->DoCreateControls();
+
+ return wxSize(m_width, m_height);
}
-void wxWizardGeneric::OnCancel(wxCommandEvent& WXUNUSED(event))
+void wxWizard::OnCancel(wxCommandEvent& WXUNUSED(event))
{
- 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->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
+ {
+ 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) )
{
- // just pass to the next page (or may be not - but we don't care here)
- (void)ShowPage(page);
+ // the event will be propagated anyhow
+ 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)
+#ifdef 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