.. module:: wizard ================== Module `wx.wizard` ================== `wx.wizard.Wizard` is a dialog class that guides the user through a sequence of steps, or pages. It is the central class for implementing 'wizard-like' dialogs. These dialogs are mostly familiar to Windows users and are nothing other than a sequence of 'pages', each displayed inside a dialog which has the buttons to navigate to the next (and previous) pages. The wizards are typically used to decompose a complex dialog into several simple steps and are mainly useful to the novice users, hence it is important to keep them as simple as possible. Usage ===== The following example shows a simple implementation that utilizes `wx.wizard.Wizard `_:: import wx import wx.wizard as wiz import images #---------------------------------------------------------------------- def makePageTitle(wizPg, title): sizer = wx.BoxSizer(wx.VERTICAL) wizPg.SetSizer(sizer) title = wx.StaticText(wizPg, -1, title) title.SetFont(wx.Font(18, wx.SWISS, wx.NORMAL, wx.BOLD)) sizer.Add(title, 0, wx.ALIGN_CENTRE|wx.ALL, 5) sizer.Add(wx.StaticLine(wizPg, -1), 0, wx.EXPAND|wx.ALL, 5) return sizer #---------------------------------------------------------------------- class TitledPage(wiz.WizardPageSimple): def __init__(self, parent, title): wiz.WizardPageSimple.__init__(self, parent) self.sizer = makePageTitle(self, title) #---------------------------------------------------------------------- class SkipNextPage(wiz.PyWizardPage): def __init__(self, parent, title): wiz.PyWizardPage.__init__(self, parent) self.next = self.prev = None self.sizer = makePageTitle(self, title) self.cb = wx.CheckBox(self, -1, "Skip next page") self.sizer.Add(self.cb, 0, wx.ALL, 5) def SetNext(self, next): self.next = next def SetPrev(self, prev): self.prev = prev # Classes derived from wxPyWizardPanel must override # GetNext and GetPrev, and may also override GetBitmap # as well as all those methods overridable by # wx.PyWindow. def GetNext(self): """ If the checkbox is set then return the next page's next page. """ if self.cb.GetValue(): self.next.GetNext().SetPrev(self) return self.next.GetNext() else: self.next.GetNext().SetPrev(self.next) return self.next def GetPrev(self): return self.prev #---------------------------------------------------------------------- class UseAltBitmapPage(wiz.PyWizardPage): def __init__(self, parent, title): wiz.PyWizardPage.__init__(self, parent) self.next = self.prev = None self.sizer = makePageTitle(self, title) self.sizer.Add(wx.StaticText(self, -1, "This page uses a different bitmap"), 0, wx.ALL, 5) def SetNext(self, next): self.next = next def SetPrev(self, prev): self.prev = prev def GetNext(self): return self.next def GetPrev(self): return self.prev def GetBitmap(self): # You usually wouldn't need to override this method # since you can set a non-default bitmap in the # wxWizardPageSimple constructor, but if you need to # dynamically change the bitmap based on the # contents of the wizard, or need to also change the # next/prev order then it can be done by overriding # GetBitmap. return images.WizTest2.GetBitmap() #---------------------------------------------------------------------- class TestPanel(wx.Panel): def __init__(self, parent): wx.Panel.__init__(self, parent, -1) b = wx.Button(self, -1, "Run Simple Wizard", pos=(50, 50)) self.Bind(wx.EVT_BUTTON, self.OnRunSimpleWizard, b) b = wx.Button(self, -1, "Run Dynamic Wizard", pos=(50, 100)) self.Bind(wx.EVT_BUTTON, self.OnRunDynamicWizard, b) self.Bind(wiz.EVT_WIZARD_PAGE_CHANGED, self.OnWizPageChanged) self.Bind(wiz.EVT_WIZARD_PAGE_CHANGING, self.OnWizPageChanging) self.Bind(wiz.EVT_WIZARD_CANCEL, self.OnWizCancel) def OnWizPageChanged(self, evt): if evt.GetDirection(): dir = "forward" else: dir = "backward" page = evt.GetPage() print "OnWizPageChanged: %s, %s\n" % (dir, page.__class__) def OnWizPageChanging(self, evt): if evt.GetDirection(): dir = "forward" else: dir = "backward" page = evt.GetPage() print "OnWizPageChanging: %s, %s\n" % (dir, page.__class__) def OnWizCancel(self, evt): page = evt.GetPage() print "OnWizCancel: %s\n" % page.__class__ # Show how to prevent cancelling of the wizard. The # other events can be Veto'd too. if page is self.page1: wx.MessageBox("Cancelling on the first page has been prevented.", "Sorry") evt.Veto() def OnWizFinished(self, evt): print "OnWizFinished\n" def OnRunSimpleWizard(self, evt): # Create the wizard and the pages wizard = wiz.Wizard(self, -1, "Simple Wizard", images.WizTest1.GetBitmap()) page1 = TitledPage(wizard, "Page 1") page2 = TitledPage(wizard, "Page 2") page3 = TitledPage(wizard, "Page 3") page4 = TitledPage(wizard, "Page 4") self.page1 = page1 page1.sizer.Add(wx.StaticText(page1, -1, """ This wizard is totally useless, but is meant to show how to chain simple wizard pages together in a non-dynamic manner. IOW, the order of the pages never changes, and so the wxWizardPageSimple class can easily be used for the pages.""")) wizard.FitToPage(page1) page4.sizer.Add(wx.StaticText(page4, -1, "\nThis is the last page.")) # Use the convenience Chain function to connect the pages wiz.WizardPageSimple_Chain(page1, page2) wiz.WizardPageSimple_Chain(page2, page3) wiz.WizardPageSimple_Chain(page3, page4) wizard.GetPageAreaSizer().Add(page1) if wizard.RunWizard(page1): wx.MessageBox("Wizard completed successfully", "That's all folks!") else: wx.MessageBox("Wizard was cancelled", "That's all folks!") def OnRunDynamicWizard(self, evt): wizard = wiz.Wizard(self, -1, "Dynamic Wizard", images.WizTest1.GetBitmap()) page1 = TitledPage(wizard, "Page 1") page2 = SkipNextPage(wizard, "Page 2") page3 = TitledPage(wizard, "Page 3") page4 = UseAltBitmapPage(wizard, "Page 4") page5 = TitledPage(wizard, "Page 5") self.page1 = page1 page1.sizer.Add(wx.StaticText(page1, -1, """ This wizard shows the ability to choose at runtime the order of the pages and also which bitmap is shown. """)) wizard.FitToPage(page1) page5.sizer.Add(wx.StaticText(page5, -1, "\nThis is the last page.")) # Set the initial order of the pages page1.SetNext(page2) page2.SetPrev(page1) page2.SetNext(page3) page3.SetPrev(page2) page3.SetNext(page4) page4.SetPrev(page3) page4.SetNext(page5) page5.SetPrev(page4) wizard.GetPageAreaSizer().Add(page1) if wizard.RunWizard(page1): wx.MessageBox("Wizard completed successfully", "That's all folks!") else: wx.MessageBox("Wizard was cancelled", "That's all folks!") app = wx.App(0) frame = wx.Frame(None) panel = TestPanel(frame) frame.Show() app.MainLoop() | Module API ========== Widgets ^^^^^^^ .. toctree:: :maxdepth: 1 :glob: wx.wizard.* | Events ^^^^^^ .. toctree:: :maxdepth: 1 :glob: ../Events/wx.wizard.*