X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/07f20d9a63226a25e71ba6c72e2803c1f58e7903..11ca2edf95b3b99733224001138d1dc7d57d2e31:/src/generic/wizard.cpp diff --git a/src/generic/wizard.cpp b/src/generic/wizard.cpp index 158b7708e3..118c11e2c6 100644 --- a/src/generic/wizard.cpp +++ b/src/generic/wizard.cpp @@ -21,7 +21,7 @@ // headers // ---------------------------------------------------------------------------- -#ifdef __GNUG__ +#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) #pragma implementation "wizardg.h" #endif @@ -46,6 +46,29 @@ #include "wx/wizard.h" +// ---------------------------------------------------------------------------- +// wxWizardSizer +// ---------------------------------------------------------------------------- + +class wxWizardSizer : public wxSizer +{ +public: + wxWizardSizer(wxWizard *owner); + + void RecalcSizes(); + wxSize CalcMin(); + + wxSize GetMaxChildSize(); + int Border() const; + +private: + wxSize SiblingSize(wxSizerItem *child); + + wxWizard *m_owner; + bool m_childSizeValid; + wxSize m_childSize; +}; + // ---------------------------------------------------------------------------- // event tables and such // ---------------------------------------------------------------------------- @@ -62,14 +85,22 @@ 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 +*/ + IMPLEMENT_ABSTRACT_CLASS(wxWizardPage, wxPanel) IMPLEMENT_DYNAMIC_CLASS(wxWizardPageSimple, wxWizardPage) IMPLEMENT_DYNAMIC_CLASS(wxWizardEvent, wxNotifyEvent) @@ -98,8 +129,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 ) { @@ -118,7 +149,7 @@ bool wxWizardPage::Create(wxWizard *parent, // initially the page is hidden, it's shown only when it becomes current Hide(); - return TRUE; + return true; } // ---------------------------------------------------------------------------- @@ -139,29 +170,6 @@ wxWizardPage *wxWizardPageSimple::GetNext() const // wxWizardSizer // ---------------------------------------------------------------------------- -class wxWizardSizer : public wxSizer -{ -public: - wxWizardSizer(wxWizard *owner); - - void RecalcSizes(); - wxSize CalcMin(); - - wxSize GetMaxChildSize(); - int Border() const; - -private: - wxSize SiblingSize(wxSizerItem *child); - - wxWizard *m_owner; - bool m_childSizeValid; - wxSize m_childSize; - - DECLARE_CLASS(wxWizardSizer); -}; - -IMPLEMENT_CLASS(wxWizardSizer, wxSizer) - wxWizardSizer::wxWizardSizer(wxWizard *owner) : m_owner(owner) { @@ -191,7 +199,7 @@ wxSize wxWizardSizer::GetMaxChildSize() #endif wxSize maxOfMin; - wxSizerItemList::Node *childNode; + wxSizerItemList::compatibility_iterator childNode; for(childNode = m_children.GetFirst(); childNode; childNode = childNode->GetNext()) @@ -218,7 +226,7 @@ wxSize wxWizardSizer::GetMaxChildSize() m_childSizeValid = true; m_childSize = maxOfMin; } - + return maxOfMin; } @@ -233,7 +241,7 @@ int wxWizardSizer::Border() const wxSize wxWizardSizer::SiblingSize(wxSizerItem *child) { wxSize maxSibling; - + if ( child->IsWindow() ) { wxWizardPage *page = wxDynamicCast(child->GetWindow(), wxWizardPage); @@ -250,7 +258,7 @@ wxSize wxWizardSizer::SiblingSize(wxSizerItem *child) } } } - + return maxSibling; } @@ -264,6 +272,7 @@ void wxWizard::Init() m_page = (wxWizardPage *)NULL; m_btnPrev = m_btnNext = NULL; m_statbmp = NULL; + m_sizerBmpAndPage = NULL; m_sizerPage = NULL; m_calledSetBorder = false; m_border = 0; @@ -271,19 +280,19 @@ void wxWizard::Init() } bool wxWizard::Create(wxWindow *parent, - int id, - const wxString& title, - const wxBitmap& bitmap, - const wxPoint& pos, - long style) + 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; } @@ -300,9 +309,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 @@ -315,8 +325,7 @@ void wxWizard::AddBitmapRow(wxBoxSizer *mainColumn) wxEXPAND // No border, (mostly useless) vertical stretching ); } - else - m_statbmp = (wxStaticBitmap *)NULL; +#endif // Added to m_sizerBmpAndPage in FinishLayout m_sizerPage = new wxWizardSizer(this); @@ -326,7 +335,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 @@ -342,6 +351,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; @@ -356,38 +369,77 @@ 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. + 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")); +#endif + + m_btnNext = new wxButton(this, wxID_FORWARD, _("&Next >")); + wxButton *btnCancel=new wxButton(this, wxID_CANCEL, _("&Cancel")); +#ifndef __WXMAC__ if (GetExtraStyle() & wxWIZARD_EX_HELPBUTTON) + btnHelp=new wxButton(this, wxID_HELP, _("&Help")); +#endif + m_btnPrev = new wxButton(this, wxID_BACKWARD, _("< &Back")); + + 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 @@ -399,10 +451,10 @@ 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, @@ -410,11 +462,11 @@ void wxWizard::DoCreateControls() 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); @@ -434,7 +486,7 @@ void wxWizard::FinishLayout() wxEXPAND | wxALL, // Vertically stretchable m_sizerPage->Border() ); - + GetSizer()->SetSizeHints(this); if ( m_posWizard == wxDefaultPosition ) CentreOnScreen(); @@ -443,7 +495,7 @@ void wxWizard::FinishLayout() void wxWizard::FitToPage(const wxWizardPage *page) { wxCHECK_RET(!m_started,wxT("wxWizard::FitToPage after RunWizard")); - + while ( page ) { wxSize size = page->GetBestSize(); @@ -460,14 +512,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 @@ -482,7 +534,7 @@ bool wxWizard::ShowPage(wxWizardPage *page, bool goingForward) !event.IsAllowed() ) { // vetoed by the page - return FALSE; + return false; } m_page->Hide(); @@ -504,17 +556,18 @@ bool wxWizard::ShowPage(wxWizardPage *page, bool goingForward) { // terminate successfully EndModal(wxID_OK); - if ( !IsModal() ) - { - wxWizardEvent event(wxEVT_WIZARD_FINISHED, GetId(),FALSE, 0); - (void)GetEventHandler()->ProcessEvent(event); - } - return TRUE; + + // 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(); @@ -523,9 +576,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 @@ -539,6 +593,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)); @@ -552,6 +607,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 @@ -562,22 +618,22 @@ 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") ); - + 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 */); + + // can't return false here because there is no old page + (void)ShowPage(firstPage, true /* forward */); return ShowModal() == wxID_OK; } @@ -602,6 +658,7 @@ wxSizer *wxWizard::GetPageAreaSizer() const void wxWizard::SetBorder(int border) { wxCHECK_RET(!m_started,wxT("wxWizard::SetBorder after RunWizard")); + m_calledSetBorder = true; m_border = border; } @@ -610,15 +667,21 @@ 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; + //static const int DEFAULT_PAGE_HEIGHT = 290; + // For compatibility with 2.4: there's too much + // space under the bitmap, probably due to differences in + // the sizer implementation. This makes it reasonable again. + static const int DEFAULT_PAGE_HEIGHT = 270; wxSize totalPageSize(DEFAULT_PAGE_WIDTH,DEFAULT_PAGE_HEIGHT); - + totalPageSize.IncTo(m_sizePage); - - if(m_statbmp) - totalPageSize.IncTo(wxSize(0,m_bitmap.GetHeight())); - + + if ( m_statbmp ) + { + totalPageSize.IncTo(wxSize(0, m_bitmap.GetHeight())); + } + return totalPageSize; } @@ -628,7 +691,7 @@ 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 @@ -679,7 +742,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); } } @@ -691,6 +754,7 @@ void wxWizard::OnWizEvent(wxWizardEvent& event) if ( !(GetExtraStyle() & wxWS_EX_BLOCK_EVENTS) ) { // the event will be propagated anyhow + event.Skip(); return; } @@ -706,7 +770,7 @@ void wxWizard::OnWizEvent(wxWizardEvent& event) // our public interface // ---------------------------------------------------------------------------- -#ifdef WXWIN_COMPATIBILITY_2_2 +#if WXWIN_COMPATIBILITY_2_2 /* static */ wxWizard *wxWizardBase::Create(wxWindow *parent,