// headers
// ----------------------------------------------------------------------------
-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
#pragma implementation "wizardg.h"
#endif
#include "wx/wizard.h"
+// ----------------------------------------------------------------------------
+// wxWizardSizer
+// ----------------------------------------------------------------------------
+
+class wxWizardSizer : public wxSizer
+{
+public:
+ wxWizardSizer(wxWizard *owner);
+
+ void RecalcSizes();
+ wxSize CalcMin();
+
+ wxSize GetMaxChildSize();
+ int Border() const;
+
+private:
+ wxSize SiblingSize(wxSizerItem *child);
+
+ wxWizard *m_owner;
+ bool m_childSizeValid;
+ wxSize m_childSize;
+};
+
// ----------------------------------------------------------------------------
// event tables and such
// ----------------------------------------------------------------------------
EVT_BUTTON(wxID_FORWARD, wxWizard::OnBackOrNext)
EVT_BUTTON(wxID_HELP, wxWizard::OnHelp)
- EVT_WIZARD_PAGE_CHANGED(-1, wxWizard::OnWizEvent)
- EVT_WIZARD_PAGE_CHANGING(-1, wxWizard::OnWizEvent)
- EVT_WIZARD_CANCEL(-1, wxWizard::OnWizEvent)
- EVT_WIZARD_FINISHED(-1, wxWizard::OnWizEvent)
- EVT_WIZARD_HELP(-1, wxWizard::OnWizEvent)
+ EVT_WIZARD_PAGE_CHANGED(wxID_ANY, wxWizard::OnWizEvent)
+ EVT_WIZARD_PAGE_CHANGING(wxID_ANY, wxWizard::OnWizEvent)
+ EVT_WIZARD_CANCEL(wxID_ANY, wxWizard::OnWizEvent)
+ EVT_WIZARD_FINISHED(wxID_ANY, wxWizard::OnWizEvent)
+ EVT_WIZARD_HELP(wxID_ANY, wxWizard::OnWizEvent)
END_EVENT_TABLE()
IMPLEMENT_DYNAMIC_CLASS(wxWizard, wxDialog)
+
+/*
+ TODO PROPERTIES :
+ wxWizard
+ extstyle
+ title
+*/
+
IMPLEMENT_ABSTRACT_CLASS(wxWizardPage, wxPanel)
IMPLEMENT_DYNAMIC_CLASS(wxWizardPageSimple, wxWizardPage)
IMPLEMENT_DYNAMIC_CLASS(wxWizardEvent, wxNotifyEvent)
const wxBitmap& bitmap,
const wxChar *resource)
{
- if ( !wxPanel::Create(parent, -1) )
- return FALSE;
+ if ( !wxPanel::Create(parent, wxID_ANY) )
+ return false;
if ( resource != NULL )
{
// initially the page is hidden, it's shown only when it becomes current
Hide();
- return TRUE;
+ return true;
}
// ----------------------------------------------------------------------------
// wxWizardSizer
// ----------------------------------------------------------------------------
-class wxWizardSizer : public wxSizer
-{
-public:
- wxWizardSizer(wxWizard *owner);
-
- void RecalcSizes();
- wxSize CalcMin();
-
- wxSize GetMaxChildSize();
- int Border() const;
-
-private:
- wxSize SiblingSize(wxSizerItem *child);
-
- wxWizard *m_owner;
- bool m_childSizeValid;
- wxSize m_childSize;
-
- DECLARE_CLASS(wxWizardSizer);
-};
-
-IMPLEMENT_CLASS(wxWizardSizer, wxSizer)
-
wxWizardSizer::wxWizardSizer(wxWizard *owner)
: m_owner(owner)
{
#endif
wxSize maxOfMin;
- wxSizerItemList::Node *childNode;
+ wxSizerItemList::compatibility_iterator childNode;
for(childNode = m_children.GetFirst(); childNode;
childNode = childNode->GetNext())
m_childSizeValid = true;
m_childSize = maxOfMin;
}
-
+
return maxOfMin;
}
wxSize wxWizardSizer::SiblingSize(wxSizerItem *child)
{
wxSize maxSibling;
-
+
if ( child->IsWindow() )
{
wxWizardPage *page = wxDynamicCast(child->GetWindow(), wxWizardPage);
}
}
}
-
+
return maxSibling;
}
m_page = (wxWizardPage *)NULL;
m_btnPrev = m_btnNext = NULL;
m_statbmp = NULL;
+ m_sizerBmpAndPage = NULL;
m_sizerPage = NULL;
m_calledSetBorder = false;
m_border = 0;
}
bool wxWizard::Create(wxWindow *parent,
- int id,
- const wxString& title,
- const wxBitmap& bitmap,
- const wxPoint& pos,
- long style)
+ int id,
+ const wxString& title,
+ const wxBitmap& bitmap,
+ const wxPoint& pos,
+ long style)
{
bool result = wxDialog::Create(parent,id,title,pos,wxDefaultSize,style);
-
+
m_posWizard = pos;
m_bitmap = bitmap ;
DoCreateControls();
-
+
return result;
}
wxEXPAND // No border, (mostly useless) horizontal stretching
);
+#if wxUSE_STATBMP
if ( m_bitmap.Ok() )
{
- m_statbmp = new wxStaticBitmap(this, -1, m_bitmap);
+ m_statbmp = new wxStaticBitmap(this, wxID_ANY, m_bitmap);
m_sizerBmpAndPage->Add(
m_statbmp,
0, // No horizontal stretching
wxEXPAND // No border, (mostly useless) vertical stretching
);
}
- else
- m_statbmp = (wxStaticBitmap *)NULL;
+#endif
// Added to m_sizerBmpAndPage in FinishLayout
m_sizerPage = new wxWizardSizer(this);
{
#if wxUSE_STATLINE
mainColumn->Add(
- new wxStaticLine(this, -1),
+ new wxStaticLine(this, wxID_ANY),
0, // Vertically unstretchable
wxEXPAND | wxALL, // Border all around, horizontally stretchable
5 // Border width
void wxWizard::AddBackNextPair(wxBoxSizer *buttonRow)
{
+ wxASSERT_MSG( m_btnNext && m_btnPrev,
+ _T("You must create the buttons before calling ")
+ _T("wxWizard::AddBackNextPair") );
+
// margin between Back and Next buttons
#ifdef __WXMAC__
static const int BACKNEXT_MARGIN = 10;
wxALL, // Border all around
5 // Border width
);
-
- m_btnPrev = new wxButton(this, wxID_BACKWARD, _("< &Back"));
+
backNextPair->Add(m_btnPrev);
backNextPair->Add(BACKNEXT_MARGIN,0,
0, // No horizontal stretching
wxEXPAND // No border, (mostly useless) vertical stretching
);
- m_btnNext = new wxButton(this, wxID_FORWARD, _("&Next >"));
backNextPair->Add(m_btnNext);
}
void wxWizard::AddButtonRow(wxBoxSizer *mainColumn)
{
+ // the order in which the buttons are created determines the TAB order - at least under MSWindows...
+ // although the 'back' button appears before the 'next' button, a more userfriendly tab order is
+ // to activate the 'next' button first (create the next button before the back button).
+ // The reason is: The user will repeatedly enter information in the wizard pages and then wants to
+ // press 'next'. If a user uses mostly the keyboard, he would have to skip the 'back' button
+ // everytime. This is annoying. There is a second reason: RETURN acts as TAB. If the 'next'
+ // button comes first in the TAB order, the user can enter information very fast using the RETURN
+ // key to TAB to the next entry field and page. This would not be possible, if the 'back' button
+ // was created before the 'next' button.
+
wxBoxSizer *buttonRow = new wxBoxSizer(wxHORIZONTAL);
+#ifdef __WXMAC__
+ if (GetExtraStyle() & wxWIZARD_EX_HELPBUTTON)
+ mainColumn->Add(
+ buttonRow,
+ 0, // Vertically unstretchable
+ wxGROW|wxALIGN_CENTRE
+ );
+ else
+#endif
mainColumn->Add(
buttonRow,
0, // Vertically unstretchable
wxALIGN_RIGHT // Right aligned, no border
);
+ // Desired TAB order is 'next', 'cancel', 'help', 'back'. This makes the 'back' button the last control on the page.
+ // Create the buttons in the right order...
+ wxButton *btnHelp=0;
+#ifdef __WXMAC__
+ if (GetExtraStyle() & wxWIZARD_EX_HELPBUTTON)
+ btnHelp=new wxButton(this, wxID_HELP, _("&Help"));
+#endif
+
+ m_btnNext = new wxButton(this, wxID_FORWARD, _("&Next >"));
+ wxButton *btnCancel=new wxButton(this, wxID_CANCEL, _("&Cancel"));
+#ifndef __WXMAC__
if (GetExtraStyle() & wxWIZARD_EX_HELPBUTTON)
+ btnHelp=new wxButton(this, wxID_HELP, _("&Help"));
+#endif
+ m_btnPrev = new wxButton(this, wxID_BACKWARD, _("< &Back"));
+
+ if (btnHelp)
+ {
buttonRow->Add(
- new wxButton(this, wxID_HELP, _("&Help")),
+ btnHelp,
0, // Horizontally unstretchable
wxALL, // Border all around, top aligned
5 // Border width
- );
+ );
+#ifdef __WXMAC__
+ // Put stretchable space between help button and others
+ buttonRow->Add(0, 0, 1, wxALIGN_CENTRE, 0);
+#endif
+ }
AddBackNextPair(buttonRow);
-
+
buttonRow->Add(
- new wxButton(this, wxID_CANCEL, _("&Cancel")),
+ btnCancel,
0, // Horizontally unstretchable
wxALL, // Border all around, top aligned
5 // Border width
// do nothing if the controls were already created
if ( WasCreated() )
return;
-
+
// wxWindow::SetSizer will be called at end
wxBoxSizer *windowSizer = new wxBoxSizer(wxVERTICAL);
-
+
wxBoxSizer *mainColumn = new wxBoxSizer(wxVERTICAL);
windowSizer->Add(
mainColumn,
wxALL | wxEXPAND, // Border all around, horizontal stretching
5 // Border width
);
-
+
AddBitmapRow(mainColumn);
AddStaticLine(mainColumn);
AddButtonRow(mainColumn);
-
+
// wxWindow::SetSizer should be followed by wxWindow::Fit, but
// this is done in FinishLayout anyway so why duplicate it
SetSizer(windowSizer);
wxEXPAND | wxALL, // Vertically stretchable
m_sizerPage->Border()
);
-
+
GetSizer()->SetSizeHints(this);
if ( m_posWizard == wxDefaultPosition )
CentreOnScreen();
void wxWizard::FitToPage(const wxWizardPage *page)
{
wxCHECK_RET(!m_started,wxT("wxWizard::FitToPage after RunWizard"));
-
+
while ( page )
{
wxSize size = page->GetBestSize();
// we'll use this to decide whether we have to change the label of this
// button or not (initially the label is "Next")
- bool btnLabelWasNext = TRUE;
+ bool btnLabelWasNext = true;
// Modified 10-20-2001 Robert Cavanaugh.
// Fixed bug for displaying a new bitmap
// in each *consecutive* page
// flag to indicate if this page uses a new bitmap
- bool bmpIsDefault = TRUE;
+ bool bmpIsDefault = true;
// use these labels to determine if we need to change the bitmap
// for this page
!event.IsAllowed() )
{
// vetoed by the page
- return FALSE;
+ return false;
}
m_page->Hide();
{
// terminate successfully
EndModal(wxID_OK);
- if ( !IsModal() )
- {
- wxWizardEvent event(wxEVT_WIZARD_FINISHED, GetId(),FALSE, 0);
- (void)GetEventHandler()->ProcessEvent(event);
- }
- return TRUE;
+
+ // and notify the user code (this is especially useful for modeless
+ // wizards)
+ wxWizardEvent event(wxEVT_WIZARD_FINISHED, GetId(), false, 0);
+ (void)GetEventHandler()->ProcessEvent(event);
+
+ return true;
}
// position and show the new page
(void)m_page->TransferDataToWindow();
-
+
// wxWizardSizer::RecalcSizes wants to be called when m_page changes
m_sizerPage->RecalcSizes();
if ( m_page->GetBitmap().Ok() )
{
bmpCur = m_page->GetBitmap();
- bmpIsDefault = FALSE;
+ bmpIsDefault = false;
}
+#if wxUSE_STATBMP
// change the bitmap if:
// 1) a default bitmap was selected in constructor
// 2) this page was constructed with a bitmap
bmp = m_page->GetBitmap();
m_statbmp->SetBitmap(bmp);
}
+#endif
// and update the buttons state
m_btnPrev->Enable(HasPrevPage(m_page));
else
m_btnNext->SetLabel(_("&Next >"));
}
+ m_btnNext->SetDefault();
// nothing to do: the label was already correct
// send the change event to the new page now
m_page->Show();
m_page->SetFocus();
- return TRUE;
+ return true;
}
bool wxWizard::RunWizard(wxWizardPage *firstPage)
{
- wxCHECK_MSG( firstPage, FALSE, wxT("can't run empty wizard") );
-
+ wxCHECK_MSG( firstPage, false, wxT("can't run empty wizard") );
+
// Set before FinishLayout to enable wxWizardSizer::GetMaxChildSize
m_started = true;
-
+
// This cannot be done sooner, because user can change layout options
// up to this moment
FinishLayout();
-
- // can't return FALSE here because there is no old page
- (void)ShowPage(firstPage, TRUE /* forward */);
+
+ // can't return false here because there is no old page
+ (void)ShowPage(firstPage, true /* forward */);
return ShowModal() == wxID_OK;
}
void wxWizard::SetBorder(int border)
{
wxCHECK_RET(!m_started,wxT("wxWizard::SetBorder after RunWizard"));
+
m_calledSetBorder = true;
m_border = border;
}
static const int DEFAULT_PAGE_HEIGHT = 290;
wxSize totalPageSize(DEFAULT_PAGE_WIDTH,DEFAULT_PAGE_HEIGHT);
-
+
totalPageSize.IncTo(m_sizePage);
-
- if(m_statbmp)
- totalPageSize.IncTo(wxSize(0,m_bitmap.GetHeight()));
-
+
+ if ( m_statbmp )
+ {
+ totalPageSize.IncTo(wxSize(0, m_bitmap.GetHeight()));
+ }
+
return totalPageSize;
}
// page, but a small extra check won't hurt
wxWindow *win = m_page ? (wxWindow *)m_page : (wxWindow *)this;
- wxWizardEvent event(wxEVT_WIZARD_CANCEL, GetId(), FALSE, m_page);
+ wxWizardEvent event(wxEVT_WIZARD_CANCEL, GetId(), false, m_page);
if ( !win->GetEventHandler()->ProcessEvent(event) || event.IsAllowed() )
{
// no objections - close the dialog
// Create and send the help event to the specific page handler
// event data contains the active page so that context-sensitive
// help is possible
- wxWizardEvent eventHelp(wxEVT_WIZARD_HELP, GetId(), TRUE, m_page);
+ wxWizardEvent eventHelp(wxEVT_WIZARD_HELP, GetId(), true, m_page);
(void)m_page->GetEventHandler()->ProcessEvent(eventHelp);
}
}
if ( !(GetExtraStyle() & wxWS_EX_BLOCK_EVENTS) )
{
// the event will be propagated anyhow
+ event.Skip();
return;
}
// our public interface
// ----------------------------------------------------------------------------
-#ifdef WXWIN_COMPATIBILITY_2_2
+#if WXWIN_COMPATIBILITY_2_2
/* static */
wxWizard *wxWizardBase::Create(wxWindow *parent,