Added ability to switch off more components of the size page UI

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

diff --git a/src/generic/wizard.cpp b/src/generic/wizard.cpp
index 5fcf9f92070177198f40f35b48026070cbc26504..60d8fa754b025a6dcaf2a982f265644393e6e3a0 100644 (file)
--- a/src/generic/wizard.cpp
+++ b/src/generic/wizard.cpp
@@ -81,11 +81,13 @@ private:
 // event tables and such
 // ----------------------------------------------------------------------------
 
 // event tables and such
 // ----------------------------------------------------------------------------
 

-DEFINE_EVENT_TYPE(wxEVT_WIZARD_PAGE_CHANGED)
-DEFINE_EVENT_TYPE(wxEVT_WIZARD_PAGE_CHANGING)
-DEFINE_EVENT_TYPE(wxEVT_WIZARD_CANCEL)
-DEFINE_EVENT_TYPE(wxEVT_WIZARD_FINISHED)
-DEFINE_EVENT_TYPE(wxEVT_WIZARD_HELP)
+wxDEFINE_EVENT( wxEVT_WIZARD_PAGE_CHANGED, wxWizardEvent );
+wxDEFINE_EVENT( wxEVT_WIZARD_PAGE_CHANGING, wxWizardEvent );
+wxDEFINE_EVENT( wxEVT_WIZARD_BEFORE_PAGE_CHANGED, wxWizardEvent );
+wxDEFINE_EVENT( wxEVT_WIZARD_CANCEL, wxWizardEvent );
+wxDEFINE_EVENT( wxEVT_WIZARD_FINISHED, wxWizardEvent );
+wxDEFINE_EVENT( wxEVT_WIZARD_HELP, wxWizardEvent );
+wxDEFINE_EVENT( wxEVT_WIZARD_PAGE_SHOWN, wxWizardEvent );

 
 BEGIN_EVENT_TABLE(wxWizard, wxDialog)
     EVT_BUTTON(wxID_CANCEL, wxWizard::OnCancel)
 
 BEGIN_EVENT_TABLE(wxWizard, wxDialog)
     EVT_BUTTON(wxID_CANCEL, wxWizard::OnCancel)


@@ -214,11 +216,6 @@ wxSize wxWizardSizer::CalcMin()
 
 wxSize wxWizardSizer::GetMaxChildSize()
 {
 
 wxSize wxWizardSizer::GetMaxChildSize()
 {

-#if !defined(__WXDEBUG__)
-    if ( m_childSize.IsFullySpecified() )
-        return m_childSize;
-#endif
-

     wxSize maxOfMin;
 
     for ( wxSizerItemList::compatibility_iterator childNode = m_children.GetFirst();
     wxSize maxOfMin;
 
     for ( wxSizerItemList::compatibility_iterator childNode = m_children.GetFirst();


@@ -230,21 +227,6 @@ wxSize wxWizardSizer::GetMaxChildSize()
         maxOfMin.IncTo(SiblingSize(child));
     }
 
         maxOfMin.IncTo(SiblingSize(child));
     }
 

-    // No longer applicable since we may change sizes when size adaptation is done
-#if 0
-#ifdef __WXDEBUG__
-    if ( m_childSize.IsFullySpecified() && m_childSize != maxOfMin )
-    {
-        wxFAIL_MSG( _T("Size changed in wxWizard::GetPageAreaSizer()")
-                    _T("after RunWizard().\n")
-                    _T("Did you forget to call GetSizer()->Fit(this) ")
-                    _T("for some page?")) ;
-
-        return m_childSize;
-    }
-#endif // __WXDEBUG__
-#endif
-

     if ( m_owner->m_started )
     {
         m_childSize = maxOfMin;
     if ( m_owner->m_started )
     {
         m_childSize = maxOfMin;


@@ -289,7 +271,7 @@ wxSize wxWizardSizer::SiblingSize(wxSizerItem *child)
 void wxWizard::Init()
 {
     m_posWizard = wxDefaultPosition;
 void wxWizard::Init()
 {
     m_posWizard = wxDefaultPosition;

-    m_page = (wxWizardPage *)NULL;
+    m_page = NULL;

     m_btnPrev = m_btnNext = NULL;
     m_statbmp = NULL;
     m_sizerBmpAndPage = NULL;
     m_btnPrev = m_btnNext = NULL;
     m_statbmp = NULL;
     m_sizerBmpAndPage = NULL;


@@ -335,7 +317,7 @@ void wxWizard::AddBitmapRow(wxBoxSizer *mainColumn)
     mainColumn->Add(
         m_sizerBmpAndPage,
         1, // Vertically stretchable
     mainColumn->Add(
         m_sizerBmpAndPage,
         1, // Vertically stretchable

-        wxEXPAND // Horizonal stretching, no border
+        wxEXPAND // Horizontal stretching, no border

     );
     mainColumn->Add(0,5,
         0, // No vertical stretching
     );
     mainColumn->Add(0,5,
         0, // No vertical stretching


@@ -343,7 +325,7 @@ void wxWizard::AddBitmapRow(wxBoxSizer *mainColumn)
     );
 
 #if wxUSE_STATBMP
     );
 
 #if wxUSE_STATBMP

-    if ( m_bitmap.Ok() )
+    if ( m_bitmap.IsOk() )

     {
         wxSize bitmapSize(wxDefaultSize);
         if (GetBitmapPlacement())
     {
         wxSize bitmapSize(wxDefaultSize);
         if (GetBitmapPlacement())


@@ -389,15 +371,8 @@ void wxWizard::AddStaticLine(wxBoxSizer *mainColumn)
 void wxWizard::AddBackNextPair(wxBoxSizer *buttonRow)
 {
     wxASSERT_MSG( m_btnNext && m_btnPrev,
 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;
-#else
-    static const int BACKNEXT_MARGIN = 0;
-#endif
+                  wxT("You must create the buttons before calling ")
+                  wxT("wxWizard::AddBackNextPair") );

 
     wxBoxSizer *backNextPair = new wxBoxSizer(wxHORIZONTAL);
     buttonRow->Add(
 
     wxBoxSizer *backNextPair = new wxBoxSizer(wxHORIZONTAL);
     buttonRow->Add(


@@ -408,7 +383,7 @@ void wxWizard::AddBackNextPair(wxBoxSizer *buttonRow)
     );
 
     backNextPair->Add(m_btnPrev);
     );
 
     backNextPair->Add(m_btnPrev);

-    backNextPair->Add(BACKNEXT_MARGIN,0,
+    backNextPair->Add(10, 0,

         0, // No horizontal stretching
         wxEXPAND // No border, (mostly useless) vertical stretching
     );
         0, // No horizontal stretching
         wxEXPAND // No border, (mostly useless) vertical stretching
     );


@@ -422,7 +397,7 @@ void wxWizard::AddButtonRow(wxBoxSizer *mainColumn)
     // 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
     // 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'
+    // every time. 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.
     // 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.


@@ -451,7 +426,7 @@ void wxWizard::AddButtonRow(wxBoxSizer *mainColumn)
     wxButton *btnHelp=0;
 #ifdef __WXMAC__
     if (GetExtraStyle() & wxWIZARD_EX_HELPBUTTON)
     wxButton *btnHelp=0;
 #ifdef __WXMAC__
     if (GetExtraStyle() & wxWIZARD_EX_HELPBUTTON)

-        btnHelp=new wxButton(this, wxID_HELP, _("&Help"), wxDefaultPosition, wxDefaultSize, buttonStyle);
+        btnHelp=new wxButton(this, wxID_HELP, wxEmptyString, wxDefaultPosition, wxDefaultSize, buttonStyle);

 #endif
 
     m_btnNext = new wxButton(this, wxID_FORWARD, _("&Next >"));
 #endif
 
     m_btnNext = new wxButton(this, wxID_FORWARD, _("&Next >"));


@@ -558,10 +533,6 @@ 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;
-

     // remember the old bitmap (if any) to compare with the new one later
     wxBitmap bmpPrev;
 
     // remember the old bitmap (if any) to compare with the new one later
     wxBitmap bmpPrev;
 


@@ -580,19 +551,14 @@ bool wxWizard::ShowPage(wxWizardPage *page, bool goingForward)
 
         m_page->Hide();
 
 
         m_page->Hide();
 

-        btnLabelWasNext = HasNextPage(m_page);
-

         bmpPrev = m_page->GetBitmap();
 
         if ( !m_usingSizer )
             m_sizerBmpAndPage->Detach(m_page);
     }
 
         bmpPrev = m_page->GetBitmap();
 
         if ( !m_usingSizer )
             m_sizerBmpAndPage->Detach(m_page);
     }
 

-    // set the new page
-    m_page = page;
-

     // is this the end?
     // is this the end?

-    if ( !m_page )
+    if ( !page )

     {
         // terminate successfully
         if ( IsModal() )
     {
         // terminate successfully
         if ( IsModal() )


@@ -607,12 +573,18 @@ bool wxWizard::ShowPage(wxWizardPage *page, bool goingForward)
 
         // and notify the user code (this is especially useful for modeless
         // wizards)
 
         // and notify the user code (this is especially useful for modeless
         // wizards)

-        wxWizardEvent event(wxEVT_WIZARD_FINISHED, GetId(), false, 0);
+        wxWizardEvent event(wxEVT_WIZARD_FINISHED, GetId(), false, m_page);

         (void)GetEventHandler()->ProcessEvent(event);
 
         (void)GetEventHandler()->ProcessEvent(event);
 

+        m_page = NULL;
+

         return true;
     }
 
         return true;
     }
 

+    // notice that we change m_page only here so that wxEVT_WIZARD_FINISHED
+    // event above could still use the correct (i.e. old) value of m_page
+    m_page = page;
+

     // position and show the new page
     (void)m_page->TransferDataToWindow();
 
     // position and show the new page
     (void)m_page->TransferDataToWindow();
 


@@ -633,10 +605,10 @@ bool wxWizard::ShowPage(wxWizardPage *page, bool goingForward)
     if ( m_statbmp )
     {
         bmp = m_page->GetBitmap();
     if ( m_statbmp )
     {
         bmp = m_page->GetBitmap();

-        if ( !bmp.Ok() )
+        if ( !bmp.IsOk() )

             bmp = m_bitmap;
 
             bmp = m_bitmap;
 

-        if ( !bmpPrev.Ok() )
+        if ( !bmpPrev.IsOk() )

             bmpPrev = m_bitmap;
 
         if (!GetBitmapPlacement())
             bmpPrev = m_bitmap;
 
         if (!GetBitmapPlacement())


@@ -651,15 +623,10 @@ bool wxWizard::ShowPage(wxWizardPage *page, bool goingForward)
     // and update the buttons state
     m_btnPrev->Enable(HasPrevPage(m_page));
 
     // and update the buttons state
     m_btnPrev->Enable(HasPrevPage(m_page));
 

-    bool hasNext = HasNextPage(m_page);
-    if ( btnLabelWasNext != hasNext )
-    {
-        if ( hasNext )
-            m_btnNext->SetLabel(_("&Next >"));
-        else
-            m_btnNext->SetLabel(_("&Finish"));
-    }
-    // nothing to do: the label was already correct
+    const bool hasNext = HasNextPage(m_page);
+    const wxString label = hasNext ? _("&Next >") : _("&Finish");
+    if ( label != m_btnNext->GetLabel() )
+        m_btnNext->SetLabel(label);

 
     m_btnNext->SetDefault();
 
 
     m_btnNext->SetDefault();
 


@@ -693,6 +660,10 @@ bool wxWizard::ShowPage(wxWizardPage *page, bool goingForward)
             m_sizerPage->RecalcSizes();
     }
 
             m_sizerPage->RecalcSizes();
     }
 

+    wxWizardEvent pageShownEvent(wxEVT_WIZARD_PAGE_SHOWN, GetId(),
+        goingForward, m_page);
+    m_page->GetEventHandler()->ProcessEvent(pageShownEvent);
+

     return true;
 }
 
     return true;
 }
 


@@ -809,10 +780,10 @@ void wxWizard::OnBackOrNext(wxCommandEvent& event)
                   (event.GetEventObject() == m_btnPrev),
                   wxT("unknown button") );
 
                   (event.GetEventObject() == m_btnPrev),
                   wxT("unknown button") );
 

-    wxCHECK_RET( m_page, _T("should have a valid current page") );
+    wxCHECK_RET( m_page, wxT("should have a valid current page") );

 
     // ask the current page first: notice that we do it before calling
 
     // ask the current page first: notice that we do it before calling

-    // GetNext/Prev() because the data transfered from the controls of the page
+    // GetNext/Prev() because the data transferred from the controls of the page

     // may change the value returned by these methods
     if ( !m_page->Validate() || !m_page->TransferDataFromWindow() )
     {
     // may change the value returned by these methods
     if ( !m_page->Validate() || !m_page->TransferDataFromWindow() )
     {


@@ -822,6 +793,13 @@ void wxWizard::OnBackOrNext(wxCommandEvent& event)
 
     bool forward = event.GetEventObject() == m_btnNext;
 
 
     bool forward = event.GetEventObject() == m_btnNext;
 

+    // Give the application a chance to set state which may influence GetNext()/GetPrev()
+    wxWizardEvent eventPreChanged(wxEVT_WIZARD_BEFORE_PAGE_CHANGED, GetId(), forward, m_page);
+    (void)m_page->GetEventHandler()->ProcessEvent(eventPreChanged);
+
+    if (!eventPreChanged.IsAllowed())
+        return;
+

     wxWizardPage *page;
     if ( forward )
     {
     wxWizardPage *page;
     if ( forward )
     {


@@ -945,6 +923,9 @@ bool wxWizard::DoLayoutAdaptation()
 
     wxStandardDialogLayoutAdapter::DoFitWithScrolling(this, windows);
 
 
     wxStandardDialogLayoutAdapter::DoFitWithScrolling(this, windows);
 

+    // Size event doesn't get sent soon enough on wxGTK
+    DoLayout();
+

     SetLayoutAdaptationDone(true);
 
     return true;
     SetLayoutAdaptationDone(true);
 
     return true;


@@ -955,7 +936,7 @@ bool wxWizard::ResizeBitmap(wxBitmap& bmp)
     if (!GetBitmapPlacement())
         return false;
 
     if (!GetBitmapPlacement())
         return false;
 

-    if (bmp.Ok())
+    if (bmp.IsOk())

     {
         wxSize pageSize = m_sizerPage->GetSize();
         if (pageSize == wxSize(0,0))
     {
         wxSize pageSize = m_sizerPage->GetSize();
         if (pageSize == wxSize(0,0))


@@ -963,7 +944,7 @@ bool wxWizard::ResizeBitmap(wxBitmap& bmp)
         int bitmapWidth = wxMax(bmp.GetWidth(), GetMinimumBitmapWidth());
         int bitmapHeight = pageSize.y;
 
         int bitmapWidth = wxMax(bmp.GetWidth(), GetMinimumBitmapWidth());
         int bitmapHeight = pageSize.y;
 

-        if (!m_statbmp->GetBitmap().Ok() || m_statbmp->GetBitmap().GetHeight() != bitmapHeight)
+        if (!m_statbmp->GetBitmap().IsOk() || m_statbmp->GetBitmap().GetHeight() != bitmapHeight)

         {
             wxBitmap bitmap(bitmapWidth, bitmapHeight);
             {
         {
             wxBitmap bitmap(bitmapWidth, bitmapHeight);
             {