]> git.saurik.com Git - wxWidgets.git/blobdiff - src/generic/wizard.cpp
minor cleanup
[wxWidgets.git] / src / generic / wizard.cpp
index 15825ddc9603cb34e73d607a083744f469e14ced..bc07fcce141b78b70e06ebf79bee12da65c7bb57 100644 (file)
@@ -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
 // 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"
 
@@ -60,10 +57,10 @@ public:
 
     wxSize GetMaxChildSize();
     int Border() const;
-    
+
 private:
     wxSize SiblingSize(wxSizerItem *child);
-    
+
     wxWizard *m_owner;
     bool m_childSizeValid;
     wxSize m_childSize;
@@ -85,14 +82,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)
@@ -121,8 +126,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 )
     {
@@ -141,7 +146,7 @@ bool wxWizardPage::Create(wxWizard *parent,
     // initially the page is hidden, it's shown only when it becomes current
     Hide();
 
-    return TRUE;
+    return true;
 }
 
 // ----------------------------------------------------------------------------
@@ -191,7 +196,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 +223,7 @@ wxSize wxWizardSizer::GetMaxChildSize()
         m_childSizeValid = true;
         m_childSize = maxOfMin;
     }
-    
+
     return maxOfMin;
 }
 
@@ -233,7 +238,7 @@ int wxWizardSizer::Border() const
 wxSize wxWizardSizer::SiblingSize(wxSizerItem *child)
 {
     wxSize maxSibling;
-    
+
     if ( child->IsWindow() )
     {
         wxWizardPage *page = wxDynamicCast(child->GetWindow(), wxWizardPage);
@@ -250,7 +255,7 @@ wxSize wxWizardSizer::SiblingSize(wxSizerItem *child)
             }
         }
     }
-    
+
     return maxSibling;
 }
 
@@ -269,6 +274,7 @@ void wxWizard::Init()
     m_calledSetBorder = false;
     m_border = 0;
     m_started = false;
+    m_wasModal = false;
 }
 
 bool wxWizard::Create(wxWindow *parent,
@@ -279,12 +285,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;
 }
 
@@ -301,9 +307,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
@@ -316,6 +323,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);
@@ -325,7 +333,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
@@ -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;
@@ -355,38 +367,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
@@ -398,22 +452,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);
@@ -427,22 +489,30 @@ 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()
     );
-    
-    GetSizer()->SetSizeHints(this);
-    if ( m_posWizard == wxDefaultPosition )
-        CentreOnScreen();
+
+    if (!isPda)
+    {
+        GetSizer()->SetSizeHints(this);
+        if ( m_posWizard == wxDefaultPosition )
+            CentreOnScreen();
+    }
 }
 
 void wxWizard::FitToPage(const wxWizardPage *page)
 {
     wxCHECK_RET(!m_started,wxT("wxWizard::FitToPage after RunWizard"));
-    
+
     while ( page )
     {
         wxSize size = page->GetBestSize();
@@ -459,14 +529,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
@@ -481,7 +551,7 @@ bool wxWizard::ShowPage(wxWizardPage *page, bool goingForward)
              !event.IsAllowed() )
         {
             // vetoed by the page
-            return FALSE;
+            return false;
         }
 
         m_page->Hide();
@@ -502,18 +572,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();
 
@@ -522,9 +601,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
@@ -538,6 +618,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));
@@ -551,6 +632,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
@@ -561,22 +643,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;
 }
@@ -609,18 +690,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;
 }
 
@@ -630,11 +718,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
 }
@@ -681,7 +777,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);
     }
 }
@@ -693,36 +789,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
 // ----------------------------------------------------------------------------