1. fixed typo ('&' instead of '|') in wxNotebook

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

diff --git a/src/generic/wizard.cpp b/src/generic/wizard.cpp
index 6fec89ad790d2a8944dfc2e1e6e4b27d8ecfeb63..e515042bec56b2e5fb11de31530827cad0e15206 100644 (file)
--- a/src/generic/wizard.cpp
+++ b/src/generic/wizard.cpp
@@ -28,9 +28,13 @@
     #pragma hdrstop
 #endif
 
     #pragma hdrstop
 #endif
 

+#if wxUSE_WIZARDDLG
+

 #ifndef WX_PRECOMP
     #include "wx/dynarray.h"
     #include "wx/intl.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"


@@ -44,95 +48,77 @@
 WX_DEFINE_ARRAY(wxPanel *, wxArrayPages);
 
 // ----------------------------------------------------------------------------
 WX_DEFINE_ARRAY(wxPanel *, wxArrayPages);
 
 // ----------------------------------------------------------------------------

-// wxWizardGeneric - generic implementation of wxWizard
+// event tables and such

 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 

-class wxWizardGeneric : public wxWizard
-{
-public:
-    // ctor
-    wxWizardGeneric(wxWindow *parent,
-                    int id,
-                    const wxString& title,
-                    const wxBitmap& bitmap,
-                    const wxPoint& pos,
-                    const wxSize& size);
-
-    // implement base class pure virtuals
-    virtual void AddPage(wxPanel *page);
-    virtual void InsertPage(int nPage, wxPanel *page);
-    virtual bool RunWizard();
-    virtual wxPanel *GetCurrentPage() const;
-
-    // implementation only from now on
-    // -------------------------------
-
-    // is the wizard running?
-    bool IsRunning() const { return m_page != -1; }
-
-    // show the given page calling TransferDataFromWindow - if it returns
-    // FALSE, the old page is not hidden and the function returns FALSE
-    bool ShowPage(size_t page);
-
-    // get the current page assuming the wizard is running
-    wxPanel *DoGetCurrentPage() const
-    {
-        wxASSERT_MSG( IsRunning(), _T("no current page!") );
-
-        return m_pages[(size_t)m_page];
-    }
-
-    // place the given page correctly and hide it
-    void DoAddPage(wxPanel *page);
-
-private:
-    // event handlers
-    void OnCancel(wxCommandEvent& event);
-    void OnBackOrNext(wxCommandEvent& event);
+DEFINE_EVENT_TYPE(wxEVT_WIZARD_PAGE_CHANGED)
+DEFINE_EVENT_TYPE(wxEVT_WIZARD_PAGE_CHANGING)
+DEFINE_EVENT_TYPE(wxEVT_WIZARD_CANCEL)

 
 

-    // wizard dimensions
-    int          m_x, m_y;      // the origin for the pages
-    int          m_width,       // the size of the page itself
-                 m_height;      // (total width is m_width + m_x)
-
-    // wizard state
-    int          m_page;        // the current page or -1
-    wxArrayPages m_pages;       // the array with all wizards pages
+BEGIN_EVENT_TABLE(wxWizard, wxDialog)
+    EVT_BUTTON(wxID_CANCEL, wxWizard::OnCancel)
+    EVT_BUTTON(-1, wxWizard::OnBackOrNext)
+END_EVENT_TABLE()

 
 

-    // wizard controls
-    wxButton    *m_btnPrev,     // the "<Back" button
-                *m_btnNext;     // the "Next>" or "Finish" button
+IMPLEMENT_DYNAMIC_CLASS(wxWizard, wxDialog)
+IMPLEMENT_ABSTRACT_CLASS(wxWizardPage, wxPanel)
+IMPLEMENT_DYNAMIC_CLASS(wxWizardPageSimple, wxWizardPage)
+IMPLEMENT_DYNAMIC_CLASS(wxWizardEvent, wxNotifyEvent)

 
 

-    DECLARE_EVENT_TABLE()
-};
+// ============================================================================
+// implementation
+// ============================================================================

 
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------

-// event tables and such
+// wxWizardPage

 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 

-BEGIN_EVENT_TABLE(wxWizardGeneric, wxDialog)
-    EVT_BUTTON(wxID_CANCEL, OnCancel)
-    EVT_BUTTON(-1, OnBackOrNext)
-END_EVENT_TABLE()
+wxWizardPage::wxWizardPage(wxWizard *parent, const wxBitmap& bitmap)
+            : wxPanel(parent), m_bitmap(bitmap)
+{
+    // initially the page is hidden, it's shown only when it becomes current
+    Hide();
+}

 
 

-IMPLEMENT_ABSTRACT_CLASS(wxWizard, wxDialog)
-IMPLEMENT_DYNAMIC_CLASS(wxWizardEvent, wxNotifyEvent)
+// ----------------------------------------------------------------------------
+// wxWizardPageSimple
+// ----------------------------------------------------------------------------

 
 

-// ============================================================================
-// implementation
-// ============================================================================
+wxWizardPage *wxWizardPageSimple::GetPrev() const
+{
+    return m_prev;
+}

 
 

+wxWizardPage *wxWizardPageSimple::GetNext() const
+{
+    return m_next;
+}

 // ----------------------------------------------------------------------------
 // generic wxWizard implementation
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 // generic wxWizard implementation
 // ----------------------------------------------------------------------------
 

-wxWizardGeneric::wxWizardGeneric(wxWindow *parent,
-                                 int id,
-                                 const wxString& title,
-                                 const wxBitmap& bitmap,
-                                 const wxPoint& pos,
-                                 const wxSize& size)
+wxWizard::wxWizard(wxWindow *parent,
+                   int id,
+                   const wxString& title,
+                   const wxBitmap& bitmap,
+                   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;
+
+    (void)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
     // ------------------------------------
 


@@ -157,48 +143,56 @@ wxWizardGeneric::wxWizardGeneric(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 = -1;
-

     // 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 += bitmap.GetWidth() + BITMAP_X_MARGIN;
-        m_height = bitmap.GetHeight();
+        m_x += m_bitmap.GetWidth() + BITMAP_X_MARGIN;
+
+        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;

+
+#if wxUSE_STATLINE

     (void)new wxStaticLine(this, -1, wxPoint(x, y),
                            wxSize(m_x + m_width - x, 2));
     (void)new wxStaticLine(this, -1, wxPoint(x, y),
                            wxSize(m_x + m_width - x, 2));

+#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);
+    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;
     (void)new wxButton(this, wxID_CANCEL, _("Cancel"), wxPoint(x, y), sizeBtn);
 
     x += sizeBtn.x + BUTTON_MARGIN;
     (void)new wxButton(this, wxID_CANCEL, _("Cancel"), wxPoint(x, y), sizeBtn);


@@ -206,96 +200,136 @@ wxWizardGeneric::wxWizardGeneric(wxWindow *parent,
     // 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();

     }
 }
 
     }
 }
 

-bool wxWizardGeneric::ShowPage(size_t page)
+void wxWizard::SetPageSize(const wxSize& size)

 {
 {

-    wxCHECK_MSG( page < m_pages.GetCount(), FALSE,
-                 _T("invalid wizard page index") );
+    // otherwise it will have no effect now as it's too late...
+    wxASSERT_MSG( !WasCreated(), _T("should be called before RunWizard()!") );

 
 

-    wxASSERT_MSG( page != (size_t)m_page, _T("this is useless") );
+    m_sizePage = size;
+}
+
+bool wxWizard::ShowPage(wxWizardPage *page, bool goingForward)
+{
+    wxASSERT_MSG( page != m_page, wxT("this is useless") );

 
 

-    size_t last = m_pages.GetCount() - 1;
-    bool mustChangeNextBtnLabel = (size_t)m_page == last || page == last;
+    // 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;

 
 

-    if ( m_page != -1 )
+    // and this tells us whether we already had the default bitmap before
+    bool bmpWasDefault = TRUE;
+
+    if ( m_page )

     {
     {

-        wxPanel *panel = DoGetCurrentPage();
-        if ( !panel->TransferDataFromWindow() )
+        // send the event to the old page
+        wxWizardEvent event(wxEVT_WIZARD_PAGE_CHANGING, GetId(), goingForward);
+        if ( m_page->GetEventHandler()->ProcessEvent(event) &&
+             !event.IsAllowed() )
+        {
+            // vetoed by the page

             return FALSE;
             return FALSE;

+        }
+
+        m_page->Hide();

 
 

-        panel->Hide();
+        btnLabelWasNext = m_page->GetNext() != (wxWizardPage *)NULL;
+        bmpWasDefault = !m_page->GetBitmap().Ok();

     }
 
     }
 

+    // set the new one

     m_page = page;
     m_page = page;

-    DoGetCurrentPage()->Show();

 
 

-    // update the buttons state
-    m_btnPrev->Enable(m_page != 0);
-    if ( mustChangeNextBtnLabel )
+    // is this the end?
+    if ( !m_page )

     {
     {

-        m_btnNext->SetLabel((size_t)m_page == last ? _("&Finish")
-                                                   : _("&Next >"));
+        // terminate successfully
+        EndModal(wxID_OK);
+
+        return TRUE;

     }
 
     }
 

-    return TRUE;
-}
+    // send the event to the new page now
+    wxWizardEvent event(wxEVT_WIZARD_PAGE_CHANGED, GetId(), goingForward);
+    (void)m_page->GetEventHandler()->ProcessEvent(event);

 
 

-void wxWizardGeneric::DoAddPage(wxPanel *page)
-{
-    page->Hide();
-    page->SetSize(m_x, m_y, m_width, m_height);
-}
+    // position and show the new page
+    (void)m_page->TransferDataToWindow();
+    m_page->SetSize(m_x, m_y, m_width, m_height);
+    m_page->Show();

 
 

-void wxWizardGeneric::AddPage(wxPanel *page)
-{
-    m_pages.Add(page);
+    // change the bitmap if necessary (and if we have it at all)
+    bool bmpIsDefault = !m_page->GetBitmap().Ok();
+    if ( m_statbmp && (bmpIsDefault != bmpWasDefault) )
+    {
+        wxBitmap bmp;
+        if ( bmpIsDefault )
+            bmp = m_bitmap;
+        else
+            bmp = m_page->GetBitmap();
+        m_statbmp->SetBitmap(bmp);
+    }

 
 

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

 
 

-void wxWizardGeneric::InsertPage(int nPage, wxPanel *page)
-{
-    m_pages.Insert(page, nPage);
-    if ( nPage < m_page )
+    bool hasNext = m_page->GetNext() != (wxWizardPage *)NULL;
+    if ( btnLabelWasNext != hasNext )

     {
     {

-        // the indices of all pages after the inserted one are shifted by 1
-        m_page++;
+        // need to update
+        if (btnLabelWasNext)
+            m_btnNext->SetLabel(_("&Finish"));
+        else
+            m_btnNext->SetLabel(_("&Next >"));

     }
     }

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

 
 

-    DoAddPage(page);
+    return TRUE;

 }
 
 }
 

-bool wxWizardGeneric::RunWizard()
+bool wxWizard::RunWizard(wxWizardPage *firstPage)

 {
 {

-    wxCHECK_MSG( m_pages.GetCount() != 0, 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
 
     // can't return FALSE here because there is no old page

-    (void)ShowPage(0u);
+    (void)ShowPage(firstPage, TRUE /* forward */);

 
     return ShowModal() == wxID_OK;
 }
 
 
     return ShowModal() == wxID_OK;
 }
 

-wxPanel *wxWizardGeneric::GetCurrentPage() const
+wxWizardPage *wxWizard::GetCurrentPage() const

 {
 {

-    return IsRunning() ? DoGetCurrentPage() : (wxPanel *)NULL;
+    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 wxWizardGeneric::OnCancel(wxCommandEvent& WXUNUSED(event))
+void wxWizard::OnCancel(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
+    wxWindow *win = m_page ? (wxWindow *)m_page : (wxWindow *)this;
+

     wxWizardEvent event(wxEVT_WIZARD_CANCEL, GetId());
     wxWizardEvent event(wxEVT_WIZARD_CANCEL, GetId());

-    if ( !GetEventHandler()->ProcessEvent(event) || event.IsAllowed() )
+    if ( !win->GetEventHandler()->ProcessEvent(event) || event.IsAllowed() )

     {
         // no objections - close the dialog
         EndModal(wxID_CANCEL);
     {
         // no objections - close the dialog
         EndModal(wxID_CANCEL);


@@ -303,53 +337,62 @@ void wxWizardGeneric::OnCancel(wxCommandEvent& WXUNUSED(event))
     //else: request to Cancel ignored
 }
 
     //else: request to Cancel ignored
 }
 

-void wxWizardGeneric::OnBackOrNext(wxCommandEvent& event)
+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") );

 
 

-    int delta = event.GetEventObject() == m_btnNext ? 1 : -1;
-    int page = m_page + delta;
+    // 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;
+    }

 
 

-    wxASSERT_MSG( page >= 0, _T("'Back' button should have been disabled!") );
+    bool forward = event.GetEventObject() == m_btnNext;

 
 

-    if ( (size_t)page == m_pages.GetCount() )
+    wxWizardPage *page;
+    if ( forward )

     {
     {

-        // check that we have valid data in the last page too
-        if ( m_pages.Last()->TransferDataFromWindow() )
-        {
-            // that's all, folks!
-            EndModal(wxID_OK);
-        }
+        page = m_page->GetNext();

     }
     }

-    else
+    else // back

     {
     {

-        // just pass to the next page (or may be not - but we don't care here)
-        (void)ShowPage(page);
+        page = m_page->GetPrev();
+
+        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);

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

-/* static */ wxWizard *wxWizard::Create(wxWindow *parent,
-                                        int id,
-                                        const wxString& title,
-                                        const wxBitmap& bitmap,
-                                        const wxPoint& pos,
-                                        const wxSize& size)
+/* static */
+wxWizard *wxWizardBase::Create(wxWindow *parent,
+                               int id,
+                               const wxString& title,
+                               const wxBitmap& bitmap,
+                               const wxPoint& pos,
+                               const wxSize& WXUNUSED(size))

 {
 {

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

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

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

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

-    m_page = m_pageOld = -1;
+    m_direction = direction;

 }
 }

+
+#endif // wxUSE_WIZARDDLG