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