Applied patch #840643 from Ian Brown with some modifications:

[wxWidgets.git] / src / generic / wizard.cpp

diff --git a/src/generic/wizard.cpp b/src/generic/wizard.cpp
index 15825ddc9603cb34e73d607a083744f469e14ced..ef910605681120fbd94227ec6c22eaaa53693ec2 100644 (file)
--- 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
 
@@ -93,6 +93,14 @@ BEGIN_EVENT_TABLE(wxWizard, wxDialog)
 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)
@@ -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())
@@ -341,6 +349,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,18 +368,26 @@ void wxWizard::AddBackNextPair(wxBoxSizer *buttonRow)
         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);
     mainColumn->Add(
         buttonRow,
@@ -375,9 +395,18 @@ void wxWizard::AddButtonRow(wxBoxSizer *mainColumn)
         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(
-            new wxButton(this, wxID_HELP, _("&Help")),
+            btnHelp,
             0, // Horizontally unstretchable
             wxALL, // Border all around, top aligned
             5 // Border width
@@ -386,7 +415,7 @@ void wxWizard::AddButtonRow(wxBoxSizer *mainColumn)
     AddBackNextPair(buttonRow);
     
     buttonRow->Add(
-        new wxButton(this, wxID_CANCEL, _("&Cancel")),
+        btnCancel,
         0, // Horizontally unstretchable
         wxALL, // Border all around, top aligned
         5 // Border width
@@ -503,11 +532,12 @@ 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);
-         }
+
+        // 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;
     }
 
@@ -708,7 +738,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,