don't include windows.h unless neccessary

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

diff --git a/src/generic/wizard.cpp b/src/generic/wizard.cpp
index 4d70f33f01c58b10485a02af669fc5b9cf963a06..eed6e10755973e8622f6eff18a0e8a8ae6a287e6 100644 (file)
--- a/src/generic/wizard.cpp
+++ b/src/generic/wizard.cpp
@@ -2,7 +2,10 @@
 // Name:        generic/wizard.cpp
 // Purpose:     generic implementation of wxWizard class
 // Author:      Vadim Zeitlin
 // Name:        generic/wizard.cpp
 // Purpose:     generic implementation of wxWizard class
 // Author:      Vadim Zeitlin

-// Modified by:
+// Modified by: Robert Cavanaugh
+//              1) Added capability for wxWizardPage to accept resources
+//              2) Added "Help" button handler stub
+//              3) Fixed ShowPage() bug on displaying bitmaps

 // Created:     15.08.99
 // RCS-ID:      $Id$
 // Copyright:   (c) 1999 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
 // Created:     15.08.99
 // RCS-ID:      $Id$
 // Copyright:   (c) 1999 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>


@@ -28,10 +31,13 @@
     #pragma hdrstop
 #endif
 
     #pragma hdrstop
 #endif
 

+#if wxUSE_WIZARDDLG
+

 #ifndef WX_PRECOMP
     #include "wx/dynarray.h"
     #include "wx/intl.h"
     #include "wx/statbmp.h"
 #ifndef WX_PRECOMP
     #include "wx/dynarray.h"
     #include "wx/intl.h"
     #include "wx/statbmp.h"

+    #include "wx/button.h"

 #endif //WX_PRECOMP
 
 #include "wx/statline.h"
 #endif //WX_PRECOMP
 
 #include "wx/statline.h"


@@ -48,9 +54,16 @@ WX_DEFINE_ARRAY(wxPanel *, wxArrayPages);
 // 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_HELP)
+

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

-    EVT_BUTTON(-1, wxWizard::OnBackOrNext)
+    EVT_BUTTON(wxID_BACKWARD, wxWizard::OnBackOrNext)
+    EVT_BUTTON(wxID_FORWARD, wxWizard::OnBackOrNext)
+    EVT_BUTTON(wxID_HELP, wxWizard::OnHelp)

 END_EVENT_TABLE()
 
 IMPLEMENT_DYNAMIC_CLASS(wxWizard, wxDialog)
 END_EVENT_TABLE()
 
 IMPLEMENT_DYNAMIC_CLASS(wxWizard, wxDialog)


@@ -66,8 +79,23 @@ IMPLEMENT_DYNAMIC_CLASS(wxWizardEvent, wxNotifyEvent)
 // wxWizardPage
 // ----------------------------------------------------------------------------
 
 // wxWizardPage
 // ----------------------------------------------------------------------------
 

-wxWizardPage::wxWizardPage(wxWizard *parent) : wxPanel(parent)
+wxWizardPage::wxWizardPage(wxWizard *parent,
+                           const wxBitmap& bitmap,
+                           const wxChar *resource)
+            : wxPanel(parent)

 {
 {

+    if ( resource != NULL )
+    {
+#if wxUSE_RESOURCES
+        if ( !LoadFromResource(this, resource) )
+        {
+            wxFAIL_MSG(wxT("wxWizardPage LoadFromResource failed!!!!"));
+        }
+#endif // wxUSE_RESOURCES
+    }
+
+    m_bitmap = bitmap;
+

     // initially the page is hidden, it's shown only when it becomes current
     Hide();
 }
     // initially the page is hidden, it's shown only when it becomes current
     Hide();
 }


@@ -89,13 +117,38 @@ wxWizardPage *wxWizardPageSimple::GetNext() const
 // generic wxWizard implementation
 // ----------------------------------------------------------------------------
 
 // generic wxWizard implementation
 // ----------------------------------------------------------------------------
 

-wxWizard::wxWizard(wxWindow *parent,
+void wxWizard::Init()
+{
+    m_posWizard = wxDefaultPosition;
+    m_page = (wxWizardPage *)NULL;
+    m_btnPrev = m_btnNext = NULL;
+    m_statbmp = NULL;
+}
+
+bool wxWizard::Create(wxWindow *parent,

                    int id,
                    const wxString& title,
                    const wxBitmap& bitmap,
                    int id,
                    const wxString& title,
                    const wxBitmap& bitmap,

-                   const wxPoint& pos,
-                   const wxSize& size)
+                   const wxPoint& pos)
+{
+    m_posWizard = pos;
+    m_bitmap = bitmap ;
+
+    // just create the dialog itself here, the controls will be created in
+    // DoCreateControls() called later when we know our final size
+    m_page = (wxWizardPage *)NULL;
+    m_btnPrev = m_btnNext = NULL;
+    m_statbmp = NULL;
+
+    return wxDialog::Create(parent, id, title, pos);
+}
+
+void wxWizard::DoCreateControls()

 {
 {

+    // do nothing if the controls were already created
+    if ( WasCreated() )
+        return;
+

     // constants defining the dialog layout
     // ------------------------------------
 
     // constants defining the dialog layout
     // ------------------------------------
 


@@ -120,36 +173,41 @@ wxWizard::wxWizard(wxWindow *parent,
     static const int DEFAULT_PAGE_WIDTH = 270;
     static const int DEFAULT_PAGE_HEIGHT = 290;
 
     static const int DEFAULT_PAGE_WIDTH = 270;
     static const int DEFAULT_PAGE_HEIGHT = 290;
 

-    // init members
-    // ------------
-
-    m_page = (wxWizardPage *)NULL;
-

     // create controls
     // ---------------
 
     wxSize sizeBtn = wxButton::GetDefaultSize();
 
     // create controls
     // ---------------
 
     wxSize sizeBtn = wxButton::GetDefaultSize();
 

-    (void)wxDialog::Create(parent, id, title, pos, size);
-

     // the global dialog layout is: a row of buttons at the bottom (aligned to
     // the right), the static line above them, the bitmap (if any) on the left
     // of the upper part of the dialog and the panel in the remaining space
     m_x = X_MARGIN;
     m_y = Y_MARGIN;
     // the global dialog layout is: a row of buttons at the bottom (aligned to
     // the right), the static line above them, the bitmap (if any) on the left
     // of the upper part of the dialog and the panel in the remaining space
     m_x = X_MARGIN;
     m_y = Y_MARGIN;

-    if ( bitmap.Ok() )
+
+    int defaultHeight;
+    if ( m_bitmap.Ok() )

     {
     {

-        (void)new wxStaticBitmap(this, -1, bitmap, wxPoint(m_x, m_y));
+        m_statbmp = new wxStaticBitmap(this, -1, m_bitmap, wxPoint(m_x, m_y));
+
+        m_x += m_bitmap.GetWidth() + BITMAP_X_MARGIN;

 
 

-        m_x += bitmap.GetWidth() + BITMAP_X_MARGIN;
-        m_height = bitmap.GetHeight();
+        defaultHeight = m_bitmap.GetHeight();

     }
     else
     {
     }
     else
     {

-        m_height = DEFAULT_PAGE_HEIGHT;
+        m_statbmp = (wxStaticBitmap *)NULL;
+
+        defaultHeight = DEFAULT_PAGE_HEIGHT;

     }
 
     }
 

-    m_width = DEFAULT_PAGE_WIDTH;
+    // use default size if none given and also make sure that the dialog is
+    // not less than the default size
+    m_height = m_sizePage.y == -1 ? defaultHeight : m_sizePage.y;
+    m_width = m_sizePage.x == -1 ? DEFAULT_PAGE_WIDTH : m_sizePage.x;
+    if ( m_height < defaultHeight )
+        m_height = defaultHeight;
+    if ( m_width < DEFAULT_PAGE_WIDTH )
+        m_width = DEFAULT_PAGE_WIDTH;

 
     int x = X_MARGIN;
     int y = m_y + m_height + BITMAP_Y_MARGIN;
 
     int x = X_MARGIN;
     int y = m_y + m_height + BITMAP_Y_MARGIN;


@@ -157,51 +215,73 @@ wxWizard::wxWizard(wxWindow *parent,
 #if wxUSE_STATLINE
     (void)new wxStaticLine(this, -1, wxPoint(x, y),
                            wxSize(m_x + m_width - x, 2));
 #if wxUSE_STATLINE
     (void)new wxStaticLine(this, -1, wxPoint(x, y),
                            wxSize(m_x + m_width - x, 2));

-#endif
+#endif // wxUSE_STATLINE

 
     x = m_x + m_width - 3*sizeBtn.x - BUTTON_MARGIN;
     y += SEPARATOR_LINE_MARGIN;
 
     x = m_x + m_width - 3*sizeBtn.x - BUTTON_MARGIN;
     y += SEPARATOR_LINE_MARGIN;

-    m_btnPrev = new wxButton(this, -1, _("< &Back"), wxPoint(x, y), sizeBtn);
+
+    if (GetExtraStyle() & wxWIZARD_EX_HELPBUTTON)
+    {
+        x -= sizeBtn.x;
+        x -= BUTTON_MARGIN ;
+
+        (void)new wxButton(this, wxID_HELP, _("&Help"), wxPoint(x, y), sizeBtn);
+        x += sizeBtn.x;
+        x += BUTTON_MARGIN ;
+    }
+
+    m_btnPrev = new wxButton(this, wxID_BACKWARD, _("< &Back"), wxPoint(x, y), sizeBtn);

 
     x += sizeBtn.x;
 
     x += sizeBtn.x;

-    m_btnNext = new wxButton(this, -1, _("&Next >"), wxPoint(x, y), sizeBtn);
+    m_btnNext = new wxButton(this, wxID_FORWARD, _("&Next >"), wxPoint(x, y), sizeBtn);

 
     x += sizeBtn.x + BUTTON_MARGIN;
 
     x += sizeBtn.x + BUTTON_MARGIN;

-    (void)new wxButton(this, wxID_CANCEL, _("Cancel"), wxPoint(x, y), sizeBtn);
+    (void)new wxButton(this, wxID_CANCEL, _("&Cancel"), wxPoint(x, y), sizeBtn);

 
     // position and size the dialog
     // ----------------------------
 
 
     // position and size the dialog
     // ----------------------------
 

-    if ( size == wxDefaultSize )
-    {
-        SetClientSize(m_x + m_width + X_MARGIN,
-                      m_y + m_height + BITMAP_Y_MARGIN +
-                        SEPARATOR_LINE_MARGIN + sizeBtn.y + Y_MARGIN);
-    }
+    SetClientSize(m_x + m_width + X_MARGIN,
+                  m_y + m_height + BITMAP_Y_MARGIN +
+                    SEPARATOR_LINE_MARGIN + sizeBtn.y + Y_MARGIN);

 
 

-    if ( pos == wxDefaultPosition )
+    if ( m_posWizard == wxDefaultPosition )

     {
     {

-        Centre();
+        CentreOnScreen();

     }
 }
 
     }
 }
 

+void wxWizard::SetPageSize(const wxSize& size)
+{
+    // otherwise it will have no effect now as it's too late...
+    wxASSERT_MSG( !WasCreated(), _T("should be called before RunWizard()!") );
+
+    m_sizePage = size;
+}
+

 bool wxWizard::ShowPage(wxWizardPage *page, bool goingForward)
 {
 bool wxWizard::ShowPage(wxWizardPage *page, bool goingForward)
 {

-    wxASSERT_MSG( page != m_page, _T("this is useless") );
+    wxASSERT_MSG( page != m_page, wxT("this is useless") );

 
     // 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;
 
 
     // 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   PreviousBitmap = wxNullBitmap;
+    wxBitmap   ThisBitmap = wxNullBitmap;
+
+    // check for previous page

     if ( m_page )
     {
     if ( m_page )
     {

-        // ask the current page first
-        if ( !m_page->TransferDataFromWindow() )
-        {
-            // the page data is incorrect
-            return FALSE;
-        }
-

         // send the event to the old page
         wxWizardEvent event(wxEVT_WIZARD_PAGE_CHANGING, GetId(), goingForward);
         if ( m_page->GetEventHandler()->ProcessEvent(event) &&
         // send the event to the old page
         wxWizardEvent event(wxEVT_WIZARD_PAGE_CHANGING, GetId(), goingForward);
         if ( m_page->GetEventHandler()->ProcessEvent(event) &&


@@ -214,9 +294,15 @@ bool wxWizard::ShowPage(wxWizardPage *page, bool goingForward)
         m_page->Hide();
 
         btnLabelWasNext = m_page->GetNext() != (wxWizardPage *)NULL;
         m_page->Hide();
 
         btnLabelWasNext = m_page->GetNext() != (wxWizardPage *)NULL;

+
+        // Get the bitmap of the previous page (if it exists)
+        if(m_page->GetBitmap().Ok())
+    {
+            PreviousBitmap = m_page->GetBitmap();
+        }

     }
 
     }
 

-    // set the new one
+    // set the new page

     m_page = page;
 
     // is this the end?
     m_page = page;
 
     // is this the end?


@@ -224,11 +310,10 @@ bool wxWizard::ShowPage(wxWizardPage *page, bool goingForward)
     {
         // terminate successfully
         EndModal(wxID_OK);
     {
         // terminate successfully
         EndModal(wxID_OK);

-

         return TRUE;
     }
 
         return TRUE;
     }
 

-    // send the event to the new page now
+    // send the change event to the new page now

     wxWizardEvent event(wxEVT_WIZARD_PAGE_CHANGED, GetId(), goingForward);
     (void)m_page->GetEventHandler()->ProcessEvent(event);
 
     wxWizardEvent event(wxEVT_WIZARD_PAGE_CHANGED, GetId(), goingForward);
     (void)m_page->GetEventHandler()->ProcessEvent(event);
 


@@ -237,13 +322,39 @@ bool wxWizard::ShowPage(wxWizardPage *page, bool goingForward)
     m_page->SetSize(m_x, m_y, m_width, m_height);
     m_page->Show();
 
     m_page->SetSize(m_x, m_y, m_width, m_height);
     m_page->Show();
 

+    // check if bitmap needs to be updated
+    // update default flag as well
+    if(m_page->GetBitmap().Ok())
+    {
+        ThisBitmap = m_page->GetBitmap();
+        bmpIsDefault = FALSE;
+    }
+
+    // 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 && (ThisBitmap != PreviousBitmap) )
+    {
+        wxBitmap bmp;
+        if ( bmpIsDefault )
+            bmp = m_bitmap;
+        else
+            bmp = m_page->GetBitmap();
+        m_statbmp->SetBitmap(bmp);
+    }
+

     // and update the buttons state
     m_btnPrev->Enable(m_page->GetPrev() != (wxWizardPage *)NULL);
 
     // and update the buttons state
     m_btnPrev->Enable(m_page->GetPrev() != (wxWizardPage *)NULL);
 

-    if ( btnLabelWasNext != (m_page->GetNext() != (wxWizardPage *)NULL) )
+    bool hasNext = m_page->GetNext() != (wxWizardPage *)NULL;
+    if ( btnLabelWasNext != hasNext )

     {
         // need to update
     {
         // need to update

-        m_btnNext->SetLabel(btnLabelWasNext ? _("&Finish") : _("&Next >"));
+        if (btnLabelWasNext)
+            m_btnNext->SetLabel(_("&Finish"));
+        else
+            m_btnNext->SetLabel(_("&Next >"));

     }
     // nothing to do: the label was already correct
 
     }
     // nothing to do: the label was already correct
 


@@ -252,7 +363,9 @@ bool wxWizard::ShowPage(wxWizardPage *page, bool goingForward)
 
 bool wxWizard::RunWizard(wxWizardPage *firstPage)
 {
 
 bool wxWizard::RunWizard(wxWizardPage *firstPage)
 {

-    wxCHECK_MSG( firstPage, FALSE, _T("can't run empty wizard") );
+    wxCHECK_MSG( firstPage, FALSE, wxT("can't run empty wizard") );
+
+    DoCreateControls();

 
     // 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 */);


@@ -265,6 +378,15 @@ wxWizardPage *wxWizard::GetCurrentPage() const
     return m_page;
 }
 
     return m_page;
 }
 

+wxSize wxWizard::GetPageSize() const
+{
+    // make sure that the controls are created because otherwise m_width and
+    // m_height would be both still -1
+    wxConstCast(this, wxWizard)->DoCreateControls();
+
+    return wxSize(m_width, m_height);
+}
+

 void wxWizard::OnCancel(wxCommandEvent& WXUNUSED(event))
 {
     // this function probably can never be called when we don't have an active
 void wxWizard::OnCancel(wxCommandEvent& WXUNUSED(event))
 {
     // this function probably can never be called when we don't have an active


@@ -284,7 +406,16 @@ void wxWizard::OnBackOrNext(wxCommandEvent& event)
 {
     wxASSERT_MSG( (event.GetEventObject() == m_btnNext) ||
                   (event.GetEventObject() == m_btnPrev),
 {
     wxASSERT_MSG( (event.GetEventObject() == m_btnNext) ||
                   (event.GetEventObject() == m_btnPrev),

-                  _T("unknown button") );
+                  wxT("unknown button") );
+
+    // 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->TransferDataFromWindow() )
+    {
+        // the page data is incorrect, don't do anything
+        return;
+    }

 
     bool forward = event.GetEventObject() == m_btnNext;
 
 
     bool forward = event.GetEventObject() == m_btnNext;
 


@@ -297,13 +428,28 @@ void wxWizard::OnBackOrNext(wxCommandEvent& event)
     {
         page = m_page->GetPrev();
 
     {
         page = m_page->GetPrev();
 

-        wxASSERT_MSG( page, _T("\"<Back\" button should have been disabled") );
+        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)
     (void)ShowPage(page, forward);
 }
 
     }
 
     // just pass to the new page (or may be not - but we don't care here)
     (void)ShowPage(page, forward);
 }
 

+void wxWizard::OnHelp(wxCommandEvent& WXUNUSED(event))
+{
+    // this function probably can never be called when we don't have an active
+    // page, but a small extra check won't hurt
+    if(m_page != NULL)
+    {
+        // 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);
+        (void)m_page->GetEventHandler()->ProcessEvent(eventHelp);
+    }
+}
+
+

 // ----------------------------------------------------------------------------
 // our public interface
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // our public interface
 // ----------------------------------------------------------------------------


@@ -314,18 +460,22 @@ wxWizard *wxWizardBase::Create(wxWindow *parent,
                                const wxString& title,
                                const wxBitmap& bitmap,
                                const wxPoint& pos,
                                const wxString& title,
                                const wxBitmap& bitmap,
                                const wxPoint& pos,

-                               const wxSize& size)
+                               const wxSize& WXUNUSED(size))

 {
 {

-    return new wxWizard(parent, id, title, bitmap, pos, size);
+    return new wxWizard(parent, id, title, bitmap, pos);

 }
 
 // ----------------------------------------------------------------------------
 // wxWizardEvent
 // ----------------------------------------------------------------------------
 
 }
 
 // ----------------------------------------------------------------------------
 // wxWizardEvent
 // ----------------------------------------------------------------------------
 

-wxWizardEvent::wxWizardEvent(wxEventType type, int id, bool direction)
+wxWizardEvent::wxWizardEvent(wxEventType type, int id, bool direction, wxWizardPage* page)

              : wxNotifyEvent(type, id)
 {
              : wxNotifyEvent(type, id)
 {

+    // Modified 10-20-2001 Robert Cavanaugh
+    // add the active page to the event data

     m_direction = direction;
     m_direction = direction;

+    m_page = page;

 }
 
 }
 

+#endif // wxUSE_WIZARDDLG