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 license
  13 ///////////////////////////////////////////////////////////////////////////////
  14
  15 // ============================================================================
  16 // declarations
  17 // ============================================================================
  18
  19 // ----------------------------------------------------------------------------
  20 // headers
  21 // ----------------------------------------------------------------------------
  22
  23 #ifdef __GNUG__
  24     #pragma implementation ".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 // simple types
  49 // ----------------------------------------------------------------------------
  50
  51 WX_DEFINE_ARRAY(wxPanel *, wxArrayPages);
  52
  53 // ----------------------------------------------------------------------------
  54 // event tables and such
  55 // ----------------------------------------------------------------------------
  56
  57 DEFINE_EVENT_TYPE(wxEVT_WIZARD_PAGE_CHANGED)
  58 DEFINE_EVENT_TYPE(wxEVT_WIZARD_PAGE_CHANGING)
  59 DEFINE_EVENT_TYPE(wxEVT_WIZARD_CANCEL)
  60 DEFINE_EVENT_TYPE(wxEVT_WIZARD_HELP)
  61
  62 BEGIN_EVENT_TABLE(wxWizard, wxDialog)
  63     EVT_BUTTON(wxID_CANCEL, wxWizard::OnCancel)
  64     EVT_BUTTON(wxID_BACKWARD, wxWizard::OnBackOrNext)
  65     EVT_BUTTON(wxID_FORWARD, wxWizard::OnBackOrNext)
  66     EVT_BUTTON(wxID_HELP, wxWizard::OnHelp)
  67 END_EVENT_TABLE()
  68
  69 IMPLEMENT_DYNAMIC_CLASS(wxWizard, wxDialog)
  70 IMPLEMENT_ABSTRACT_CLASS(wxWizardPage, wxPanel)
  71 IMPLEMENT_DYNAMIC_CLASS(wxWizardPageSimple, wxWizardPage)
  72 IMPLEMENT_DYNAMIC_CLASS(wxWizardEvent, wxNotifyEvent)
  73
  74 // ============================================================================
  75 // implementation
  76 // ============================================================================
  77
  78 // ----------------------------------------------------------------------------
  79 // wxWizardPage
  80 // ----------------------------------------------------------------------------
  81
  82 wxWizardPage::wxWizardPage(wxWizard *parent,
  83                            const wxBitmap& bitmap,
  84                            const wxChar *resource)
  85             : wxPanel(parent)
  86 {
  87     if ( resource != NULL )
  88     {
  89 #if wxUSE_RESOURCES
  90         if ( !LoadFromResource(this, resource) )
  91         {
  92             wxFAIL_MSG(wxT("wxWizardPage LoadFromResource failed!!!!"));
  93         }
  94 #endif // wxUSE_RESOURCES
  95     }
  96
  97     m_PageBitmap = bitmap;
  98
  99     // initially the page is hidden, it's shown only when it becomes current
 100     Hide();
 101 }
 102
 103 // ----------------------------------------------------------------------------
 104 // wxWizardPageSimple
 105 // ----------------------------------------------------------------------------
 106
 107 wxWizardPage *wxWizardPageSimple::GetPrev() const
 108 {
 109     return m_prev;
 110 }
 111
 112 wxWizardPage *wxWizardPageSimple::GetNext() const
 113 {
 114     return m_next;
 115 }
 116 // ----------------------------------------------------------------------------
 117 // generic wxWizard implementation
 118 // ----------------------------------------------------------------------------
 119
 120 void wxWizard::Init()
 121 {
 122     m_posWizard = wxDefaultPosition;
 123     m_page = (wxWizardPage *)NULL;
 124     m_btnPrev = m_btnNext = NULL;
 125     m_statbmp = NULL;
 126 }
 127
 128 bool wxWizard::Create(wxWindow *parent,
 129                    int id,
 130                    const wxString& title,
 131                    const wxBitmap& bitmap,
 132                    const wxPoint& pos)
 133 {
 134     m_posWizard = pos;
 135     m_bitmap = bitmap ;
 136     // just create the dialog itself here, the controls will be created in
 137     // DoCreateControls() called later when we know our final size
 138     m_page = (wxWizardPage *)NULL;
 139     m_btnPrev = m_btnNext = NULL;
 140     m_statbmp = NULL;
 141
 142     return wxDialog::Create(parent, id, title, pos);
 143 }
 144
 145 void wxWizard::DoCreateControls()
 146 {
 147     // do nothing if the controls were already created
 148     if ( WasCreated() )
 149         return;
 150
 151     // constants defining the dialog layout
 152     // ------------------------------------
 153
 154     // these constants define the position of the upper left corner of the
 155     // bitmap or the page in the wizard
 156     static const int X_MARGIN = 10;
 157     static const int Y_MARGIN = 10;
 158
 159     // margin between the bitmap and the panel
 160     static const int BITMAP_X_MARGIN = 15;
 161
 162     // margin between the bitmap and the static line
 163     static const int BITMAP_Y_MARGIN = 15;
 164
 165     // margin between the static line and the buttons
 166     static const int SEPARATOR_LINE_MARGIN = 15;
 167
 168     // margin between "Next >" and "Cancel" buttons
 169     static const int BUTTON_MARGIN = 10;
 170
 171     // default width and height of the page
 172     static const int DEFAULT_PAGE_WIDTH = 270;
 173     static const int DEFAULT_PAGE_HEIGHT = 290;
 174
 175     // create controls
 176     // ---------------
 177
 178     wxSize sizeBtn = wxButton::GetDefaultSize();
 179
 180     // the global dialog layout is: a row of buttons at the bottom (aligned to
 181     // the right), the static line above them, the bitmap (if any) on the left
 182     // of the upper part of the dialog and the panel in the remaining space
 183     m_x = X_MARGIN;
 184     m_y = Y_MARGIN;
 185
 186     int defaultHeight;
 187     if ( m_bitmap.Ok() )
 188     {
 189         m_statbmp = new wxStaticBitmap(this, -1, m_bitmap, wxPoint(m_x, m_y));
 190
 191         m_x += m_bitmap.GetWidth() + BITMAP_X_MARGIN;
 192
 193         defaultHeight = m_bitmap.GetHeight();
 194     }
 195     else
 196     {
 197         m_statbmp = (wxStaticBitmap *)NULL;
 198
 199         defaultHeight = DEFAULT_PAGE_HEIGHT;
 200     }
 201
 202     // use default size if none given and also make sure that the dialog is
 203     // not less than the default size
 204     m_height = m_sizePage.y == -1 ? defaultHeight : m_sizePage.y;
 205     m_width = m_sizePage.x == -1 ? DEFAULT_PAGE_WIDTH : m_sizePage.x;
 206     if ( m_height < defaultHeight )
 207         m_height = defaultHeight;
 208     if ( m_width < DEFAULT_PAGE_WIDTH )
 209         m_width = DEFAULT_PAGE_WIDTH;
 210
 211     int x = X_MARGIN;
 212     int y = m_y + m_height + BITMAP_Y_MARGIN;
 213
 214 #if wxUSE_STATLINE
 215     (void)new wxStaticLine(this, -1, wxPoint(x, y),
 216                            wxSize(m_x + m_width - x, 2));
 217 #endif // wxUSE_STATLINE
 218
 219     x = m_x + m_width - 3*sizeBtn.x - BUTTON_MARGIN;
 220     y += SEPARATOR_LINE_MARGIN;
 221
 222     if (GetExtraStyle() & wxWIZARD_EX_HELPBUTTON)
 223     {
 224         x -= sizeBtn.x;
 225         x -= BUTTON_MARGIN ;
 226
 227         (void)new wxButton(this, wxID_HELP, _("&Help"), wxPoint(x, y), sizeBtn);
 228         x += sizeBtn.x;
 229         x += BUTTON_MARGIN ;
 230     }
 231
 232     m_btnPrev = new wxButton(this, wxID_BACKWARD, _("< &Back"), wxPoint(x, y), sizeBtn);
 233
 234     x += sizeBtn.x;
 235     m_btnNext = new wxButton(this, wxID_FORWARD, _("&Next >"), wxPoint(x, y), sizeBtn);
 236
 237     x += sizeBtn.x + BUTTON_MARGIN;
 238     (void)new wxButton(this, wxID_CANCEL, _("&Cancel"), wxPoint(x, y), sizeBtn);
 239
 240     // position and size the dialog
 241     // ----------------------------
 242
 243     SetClientSize(m_x + m_width + X_MARGIN,
 244                   m_y + m_height + BITMAP_Y_MARGIN +
 245                     SEPARATOR_LINE_MARGIN + sizeBtn.y + Y_MARGIN);
 246
 247     if ( m_posWizard == wxDefaultPosition )
 248     {
 249         CentreOnScreen();
 250     }
 251 }
 252
 253 void wxWizard::SetPageSize(const wxSize& size)
 254 {
 255     // otherwise it will have no effect now as it's too late...
 256     wxASSERT_MSG( !WasCreated(), _T("should be called before RunWizard()!") );
 257
 258     m_sizePage = size;
 259 }
 260
 261 bool wxWizard::ShowPage(wxWizardPage *page, bool goingForward)
 262 {
 263     wxASSERT_MSG( page != m_page, wxT("this is useless") );
 264
 265     // we'll use this to decide whether we have to change the label of this
 266     // button or not (initially the label is "Next")
 267     bool btnLabelWasNext = TRUE;
 268
 269     // Modified 10-20-2001 Robert Cavanaugh.
 270     // Fixed bug for displaying a new bitmap
 271     // in each *consecutive* page
 272
 273     // flag to indicate if this page uses a new bitmap
 274     bool bmpIsDefault = TRUE;
 275
 276     // use these labels to determine if we need to change the bitmap
 277     // for this page
 278     wxBitmap   PreviousBitmap = wxNullBitmap;
 279     wxBitmap   ThisBitmap = wxNullBitmap;
 280
 281     // check for previous page
 282     if ( m_page )
 283     {
 284         // send the event to the old page
 285         wxWizardEvent event(wxEVT_WIZARD_PAGE_CHANGING, GetId(), goingForward);
 286         if ( m_page->GetEventHandler()->ProcessEvent(event) &&
 287              !event.IsAllowed() )
 288         {
 289             // vetoed by the page
 290             return FALSE;
 291         }
 292
 293         m_page->Hide();
 294
 295         btnLabelWasNext = m_page->GetNext() != (wxWizardPage *)NULL;
 296
 297         // Get the bitmap of the previous page (if it exists)
 298         if(m_page->GetBitmap().Ok())
 299     {
 300             PreviousBitmap = m_page->GetBitmap();
 301         }
 302     }
 303
 304     // set the new page
 305     m_page = page;
 306
 307     // is this the end?
 308     if ( !m_page )
 309     {
 310         // terminate successfully
 311         EndModal(wxID_OK);
 312         return TRUE;
 313     }
 314
 315     // send the change event to the new page now
 316     wxWizardEvent event(wxEVT_WIZARD_PAGE_CHANGED, GetId(), goingForward);
 317     (void)m_page->GetEventHandler()->ProcessEvent(event);
 318
 319     // position and show the new page
 320     (void)m_page->TransferDataToWindow();
 321     m_page->SetSize(m_x, m_y, m_width, m_height);
 322     m_page->Show();
 323
 324     // check if bitmap needs to be updated
 325     // update default flag as well
 326     if(m_page->GetBitmap().Ok())
 327     {
 328         ThisBitmap = m_page->GetBitmap();
 329         bmpIsDefault = FALSE;
 330     }
 331
 332     // change the bitmap if:
 333     // 1) a default bitmap was selected in constructor
 334     // 2) this page was constructed with a bitmap
 335     // 3) this bitmap is not the previous bitmap
 336     if( m_statbmp && (ThisBitmap != PreviousBitmap) )
 337     {
 338         wxBitmap bmp;
 339         if ( bmpIsDefault )
 340             bmp = m_bitmap;
 341         else
 342             bmp = m_page->GetBitmap();
 343         m_statbmp->SetBitmap(bmp);
 344     }
 345
 346     // and update the buttons state
 347     m_btnPrev->Enable(m_page->GetPrev() != (wxWizardPage *)NULL);
 348
 349     bool hasNext = m_page->GetNext() != (wxWizardPage *)NULL;
 350     if ( btnLabelWasNext != hasNext )
 351     {
 352         // need to update
 353         if (btnLabelWasNext)
 354             m_btnNext->SetLabel(_("&Finish"));
 355         else
 356             m_btnNext->SetLabel(_("&Next >"));
 357     }
 358     // nothing to do: the label was already correct
 359
 360     return TRUE;
 361 }
 362
 363 bool wxWizard::RunWizard(wxWizardPage *firstPage)
 364 {
 365     wxCHECK_MSG( firstPage, FALSE, wxT("can't run empty wizard") );
 366
 367     DoCreateControls();
 368
 369     // can't return FALSE here because there is no old page
 370     (void)ShowPage(firstPage, TRUE /* forward */);
 371
 372     return ShowModal() == wxID_OK;
 373 }
 374
 375 wxWizardPage *wxWizard::GetCurrentPage() const
 376 {
 377     return m_page;
 378 }
 379
 380 wxSize wxWizard::GetPageSize() const
 381 {
 382     // make sure that the controls are created because otherwise m_width and
 383     // m_height would be both still -1
 384     wxConstCast(this, wxWizard)->DoCreateControls();
 385
 386     return wxSize(m_width, m_height);
 387 }
 388
 389 void wxWizard::OnCancel(wxCommandEvent& WXUNUSED(event))
 390 {
 391     // this function probably can never be called when we don't have an active
 392     // page, but a small extra check won't hurt
 393     wxWindow *win = m_page ? (wxWindow *)m_page : (wxWindow *)this;
 394
 395     wxWizardEvent event(wxEVT_WIZARD_CANCEL, GetId());
 396     if ( !win->GetEventHandler()->ProcessEvent(event) || event.IsAllowed() )
 397     {
 398         // no objections - close the dialog
 399         EndModal(wxID_CANCEL);
 400     }
 401     //else: request to Cancel ignored
 402 }
 403
 404 void wxWizard::OnBackOrNext(wxCommandEvent& event)
 405 {
 406     wxASSERT_MSG( (event.GetEventObject() == m_btnNext) ||
 407                   (event.GetEventObject() == m_btnPrev),
 408                   wxT("unknown button") );
 409
 410     // ask the current page first: notice that we do it before calling
 411     // GetNext/Prev() because the data transfered from the controls of the page
 412     // may change the value returned by these methods
 413     if ( m_page && !m_page->TransferDataFromWindow() )
 414     {
 415         // the page data is incorrect, don't do anything
 416         return;
 417     }
 418
 419     bool forward = event.GetEventObject() == m_btnNext;
 420
 421     wxWizardPage *page;
 422     if ( forward )
 423     {
 424         page = m_page->GetNext();
 425     }
 426     else // back
 427     {
 428         page = m_page->GetPrev();
 429
 430         wxASSERT_MSG( page, wxT("\"<Back\" button should have been disabled") );
 431     }
 432
 433     // just pass to the new page (or may be not - but we don't care here)
 434     (void)ShowPage(page, forward);
 435 }
 436
 437 void wxWizard::OnHelp(wxCommandEvent& WXUNUSED(event))
 438 {
 439     // this function probably can never be called when we don't have an active
 440     // page, but a small extra check won't hurt
 441     if(m_page != NULL)
 442     {
 443         // Create and send the help event to the specific page handler
 444         // event data contains the active page so that context-sensitive
 445         // help is possible
 446         wxWizardEvent eventHelp(wxEVT_WIZARD_HELP, GetId(), TRUE, m_page);
 447         (void)m_page->GetEventHandler()->ProcessEvent(eventHelp);
 448     }
 449 }
 450
 451
 452 // ----------------------------------------------------------------------------
 453 // our public interface
 454 // ----------------------------------------------------------------------------
 455
 456 /* static */
 457 wxWizard *wxWizardBase::Create(wxWindow *parent,
 458                                int id,
 459                                const wxString& title,
 460                                const wxBitmap& bitmap,
 461                                const wxPoint& pos,
 462                                const wxSize& WXUNUSED(size))
 463 {
 464     return new wxWizard(parent, id, title, bitmap, pos);
 465 }
 466
 467 // ----------------------------------------------------------------------------
 468 // wxWizardEvent
 469 // ----------------------------------------------------------------------------
 470
 471 wxWizardEvent::wxWizardEvent(wxEventType type, int id, bool direction, wxWizardPage* page)
 472              : wxNotifyEvent(type, id)
 473 {
 474     // Modified 10-20-2001 Robert Cavanaugh
 475     // add the active page to the event data
 476     m_direction = direction;
 477     m_page = page;
 478 }
 479
 480 #endif // wxUSE_WIZARDDLG