1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: src/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 // For compilers that support precompilation, includes "wx.h".
25 #include "wx/wxprec.h"
34 #include "wx/dynarray.h"
36 #include "wx/statbmp.h"
37 #include "wx/button.h"
40 #include "wx/statline.h"
42 #include "wx/settings.h"
44 #include "wx/wizard.h"
46 // ----------------------------------------------------------------------------
48 // ----------------------------------------------------------------------------
50 class wxWizardSizer
: public wxSizer
53 wxWizardSizer(wxWizard
*owner
);
58 wxSize
GetMaxChildSize();
62 wxSize
SiblingSize(wxSizerItem
*child
);
65 bool m_childSizeValid
;
69 // ----------------------------------------------------------------------------
70 // event tables and such
71 // ----------------------------------------------------------------------------
73 DEFINE_EVENT_TYPE(wxEVT_WIZARD_PAGE_CHANGED
)
74 DEFINE_EVENT_TYPE(wxEVT_WIZARD_PAGE_CHANGING
)
75 DEFINE_EVENT_TYPE(wxEVT_WIZARD_CANCEL
)
76 DEFINE_EVENT_TYPE(wxEVT_WIZARD_FINISHED
)
77 DEFINE_EVENT_TYPE(wxEVT_WIZARD_HELP
)
79 BEGIN_EVENT_TABLE(wxWizard
, wxDialog
)
80 EVT_BUTTON(wxID_CANCEL
, wxWizard::OnCancel
)
81 EVT_BUTTON(wxID_BACKWARD
, wxWizard::OnBackOrNext
)
82 EVT_BUTTON(wxID_FORWARD
, wxWizard::OnBackOrNext
)
83 EVT_BUTTON(wxID_HELP
, wxWizard::OnHelp
)
85 EVT_WIZARD_PAGE_CHANGED(wxID_ANY
, wxWizard::OnWizEvent
)
86 EVT_WIZARD_PAGE_CHANGING(wxID_ANY
, wxWizard::OnWizEvent
)
87 EVT_WIZARD_CANCEL(wxID_ANY
, wxWizard::OnWizEvent
)
88 EVT_WIZARD_FINISHED(wxID_ANY
, wxWizard::OnWizEvent
)
89 EVT_WIZARD_HELP(wxID_ANY
, wxWizard::OnWizEvent
)
92 IMPLEMENT_DYNAMIC_CLASS(wxWizard
, wxDialog
)
101 IMPLEMENT_ABSTRACT_CLASS(wxWizardPage
, wxPanel
)
102 IMPLEMENT_DYNAMIC_CLASS(wxWizardPageSimple
, wxWizardPage
)
103 IMPLEMENT_DYNAMIC_CLASS(wxWizardEvent
, wxNotifyEvent
)
105 // ============================================================================
107 // ============================================================================
109 // ----------------------------------------------------------------------------
111 // ----------------------------------------------------------------------------
113 void wxWizardPage::Init()
115 m_bitmap
= wxNullBitmap
;
118 wxWizardPage::wxWizardPage(wxWizard
*parent
,
119 const wxBitmap
& bitmap
,
120 const wxChar
*resource
)
122 Create(parent
, bitmap
, resource
);
125 bool wxWizardPage::Create(wxWizard
*parent
,
126 const wxBitmap
& bitmap
,
127 const wxChar
*resource
)
129 if ( !wxPanel::Create(parent
, wxID_ANY
) )
132 if ( resource
!= NULL
)
134 #if wxUSE_WX_RESOURCES
136 if ( !LoadFromResource(this, resource
) )
138 wxFAIL_MSG(wxT("wxWizardPage LoadFromResource failed!!!!"));
141 #endif // wxUSE_RESOURCES
146 // initially the page is hidden, it's shown only when it becomes current
152 // ----------------------------------------------------------------------------
153 // wxWizardPageSimple
154 // ----------------------------------------------------------------------------
156 wxWizardPage
*wxWizardPageSimple::GetPrev() const
161 wxWizardPage
*wxWizardPageSimple::GetNext() const
166 // ----------------------------------------------------------------------------
168 // ----------------------------------------------------------------------------
170 wxWizardSizer::wxWizardSizer(wxWizard
*owner
)
173 m_childSizeValid
= false;
176 void wxWizardSizer::RecalcSizes()
178 // Effect of this function depends on m_owner->m_page and
179 // it should be called whenever it changes (wxWizard::ShowPage)
180 if ( m_owner
->m_page
)
182 m_owner
->m_page
->SetSize(m_position
.x
,m_position
.y
, m_size
.x
,m_size
.y
);
186 wxSize
wxWizardSizer::CalcMin()
188 return m_owner
->GetPageSize();
191 wxSize
wxWizardSizer::GetMaxChildSize()
193 #if !defined(__WXDEBUG__)
194 if ( m_childSizeValid
)
199 wxSizerItemList::compatibility_iterator childNode
;
201 for(childNode
= m_children
.GetFirst(); childNode
;
202 childNode
= childNode
->GetNext())
204 wxSizerItem
*child
= childNode
->GetData();
205 maxOfMin
.IncTo(child
->CalcMin());
206 maxOfMin
.IncTo(SiblingSize(child
));
210 if ( m_childSizeValid
&& m_childSize
!= maxOfMin
)
212 wxFAIL_MSG( _T("Size changed in wxWizard::GetPageAreaSizer()")
213 _T("after RunWizard().\n")
214 _T("Did you forget to call GetSizer()->Fit(this) ")
215 _T("for some page?")) ;
219 #endif // __WXDEBUG__
221 if ( m_owner
->m_started
)
223 m_childSizeValid
= true;
224 m_childSize
= maxOfMin
;
230 int wxWizardSizer::Border() const
232 if ( m_owner
->m_calledSetBorder
)
233 return m_owner
->m_border
;
235 return m_children
.IsEmpty() ? 5 : 0;
238 wxSize
wxWizardSizer::SiblingSize(wxSizerItem
*child
)
242 if ( child
->IsWindow() )
244 wxWizardPage
*page
= wxDynamicCast(child
->GetWindow(), wxWizardPage
);
247 for ( wxWizardPage
*sibling
= page
->GetNext();
249 sibling
= sibling
->GetNext() )
251 if ( sibling
->GetSizer() )
253 maxSibling
.IncTo(sibling
->GetSizer()->CalcMin());
262 // ----------------------------------------------------------------------------
263 // generic wxWizard implementation
264 // ----------------------------------------------------------------------------
266 void wxWizard::Init()
268 m_posWizard
= wxDefaultPosition
;
269 m_page
= (wxWizardPage
*)NULL
;
270 m_btnPrev
= m_btnNext
= NULL
;
272 m_sizerBmpAndPage
= NULL
;
274 m_calledSetBorder
= false;
280 bool wxWizard::Create(wxWindow
*parent
,
282 const wxString
& title
,
283 const wxBitmap
& bitmap
,
287 bool result
= wxDialog::Create(parent
,id
,title
,pos
,wxDefaultSize
,style
);
297 void wxWizard::AddBitmapRow(wxBoxSizer
*mainColumn
)
299 m_sizerBmpAndPage
= new wxBoxSizer(wxHORIZONTAL
);
302 1, // Vertically stretchable
303 wxEXPAND
// Horizonal stretching, no border
306 0, // No vertical stretching
307 wxEXPAND
// No border, (mostly useless) horizontal stretching
313 m_statbmp
= new wxStaticBitmap(this, wxID_ANY
, m_bitmap
);
314 m_sizerBmpAndPage
->Add(
316 0, // No horizontal stretching
317 wxALL
, // Border all around, top alignment
320 m_sizerBmpAndPage
->Add(
322 0, // No horizontal stretching
323 wxEXPAND
// No border, (mostly useless) vertical stretching
328 // Added to m_sizerBmpAndPage in FinishLayout
329 m_sizerPage
= new wxWizardSizer(this);
332 void wxWizard::AddStaticLine(wxBoxSizer
*mainColumn
)
336 new wxStaticLine(this, wxID_ANY
),
337 0, // Vertically unstretchable
338 wxEXPAND
| wxALL
, // Border all around, horizontally stretchable
342 0, // No vertical stretching
343 wxEXPAND
// No border, (mostly useless) horizontal stretching
347 #endif // wxUSE_STATLINE
350 void wxWizard::AddBackNextPair(wxBoxSizer
*buttonRow
)
352 wxASSERT_MSG( m_btnNext
&& m_btnPrev
,
353 _T("You must create the buttons before calling ")
354 _T("wxWizard::AddBackNextPair") );
356 // margin between Back and Next buttons
358 static const int BACKNEXT_MARGIN
= 10;
360 static const int BACKNEXT_MARGIN
= 0;
363 wxBoxSizer
*backNextPair
= new wxBoxSizer(wxHORIZONTAL
);
366 0, // No horizontal stretching
367 wxALL
, // Border all around
371 backNextPair
->Add(m_btnPrev
);
372 backNextPair
->Add(BACKNEXT_MARGIN
,0,
373 0, // No horizontal stretching
374 wxEXPAND
// No border, (mostly useless) vertical stretching
376 backNextPair
->Add(m_btnNext
);
379 void wxWizard::AddButtonRow(wxBoxSizer
*mainColumn
)
381 // the order in which the buttons are created determines the TAB order - at least under MSWindows...
382 // although the 'back' button appears before the 'next' button, a more userfriendly tab order is
383 // to activate the 'next' button first (create the next button before the back button).
384 // The reason is: The user will repeatedly enter information in the wizard pages and then wants to
385 // press 'next'. If a user uses mostly the keyboard, he would have to skip the 'back' button
386 // everytime. This is annoying. There is a second reason: RETURN acts as TAB. If the 'next'
387 // button comes first in the TAB order, the user can enter information very fast using the RETURN
388 // key to TAB to the next entry field and page. This would not be possible, if the 'back' button
389 // was created before the 'next' button.
391 bool isPda
= (wxSystemSettings::GetScreenType() <= wxSYS_SCREEN_PDA
);
392 int buttonStyle
= isPda
? wxBU_EXACTFIT
: 0;
394 wxBoxSizer
*buttonRow
= new wxBoxSizer(wxHORIZONTAL
);
396 if (GetExtraStyle() & wxWIZARD_EX_HELPBUTTON
)
399 0, // Vertically unstretchable
400 wxGROW
|wxALIGN_CENTRE
406 0, // Vertically unstretchable
407 wxALIGN_RIGHT
// Right aligned, no border
410 // Desired TAB order is 'next', 'cancel', 'help', 'back'. This makes the 'back' button the last control on the page.
411 // Create the buttons in the right order...
414 if (GetExtraStyle() & wxWIZARD_EX_HELPBUTTON
)
415 btnHelp
=new wxButton(this, wxID_HELP
, _("&Help"), wxDefaultPosition
, wxDefaultSize
, buttonStyle
);
418 m_btnNext
= new wxButton(this, wxID_FORWARD
, _("&Next >"));
419 wxButton
*btnCancel
=new wxButton(this, wxID_CANCEL
, _("&Cancel"), wxDefaultPosition
, wxDefaultSize
, buttonStyle
);
421 if (GetExtraStyle() & wxWIZARD_EX_HELPBUTTON
)
422 btnHelp
=new wxButton(this, wxID_HELP
, _("&Help"), wxDefaultPosition
, wxDefaultSize
, buttonStyle
);
424 m_btnPrev
= new wxButton(this, wxID_BACKWARD
, _("< &Back"), wxDefaultPosition
, wxDefaultSize
, buttonStyle
);
430 0, // Horizontally unstretchable
431 wxALL
, // Border all around, top aligned
435 // Put stretchable space between help button and others
436 buttonRow
->Add(0, 0, 1, wxALIGN_CENTRE
, 0);
440 AddBackNextPair(buttonRow
);
444 0, // Horizontally unstretchable
445 wxALL
, // Border all around, top aligned
450 void wxWizard::DoCreateControls()
452 // do nothing if the controls were already created
456 bool isPda
= (wxSystemSettings::GetScreenType() <= wxSYS_SCREEN_PDA
);
458 // Horizontal stretching, and if not PDA, border all around
459 int mainColumnSizerFlags
= isPda
? wxEXPAND
: wxALL
|wxEXPAND
;
461 // wxWindow::SetSizer will be called at end
462 wxBoxSizer
*windowSizer
= new wxBoxSizer(wxVERTICAL
);
464 wxBoxSizer
*mainColumn
= new wxBoxSizer(wxVERTICAL
);
467 1, // Vertical stretching
468 mainColumnSizerFlags
,
472 AddBitmapRow(mainColumn
);
475 AddStaticLine(mainColumn
);
477 AddButtonRow(mainColumn
);
479 // wxWindow::SetSizer should be followed by wxWindow::Fit, but
480 // this is done in FinishLayout anyway so why duplicate it
481 SetSizer(windowSizer
);
484 void wxWizard::SetPageSize(const wxSize
& size
)
486 wxCHECK_RET(!m_started
,wxT("wxWizard::SetPageSize after RunWizard"));
490 void wxWizard::FinishLayout()
492 bool isPda
= (wxSystemSettings::GetScreenType() <= wxSYS_SCREEN_PDA
);
494 // Set to enable wxWizardSizer::GetMaxChildSize
497 m_sizerBmpAndPage
->Add(
499 1, // Horizontal stretching
500 wxEXPAND
| wxALL
, // Vertically stretchable
501 m_sizerPage
->Border()
506 GetSizer()->SetSizeHints(this);
507 if ( m_posWizard
== wxDefaultPosition
)
512 void wxWizard::FitToPage(const wxWizardPage
*page
)
514 wxCHECK_RET(!m_started
,wxT("wxWizard::FitToPage after RunWizard"));
518 wxSize size
= page
->GetBestSize();
520 m_sizePage
.IncTo(size
);
522 page
= page
->GetNext();
526 bool wxWizard::ShowPage(wxWizardPage
*page
, bool goingForward
)
528 wxASSERT_MSG( page
!= m_page
, wxT("this is useless") );
530 // we'll use this to decide whether we have to change the label of this
531 // button or not (initially the label is "Next")
532 bool btnLabelWasNext
= true;
534 // Modified 10-20-2001 Robert Cavanaugh.
535 // Fixed bug for displaying a new bitmap
536 // in each *consecutive* page
538 // flag to indicate if this page uses a new bitmap
539 bool bmpIsDefault
= true;
541 // use these labels to determine if we need to change the bitmap
543 wxBitmap bmpPrev
, bmpCur
;
545 // check for previous page
548 // send the event to the old page
549 wxWizardEvent
event(wxEVT_WIZARD_PAGE_CHANGING
, GetId(), goingForward
, m_page
);
550 if ( m_page
->GetEventHandler()->ProcessEvent(event
) &&
553 // vetoed by the page
559 btnLabelWasNext
= HasNextPage(m_page
);
561 // Get the bitmap of the previous page (if it exists)
562 if ( m_page
->GetBitmap().Ok() )
564 bmpPrev
= m_page
->GetBitmap();
574 // terminate successfully
581 SetReturnCode(wxID_OK
);
585 // and notify the user code (this is especially useful for modeless
587 wxWizardEvent
event(wxEVT_WIZARD_FINISHED
, GetId(), false, 0);
588 (void)GetEventHandler()->ProcessEvent(event
);
593 // position and show the new page
594 (void)m_page
->TransferDataToWindow();
596 // wxWizardSizer::RecalcSizes wants to be called when m_page changes
597 m_sizerPage
->RecalcSizes();
599 // check if bitmap needs to be updated
600 // update default flag as well
601 if ( m_page
->GetBitmap().Ok() )
603 bmpCur
= m_page
->GetBitmap();
604 bmpIsDefault
= false;
608 // change the bitmap if:
609 // 1) a default bitmap was selected in constructor
610 // 2) this page was constructed with a bitmap
611 // 3) this bitmap is not the previous bitmap
612 if ( m_statbmp
&& (bmpCur
!= bmpPrev
) )
618 bmp
= m_page
->GetBitmap();
619 m_statbmp
->SetBitmap(bmp
);
623 // and update the buttons state
624 m_btnPrev
->Enable(HasPrevPage(m_page
));
626 bool hasNext
= HasNextPage(m_page
);
627 if ( btnLabelWasNext
!= hasNext
)
631 m_btnNext
->SetLabel(_("&Finish"));
633 m_btnNext
->SetLabel(_("&Next >"));
635 m_btnNext
->SetDefault();
636 // nothing to do: the label was already correct
638 // send the change event to the new page now
639 wxWizardEvent
event(wxEVT_WIZARD_PAGE_CHANGED
, GetId(), goingForward
, m_page
);
640 (void)m_page
->GetEventHandler()->ProcessEvent(event
);
642 // and finally show it
649 bool wxWizard::RunWizard(wxWizardPage
*firstPage
)
651 wxCHECK_MSG( firstPage
, false, wxT("can't run empty wizard") );
653 // This cannot be done sooner, because user can change layout options
657 // can't return false here because there is no old page
658 (void)ShowPage(firstPage
, true /* forward */);
662 return ShowModal() == wxID_OK
;
665 wxWizardPage
*wxWizard::GetCurrentPage() const
670 wxSize
wxWizard::GetPageSize() const
672 wxSize
pageSize(GetManualPageSize());
673 pageSize
.IncTo(m_sizerPage
->GetMaxChildSize());
677 wxSizer
*wxWizard::GetPageAreaSizer() const
682 void wxWizard::SetBorder(int border
)
684 wxCHECK_RET(!m_started
,wxT("wxWizard::SetBorder after RunWizard"));
686 m_calledSetBorder
= true;
690 wxSize
wxWizard::GetManualPageSize() const
692 // default width and height of the page
693 int DEFAULT_PAGE_WIDTH
= 270;
694 int DEFAULT_PAGE_HEIGHT
= 270;
695 bool isPda
= (wxSystemSettings::GetScreenType() <= wxSYS_SCREEN_PDA
);
698 // Make the default page size small enough to fit on screen
699 DEFAULT_PAGE_WIDTH
= wxSystemSettings::GetMetric(wxSYS_SCREEN_X
) / 2;
700 DEFAULT_PAGE_HEIGHT
= wxSystemSettings::GetMetric(wxSYS_SCREEN_Y
) / 2;
703 wxSize
totalPageSize(DEFAULT_PAGE_WIDTH
,DEFAULT_PAGE_HEIGHT
);
705 totalPageSize
.IncTo(m_sizePage
);
709 totalPageSize
.IncTo(wxSize(0, m_bitmap
.GetHeight()));
712 return totalPageSize
;
715 void wxWizard::OnCancel(wxCommandEvent
& WXUNUSED(eventUnused
))
717 // this function probably can never be called when we don't have an active
718 // page, but a small extra check won't hurt
719 wxWindow
*win
= m_page
? (wxWindow
*)m_page
: (wxWindow
*)this;
721 wxWizardEvent
event(wxEVT_WIZARD_CANCEL
, GetId(), false, m_page
);
722 if ( !win
->GetEventHandler()->ProcessEvent(event
) || event
.IsAllowed() )
724 // no objections - close the dialog
727 EndModal(wxID_CANCEL
);
731 SetReturnCode(wxID_CANCEL
);
735 //else: request to Cancel ignored
738 void wxWizard::OnBackOrNext(wxCommandEvent
& event
)
740 wxASSERT_MSG( (event
.GetEventObject() == m_btnNext
) ||
741 (event
.GetEventObject() == m_btnPrev
),
742 wxT("unknown button") );
744 // ask the current page first: notice that we do it before calling
745 // GetNext/Prev() because the data transfered from the controls of the page
746 // may change the value returned by these methods
747 if ( m_page
&& (!m_page
->Validate() || !m_page
->TransferDataFromWindow()) )
749 // the page data is incorrect, don't do anything
753 bool forward
= event
.GetEventObject() == m_btnNext
;
758 page
= m_page
->GetNext();
762 page
= m_page
->GetPrev();
764 wxASSERT_MSG( page
, wxT("\"<Back\" button should have been disabled") );
767 // just pass to the new page (or may be not - but we don't care here)
768 (void)ShowPage(page
, forward
);
771 void wxWizard::OnHelp(wxCommandEvent
& WXUNUSED(event
))
773 // this function probably can never be called when we don't have an active
774 // page, but a small extra check won't hurt
777 // Create and send the help event to the specific page handler
778 // event data contains the active page so that context-sensitive
780 wxWizardEvent
eventHelp(wxEVT_WIZARD_HELP
, GetId(), true, m_page
);
781 (void)m_page
->GetEventHandler()->ProcessEvent(eventHelp
);
785 void wxWizard::OnWizEvent(wxWizardEvent
& event
)
787 // the dialogs have wxWS_EX_BLOCK_EVENTS style on by default but we want to
788 // propagate wxEVT_WIZARD_XXX to the parent (if any), so do it manually
789 if ( !(GetExtraStyle() & wxWS_EX_BLOCK_EVENTS
) )
791 // the event will be propagated anyhow
796 wxWindow
*parent
= GetParent();
798 if ( !parent
|| !parent
->GetEventHandler()->ProcessEvent(event
) )
804 if ( ( !m_wasModal
) &&
806 ( event
.GetEventType() == wxEVT_WIZARD_FINISHED
||
807 event
.GetEventType() == wxEVT_WIZARD_CANCEL
815 // ----------------------------------------------------------------------------
817 // ----------------------------------------------------------------------------
819 wxWizardEvent::wxWizardEvent(wxEventType type
, int id
, bool direction
, wxWizardPage
* page
)
820 : wxNotifyEvent(type
, id
)
822 // Modified 10-20-2001 Robert Cavanaugh
823 // add the active page to the event data
824 m_direction
= direction
;
828 #endif // wxUSE_WIZARDDLG