X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/066f1b7a9580fc6c487efa753d61e3683de61407..777f37e0ccea2836804085fc7d0f5d9666a787f9:/src/generic/wizard.cpp diff --git a/src/generic/wizard.cpp b/src/generic/wizard.cpp index 329399e221..4690af5eae 100644 --- a/src/generic/wizard.cpp +++ b/src/generic/wizard.cpp @@ -1,5 +1,5 @@ /////////////////////////////////////////////////////////////////////////////// -// Name: generic/wizard.cpp +// Name: src/generic/wizard.cpp // Purpose: generic implementation of wxWizard class // Author: Vadim Zeitlin // Modified by: Robert Cavanaugh @@ -21,10 +21,6 @@ // headers // ---------------------------------------------------------------------------- -#ifdef __GNUG__ - #pragma implementation "wizardg.h" -#endif - // For compilers that support precompilation, includes "wx.h". #include "wx/wxprec.h" @@ -43,6 +39,7 @@ #include "wx/statline.h" #include "wx/sizer.h" +#include "wx/settings.h" #include "wx/wizard.h" @@ -55,15 +52,25 @@ class wxWizardSizer : public wxSizer public: wxWizardSizer(wxWizard *owner); - void RecalcSizes(); - wxSize CalcMin(); + virtual wxSizerItem *Insert(size_t index, wxSizerItem *item); + virtual void RecalcSizes(); + virtual wxSize CalcMin(); + + // get the max size of all wizard pages wxSize GetMaxChildSize(); - int Border() const; - + + // 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); - + wxWizard *m_owner; bool m_childSizeValid; wxSize m_childSize; @@ -85,20 +92,20 @@ BEGIN_EVENT_TABLE(wxWizard, wxDialog) 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) + 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() IMPLEMENT_DYNAMIC_CLASS(wxWizard, wxDialog) /* - TODO PROPERTIES : - wxWizard - extstyle - title + TODO PROPERTIES : + wxWizard + extstyle + title */ IMPLEMENT_ABSTRACT_CLASS(wxWizardPage, wxPanel) @@ -129,8 +136,8 @@ bool wxWizardPage::Create(wxWizard *parent, const wxBitmap& bitmap, const wxChar *resource) { - if ( !wxPanel::Create(parent, -1) ) - return FALSE; + if ( !wxPanel::Create(parent, wxID_ANY) ) + return false; if ( resource != NULL ) { @@ -149,7 +156,7 @@ bool wxWizardPage::Create(wxWizard *parent, // initially the page is hidden, it's shown only when it becomes current Hide(); - return TRUE; + return true; } // ---------------------------------------------------------------------------- @@ -171,18 +178,43 @@ wxWizardPage *wxWizardPageSimple::GetNext() const // ---------------------------------------------------------------------------- wxWizardSizer::wxWizardSizer(wxWizard *owner) - : m_owner(owner) + : m_owner(owner) { m_childSizeValid = false; } +wxSizerItem *wxWizardSizer::Insert(size_t index, wxSizerItem *item) +{ + 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 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); + } +} + 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); + m_owner->m_page->SetSize(m_position.x, m_position.y, m_size.x, m_size.y); } } @@ -226,11 +258,11 @@ wxSize wxWizardSizer::GetMaxChildSize() m_childSizeValid = true; m_childSize = maxOfMin; } - + return maxOfMin; } -int wxWizardSizer::Border() const +int wxWizardSizer::GetBorder() const { if ( m_owner->m_calledSetBorder ) return m_owner->m_border; @@ -241,7 +273,7 @@ int wxWizardSizer::Border() const wxSize wxWizardSizer::SiblingSize(wxSizerItem *child) { wxSize maxSibling; - + if ( child->IsWindow() ) { wxWizardPage *page = wxDynamicCast(child->GetWindow(), wxWizardPage); @@ -258,7 +290,7 @@ wxSize wxWizardSizer::SiblingSize(wxSizerItem *child) } } } - + return maxSibling; } @@ -277,6 +309,7 @@ void wxWizard::Init() m_calledSetBorder = false; m_border = 0; m_started = false; + m_wasModal = false; } bool wxWizard::Create(wxWindow *parent, @@ -287,12 +320,12 @@ bool wxWizard::Create(wxWindow *parent, long style) { bool result = wxDialog::Create(parent,id,title,pos,wxDefaultSize,style); - + m_posWizard = pos; m_bitmap = bitmap ; DoCreateControls(); - + return result; } @@ -309,9 +342,10 @@ void wxWizard::AddBitmapRow(wxBoxSizer *mainColumn) wxEXPAND // No border, (mostly useless) horizontal stretching ); +#if wxUSE_STATBMP if ( m_bitmap.Ok() ) { - m_statbmp = new wxStaticBitmap(this, -1, m_bitmap); + m_statbmp = new wxStaticBitmap(this, wxID_ANY, m_bitmap); m_sizerBmpAndPage->Add( m_statbmp, 0, // No horizontal stretching @@ -324,6 +358,7 @@ void wxWizard::AddBitmapRow(wxBoxSizer *mainColumn) wxEXPAND // No border, (mostly useless) vertical stretching ); } +#endif // Added to m_sizerBmpAndPage in FinishLayout m_sizerPage = new wxWizardSizer(this); @@ -333,7 +368,7 @@ void wxWizard::AddStaticLine(wxBoxSizer *mainColumn) { #if wxUSE_STATLINE mainColumn->Add( - new wxStaticLine(this, -1), + new wxStaticLine(this, wxID_ANY), 0, // Vertically unstretchable wxEXPAND | wxALL, // Border all around, horizontally stretchable 5 // Border width @@ -349,6 +384,10 @@ void wxWizard::AddStaticLine(wxBoxSizer *mainColumn) 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; @@ -363,38 +402,80 @@ void wxWizard::AddBackNextPair(wxBoxSizer *buttonRow) wxALL, // Border all around 5 // Border width ); - - m_btnPrev = new wxButton(this, wxID_BACKWARD, _("< &Back")); + backNextPair->Add(m_btnPrev); backNextPair->Add(BACKNEXT_MARGIN,0, 0, // No horizontal stretching wxEXPAND // No border, (mostly useless) vertical stretching ); - m_btnNext = new wxButton(this, wxID_FORWARD, _("&Next >")); 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) + { buttonRow->Add( - new wxButton(this, wxID_HELP, _("&Help")), + 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( - new wxButton(this, wxID_CANCEL, _("&Cancel")), + btnCancel, 0, // Horizontally unstretchable wxALL, // Border all around, top aligned 5 // Border width @@ -406,22 +487,30 @@ 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 - wxALL | wxEXPAND, // Border all around, horizontal stretching + mainColumnSizerFlags, 5 // Border width ); - + AddBitmapRow(mainColumn); - AddStaticLine(mainColumn); + + if (!isPda) + 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); @@ -435,22 +524,34 @@ void wxWizard::SetPageSize(const wxSize& size) void wxWizard::FinishLayout() { + bool isPda = (wxSystemSettings::GetScreenType() <= wxSYS_SCREEN_PDA); + + // Set to enable wxWizardSizer::GetMaxChildSize + m_started = true; + m_sizerBmpAndPage->Add( m_sizerPage, 1, // Horizontal stretching wxEXPAND | wxALL, // Vertically stretchable - m_sizerPage->Border() + m_sizerPage->GetBorder() ); - - GetSizer()->SetSizeHints(this); - if ( m_posWizard == wxDefaultPosition ) - CentreOnScreen(); + + if (!isPda) + { + GetSizer()->SetSizeHints(this); + if ( m_posWizard == wxDefaultPosition ) + CentreOnScreen(); + } + + // now that our layout is computed correctly, hide the pages artificially + // shown in wxWizardSizer::Insert() back again + m_sizerPage->HidePages(); } void wxWizard::FitToPage(const wxWizardPage *page) { wxCHECK_RET(!m_started,wxT("wxWizard::FitToPage after RunWizard")); - + while ( page ) { wxSize size = page->GetBestSize(); @@ -467,14 +568,14 @@ bool wxWizard::ShowPage(wxWizardPage *page, bool goingForward) // 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; + bool btnLabelWasNext = true; // Modified 10-20-2001 Robert Cavanaugh. // Fixed bug for displaying a new bitmap // in each *consecutive* page // flag to indicate if this page uses a new bitmap - bool bmpIsDefault = TRUE; + bool bmpIsDefault = true; // use these labels to determine if we need to change the bitmap // for this page @@ -489,7 +590,7 @@ bool wxWizard::ShowPage(wxWizardPage *page, bool goingForward) !event.IsAllowed() ) { // vetoed by the page - return FALSE; + return false; } m_page->Hide(); @@ -510,18 +611,27 @@ bool wxWizard::ShowPage(wxWizardPage *page, bool goingForward) if ( !m_page ) { // terminate successfully - EndModal(wxID_OK); - if ( !IsModal() ) - { - wxWizardEvent event(wxEVT_WIZARD_FINISHED, GetId(),FALSE, 0); - (void)GetEventHandler()->ProcessEvent(event); - } - return TRUE; + 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(); - + // wxWizardSizer::RecalcSizes wants to be called when m_page changes m_sizerPage->RecalcSizes(); @@ -530,9 +640,10 @@ bool wxWizard::ShowPage(wxWizardPage *page, bool goingForward) if ( m_page->GetBitmap().Ok() ) { bmpCur = m_page->GetBitmap(); - bmpIsDefault = FALSE; + 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 @@ -546,6 +657,7 @@ bool wxWizard::ShowPage(wxWizardPage *page, bool goingForward) bmp = m_page->GetBitmap(); m_statbmp->SetBitmap(bmp); } +#endif // and update the buttons state m_btnPrev->Enable(HasPrevPage(m_page)); @@ -559,6 +671,7 @@ bool wxWizard::ShowPage(wxWizardPage *page, bool goingForward) 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 @@ -569,22 +682,21 @@ bool wxWizard::ShowPage(wxWizardPage *page, bool goingForward) m_page->Show(); m_page->SetFocus(); - return TRUE; + return true; } bool wxWizard::RunWizard(wxWizardPage *firstPage) { - wxCHECK_MSG( firstPage, FALSE, wxT("can't run empty wizard") ); - - // Set before FinishLayout to enable wxWizardSizer::GetMaxChildSize - m_started = true; - + wxCHECK_MSG( firstPage, false, wxT("can't run empty wizard") ); + // 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 */); + + // can't return false here because there is no old page + (void)ShowPage(firstPage, true /* forward */); + + m_wasModal = true; return ShowModal() == wxID_OK; } @@ -617,18 +729,25 @@ void wxWizard::SetBorder(int border) wxSize wxWizard::GetManualPageSize() const { // default width and height of the page - static const int DEFAULT_PAGE_WIDTH = 270; - static const int DEFAULT_PAGE_HEIGHT = 290; + int DEFAULT_PAGE_WIDTH = 270; + int DEFAULT_PAGE_HEIGHT = 270; + bool isPda = (wxSystemSettings::GetScreenType() <= wxSYS_SCREEN_PDA); + if (isPda) + { + // 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; + } wxSize totalPageSize(DEFAULT_PAGE_WIDTH,DEFAULT_PAGE_HEIGHT); - + totalPageSize.IncTo(m_sizePage); - + if ( m_statbmp ) { totalPageSize.IncTo(wxSize(0, m_bitmap.GetHeight())); } - + return totalPageSize; } @@ -638,11 +757,19 @@ void wxWizard::OnCancel(wxCommandEvent& WXUNUSED(eventUnused)) // 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); + wxWizardEvent event(wxEVT_WIZARD_CANCEL, GetId(), false, m_page); if ( !win->GetEventHandler()->ProcessEvent(event) || event.IsAllowed() ) { // no objections - close the dialog - EndModal(wxID_CANCEL); + if(IsModal()) + { + EndModal(wxID_CANCEL); + } + else + { + SetReturnCode(wxID_CANCEL); + Hide(); + } } //else: request to Cancel ignored } @@ -653,10 +780,12 @@ void wxWizard::OnBackOrNext(wxCommandEvent& event) (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 transfered from the controls of the page // may change the value returned by these methods - if ( m_page && (!m_page->Validate() || !m_page->TransferDataFromWindow()) ) + if ( !m_page->Validate() || !m_page->TransferDataFromWindow() ) { // the page data is incorrect, don't do anything return; @@ -689,7 +818,7 @@ void wxWizard::OnHelp(wxCommandEvent& WXUNUSED(event)) // 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); + wxWizardEvent eventHelp(wxEVT_WIZARD_HELP, GetId(), true, m_page); (void)m_page->GetEventHandler()->ProcessEvent(eventHelp); } } @@ -701,36 +830,29 @@ void wxWizard::OnWizEvent(wxWizardEvent& event) if ( !(GetExtraStyle() & wxWS_EX_BLOCK_EVENTS) ) { // the event will be propagated anyhow - return; + event.Skip(); } + else + { + wxWindow *parent = GetParent(); - wxWindow *parent = GetParent(); + if ( !parent || !parent->GetEventHandler()->ProcessEvent(event) ) + { + event.Skip(); + } + } - if ( !parent || !parent->GetEventHandler()->ProcessEvent(event) ) + if ( ( !m_wasModal ) && + event.IsAllowed() && + ( event.GetEventType() == wxEVT_WIZARD_FINISHED || + event.GetEventType() == wxEVT_WIZARD_CANCEL + ) + ) { - event.Skip(); + Destroy(); } } -// ---------------------------------------------------------------------------- -// our public interface -// ---------------------------------------------------------------------------- - -#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 wxWizard(parent, id, title, bitmap, pos); -} - -#endif // WXWIN_COMPATIBILITY_2_2 - // ---------------------------------------------------------------------------- // wxWizardEvent // ----------------------------------------------------------------------------