/////////////////////////////////////////////////////////////////////////////// // Name: generic/wizard.cpp // Purpose: generic implementation of wxWizard class // Author: Vadim Zeitlin // 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: wizardex.cpp 19603 2009-11-18 17:30:03Z romw $ // Copyright: (c) 1999 Vadim Zeitlin // Licence: wxWindows licence /////////////////////////////////////////////////////////////////////////////// #include "stdwx.h" #include "BOINCGUIApp.h" #include "wizardex.h" // ---------------------------------------------------------------------------- // wxWizardSizer // ---------------------------------------------------------------------------- class wxWizardExSizer : public wxSizer { public: wxWizardExSizer(wxWizardEx *owner); virtual wxSizerItem *Insert(size_t index, wxSizerItem *item); virtual void RecalcSizes(); virtual wxSize CalcMin(); // get the max size of all wizard pages wxSize GetMaxChildSize(); // return the border which can be either set using wxWizard::SetBorder() or // have default value int GetBorder() const; // hide the pages which we temporarily "show" when they're added to this // sizer (see Insert()) void HidePages(); private: wxSize SiblingSize(wxSizerItem *child); wxWizardEx *m_owner; wxSize m_childSize; }; // ---------------------------------------------------------------------------- // wxWizardSizer // ---------------------------------------------------------------------------- wxWizardExSizer::wxWizardExSizer(wxWizardEx *owner) : m_owner(owner), m_childSize(wxDefaultSize) { } wxSizerItem *wxWizardExSizer::Insert(size_t index, wxSizerItem *item) { m_owner->m_usingSizer = true; if ( item->IsWindow() ) { // 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); } void wxWizardExSizer::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); } } void wxWizardExSizer::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(wxRect(m_position, m_size)); } } wxSize wxWizardExSizer::CalcMin() { return m_owner->GetPageSize(); } wxSize wxWizardExSizer::GetMaxChildSize() { #if !defined(__WXDEBUG__) if ( m_childSize.IsFullySpecified() ) return m_childSize; #endif wxSize maxOfMin; for ( wxSizerItemList::compatibility_iterator childNode = m_children.GetFirst(); childNode; childNode = childNode->GetNext() ) { wxSizerItem *child = childNode->GetData(); maxOfMin.IncTo(child->CalcMin()); maxOfMin.IncTo(SiblingSize(child)); } #ifdef __WXDEBUG__ if ( !m_owner->m_pageRefreshed && 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?")) ; return m_childSize; } #endif // __WXDEBUG__ if ( m_owner->m_started ) { m_childSize = maxOfMin; } m_owner->m_pageRefreshed = false; return maxOfMin; } int wxWizardExSizer::GetBorder() const { return m_owner->m_border; } wxSize wxWizardExSizer::SiblingSize(wxSizerItem *child) { wxSize maxSibling; if ( child->IsWindow() ) { wxWizardPageEx *page = wxDynamicCast(child->GetWindow(), wxWizardPageEx); if ( page ) { for ( wxWizardPageEx *sibling = page->GetNext(); sibling; sibling = sibling->GetNext() ) { if ( sibling->GetSizer() ) { maxSibling.IncTo(sibling->GetSizer()->CalcMin()); } } } } return maxSibling; } // ---------------------------------------------------------------------------- // wxWizardPage // ---------------------------------------------------------------------------- IMPLEMENT_ABSTRACT_CLASS(wxWizardPageEx, wxPanel) void wxWizardPageEx::Init() { } wxWizardPageEx::wxWizardPageEx( wxWizardEx *parent, int id, const wxChar *resource) { Create(parent, id, resource); } bool wxWizardPageEx::Create( wxWizardEx *parent, int id, const wxChar *resource) { if ( !wxPanel::Create(parent, id) ) return false; if ( resource != NULL ) { #if wxUSE_WX_RESOURCES #if 0 if ( !LoadFromResource(this, resource) ) { wxFAIL_MSG(wxT("wxWizardPageEx LoadFromResource failed!!!!")); } #endif #endif // wxUSE_RESOURCES } // initially the page is hidden, it's shown only when it becomes current Hide(); return true; } void wxWizardPageEx::RefreshPage() { } // ---------------------------------------------------------------------------- // event tables and such // ---------------------------------------------------------------------------- DEFINE_EVENT_TYPE(wxEVT_WIZARDEX_PAGE_CHANGED) DEFINE_EVENT_TYPE(wxEVT_WIZARDEX_PAGE_CHANGING) DEFINE_EVENT_TYPE(wxEVT_WIZARDEX_CANCEL) DEFINE_EVENT_TYPE(wxEVT_WIZARDEX_FINISHED) DEFINE_EVENT_TYPE(wxEVT_WIZARDEX_HELP) BEGIN_EVENT_TABLE(wxWizardEx, wxDialog) EVT_BUTTON(wxID_CANCEL, wxWizardEx::OnCancel) EVT_BUTTON(wxID_BACKWARD, wxWizardEx::OnBackOrNext) EVT_BUTTON(wxID_FORWARD, wxWizardEx::OnBackOrNext) EVT_BUTTON(wxID_HELP, wxWizardEx::OnHelp) EVT_SHOW(wxWizardEx::OnShowEvent) EVT_WIZARDEX_PAGE_CHANGED(wxID_ANY, wxWizardEx::OnWizEvent) EVT_WIZARDEX_PAGE_CHANGING(wxID_ANY, wxWizardEx::OnWizEvent) EVT_WIZARDEX_CANCEL(wxID_ANY, wxWizardEx::OnWizEvent) EVT_WIZARDEX_FINISHED(wxID_ANY, wxWizardEx::OnWizEvent) EVT_WIZARDEX_HELP(wxID_ANY, wxWizardEx::OnWizEvent) END_EVENT_TABLE() IMPLEMENT_DYNAMIC_CLASS(wxWizardEx, wxDialog) // ---------------------------------------------------------------------------- // generic wxWizardEx implementation // ---------------------------------------------------------------------------- void wxWizardEx::Init() { m_posWizard = wxDefaultPosition; m_page = (wxWizardPageEx*)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; } bool wxWizardEx::Create(wxWindow *parent, int id, const wxString& title, const wxPoint& pos, long style) { bool result = wxDialog::Create(parent,id,title,pos,wxDefaultSize,style); m_posWizard = pos; m_pageRefreshed = false; DoCreateControls(); return result; } void wxWizardEx::AddBitmapRow(wxBoxSizer *mainColumn) { m_sizerBmpAndPage = new wxBoxSizer(wxHORIZONTAL); mainColumn->Add( m_sizerBmpAndPage, 1, // Vertically stretchable wxEXPAND // Horizontal stretching, no border ); mainColumn->Add(0,5, 0, // No vertical stretching wxEXPAND // No border, (mostly useless) horizontal stretching ); // Added to m_sizerBmpAndPage later m_sizerPage = new wxWizardExSizer(this); } void wxWizardEx::AddStaticLine(wxBoxSizer *mainColumn) { #if wxUSE_STATLINE mainColumn->Add( new wxStaticLine(this, wxID_ANY, wxDefaultPosition, wxSize(495, -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 wxWizardEx::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 wxWizardEx::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 >")); m_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) { 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 } AddBackNextPair(buttonRow); buttonRow->Add( m_btnCancel, 0, // Horizontally unstretchable wxALL, // Border all around, top aligned 5 // Border width ); } void wxWizardEx::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 wxWizardEx::SetPageSize(const wxSize& size) { wxCHECK_RET(!m_started,wxT("wxWizard::SetPageSize after RunWizard")); m_sizePage = size; } void wxWizardEx::FitToPage(const wxWizardPageEx *page) { wxCHECK_RET(!m_started, wxT("wxWizard::FitToPage after RunWizard")); while ( page ) { wxSize size = page->GetBestSize(); m_sizePage.IncTo(size); page = page->GetNext(); } } bool wxWizardEx::ShowPage(wxWizardPageEx *page, bool goingForward) { wxASSERT_MSG( page != m_page, wxT("this is useless") ); wxSizerFlags flags(1); flags.Border(wxALL, m_border).Expand(); if ( !m_started ) { 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(); } } // 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; // check for previous page if ( m_page ) { // send the event to the old page wxWizardExEvent event(wxEVT_WIZARDEX_PAGE_CHANGING, GetId(), goingForward, m_page); if ( m_page->GetEventHandler()->ProcessEvent(event) && !event.IsAllowed() ) { // vetoed by the page return false; } m_page->Hide(); btnLabelWasNext = HasNextPage(m_page); 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_WIZARDEX_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()); } // and update the buttons state m_btnPrev->Enable(HasPrevPage(m_page)); bool hasNext = HasNextPage(m_page); if ( btnLabelWasNext != hasNext ) { m_btnNext->SetLabel(hasNext ? _("&Next >") : _("&Finish")); } // nothing to do: the label was already correct m_btnNext->SetDefault(); // enable 'Cancel' button if this is not a final step only m_btnCancel->Enable(hasNext); // send the change event to the new page now wxWizardExEvent event(wxEVT_WIZARDEX_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; if ( wxSystemSettings::GetScreenType() > wxSYS_SCREEN_PDA ) { GetSizer()->SetSizeHints(this); if ( m_posWizard == wxDefaultPosition ) CentreOnScreen(); } } return true; } bool wxWizardEx::RunWizard(wxWizardPageEx *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; } wxWizardPageEx *wxWizardEx::GetCurrentPage() const { return m_page; } wxSize wxWizardEx::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_usingSizer ) { // make it big enough to contain all pages added to the sizer pageSize.IncTo(m_sizerPage->GetMaxChildSize()); } return pageSize; } wxSizer *wxWizardEx::GetPageAreaSizer() const { return m_sizerPage; } void wxWizardEx::SetBorder(int border) { wxCHECK_RET(!m_started, wxT("wxWizard::SetBorder after RunWizard")); m_border = border; } void wxWizardEx::OnCancel(wxCommandEvent& WXUNUSED(eventUnused)) { // 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; wxWizardExEvent event(wxEVT_WIZARDEX_CANCEL, GetId(), false, m_page); if ( !win->GetEventHandler()->ProcessEvent(event) || event.IsAllowed() ) { // no objections - close the dialog if(IsModal()) { EndModal(wxID_CANCEL); } else { SetReturnCode(wxID_CANCEL); Hide(); } } //else: request to Cancel ignored } void wxWizardEx::OnBackOrNext(wxCommandEvent& event) { wxASSERT_MSG( (event.GetEventObject() == m_btnNext) || (event.GetEventObject() == m_btnPrev), wxT("unknown button") ); wxCHECK_RET( m_page, _T("should have a valid current page") ); // ask the current page first: notice that we do it before calling // GetNext/Prev() because the data transferred from the controls of the page // may change the value returned by these methods if (event.GetEventObject() == m_btnNext) { if ( !m_page->Validate() || !m_page->TransferDataFromWindow() ) { // the page data is incorrect, don't do anything return; } } bool forward = event.GetEventObject() == m_btnNext; wxWizardPageEx *page; if ( forward ) { page = m_page->GetNext(); } else // back { page = m_page->GetPrev(); wxASSERT_MSG( page, wxT("\"GetEventHandler()->ProcessEvent(eventHelp); } } void wxWizardEx::OnWizEvent(wxWizardExEvent& 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) ) { event.Skip(); } } if ( ( !m_wasModal ) && event.IsAllowed() && ( event.GetEventType() == wxEVT_WIZARDEX_FINISHED || event.GetEventType() == wxEVT_WIZARDEX_CANCEL ) ) { Destroy(); } } void wxWizardEx::OnShowEvent(wxShowEvent& event) { if (event.IsShown() && m_page != NULL) { m_pageRefreshed = true; m_page->RefreshPage(); } } // ---------------------------------------------------------------------------- // wxWizardExEvent // ---------------------------------------------------------------------------- IMPLEMENT_DYNAMIC_CLASS(wxWizardExEvent, wxNotifyEvent) wxWizardExEvent::wxWizardExEvent(wxEventType type, int id, bool direction, wxWizardPageEx* page) : wxNotifyEvent(type, id) { // Modified 10-20-2001 Robert Cavanaugh // add the active page to the event data m_direction = direction; m_page = page; }