src/generic/wizard.cpp

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        generic/wizard.cpp
   3 // Purpose:     generic implementation of wxWizard class
   4 // Author:      Vadim Zeitlin
   5 // Modified by: Robert Cavanaugh
   6 //              1) Added capability for wxWizardPage to accept resources
   7 //              2) Added "Help" button handler stub
   8 //              3) Fixed ShowPage() bug on displaying bitmaps
   9 // Created:     15.08.99
  10 // RCS-ID:      $Id$
  11 // Copyright:   (c) 1999 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
  12 // Licence:     wxWindows licence
  13 ///////////////////////////////////////////////////////////////////////////////
  14
  15 // ============================================================================
  16 // declarations
  17 // ============================================================================
  18
  19 // ----------------------------------------------------------------------------
  20 // headers
  21 // ----------------------------------------------------------------------------
  22
  23 #ifdef __GNUG__
  24     #pragma implementation "wizardg.h"
  25 #endif
  26
  27 // For compilers that support precompilation, includes "wx.h".
  28 #include "wx/wxprec.h"
  29
  30 #ifdef __BORLANDC__
  31     #pragma hdrstop
  32 #endif
  33
  34 #if wxUSE_WIZARDDLG
  35
  36 #ifndef WX_PRECOMP
  37     #include "wx/dynarray.h"
  38     #include "wx/intl.h"
  39     #include "wx/statbmp.h"
  40     #include "wx/button.h"
  41 #endif //WX_PRECOMP
  42
  43 #include "wx/statline.h"
  44
  45 #include "wx/wizard.h"
  46
  47 // ----------------------------------------------------------------------------
  48 // event tables and such
  49 // ----------------------------------------------------------------------------
  50
  51 DEFINE_EVENT_TYPE(wxEVT_WIZARD_PAGE_CHANGED)
  52 DEFINE_EVENT_TYPE(wxEVT_WIZARD_PAGE_CHANGING)
  53 DEFINE_EVENT_TYPE(wxEVT_WIZARD_CANCEL)
  54 DEFINE_EVENT_TYPE(wxEVT_WIZARD_FINISHED)
  55 DEFINE_EVENT_TYPE(wxEVT_WIZARD_HELP)
  56
  57 BEGIN_EVENT_TABLE(wxWizard, wxDialog)
  58     EVT_BUTTON(wxID_CANCEL, wxWizard::OnCancel)
  59     EVT_BUTTON(wxID_BACKWARD, wxWizard::OnBackOrNext)
  60     EVT_BUTTON(wxID_FORWARD, wxWizard::OnBackOrNext)
  61     EVT_BUTTON(wxID_HELP, wxWizard::OnHelp)
  62
  63     EVT_WIZARD_PAGE_CHANGED(-1, wxWizard::OnWizEvent)
  64     EVT_WIZARD_PAGE_CHANGING(-1, wxWizard::OnWizEvent)
  65     EVT_WIZARD_CANCEL(-1, wxWizard::OnWizEvent)
  66     EVT_WIZARD_FINISHED(-1, wxWizard::OnWizEvent)
  67     EVT_WIZARD_HELP(-1, wxWizard::OnWizEvent)
  68 END_EVENT_TABLE()
  69
  70 IMPLEMENT_DYNAMIC_CLASS(wxWizard, wxDialog)
  71 IMPLEMENT_ABSTRACT_CLASS(wxWizardPage, wxPanel)
  72 IMPLEMENT_DYNAMIC_CLASS(wxWizardPageSimple, wxWizardPage)
  73 IMPLEMENT_DYNAMIC_CLASS(wxWizardEvent, wxNotifyEvent)
  74
  75 // ============================================================================
  76 // implementation
  77 // ============================================================================
  78
  79 // ----------------------------------------------------------------------------
  80 // wxWizardPage
  81 // ----------------------------------------------------------------------------
  82
  83 void wxWizardPage::Init()
  84 {
  85     m_bitmap = wxNullBitmap;
  86 }
  87
  88 wxWizardPage::wxWizardPage(wxWizard *parent,
  89                            const wxBitmap& bitmap,
  90                            const wxChar *resource)
  91 {
  92     Create(parent, bitmap, resource);
  93 }
  94
  95 bool wxWizardPage::Create(wxWizard *parent,
  96                           const wxBitmap& bitmap,
  97                           const wxChar *resource)
  98 {
  99     if ( !wxPanel::Create(parent, -1) )
 100         return FALSE;
 101
 102     if ( resource != NULL )
 103     {
 104 #if wxUSE_WX_RESOURCES
 105         if ( !LoadFromResource(this, resource) )
 106         {
 107             wxFAIL_MSG(wxT("wxWizardPage LoadFromResource failed!!!!"));
 108         }
 109 #endif // wxUSE_RESOURCES
 110     }
 111
 112     m_bitmap = bitmap;
 113
 114     // initially the page is hidden, it's shown only when it becomes current
 115     Hide();
 116
 117     return TRUE;
 118 }
 119
 120 // ----------------------------------------------------------------------------
 121 // wxWizardPageSimple
 122 // ----------------------------------------------------------------------------
 123
 124 wxWizardPage *wxWizardPageSimple::GetPrev() const
 125 {
 126     return m_prev;
 127 }
 128
 129 wxWizardPage *wxWizardPageSimple::GetNext() const
 130 {
 131     return m_next;
 132 }
 133 // ----------------------------------------------------------------------------
 134 // generic wxWizard implementation
 135 // ----------------------------------------------------------------------------
 136
 137 void wxWizard::Init()
 138 {
 139     m_posWizard = wxDefaultPosition;
 140     m_page = (wxWizardPage *)NULL;
 141     m_btnPrev = m_btnNext = NULL;
 142     m_statbmp = NULL;
 143 }
 144
 145 bool wxWizard::Create(wxWindow *parent,
 146                    int id,
 147                    const wxString& title,
 148                    const wxBitmap& bitmap,
 149                    const wxPoint& pos)
 150 {
 151     m_posWizard = pos;
 152     m_bitmap = bitmap ;
 153
 154     // just create the dialog itself here, the controls will be created in
 155     // DoCreateControls() called later when we know our final size
 156     m_page = (wxWizardPage *)NULL;
 157     m_btnPrev = m_btnNext = NULL;
 158     m_statbmp = NULL;
 159
 160     return wxDialog::Create(parent, id, title, pos);
 161 }
 162
 163 void wxWizard::DoCreateControls()
 164 {
 165     // do nothing if the controls were already created
 166     if ( WasCreated() )
 167         return;
 168
 169     // constants defining the dialog layout
 170     // ------------------------------------
 171
 172     // these constants define the position of the upper left corner of the
 173     // bitmap or the page in the wizard
 174     static const int X_MARGIN = 10;
 175     static const int Y_MARGIN = 10;
 176
 177     // margin between the bitmap and the panel
 178     static const int BITMAP_X_MARGIN = 15;
 179
 180     // margin between the bitmap and the static line
 181     static const int BITMAP_Y_MARGIN = 15;
 182
 183     // margin between the static line and the buttons
 184     static const int SEPARATOR_LINE_MARGIN = 15;
 185
 186     // margin between "Next >" and "Cancel" buttons
 187     static const int BUTTON_MARGIN = 10;
 188
 189     // margin between Back and Next buttons
 190 #ifdef __WXMAC__
 191     static const int BACKNEXT_MARGIN = 10;
 192 #else
 193     static const int BACKNEXT_MARGIN = 0;
 194 #endif
 195
 196     // default width and height of the page
 197     static const int DEFAULT_PAGE_WIDTH = 270;
 198     static const int DEFAULT_PAGE_HEIGHT = 290;
 199
 200     // create controls
 201     // ---------------
 202
 203     wxSize sizeBtn = wxButton::GetDefaultSize();
 204
 205     // the global dialog layout is: a row of buttons at the bottom (aligned to
 206     // the right), the static line above them, the bitmap (if any) on the left
 207     // of the upper part of the dialog and the panel in the remaining space
 208     m_x = X_MARGIN;
 209     m_y = Y_MARGIN;
 210
 211     int defaultHeight;
 212     if ( m_bitmap.Ok() )
 213     {
 214         m_statbmp = new wxStaticBitmap(this, -1, m_bitmap, wxPoint(m_x, m_y));
 215
 216         m_x += m_bitmap.GetWidth() + BITMAP_X_MARGIN;
 217
 218         defaultHeight = m_bitmap.GetHeight();
 219     }
 220     else
 221     {
 222         m_statbmp = (wxStaticBitmap *)NULL;
 223
 224         defaultHeight = DEFAULT_PAGE_HEIGHT;
 225     }
 226
 227     // use default size if none given and also make sure that the dialog is
 228     // not less than the default size
 229     m_height = m_sizePage.y == -1 ? defaultHeight : m_sizePage.y;
 230     m_width = m_sizePage.x == -1 ? DEFAULT_PAGE_WIDTH : m_sizePage.x;
 231     if ( m_height < defaultHeight )
 232         m_height = defaultHeight;
 233     if ( m_width < DEFAULT_PAGE_WIDTH )
 234         m_width = DEFAULT_PAGE_WIDTH;
 235
 236     int x = X_MARGIN;
 237     int y = m_y + m_height + BITMAP_Y_MARGIN;
 238
 239 #if wxUSE_STATLINE
 240     (void)new wxStaticLine(this, -1, wxPoint(x, y),
 241                            wxSize(m_x + m_width - x, 2));
 242 #endif // wxUSE_STATLINE
 243
 244     x = m_x + m_width - 3*sizeBtn.x - BUTTON_MARGIN - BACKNEXT_MARGIN;
 245     y += SEPARATOR_LINE_MARGIN;
 246
 247     if (GetExtraStyle() & wxWIZARD_EX_HELPBUTTON)
 248     {
 249         x -= sizeBtn.x;
 250         x -= BUTTON_MARGIN ;
 251
 252         (void)new wxButton(this, wxID_HELP, _("&Help"), wxPoint(x, y), sizeBtn);
 253         x += sizeBtn.x;
 254         x += BUTTON_MARGIN ;
 255     }
 256
 257     m_btnPrev = new wxButton(this, wxID_BACKWARD, _("< &Back"), wxPoint(x, y), sizeBtn);
 258
 259     x += sizeBtn.x;
 260     x += BACKNEXT_MARGIN;
 261
 262     m_btnNext = new wxButton(this, wxID_FORWARD, _("&Next >"), wxPoint(x, y), sizeBtn);
 263
 264     x += sizeBtn.x + BUTTON_MARGIN;
 265     (void)new wxButton(this, wxID_CANCEL, _("&Cancel"), wxPoint(x, y), sizeBtn);
 266
 267     // position and size the dialog
 268     // ----------------------------
 269
 270     SetClientSize(m_x + m_width + X_MARGIN,
 271                   m_y + m_height + BITMAP_Y_MARGIN +
 272                     SEPARATOR_LINE_MARGIN + sizeBtn.y + Y_MARGIN);
 273
 274     if ( m_posWizard == wxDefaultPosition )
 275     {
 276         CentreOnScreen();
 277     }
 278 }
 279
 280 void wxWizard::SetPageSize(const wxSize& size)
 281 {
 282     // otherwise it will have no effect now as it's too late...
 283     wxASSERT_MSG( !WasCreated(), _T("should be called before RunWizard()!") );
 284
 285     m_sizePage = size;
 286 }
 287
 288 void wxWizard::FitToPage(const wxWizardPage *page)
 289 {
 290     // otherwise it will have no effect now as it's too late...
 291     wxASSERT_MSG( !WasCreated(), _T("should be called before RunWizard()!") );
 292
 293     wxSize sizeMax;
 294     while ( page )
 295     {
 296         wxSize size = page->GetBestSize();
 297
 298         if ( size.x > sizeMax.x )
 299             sizeMax.x = size.x;
 300
 301         if ( size.y > sizeMax.y )
 302             sizeMax.y = size.y;
 303
 304         page = page->GetNext();
 305     }
 306
 307     if ( sizeMax.x > m_sizePage.x )
 308         m_sizePage.x = sizeMax.x;
 309
 310     if ( sizeMax.y > m_sizePage.y )
 311         m_sizePage.y = sizeMax.y;
 312 }
 313
 314 bool wxWizard::ShowPage(wxWizardPage *page, bool goingForward)
 315 {
 316     wxASSERT_MSG( page != m_page, wxT("this is useless") );
 317
 318     // we'll use this to decide whether we have to change the label of this
 319     // button or not (initially the label is "Next")
 320     bool btnLabelWasNext = TRUE;
 321
 322     // Modified 10-20-2001 Robert Cavanaugh.
 323     // Fixed bug for displaying a new bitmap
 324     // in each *consecutive* page
 325
 326     // flag to indicate if this page uses a new bitmap
 327     bool bmpIsDefault = TRUE;
 328
 329     // use these labels to determine if we need to change the bitmap
 330     // for this page
 331     wxBitmap bmpPrev, bmpCur;
 332
 333     // check for previous page
 334     if ( m_page )
 335     {
 336         // send the event to the old page
 337         wxWizardEvent event(wxEVT_WIZARD_PAGE_CHANGING, GetId(), goingForward, m_page);
 338         if ( m_page->GetEventHandler()->ProcessEvent(event) &&
 339              !event.IsAllowed() )
 340         {
 341             // vetoed by the page
 342             return FALSE;
 343         }
 344
 345         m_page->Hide();
 346
 347         btnLabelWasNext = HasNextPage(m_page);
 348
 349         // Get the bitmap of the previous page (if it exists)
 350         if ( m_page->GetBitmap().Ok() )
 351         {
 352             bmpPrev = m_page->GetBitmap();
 353         }
 354     }
 355
 356     // set the new page
 357     m_page = page;
 358
 359     // is this the end?
 360     if ( !m_page )
 361     {
 362         // terminate successfully
 363         EndModal(wxID_OK);
 364         if ( !IsModal() )
 365          {
 366            wxWizardEvent event(wxEVT_WIZARD_FINISHED, GetId(),FALSE, 0);
 367            (void)GetEventHandler()->ProcessEvent(event);
 368          }
 369         return TRUE;
 370     }
 371
 372     // position and show the new page
 373     (void)m_page->TransferDataToWindow();
 374     m_page->SetSize(m_x, m_y, m_width, m_height);
 375
 376     // check if bitmap needs to be updated
 377     // update default flag as well
 378     if ( m_page->GetBitmap().Ok() )
 379     {
 380         bmpCur = m_page->GetBitmap();
 381         bmpIsDefault = FALSE;
 382     }
 383
 384     // change the bitmap if:
 385     // 1) a default bitmap was selected in constructor
 386     // 2) this page was constructed with a bitmap
 387     // 3) this bitmap is not the previous bitmap
 388     if ( m_statbmp && (bmpCur != bmpPrev) )
 389     {
 390         wxBitmap bmp;
 391         if ( bmpIsDefault )
 392             bmp = m_bitmap;
 393         else
 394             bmp = m_page->GetBitmap();
 395         m_statbmp->SetBitmap(bmp);
 396     }
 397
 398     // and update the buttons state
 399     m_btnPrev->Enable(HasPrevPage(m_page));
 400
 401     bool hasNext = HasNextPage(m_page);
 402     if ( btnLabelWasNext != hasNext )
 403     {
 404         // need to update
 405         if (btnLabelWasNext)
 406             m_btnNext->SetLabel(_("&Finish"));
 407         else
 408             m_btnNext->SetLabel(_("&Next >"));
 409     }
 410     // nothing to do: the label was already correct
 411
 412     // send the change event to the new page now
 413     wxWizardEvent event(wxEVT_WIZARD_PAGE_CHANGED, GetId(), goingForward, m_page);
 414     (void)m_page->GetEventHandler()->ProcessEvent(event);
 415
 416     // and finally show it
 417     m_page->Show();
 418     m_page->SetFocus();
 419
 420     return TRUE;
 421 }
 422
 423 bool wxWizard::RunWizard(wxWizardPage *firstPage)
 424 {
 425     wxCHECK_MSG( firstPage, FALSE, wxT("can't run empty wizard") );
 426
 427     DoCreateControls();
 428
 429     // can't return FALSE here because there is no old page
 430     (void)ShowPage(firstPage, TRUE /* forward */);
 431
 432     return ShowModal() == wxID_OK;
 433 }
 434
 435 wxWizardPage *wxWizard::GetCurrentPage() const
 436 {
 437     return m_page;
 438 }
 439
 440 wxSize wxWizard::GetPageSize() const
 441 {
 442     // make sure that the controls are created because otherwise m_width and
 443     // m_height would be both still -1
 444     wxConstCast(this, wxWizard)->DoCreateControls();
 445
 446     return wxSize(m_width, m_height);
 447 }
 448
 449 void wxWizard::OnCancel(wxCommandEvent& WXUNUSED(event))
 450 {
 451     // this function probably can never be called when we don't have an active
 452     // page, but a small extra check won't hurt
 453     wxWindow *win = m_page ? (wxWindow *)m_page : (wxWindow *)this;
 454
 455     wxWizardEvent event(wxEVT_WIZARD_CANCEL, GetId(), FALSE, m_page);
 456     if ( !win->GetEventHandler()->ProcessEvent(event) || event.IsAllowed() )
 457     {
 458         // no objections - close the dialog
 459         EndModal(wxID_CANCEL);
 460     }
 461     //else: request to Cancel ignored
 462 }
 463
 464 void wxWizard::OnBackOrNext(wxCommandEvent& event)
 465 {
 466     wxASSERT_MSG( (event.GetEventObject() == m_btnNext) ||
 467                   (event.GetEventObject() == m_btnPrev),
 468                   wxT("unknown button") );
 469
 470     // ask the current page first: notice that we do it before calling
 471     // GetNext/Prev() because the data transfered from the controls of the page
 472     // may change the value returned by these methods
 473     if ( m_page && !m_page->TransferDataFromWindow() )
 474     {
 475         // the page data is incorrect, don't do anything
 476         return;
 477     }
 478
 479     bool forward = event.GetEventObject() == m_btnNext;
 480
 481     wxWizardPage *page;
 482     if ( forward )
 483     {
 484         page = m_page->GetNext();
 485     }
 486     else // back
 487     {
 488         page = m_page->GetPrev();
 489
 490         wxASSERT_MSG( page, wxT("\"<Back\" button should have been disabled") );
 491     }
 492
 493     // just pass to the new page (or may be not - but we don't care here)
 494     (void)ShowPage(page, forward);
 495 }
 496
 497 void wxWizard::OnHelp(wxCommandEvent& WXUNUSED(event))
 498 {
 499     // this function probably can never be called when we don't have an active
 500     // page, but a small extra check won't hurt
 501     if(m_page != NULL)
 502     {
 503         // Create and send the help event to the specific page handler
 504         // event data contains the active page so that context-sensitive
 505         // help is possible
 506         wxWizardEvent eventHelp(wxEVT_WIZARD_HELP, GetId(), TRUE, m_page);
 507         (void)m_page->GetEventHandler()->ProcessEvent(eventHelp);
 508     }
 509 }
 510
 511 void wxWizard::OnWizEvent(wxWizardEvent& event)
 512 {
 513     // the dialogs have wxWS_EX_BLOCK_EVENTS style on by default but we want to
 514     // propagate wxEVT_WIZARD_XXX to the parent (if any), so do it manually
 515     if ( !(GetExtraStyle() & wxWS_EX_BLOCK_EVENTS) )
 516     {
 517         // the event will be propagated anyhow
 518         return;
 519     }
 520
 521     wxWindow *parent = GetParent();
 522
 523     if ( !parent || !parent->GetEventHandler()->ProcessEvent(event) )
 524     {
 525         event.Skip();
 526     }
 527 }
 528
 529 // ----------------------------------------------------------------------------
 530 // our public interface
 531 // ----------------------------------------------------------------------------
 532
 533 #ifdef WXWIN_COMPATIBILITY_2_2
 534
 535 /* static */
 536 wxWizard *wxWizardBase::Create(wxWindow *parent,
 537                                int id,
 538                                const wxString& title,
 539                                const wxBitmap& bitmap,
 540                                const wxPoint& pos,
 541                                const wxSize& WXUNUSED(size))
 542 {
 543     return new wxWizard(parent, id, title, bitmap, pos);
 544 }
 545
 546 #endif // WXWIN_COMPATIBILITY_2_2
 547
 548 // ----------------------------------------------------------------------------
 549 // wxWizardEvent
 550 // ----------------------------------------------------------------------------
 551
 552 wxWizardEvent::wxWizardEvent(wxEventType type, int id, bool direction, wxWizardPage* page)
 553              : wxNotifyEvent(type, id)
 554 {
 555     // Modified 10-20-2001 Robert Cavanaugh
 556     // add the active page to the event data
 557     m_direction = direction;
 558     m_page = page;
 559 }
 560
 561 #endif // wxUSE_WIZARDDLG