1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
|
#------------------------------------------------------------------------------
# Copyright (c) 2005, Enthought, Inc.
# All rights reserved.
#
# This software is provided without warranty under the terms of the BSD
# license included in enthought/LICENSE.txt and may be redistributed only
# under the conditions described in the aforementioned license. The license
# is also available online at http://www.enthought.com/licenses/BSD.txt
# Thanks for using Enthought open source!
#
# Author: Enthought, Inc.
# Description: <Enthought pyface package component>
#------------------------------------------------------------------------------
""" Base class for all Pyface wizards. """
# Major package imports.
import wx
# Enthought library imports.
from enthought.pyface.api import Dialog, LayeredPanel
from enthought.traits.api import Bool, Instance, Str
# Local imports.
from wizard_controller import WizardController
class Wizard(Dialog):
""" Base class for all Pyface wizards. """
#### 'Window' interface ###################################################
# The dialog title.
title = Str('Wizard')
#### 'Wizard' interface ###################################################
# The wizard controller provides the pages displayed in the wizard, and
# determines when the wizard is complete etc.
controller = Instance(WizardController)
# Should the 'Cancel' button be displayed?
show_cancel = Bool(True)
###########################################################################
# 'Wizard' interface.
###########################################################################
def next(self):
""" Advance to the next page in the wizard. """
page = self.controller.get_next_page(self.controller.current_page)
self._show_page(page)
return
def previous(self):
""" Return to the previous page in the wizard. """
page = self.controller.get_previous_page(self.controller.current_page)
self._show_page(page)
return
###########################################################################
# Protected 'Window' interface.
###########################################################################
def _create_contents(self, parent):
""" Creates the window contents. """
# This creates the dialog and button areas.
super(Wizard, self)._create_contents(parent)
# Wire up the controller.
self._initialize_controller(self.controller)
# Show the first page.
self._show_page(self.controller.get_first_page())
return
###########################################################################
# Protected 'Dialog' interface.
###########################################################################
def _create_dialog_area(self, parent):
""" Creates the main content of the dialog. """
self._layered_panel = panel = LayeredPanel(parent)
# fixme: Specific size?
panel.control.SetSize((100, 200))
return panel.control
def _create_buttons(self, parent):
""" Creates the buttons. """
sizer = wx.BoxSizer(wx.HORIZONTAL)
# 'Back' button.
self._back = back = wx.Button(parent, -1, "Back")
wx.EVT_BUTTON(parent, back.GetId(), self._on_back)
sizer.Add(back, 0)
# 'Next' button.
self._next = next = wx.Button(parent, -1, "Next")
wx.EVT_BUTTON(parent, next.GetId(), self._on_next)
sizer.Add(next, 0, wx.LEFT, 5)
next.SetDefault()
# 'Finish' button.
self._finish = finish = wx.Button(parent, wx.ID_OK, "Finish")
finish.Enable(self.controller.complete)
wx.EVT_BUTTON(parent, wx.ID_OK, self._on_ok)
sizer.Add(finish, 0, wx.LEFT, 5)
# 'Cancel' button.
if self.show_cancel:
self._cancel = cancel = wx.Button(parent, wx.ID_CANCEL, "Cancel")
wx.EVT_BUTTON(parent, wx.ID_CANCEL, self._on_cancel)
sizer.Add(cancel, 0, wx.LEFT, 10)
# 'Help' button.
if len(self.help_id) > 0:
help = wx.Button(parent, wx.ID_HELP, "Help")
wx.EVT_BUTTON(parent, wx.ID_HELP, self._on_help)
sizer.Add(help, 0, wx.LEFT, 10)
return sizer
###########################################################################
# Private interface.
###########################################################################
def _initialize_controller(self, controller):
""" Initializes the wizard controller. """
controller.on_trait_change(self._update, 'complete')
controller.on_trait_change(
self._on_current_page_changed, 'current_page'
)
return
def _show_page(self, page):
""" Show the page at the specified index. """
panel = self._layered_panel
# If the page has not yet been shown then create it.
if not panel.has_layer(page.id):
panel.add_layer(page.id, page.create_page(panel.control))
# Show the page.
layer = panel.show_layer(page.id)
layer.SetFocus()
# Set the current page in the controller.
#
# fixme: Shouldn't this interface be reversed? Maybe calling
# 'next_page' on the controller should cause it to set its own current
# page?
self.controller.current_page = page
return
def _update(self):
""" Enables/disables buttons depending on the state of the wizard. """
controller = self.controller
current_page = controller.current_page
is_first_page = controller.is_first_page(current_page)
is_last_page = controller.is_last_page(current_page)
# 'Next button'.
if self._next is not None:
self._next.Enable(current_page.complete and not is_last_page)
# 'Back' button.
if self._back is not None:
self._back.Enable(not is_first_page)
# 'Finish' button.
if self._finish is not None:
self._finish.Enable(controller.complete)
# If this is the last page then the 'Finish' button is the default
# button, otherwise the 'Next' button is the default button.
if is_last_page:
if self._finish is not None:
self._finish.SetDefault()
else:
if self._next is not None:
self._next.SetDefault()
return
#### Trait event handlers #################################################
def _on_current_page_changed(self, obj, trait_name, old, new):
""" Called when the current page is changed. """
if old is not None:
old.on_trait_change(self._update, 'complete', remove=True)
if new is not None:
new.on_trait_change(self._update, 'complete')
self._update()
return
def _on_closed_changed(self):
""" Called when the wizard is closed. """
self.controller.dispose_pages()
return
#### wx event handlers ####################################################
def _on_next(self, event):
""" Called when the 'Next' button is pressed. """
self.next()
return
def _on_back(self, event):
""" Called when the 'Back' button is pressed. """
self.previous()
return
#### EOF ######################################################################
|
