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"
46 #include "wx/settings.h"
48 #include "wx/wizard.h"
50 // ----------------------------------------------------------------------------
52 // ----------------------------------------------------------------------------
54 class wxWizardSizer
: public wxSizer
57 wxWizardSizer(wxWizard
*owner
);
62 wxSize
GetMaxChildSize();
66 wxSize
SiblingSize(wxSizerItem
*child
);
69 bool m_childSizeValid
;
73 // ----------------------------------------------------------------------------
74 // event tables and such
75 // ----------------------------------------------------------------------------
77 DEFINE_EVENT_TYPE(wxEVT_WIZARD_PAGE_CHANGED
)
78 DEFINE_EVENT_TYPE(wxEVT_WIZARD_PAGE_CHANGING
)
79 DEFINE_EVENT_TYPE(wxEVT_WIZARD_CANCEL
)
80 DEFINE_EVENT_TYPE(wxEVT_WIZARD_FINISHED
)
81 DEFINE_EVENT_TYPE(wxEVT_WIZARD_HELP
)
83 BEGIN_EVENT_TABLE(wxWizard
, wxDialog
)
84 EVT_BUTTON(wxID_CANCEL
, wxWizard::OnCancel
)
85 EVT_BUTTON(wxID_BACKWARD
, wxWizard::OnBackOrNext
)
86 EVT_BUTTON(wxID_FORWARD
, wxWizard::OnBackOrNext
)
87 EVT_BUTTON(wxID_HELP
, wxWizard::OnHelp
)
89 EVT_WIZARD_PAGE_CHANGED(wxID_ANY
, wxWizard::OnWizEvent
)
90 EVT_WIZARD_PAGE_CHANGING(wxID_ANY
, wxWizard::OnWizEvent
)
91 EVT_WIZARD_CANCEL(wxID_ANY
, wxWizard::OnWizEvent
)
92 EVT_WIZARD_FINISHED(wxID_ANY
, wxWizard::OnWizEvent
)
93 EVT_WIZARD_HELP(wxID_ANY
, wxWizard::OnWizEvent
)
96 IMPLEMENT_DYNAMIC_CLASS(wxWizard
, wxDialog
)
105 IMPLEMENT_ABSTRACT_CLASS(wxWizardPage
, wxPanel
)
106 IMPLEMENT_DYNAMIC_CLASS(wxWizardPageSimple
, wxWizardPage
)
107 IMPLEMENT_DYNAMIC_CLASS(wxWizardEvent
, wxNotifyEvent
)
109 // ============================================================================
111 // ============================================================================
113 // ----------------------------------------------------------------------------
115 // ----------------------------------------------------------------------------
117 void wxWizardPage::Init()
119 m_bitmap
= wxNullBitmap
;
122 wxWizardPage::wxWizardPage(wxWizard
*parent
,
123 const wxBitmap
& bitmap
,
124 const wxChar
*resource
)
126 Create(parent
, bitmap
, resource
);
129 bool wxWizardPage::Create(wxWizard
*parent
,
130 const wxBitmap
& bitmap
,
131 const wxChar
*resource
)
133 if ( !wxPanel::Create(parent
, wxID_ANY
) )
136 if ( resource
!= NULL
)
138 #if wxUSE_WX_RESOURCES
140 if ( !LoadFromResource(this, resource
) )
142 wxFAIL_MSG(wxT("wxWizardPage LoadFromResource failed!!!!"));
145 #endif // wxUSE_RESOURCES
150 // initially the page is hidden, it's shown only when it becomes current
156 // ----------------------------------------------------------------------------
157 // wxWizardPageSimple
158 // ----------------------------------------------------------------------------
160 wxWizardPage
*wxWizardPageSimple::GetPrev() const
165 wxWizardPage
*wxWizardPageSimple::GetNext() const
170 // ----------------------------------------------------------------------------
172 // ----------------------------------------------------------------------------
174 wxWizardSizer::wxWizardSizer(wxWizard
*owner
)
177 m_childSizeValid
= false;
180 void wxWizardSizer::RecalcSizes()
182 // Effect of this function depends on m_owner->m_page and
183 // it should be called whenever it changes (wxWizard::ShowPage)
184 if ( m_owner
->m_page
)
186 m_owner
->m_page
->SetSize(m_position
.x
,m_position
.y
, m_size
.x
,m_size
.y
);
190 wxSize
wxWizardSizer::CalcMin()
192 return m_owner
->GetPageSize();
195 wxSize
wxWizardSizer::GetMaxChildSize()
197 #if !defined(__WXDEBUG__)
198 if ( m_childSizeValid
)
203 wxSizerItemList::compatibility_iterator childNode
;
205 for(childNode
= m_children
.GetFirst(); childNode
;
206 childNode
= childNode
->GetNext())
208 wxSizerItem
*child
= childNode
->GetData();
209 maxOfMin
.IncTo(child
->CalcMin());
210 maxOfMin
.IncTo(SiblingSize(child
));
214 if ( m_childSizeValid
&& m_childSize
!= maxOfMin
)
216 wxFAIL_MSG( _T("Size changed in wxWizard::GetPageAreaSizer()")
217 _T("after RunWizard().\n")
218 _T("Did you forget to call GetSizer()->Fit(this) ")
219 _T("for some page?")) ;
223 #endif // __WXDEBUG__
225 if ( m_owner
->m_started
)
227 m_childSizeValid
= true;
228 m_childSize
= maxOfMin
;
234 int wxWizardSizer::Border() const
236 if ( m_owner
->m_calledSetBorder
)
237 return m_owner
->m_border
;
239 return m_children
.IsEmpty() ? 5 : 0;
242 wxSize
wxWizardSizer::SiblingSize(wxSizerItem
*child
)
246 if ( child
->IsWindow() )
248 wxWizardPage
*page
= wxDynamicCast(child
->GetWindow(), wxWizardPage
);
251 for ( wxWizardPage
*sibling
= page
->GetNext();
253 sibling
= sibling
->GetNext() )
255 if ( sibling
->GetSizer() )
257 maxSibling
.IncTo(sibling
->GetSizer()->CalcMin());
266 // ----------------------------------------------------------------------------
267 // generic wxWizard implementation
268 // ----------------------------------------------------------------------------
270 void wxWizard::Init()
272 m_posWizard
= wxDefaultPosition
;
273 m_page
= (wxWizardPage
*)NULL
;
274 m_btnPrev
= m_btnNext
= NULL
;
276 m_sizerBmpAndPage
= NULL
;
278 m_calledSetBorder
= false;
283 bool wxWizard::Create(wxWindow
*parent
,
285 const wxString
& title
,
286 const wxBitmap
& bitmap
,
290 bool result
= wxDialog::Create(parent
,id
,title
,pos
,wxDefaultSize
,style
);
300 void wxWizard::AddBitmapRow(wxBoxSizer
*mainColumn
)
302 m_sizerBmpAndPage
= new wxBoxSizer(wxHORIZONTAL
);
305 1, // Vertically stretchable
306 wxEXPAND
// Horizonal stretching, no border
309 0, // No vertical stretching
310 wxEXPAND
// No border, (mostly useless) horizontal stretching
316 m_statbmp
= new wxStaticBitmap(this, wxID_ANY
, m_bitmap
);
317 m_sizerBmpAndPage
->Add(
319 0, // No horizontal stretching
320 wxALL
, // Border all around, top alignment
323 m_sizerBmpAndPage
->Add(
325 0, // No horizontal stretching
326 wxEXPAND
// No border, (mostly useless) vertical stretching
331 // Added to m_sizerBmpAndPage in FinishLayout
332 m_sizerPage
= new wxWizardSizer(this);
335 void wxWizard::AddStaticLine(wxBoxSizer
*mainColumn
)
339 new wxStaticLine(this, wxID_ANY
),
340 0, // Vertically unstretchable
341 wxEXPAND
| wxALL
, // Border all around, horizontally stretchable
345 0, // No vertical stretching
346 wxEXPAND
// No border, (mostly useless) horizontal stretching
350 #endif // wxUSE_STATLINE
353 void wxWizard::AddBackNextPair(wxBoxSizer
*buttonRow
)
355 wxASSERT_MSG( m_btnNext
&& m_btnPrev
,
356 _T("You must create the buttons before calling ")
357 _T("wxWizard::AddBackNextPair") );
359 // margin between Back and Next buttons
361 static const int BACKNEXT_MARGIN
= 10;
363 static const int BACKNEXT_MARGIN
= 0;
366 wxBoxSizer
*backNextPair
= new wxBoxSizer(wxHORIZONTAL
);
369 0, // No horizontal stretching
370 wxALL
, // Border all around
374 backNextPair
->Add(m_btnPrev
);
375 backNextPair
->Add(BACKNEXT_MARGIN
,0,
376 0, // No horizontal stretching
377 wxEXPAND
// No border, (mostly useless) vertical stretching
379 backNextPair
->Add(m_btnNext
);
382 void wxWizard::AddButtonRow(wxBoxSizer
*mainColumn
)
384 // the order in which the buttons are created determines the TAB order - at least under MSWindows...
385 // although the 'back' button appears before the 'next' button, a more userfriendly tab order is
386 // to activate the 'next' button first (create the next button before the back button).
387 // The reason is: The user will repeatedly enter information in the wizard pages and then wants to
388 // press 'next'. If a user uses mostly the keyboard, he would have to skip the 'back' button
389 // everytime. This is annoying. There is a second reason: RETURN acts as TAB. If the 'next'
390 // button comes first in the TAB order, the user can enter information very fast using the RETURN
391 // key to TAB to the next entry field and page. This would not be possible, if the 'back' button
392 // was created before the 'next' button.
394 bool isPda
= (wxSystemSettings::GetScreenType() <= wxSYS_SCREEN_PDA
);
395 int buttonStyle
= isPda
? wxBU_EXACTFIT
: 0;
397 wxBoxSizer
*buttonRow
= new wxBoxSizer(wxHORIZONTAL
);
399 if (GetExtraStyle() & wxWIZARD_EX_HELPBUTTON
)
402 0, // Vertically unstretchable
403 wxGROW
|wxALIGN_CENTRE
409 0, // Vertically unstretchable
410 wxALIGN_RIGHT
// Right aligned, no border
413 // Desired TAB order is 'next', 'cancel', 'help', 'back'. This makes the 'back' button the last control on the page.
414 // Create the buttons in the right order...
417 if (GetExtraStyle() & wxWIZARD_EX_HELPBUTTON
)
418 btnHelp
=new wxButton(this, wxID_HELP
, _("&Help"), wxDefaultPosition
, wxDefaultSize
, buttonStyle
);
421 m_btnNext
= new wxButton(this, wxID_FORWARD
, _("&Next >"));
422 wxButton
*btnCancel
=new wxButton(this, wxID_CANCEL
, _("&Cancel"), wxDefaultPosition
, wxDefaultSize
, buttonStyle
);
424 if (GetExtraStyle() & wxWIZARD_EX_HELPBUTTON
)
425 btnHelp
=new wxButton(this, wxID_HELP
, _("&Help"), wxDefaultPosition
, wxDefaultSize
, buttonStyle
);
427 m_btnPrev
= new wxButton(this, wxID_BACKWARD
, _("< &Back"), wxDefaultPosition
, wxDefaultSize
, buttonStyle
);
433 0, // Horizontally unstretchable
434 wxALL
, // Border all around, top aligned
438 // Put stretchable space between help button and others
439 buttonRow
->Add(0, 0, 1, wxALIGN_CENTRE
, 0);
443 AddBackNextPair(buttonRow
);
447 0, // Horizontally unstretchable
448 wxALL
, // Border all around, top aligned
453 void wxWizard::DoCreateControls()
455 // do nothing if the controls were already created
459 bool isPda
= (wxSystemSettings::GetScreenType() <= wxSYS_SCREEN_PDA
);
461 // Horizontal stretching, and if not PDA, border all around
462 int mainColumnSizerFlags
= isPda
? wxEXPAND
: wxALL
|wxEXPAND
;
464 // wxWindow::SetSizer will be called at end
465 wxBoxSizer
*windowSizer
= new wxBoxSizer(wxVERTICAL
);
467 wxBoxSizer
*mainColumn
= new wxBoxSizer(wxVERTICAL
);
470 1, // Vertical stretching
471 mainColumnSizerFlags
,
475 AddBitmapRow(mainColumn
);
478 AddStaticLine(mainColumn
);
480 AddButtonRow(mainColumn
);
482 // wxWindow::SetSizer should be followed by wxWindow::Fit, but
483 // this is done in FinishLayout anyway so why duplicate it
484 SetSizer(windowSizer
);
487 void wxWizard::SetPageSize(const wxSize
& size
)
489 wxCHECK_RET(!m_started
,wxT("wxWizard::SetPageSize after RunWizard"));
493 void wxWizard::FinishLayout()
495 bool isPda
= (wxSystemSettings::GetScreenType() <= wxSYS_SCREEN_PDA
);
497 // Set to enable wxWizardSizer::GetMaxChildSize
500 m_sizerBmpAndPage
->Add(
502 1, // Horizontal stretching
503 wxEXPAND
| wxALL
, // Vertically stretchable
504 m_sizerPage
->Border()
509 GetSizer()->SetSizeHints(this);
510 if ( m_posWizard
== wxDefaultPosition
)
515 void wxWizard::FitToPage(const wxWizardPage
*page
)
517 wxCHECK_RET(!m_started
,wxT("wxWizard::FitToPage after RunWizard"));
521 wxSize size
= page
->GetBestSize();
523 m_sizePage
.IncTo(size
);
525 page
= page
->GetNext();
529 bool wxWizard::ShowPage(wxWizardPage
*page
, bool goingForward
)
531 wxASSERT_MSG( page
!= m_page
, wxT("this is useless") );
533 // we'll use this to decide whether we have to change the label of this
534 // button or not (initially the label is "Next")
535 bool btnLabelWasNext
= true;
537 // Modified 10-20-2001 Robert Cavanaugh.
538 // Fixed bug for displaying a new bitmap
539 // in each *consecutive* page
541 // flag to indicate if this page uses a new bitmap
542 bool bmpIsDefault
= true;
544 // use these labels to determine if we need to change the bitmap
546 wxBitmap bmpPrev
, bmpCur
;
548 // check for previous page
551 // send the event to the old page
552 wxWizardEvent
event(wxEVT_WIZARD_PAGE_CHANGING
, GetId(), goingForward
, m_page
);
553 if ( m_page
->GetEventHandler()->ProcessEvent(event
) &&
556 // vetoed by the page
562 btnLabelWasNext
= HasNextPage(m_page
);
564 // Get the bitmap of the previous page (if it exists)
565 if ( m_page
->GetBitmap().Ok() )
567 bmpPrev
= m_page
->GetBitmap();
577 // terminate successfully
584 SetReturnCode(wxID_OK
);
588 // and notify the user code (this is especially useful for modeless
590 wxWizardEvent
event(wxEVT_WIZARD_FINISHED
, GetId(), false, 0);
591 (void)GetEventHandler()->ProcessEvent(event
);
596 // position and show the new page
597 (void)m_page
->TransferDataToWindow();
599 // wxWizardSizer::RecalcSizes wants to be called when m_page changes
600 m_sizerPage
->RecalcSizes();
602 // check if bitmap needs to be updated
603 // update default flag as well
604 if ( m_page
->GetBitmap().Ok() )
606 bmpCur
= m_page
->GetBitmap();
607 bmpIsDefault
= false;
611 // change the bitmap if:
612 // 1) a default bitmap was selected in constructor
613 // 2) this page was constructed with a bitmap
614 // 3) this bitmap is not the previous bitmap
615 if ( m_statbmp
&& (bmpCur
!= bmpPrev
) )
621 bmp
= m_page
->GetBitmap();
622 m_statbmp
->SetBitmap(bmp
);
626 // and update the buttons state
627 m_btnPrev
->Enable(HasPrevPage(m_page
));
629 bool hasNext
= HasNextPage(m_page
);
630 if ( btnLabelWasNext
!= hasNext
)
634 m_btnNext
->SetLabel(_("&Finish"));
636 m_btnNext
->SetLabel(_("&Next >"));
638 m_btnNext
->SetDefault();
639 // nothing to do: the label was already correct
641 // send the change event to the new page now
642 wxWizardEvent
event(wxEVT_WIZARD_PAGE_CHANGED
, GetId(), goingForward
, m_page
);
643 (void)m_page
->GetEventHandler()->ProcessEvent(event
);
645 // and finally show it
652 bool wxWizard::RunWizard(wxWizardPage
*firstPage
)
654 wxCHECK_MSG( firstPage
, false, wxT("can't run empty wizard") );
656 // This cannot be done sooner, because user can change layout options
660 // can't return false here because there is no old page
661 (void)ShowPage(firstPage
, true /* forward */);
663 return ShowModal() == wxID_OK
;
666 wxWizardPage
*wxWizard::GetCurrentPage() const
671 wxSize
wxWizard::GetPageSize() const
673 wxSize
pageSize(GetManualPageSize());
674 pageSize
.IncTo(m_sizerPage
->GetMaxChildSize());
678 wxSizer
*wxWizard::GetPageAreaSizer() const
683 void wxWizard::SetBorder(int border
)
685 wxCHECK_RET(!m_started
,wxT("wxWizard::SetBorder after RunWizard"));
687 m_calledSetBorder
= true;
691 wxSize
wxWizard::GetManualPageSize() const
693 // default width and height of the page
694 int DEFAULT_PAGE_WIDTH
= 270;
695 int DEFAULT_PAGE_HEIGHT
= 270;
696 bool isPda
= (wxSystemSettings::GetScreenType() <= wxSYS_SCREEN_PDA
);
699 // Make the default page size small enough to fit on screen
700 DEFAULT_PAGE_WIDTH
= wxSystemSettings::GetMetric(wxSYS_SCREEN_X
) / 2;
701 DEFAULT_PAGE_HEIGHT
= wxSystemSettings::GetMetric(wxSYS_SCREEN_Y
) / 2;
704 wxSize
totalPageSize(DEFAULT_PAGE_WIDTH
,DEFAULT_PAGE_HEIGHT
);
706 totalPageSize
.IncTo(m_sizePage
);
710 totalPageSize
.IncTo(wxSize(0, m_bitmap
.GetHeight()));
713 return totalPageSize
;
716 void wxWizard::OnCancel(wxCommandEvent
& WXUNUSED(eventUnused
))
718 // this function probably can never be called when we don't have an active
719 // page, but a small extra check won't hurt
720 wxWindow
*win
= m_page
? (wxWindow
*)m_page
: (wxWindow
*)this;
722 wxWizardEvent
event(wxEVT_WIZARD_CANCEL
, GetId(), false, m_page
);
723 if ( !win
->GetEventHandler()->ProcessEvent(event
) || event
.IsAllowed() )
725 // no objections - close the dialog
728 EndModal(wxID_CANCEL
);
732 SetReturnCode(wxID_CANCEL
);
736 //else: request to Cancel ignored
739 void wxWizard::OnBackOrNext(wxCommandEvent
& event
)
741 wxASSERT_MSG( (event
.GetEventObject() == m_btnNext
) ||
742 (event
.GetEventObject() == m_btnPrev
),
743 wxT("unknown button") );
745 // ask the current page first: notice that we do it before calling
746 // GetNext/Prev() because the data transfered from the controls of the page
747 // may change the value returned by these methods
748 if ( m_page
&& (!m_page
->Validate() || !m_page
->TransferDataFromWindow()) )
750 // the page data is incorrect, don't do anything
754 bool forward
= event
.GetEventObject() == m_btnNext
;
759 page
= m_page
->GetNext();
763 page
= m_page
->GetPrev();
765 wxASSERT_MSG( page
, wxT("\"<Back\" button should have been disabled") );
768 // just pass to the new page (or may be not - but we don't care here)
769 (void)ShowPage(page
, forward
);
772 void wxWizard::OnHelp(wxCommandEvent
& WXUNUSED(event
))
774 // this function probably can never be called when we don't have an active
775 // page, but a small extra check won't hurt
778 // Create and send the help event to the specific page handler
779 // event data contains the active page so that context-sensitive
781 wxWizardEvent
eventHelp(wxEVT_WIZARD_HELP
, GetId(), true, m_page
);
782 (void)m_page
->GetEventHandler()->ProcessEvent(eventHelp
);
786 void wxWizard::OnWizEvent(wxWizardEvent
& event
)
788 // the dialogs have wxWS_EX_BLOCK_EVENTS style on by default but we want to
789 // propagate wxEVT_WIZARD_XXX to the parent (if any), so do it manually
790 if ( !(GetExtraStyle() & wxWS_EX_BLOCK_EVENTS
) )
792 // the event will be propagated anyhow
797 wxWindow
*parent
= GetParent();
799 if ( !parent
|| !parent
->GetEventHandler()->ProcessEvent(event
) )
807 ( event
.GetEventType() == wxEVT_WIZARD_FINISHED
||
808 event
.GetEventType() == wxEVT_WIZARD_CANCEL
816 // ----------------------------------------------------------------------------
817 // our public interface
818 // ----------------------------------------------------------------------------
820 #if WXWIN_COMPATIBILITY_2_2
823 wxWizard
*wxWizardBase::Create(wxWindow
*parent
,
825 const wxString
& title
,
826 const wxBitmap
& bitmap
,
828 const wxSize
& WXUNUSED(size
))
830 return new wxWizard(parent
, id
, title
, bitmap
, pos
);
833 #endif // WXWIN_COMPATIBILITY_2_2
835 // ----------------------------------------------------------------------------
837 // ----------------------------------------------------------------------------
839 wxWizardEvent::wxWizardEvent(wxEventType type
, int id
, bool direction
, wxWizardPage
* page
)
840 : wxNotifyEvent(type
, id
)
842 // Modified 10-20-2001 Robert Cavanaugh
843 // add the active page to the event data
844 m_direction
= direction
;
848 #endif // wxUSE_WIZARDDLG