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 // Robert Vazan (sizers)
12 // Copyright: (c) 1999 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
13 // Licence: wxWindows licence
14 ///////////////////////////////////////////////////////////////////////////////
16 // ============================================================================
18 // ============================================================================
20 // ----------------------------------------------------------------------------
22 // ----------------------------------------------------------------------------
24 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
25 #pragma implementation "wizardg.h"
28 // For compilers that support precompilation, includes "wx.h".
29 #include "wx/wxprec.h"
38 #include "wx/dynarray.h"
40 #include "wx/statbmp.h"
41 #include "wx/button.h"
44 #include "wx/statline.h"
47 #include "wx/wizard.h"
49 // ----------------------------------------------------------------------------
51 // ----------------------------------------------------------------------------
53 class wxWizardSizer
: public wxSizer
56 wxWizardSizer(wxWizard
*owner
);
61 wxSize
GetMaxChildSize();
65 wxSize
SiblingSize(wxSizerItem
*child
);
68 bool m_childSizeValid
;
72 // ----------------------------------------------------------------------------
73 // event tables and such
74 // ----------------------------------------------------------------------------
76 DEFINE_EVENT_TYPE(wxEVT_WIZARD_PAGE_CHANGED
)
77 DEFINE_EVENT_TYPE(wxEVT_WIZARD_PAGE_CHANGING
)
78 DEFINE_EVENT_TYPE(wxEVT_WIZARD_CANCEL
)
79 DEFINE_EVENT_TYPE(wxEVT_WIZARD_FINISHED
)
80 DEFINE_EVENT_TYPE(wxEVT_WIZARD_HELP
)
82 BEGIN_EVENT_TABLE(wxWizard
, wxDialog
)
83 EVT_BUTTON(wxID_CANCEL
, wxWizard::OnCancel
)
84 EVT_BUTTON(wxID_BACKWARD
, wxWizard::OnBackOrNext
)
85 EVT_BUTTON(wxID_FORWARD
, wxWizard::OnBackOrNext
)
86 EVT_BUTTON(wxID_HELP
, wxWizard::OnHelp
)
88 EVT_WIZARD_PAGE_CHANGED(wxID_ANY
, wxWizard::OnWizEvent
)
89 EVT_WIZARD_PAGE_CHANGING(wxID_ANY
, wxWizard::OnWizEvent
)
90 EVT_WIZARD_CANCEL(wxID_ANY
, wxWizard::OnWizEvent
)
91 EVT_WIZARD_FINISHED(wxID_ANY
, wxWizard::OnWizEvent
)
92 EVT_WIZARD_HELP(wxID_ANY
, wxWizard::OnWizEvent
)
95 IMPLEMENT_DYNAMIC_CLASS(wxWizard
, wxDialog
)
104 IMPLEMENT_ABSTRACT_CLASS(wxWizardPage
, wxPanel
)
105 IMPLEMENT_DYNAMIC_CLASS(wxWizardPageSimple
, wxWizardPage
)
106 IMPLEMENT_DYNAMIC_CLASS(wxWizardEvent
, wxNotifyEvent
)
108 // ============================================================================
110 // ============================================================================
112 // ----------------------------------------------------------------------------
114 // ----------------------------------------------------------------------------
116 void wxWizardPage::Init()
118 m_bitmap
= wxNullBitmap
;
121 wxWizardPage::wxWizardPage(wxWizard
*parent
,
122 const wxBitmap
& bitmap
,
123 const wxChar
*resource
)
125 Create(parent
, bitmap
, resource
);
128 bool wxWizardPage::Create(wxWizard
*parent
,
129 const wxBitmap
& bitmap
,
130 const wxChar
*resource
)
132 if ( !wxPanel::Create(parent
, wxID_ANY
) )
135 if ( resource
!= NULL
)
137 #if wxUSE_WX_RESOURCES
139 if ( !LoadFromResource(this, resource
) )
141 wxFAIL_MSG(wxT("wxWizardPage LoadFromResource failed!!!!"));
144 #endif // wxUSE_RESOURCES
149 // initially the page is hidden, it's shown only when it becomes current
155 // ----------------------------------------------------------------------------
156 // wxWizardPageSimple
157 // ----------------------------------------------------------------------------
159 wxWizardPage
*wxWizardPageSimple::GetPrev() const
164 wxWizardPage
*wxWizardPageSimple::GetNext() const
169 // ----------------------------------------------------------------------------
171 // ----------------------------------------------------------------------------
173 wxWizardSizer::wxWizardSizer(wxWizard
*owner
)
176 m_childSizeValid
= false;
179 void wxWizardSizer::RecalcSizes()
181 // Effect of this function depends on m_owner->m_page and
182 // it should be called whenever it changes (wxWizard::ShowPage)
183 if ( m_owner
->m_page
)
185 m_owner
->m_page
->SetSize(m_position
.x
,m_position
.y
, m_size
.x
,m_size
.y
);
189 wxSize
wxWizardSizer::CalcMin()
191 return m_owner
->GetPageSize();
194 wxSize
wxWizardSizer::GetMaxChildSize()
196 #if !defined(__WXDEBUG__)
197 if ( m_childSizeValid
)
202 wxSizerItemList::compatibility_iterator childNode
;
204 for(childNode
= m_children
.GetFirst(); childNode
;
205 childNode
= childNode
->GetNext())
207 wxSizerItem
*child
= childNode
->GetData();
208 maxOfMin
.IncTo(child
->CalcMin());
209 maxOfMin
.IncTo(SiblingSize(child
));
213 if ( m_childSizeValid
&& m_childSize
!= maxOfMin
)
215 wxFAIL_MSG( _T("Size changed in wxWizard::GetPageAreaSizer()")
216 _T("after RunWizard().\n")
217 _T("Did you forget to call GetSizer()->Fit(this) ")
218 _T("for some page?")) ;
222 #endif // __WXDEBUG__
224 if ( m_owner
->m_started
)
226 m_childSizeValid
= true;
227 m_childSize
= maxOfMin
;
233 int wxWizardSizer::Border() const
235 if ( m_owner
->m_calledSetBorder
)
236 return m_owner
->m_border
;
238 return m_children
.IsEmpty() ? 5 : 0;
241 wxSize
wxWizardSizer::SiblingSize(wxSizerItem
*child
)
245 if ( child
->IsWindow() )
247 wxWizardPage
*page
= wxDynamicCast(child
->GetWindow(), wxWizardPage
);
250 for ( wxWizardPage
*sibling
= page
->GetNext();
252 sibling
= sibling
->GetNext() )
254 if ( sibling
->GetSizer() )
256 maxSibling
.IncTo(sibling
->GetSizer()->CalcMin());
265 // ----------------------------------------------------------------------------
266 // generic wxWizard implementation
267 // ----------------------------------------------------------------------------
269 void wxWizard::Init()
271 m_posWizard
= wxDefaultPosition
;
272 m_page
= (wxWizardPage
*)NULL
;
273 m_btnPrev
= m_btnNext
= NULL
;
275 m_sizerBmpAndPage
= NULL
;
277 m_calledSetBorder
= false;
282 bool wxWizard::Create(wxWindow
*parent
,
284 const wxString
& title
,
285 const wxBitmap
& bitmap
,
289 bool result
= wxDialog::Create(parent
,id
,title
,pos
,wxDefaultSize
,style
);
299 void wxWizard::AddBitmapRow(wxBoxSizer
*mainColumn
)
301 m_sizerBmpAndPage
= new wxBoxSizer(wxHORIZONTAL
);
304 1, // Vertically stretchable
305 wxEXPAND
// Horizonal stretching, no border
308 0, // No vertical stretching
309 wxEXPAND
// No border, (mostly useless) horizontal stretching
315 m_statbmp
= new wxStaticBitmap(this, wxID_ANY
, m_bitmap
);
316 m_sizerBmpAndPage
->Add(
318 0, // No horizontal stretching
319 wxALL
, // Border all around, top alignment
322 m_sizerBmpAndPage
->Add(
324 0, // No horizontal stretching
325 wxEXPAND
// No border, (mostly useless) vertical stretching
330 // Added to m_sizerBmpAndPage in FinishLayout
331 m_sizerPage
= new wxWizardSizer(this);
334 void wxWizard::AddStaticLine(wxBoxSizer
*mainColumn
)
338 new wxStaticLine(this, wxID_ANY
),
339 0, // Vertically unstretchable
340 wxEXPAND
| wxALL
, // Border all around, horizontally stretchable
344 0, // No vertical stretching
345 wxEXPAND
// No border, (mostly useless) horizontal stretching
349 #endif // wxUSE_STATLINE
352 void wxWizard::AddBackNextPair(wxBoxSizer
*buttonRow
)
354 wxASSERT_MSG( m_btnNext
&& m_btnPrev
,
355 _T("You must create the buttons before calling ")
356 _T("wxWizard::AddBackNextPair") );
358 // margin between Back and Next buttons
360 static const int BACKNEXT_MARGIN
= 10;
362 static const int BACKNEXT_MARGIN
= 0;
365 wxBoxSizer
*backNextPair
= new wxBoxSizer(wxHORIZONTAL
);
368 0, // No horizontal stretching
369 wxALL
, // Border all around
373 backNextPair
->Add(m_btnPrev
);
374 backNextPair
->Add(BACKNEXT_MARGIN
,0,
375 0, // No horizontal stretching
376 wxEXPAND
// No border, (mostly useless) vertical stretching
378 backNextPair
->Add(m_btnNext
);
381 void wxWizard::AddButtonRow(wxBoxSizer
*mainColumn
)
383 // the order in which the buttons are created determines the TAB order - at least under MSWindows...
384 // although the 'back' button appears before the 'next' button, a more userfriendly tab order is
385 // to activate the 'next' button first (create the next button before the back button).
386 // The reason is: The user will repeatedly enter information in the wizard pages and then wants to
387 // press 'next'. If a user uses mostly the keyboard, he would have to skip the 'back' button
388 // everytime. This is annoying. There is a second reason: RETURN acts as TAB. If the 'next'
389 // button comes first in the TAB order, the user can enter information very fast using the RETURN
390 // key to TAB to the next entry field and page. This would not be possible, if the 'back' button
391 // was created before the 'next' button.
393 wxBoxSizer
*buttonRow
= new wxBoxSizer(wxHORIZONTAL
);
395 if (GetExtraStyle() & wxWIZARD_EX_HELPBUTTON
)
398 0, // Vertically unstretchable
399 wxGROW
|wxALIGN_CENTRE
405 0, // Vertically unstretchable
406 wxALIGN_RIGHT
// Right aligned, no border
409 // Desired TAB order is 'next', 'cancel', 'help', 'back'. This makes the 'back' button the last control on the page.
410 // Create the buttons in the right order...
413 if (GetExtraStyle() & wxWIZARD_EX_HELPBUTTON
)
414 btnHelp
=new wxButton(this, wxID_HELP
, _("&Help"));
417 m_btnNext
= new wxButton(this, wxID_FORWARD
, _("&Next >"));
418 wxButton
*btnCancel
=new wxButton(this, wxID_CANCEL
, _("&Cancel"));
420 if (GetExtraStyle() & wxWIZARD_EX_HELPBUTTON
)
421 btnHelp
=new wxButton(this, wxID_HELP
, _("&Help"));
423 m_btnPrev
= new wxButton(this, wxID_BACKWARD
, _("< &Back"));
429 0, // Horizontally unstretchable
430 wxALL
, // Border all around, top aligned
434 // Put stretchable space between help button and others
435 buttonRow
->Add(0, 0, 1, wxALIGN_CENTRE
, 0);
439 AddBackNextPair(buttonRow
);
443 0, // Horizontally unstretchable
444 wxALL
, // Border all around, top aligned
449 void wxWizard::DoCreateControls()
451 // do nothing if the controls were already created
455 // wxWindow::SetSizer will be called at end
456 wxBoxSizer
*windowSizer
= new wxBoxSizer(wxVERTICAL
);
458 wxBoxSizer
*mainColumn
= new wxBoxSizer(wxVERTICAL
);
461 1, // Vertical stretching
462 wxALL
| wxEXPAND
, // Border all around, horizontal stretching
466 AddBitmapRow(mainColumn
);
467 AddStaticLine(mainColumn
);
468 AddButtonRow(mainColumn
);
470 // wxWindow::SetSizer should be followed by wxWindow::Fit, but
471 // this is done in FinishLayout anyway so why duplicate it
472 SetSizer(windowSizer
);
475 void wxWizard::SetPageSize(const wxSize
& size
)
477 wxCHECK_RET(!m_started
,wxT("wxWizard::SetPageSize after RunWizard"));
481 void wxWizard::FinishLayout()
483 m_sizerBmpAndPage
->Add(
485 1, // Horizontal stretching
486 wxEXPAND
| wxALL
, // Vertically stretchable
487 m_sizerPage
->Border()
490 GetSizer()->SetSizeHints(this);
491 if ( m_posWizard
== wxDefaultPosition
)
495 void wxWizard::FitToPage(const wxWizardPage
*page
)
497 wxCHECK_RET(!m_started
,wxT("wxWizard::FitToPage after RunWizard"));
501 wxSize size
= page
->GetBestSize();
503 m_sizePage
.IncTo(size
);
505 page
= page
->GetNext();
509 bool wxWizard::ShowPage(wxWizardPage
*page
, bool goingForward
)
511 wxASSERT_MSG( page
!= m_page
, wxT("this is useless") );
513 // we'll use this to decide whether we have to change the label of this
514 // button or not (initially the label is "Next")
515 bool btnLabelWasNext
= true;
517 // Modified 10-20-2001 Robert Cavanaugh.
518 // Fixed bug for displaying a new bitmap
519 // in each *consecutive* page
521 // flag to indicate if this page uses a new bitmap
522 bool bmpIsDefault
= true;
524 // use these labels to determine if we need to change the bitmap
526 wxBitmap bmpPrev
, bmpCur
;
528 // check for previous page
531 // send the event to the old page
532 wxWizardEvent
event(wxEVT_WIZARD_PAGE_CHANGING
, GetId(), goingForward
, m_page
);
533 if ( m_page
->GetEventHandler()->ProcessEvent(event
) &&
536 // vetoed by the page
542 btnLabelWasNext
= HasNextPage(m_page
);
544 // Get the bitmap of the previous page (if it exists)
545 if ( m_page
->GetBitmap().Ok() )
547 bmpPrev
= m_page
->GetBitmap();
557 // terminate successfully
560 // and notify the user code (this is especially useful for modeless
562 wxWizardEvent
event(wxEVT_WIZARD_FINISHED
, GetId(), false, 0);
563 (void)GetEventHandler()->ProcessEvent(event
);
568 // position and show the new page
569 (void)m_page
->TransferDataToWindow();
571 // wxWizardSizer::RecalcSizes wants to be called when m_page changes
572 m_sizerPage
->RecalcSizes();
574 // check if bitmap needs to be updated
575 // update default flag as well
576 if ( m_page
->GetBitmap().Ok() )
578 bmpCur
= m_page
->GetBitmap();
579 bmpIsDefault
= false;
583 // change the bitmap if:
584 // 1) a default bitmap was selected in constructor
585 // 2) this page was constructed with a bitmap
586 // 3) this bitmap is not the previous bitmap
587 if ( m_statbmp
&& (bmpCur
!= bmpPrev
) )
593 bmp
= m_page
->GetBitmap();
594 m_statbmp
->SetBitmap(bmp
);
598 // and update the buttons state
599 m_btnPrev
->Enable(HasPrevPage(m_page
));
601 bool hasNext
= HasNextPage(m_page
);
602 if ( btnLabelWasNext
!= hasNext
)
606 m_btnNext
->SetLabel(_("&Finish"));
608 m_btnNext
->SetLabel(_("&Next >"));
610 m_btnNext
->SetDefault();
611 // nothing to do: the label was already correct
613 // send the change event to the new page now
614 wxWizardEvent
event(wxEVT_WIZARD_PAGE_CHANGED
, GetId(), goingForward
, m_page
);
615 (void)m_page
->GetEventHandler()->ProcessEvent(event
);
617 // and finally show it
624 bool wxWizard::RunWizard(wxWizardPage
*firstPage
)
626 wxCHECK_MSG( firstPage
, false, wxT("can't run empty wizard") );
628 // Set before FinishLayout to enable wxWizardSizer::GetMaxChildSize
631 // This cannot be done sooner, because user can change layout options
635 // can't return false here because there is no old page
636 (void)ShowPage(firstPage
, true /* forward */);
638 return ShowModal() == wxID_OK
;
641 wxWizardPage
*wxWizard::GetCurrentPage() const
646 wxSize
wxWizard::GetPageSize() const
648 wxSize
pageSize(GetManualPageSize());
649 pageSize
.IncTo(m_sizerPage
->GetMaxChildSize());
653 wxSizer
*wxWizard::GetPageAreaSizer() const
658 void wxWizard::SetBorder(int border
)
660 wxCHECK_RET(!m_started
,wxT("wxWizard::SetBorder after RunWizard"));
662 m_calledSetBorder
= true;
666 wxSize
wxWizard::GetManualPageSize() const
668 // default width and height of the page
669 static const int DEFAULT_PAGE_WIDTH
= 270;
670 static const int DEFAULT_PAGE_HEIGHT
= 290;
672 wxSize
totalPageSize(DEFAULT_PAGE_WIDTH
,DEFAULT_PAGE_HEIGHT
);
674 totalPageSize
.IncTo(m_sizePage
);
678 totalPageSize
.IncTo(wxSize(0, m_bitmap
.GetHeight()));
681 return totalPageSize
;
684 void wxWizard::OnCancel(wxCommandEvent
& WXUNUSED(eventUnused
))
686 // this function probably can never be called when we don't have an active
687 // page, but a small extra check won't hurt
688 wxWindow
*win
= m_page
? (wxWindow
*)m_page
: (wxWindow
*)this;
690 wxWizardEvent
event(wxEVT_WIZARD_CANCEL
, GetId(), false, m_page
);
691 if ( !win
->GetEventHandler()->ProcessEvent(event
) || event
.IsAllowed() )
693 // no objections - close the dialog
694 EndModal(wxID_CANCEL
);
696 //else: request to Cancel ignored
699 void wxWizard::OnBackOrNext(wxCommandEvent
& event
)
701 wxASSERT_MSG( (event
.GetEventObject() == m_btnNext
) ||
702 (event
.GetEventObject() == m_btnPrev
),
703 wxT("unknown button") );
705 // ask the current page first: notice that we do it before calling
706 // GetNext/Prev() because the data transfered from the controls of the page
707 // may change the value returned by these methods
708 if ( m_page
&& (!m_page
->Validate() || !m_page
->TransferDataFromWindow()) )
710 // the page data is incorrect, don't do anything
714 bool forward
= event
.GetEventObject() == m_btnNext
;
719 page
= m_page
->GetNext();
723 page
= m_page
->GetPrev();
725 wxASSERT_MSG( page
, wxT("\"<Back\" button should have been disabled") );
728 // just pass to the new page (or may be not - but we don't care here)
729 (void)ShowPage(page
, forward
);
732 void wxWizard::OnHelp(wxCommandEvent
& WXUNUSED(event
))
734 // this function probably can never be called when we don't have an active
735 // page, but a small extra check won't hurt
738 // Create and send the help event to the specific page handler
739 // event data contains the active page so that context-sensitive
741 wxWizardEvent
eventHelp(wxEVT_WIZARD_HELP
, GetId(), true, m_page
);
742 (void)m_page
->GetEventHandler()->ProcessEvent(eventHelp
);
746 void wxWizard::OnWizEvent(wxWizardEvent
& event
)
748 // the dialogs have wxWS_EX_BLOCK_EVENTS style on by default but we want to
749 // propagate wxEVT_WIZARD_XXX to the parent (if any), so do it manually
750 if ( !(GetExtraStyle() & wxWS_EX_BLOCK_EVENTS
) )
752 // the event will be propagated anyhow
757 wxWindow
*parent
= GetParent();
759 if ( !parent
|| !parent
->GetEventHandler()->ProcessEvent(event
) )
765 // ----------------------------------------------------------------------------
766 // our public interface
767 // ----------------------------------------------------------------------------
769 #if WXWIN_COMPATIBILITY_2_2
772 wxWizard
*wxWizardBase::Create(wxWindow
*parent
,
774 const wxString
& title
,
775 const wxBitmap
& bitmap
,
777 const wxSize
& WXUNUSED(size
))
779 return new wxWizard(parent
, id
, title
, bitmap
, pos
);
782 #endif // WXWIN_COMPATIBILITY_2_2
784 // ----------------------------------------------------------------------------
786 // ----------------------------------------------------------------------------
788 wxWizardEvent::wxWizardEvent(wxEventType type
, int id
, bool direction
, wxWizardPage
* page
)
789 : wxNotifyEvent(type
, id
)
791 // Modified 10-20-2001 Robert Cavanaugh
792 // add the active page to the event data
793 m_direction
= direction
;
797 #endif // wxUSE_WIZARDDLG