]> git.saurik.com Git - wxWidgets.git/blobdiff - src/generic/wizard.cpp
don't use strlen() to verify the length of the string as it can contain embedded...
[wxWidgets.git] / src / generic / wizard.cpp
index befab3da0848228ea85089c078b67c0d90f78f65..385a10d8b866151691ab633d5c0e6eefee4f1701 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
     #include "wx/intl.h"
     #include "wx/statbmp.h"
     #include "wx/button.h"
+    #include "wx/settings.h"
+    #include "wx/sizer.h"
 #endif //WX_PRECOMP
 
 #include "wx/statline.h"
-#include "wx/sizer.h"
-#include "wx/settings.h"
 
 #include "wx/wizard.h"
 
@@ -52,17 +52,26 @@ 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;
 };
 
@@ -168,9 +177,36 @@ wxWizardPage *wxWizardPageSimple::GetNext() const
 // ----------------------------------------------------------------------------
 
 wxWizardSizer::wxWizardSizer(wxWizard *owner)
-    : m_owner(owner)
+             : m_owner(owner),
+               m_childSize(wxDefaultSize)
+{
+}
+
+wxSizerItem *wxWizardSizer::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 wxWizardSizer::HidePages()
 {
-    m_childSizeValid = false;
+    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()
@@ -179,7 +215,7 @@ void wxWizardSizer::RecalcSizes()
     // 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(wxRect(m_position, m_size));
     }
 }
 
@@ -191,15 +227,15 @@ wxSize wxWizardSizer::CalcMin()
 wxSize wxWizardSizer::GetMaxChildSize()
 {
 #if !defined(__WXDEBUG__)
-    if ( m_childSizeValid )
+    if ( m_childSize.IsFullySpecified() )
         return m_childSize;
 #endif
 
     wxSize maxOfMin;
-    wxSizerItemList::compatibility_iterator childNode;
 
-    for(childNode = m_children.GetFirst(); childNode;
-        childNode = childNode->GetNext())
+    for ( wxSizerItemList::compatibility_iterator childNode = m_children.GetFirst();
+          childNode;
+          childNode = childNode->GetNext() )
     {
         wxSizerItem *child = childNode->GetData();
         maxOfMin.IncTo(child->CalcMin());
@@ -207,7 +243,7 @@ wxSize wxWizardSizer::GetMaxChildSize()
     }
 
 #ifdef __WXDEBUG__
-    if ( m_childSizeValid && m_childSize != maxOfMin )
+    if ( m_childSize.IsFullySpecified() && m_childSize != maxOfMin )
     {
         wxFAIL_MSG( _T("Size changed in wxWizard::GetPageAreaSizer()")
                     _T("after RunWizard().\n")
@@ -220,19 +256,15 @@ wxSize wxWizardSizer::GetMaxChildSize()
 
     if ( m_owner->m_started )
     {
-        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;
-
-    return m_children.IsEmpty() ? 5 : 0;
+    return m_owner->m_border;
 }
 
 wxSize wxWizardSizer::SiblingSize(wxSizerItem *child)
@@ -263,10 +295,6 @@ wxSize wxWizardSizer::SiblingSize(wxSizerItem *child)
 // generic wxWizard implementation
 // ----------------------------------------------------------------------------
 
-// FIXME: this is a hack
-WX_DEFINE_ARRAY_PTR(wxWizard *, wxModelessWizards);
-static wxModelessWizards modelessWizards;
-
 void wxWizard::Init()
 {
     m_posWizard = wxDefaultPosition;
@@ -275,10 +303,10 @@ void wxWizard::Init()
     m_statbmp = NULL;
     m_sizerBmpAndPage = NULL;
     m_sizerPage = NULL;
-    m_calledSetBorder = false;
-    m_border = 0;
+    m_border = 5;
     m_started = false;
-    modelessWizards.Add(this);
+    m_wasModal = false;
+    m_usingSizer = false;
 }
 
 bool wxWizard::Create(wxWindow *parent,
@@ -329,7 +357,7 @@ void wxWizard::AddBitmapRow(wxBoxSizer *mainColumn)
     }
 #endif
 
-    // Added to m_sizerBmpAndPage in FinishLayout
+    // Added to m_sizerBmpAndPage later
     m_sizerPage = new wxWizardSizer(this);
 }
 
@@ -393,7 +421,7 @@ void wxWizard::AddButtonRow(wxBoxSizer *mainColumn)
     // was created before the 'next' button.
 
     bool isPda = (wxSystemSettings::GetScreenType() <= wxSYS_SCREEN_PDA);
-    int buttonStyle = isPda ? wxBU_EXACTFIT : 0;    
+    int buttonStyle = isPda ? wxBU_EXACTFIT : 0;
 
     wxBoxSizer *buttonRow = new wxBoxSizer(wxHORIZONTAL);
 #ifdef __WXMAC__
@@ -458,10 +486,10 @@ void wxWizard::DoCreateControls()
         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);
 
@@ -474,48 +502,24 @@ void wxWizard::DoCreateControls()
     );
 
     AddBitmapRow(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);
 }
 
 void wxWizard::SetPageSize(const wxSize& size)
 {
-    wxCHECK_RET(!m_started,wxT("wxWizard::SetPageSize after RunWizard"));
+    wxCHECK_RET(!m_started, wxT("wxWizard::SetPageSize after RunWizard"));
     m_sizePage = 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()
-    );
-
-    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"));
+    wxCHECK_RET(!m_started, wxT("wxWizard::FitToPage after RunWizard"));
 
     while ( page )
     {
@@ -531,26 +535,35 @@ bool wxWizard::ShowPage(wxWizardPage *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;
 
-    // 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;
-
-    // use these labels to determine if we need to change the bitmap
-    // for this page
-    wxBitmap bmpPrev, bmpCur;
+    // remember the old bitmap (if any) to compare with the new one later
+    wxBitmap bmpPrev;
 
     // check for previous page
     if ( m_page )
     {
         // send the event to the old page
-        wxWizardEvent event(wxEVT_WIZARD_PAGE_CHANGING, GetId(), goingForward, m_page);
+        wxWizardEvent event(wxEVT_WIZARD_PAGE_CHANGING, GetId(),
+                            goingForward, m_page);
         if ( m_page->GetEventHandler()->ProcessEvent(event) &&
              !event.IsAllowed() )
         {
@@ -562,11 +575,10 @@ bool wxWizard::ShowPage(wxWizardPage *page, bool goingForward)
 
         btnLabelWasNext = HasNextPage(m_page);
 
-        // Get the bitmap of the previous page (if it exists)
-        if ( m_page->GetBitmap().Ok() )
-        {
-            bmpPrev = m_page->GetBitmap();
-        }
+        bmpPrev = m_page->GetBitmap();
+
+        if ( !m_usingSizer )
+            m_sizerBmpAndPage->Detach(m_page);
     }
 
     // set the new page
@@ -576,7 +588,7 @@ bool wxWizard::ShowPage(wxWizardPage *page, bool goingForward)
     if ( !m_page )
     {
         // terminate successfully
-        if(IsModal())
+        if ( IsModal() )
         {
             EndModal(wxID_OK);
         }
@@ -597,32 +609,33 @@ bool wxWizard::ShowPage(wxWizardPage *page, bool goingForward)
     // position and show the new page
     (void)m_page->TransferDataToWindow();
 
-    // wxWizardSizer::RecalcSizes wants to be called when m_page changes
-    m_sizerPage->RecalcSizes();
-
-    // check if bitmap needs to be updated
-    // update default flag as well
-    if ( m_page->GetBitmap().Ok() )
+    if ( m_usingSizer )
     {
-        bmpCur = m_page->GetBitmap();
-        bmpIsDefault = false;
+        // 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());
     }
 
 #if wxUSE_STATBMP
-    // change the bitmap if:
-    // 1) a default bitmap was selected in constructor
-    // 2) this page was constructed with a bitmap
-    // 3) this bitmap is not the previous bitmap
-    if ( m_statbmp && (bmpCur != bmpPrev) )
+    // update the bitmap if:it changed
+    if ( m_statbmp )
     {
-        wxBitmap bmp;
-        if ( bmpIsDefault )
+        wxBitmap bmp = m_page->GetBitmap();
+        if ( !bmp.Ok() )
             bmp = m_bitmap;
-        else
-            bmp = m_page->GetBitmap();
-        m_statbmp->SetBitmap(bmp);
+
+        if ( !bmpPrev.Ok() )
+            bmpPrev = m_bitmap;
+
+        if ( !bmp.IsSameAs(bmpPrev) )
+            m_statbmp->SetBitmap(bmp);
     }
-#endif
+#endif // wxUSE_STATBMP
+
 
     // and update the buttons state
     m_btnPrev->Enable(HasPrevPage(m_page));
@@ -630,15 +643,13 @@ bool wxWizard::ShowPage(wxWizardPage *page, bool goingForward)
     bool hasNext = HasNextPage(m_page);
     if ( btnLabelWasNext != hasNext )
     {
-        // need to update
-        if (btnLabelWasNext)
-            m_btnNext->SetLabel(_("&Finish"));
-        else
-            m_btnNext->SetLabel(_("&Next >"));
+        m_btnNext->SetLabel(hasNext ? _("&Next >") : _("&Finish"));
     }
-    m_btnNext->SetDefault();
     // nothing to do: the label was already correct
 
+    m_btnNext->SetDefault();
+
+
     // send the change event to the new page now
     wxWizardEvent event(wxEVT_WIZARD_PAGE_CHANGED, GetId(), goingForward, m_page);
     (void)m_page->GetEventHandler()->ProcessEvent(event);
@@ -647,6 +658,21 @@ bool wxWizard::ShowPage(wxWizardPage *page, bool goingForward)
     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;
 }
 
@@ -654,14 +680,10 @@ bool wxWizard::RunWizard(wxWizardPage *firstPage)
 {
     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 */);
 
-    modelessWizards.Remove(this);
+    m_wasModal = true;
 
     return ShowModal() == wxID_OK;
 }
@@ -672,48 +694,53 @@ wxWizardPage *wxWizard::GetCurrentPage() const
 }
 
 wxSize wxWizard::GetPageSize() const
-{
-    wxSize pageSize(GetManualPageSize());
-    pageSize.IncTo(m_sizerPage->GetMaxChildSize());
-    return pageSize;
-}
-
-wxSizer *wxWizard::GetPageAreaSizer() const
-{
-    return m_sizerPage;
-}
-
-void wxWizard::SetBorder(int border)
-{
-    wxCHECK_RET(!m_started,wxT("wxWizard::SetBorder after RunWizard"));
-
-    m_calledSetBorder = true;
-    m_border = border;
-}
-
-wxSize wxWizard::GetManualPageSize() const
 {
     // default width and height of the page
-    int DEFAULT_PAGE_WIDTH = 270;
-    int DEFAULT_PAGE_HEIGHT = 270;
-    bool isPda = (wxSystemSettings::GetScreenType() <= wxSYS_SCREEN_PDA);
-    if (isPda)
+    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;
     }
-    
-    wxSize totalPageSize(DEFAULT_PAGE_WIDTH,DEFAULT_PAGE_HEIGHT);
+    else // !PDA
+    {
+        DEFAULT_PAGE_WIDTH =
+        DEFAULT_PAGE_HEIGHT = 270;
+    }
 
-    totalPageSize.IncTo(m_sizePage);
+    // 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_statbmp )
     {
-        totalPageSize.IncTo(wxSize(0, m_bitmap.GetHeight()));
+        // make the page at least as tall as the bitmap
+        pageSize.IncTo(wxSize(0, m_bitmap.GetHeight()));
     }
 
-    return totalPageSize;
+    if ( m_usingSizer )
+    {
+        // make it big enough to contain all pages added to the sizer
+        pageSize.IncTo(m_sizerPage->GetMaxChildSize());
+    }
+
+    return pageSize;
+}
+
+wxSizer *wxWizard::GetPageAreaSizer() const
+{
+    return m_sizerPage;
+}
+
+void wxWizard::SetBorder(int border)
+{
+    wxCHECK_RET(!m_started, wxT("wxWizard::SetBorder after RunWizard"));
+
+    m_border = border;
 }
 
 void wxWizard::OnCancel(wxCommandEvent& WXUNUSED(eventUnused))
@@ -745,10 +772,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;
@@ -768,7 +797,7 @@ void wxWizard::OnBackOrNext(wxCommandEvent& event)
         wxASSERT_MSG( page, wxT("\"<Back\" button should have been disabled") );
     }
 
-    // just pass to the new page (or may be not - but we don't care here)
+    // just pass to the new page (or maybe not - but we don't care here)
     (void)ShowPage(page, forward);
 }
 
@@ -805,37 +834,17 @@ void wxWizard::OnWizEvent(wxWizardEvent& event)
         }
     }
 
-    if ( ( modelessWizards.Index(this) != wxNOT_FOUND ) &&
+    if ( ( !m_wasModal ) &&
          event.IsAllowed() &&
          ( event.GetEventType() == wxEVT_WIZARD_FINISHED ||
            event.GetEventType() == wxEVT_WIZARD_CANCEL
          )
        )
     {
-        modelessWizards.Remove(this);
         Destroy();
     }
 }
 
-// ----------------------------------------------------------------------------
-// our public interface
-// ----------------------------------------------------------------------------
-
-#if 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
 // ----------------------------------------------------------------------------