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
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
|
# (C) Copyright 2005-2023 Enthought, Inc., Austin, TX
# All rights reserved.
#
# This software is provided without warranty under the terms of the BSD
# license included in 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>
""" The abstract interface for all pyface top-level windows. """
from traits.api import Event, HasTraits, Tuple, Str, Vetoable, VetoableEvent
from pyface.constant import NO
from pyface.key_pressed_event import KeyPressedEvent
from pyface.i_widget import IWidget
class IWindow(IWidget):
""" The abstract interface for all pyface top-level windows.
A pyface top-level window has no visual representation until it is opened
(ie. its 'control' trait will be None until it is opened).
"""
# 'IWindow' interface -----------------------------------------------------
#: The position of the window.
position = Tuple()
#: The size of the window.
size = Tuple()
#: The window title.
title = Str()
# Window Events ----------------------------------------------------------
#: The window has been opened.
opened = Event()
#: The window is about to open.
opening = VetoableEvent()
#: The window has been activated.
activated = Event()
#: The window has been closed.
closed = Event()
#: The window is about to be closed.
closing = VetoableEvent()
#: The window has been deactivated.
deactivated = Event()
#: A key was pressed while the window had focus.
# FIXME v3: This smells of a hack. What's so special about key presses?
# FIXME v3: Str
key_pressed = Event(KeyPressedEvent)
# -------------------------------------------------------------------------
# 'IWindow' interface.
# -------------------------------------------------------------------------
def open(self):
""" Opens the window.
This fires the :py:attr:`closing` vetoable event, giving listeners the
opportunity to veto the opening of the window.
If the window is opened, the :py:attr:`opened` event will be fired
with the IWindow instance as the event value.
Returns
-------
opened : bool
Whether or not the window was opened.
"""
def close(self, force=False):
""" Closes the window.
This fires the :py:attr:`closing` vetoable event, giving listeners the
opportunity to veto the closing of the window. If :py:obj:`force` is
:py:obj:`True` then the window will close no matter what.
If the window is closed, the closed event will be fired with the window
object as the event value.
Parameters
----------
force : bool
Whether the window should close despite vetos.
Returns
-------
closed : bool
Whether or not the window is closed.
"""
def confirm(self, message, title=None, cancel=False, default=NO):
""" Convenience method to show a confirmation dialog.
Parameters
----------
message : str
The text of the message to display.
title : str
The text of the dialog title.
cancel : bool
``True`` if the dialog should contain a Cancel button.
default : NO, YES or CANCEL
Which button should be the default button.
"""
def information(
self,
message,
title="Information",
detail="",
informative="",
text_format="auto"
):
""" Convenience method to show an information message dialog.
Parameters
----------
message : str
The text of the message to display.
title : str
The text of the dialog title.
detail : str
Further details about the message.
informative : str
Explanatory text to display along with the message.
text_format : str
Specifies what text format to use in the resulting message dialog.
One of "auto", "plain", or "rich".
"""
def warning(
self,
message,
title="Warning",
detail="",
informative="",
text_format="auto"
):
""" Convenience method to show a warning message dialog.
Parameters
----------
message : str
The text of the message to display.
title : str
The text of the dialog title.
detail : str
Further details about the message.
informative : str
Explanatory text to display along with the message.
text_format : str
Specifies what text format to use in the resulting message dialog.
One of "auto", "plain", or "rich".
"""
def error(
self,
message,
title="Error",
detail="",
informative="",
text_format="auto"
):
""" Convenience method to show an error message dialog.
Parameters
----------
message : str
The text of the message to display.
title : str
The text of the dialog title.
detail : str
Further details about the message.
informative : str
Explanatory text to display along with the message.
text_format : str
Specifies what text format to use in the resulting message dialog.
One of "auto", "plain", or "rich".
"""
class MWindow(HasTraits):
""" The mixin class that contains common code for toolkit specific
implementations of the IWindow interface.
Implements: close(), confirm(), open()
Reimplements: create()
"""
# -------------------------------------------------------------------------
# 'IWindow' interface.
# -------------------------------------------------------------------------
def open(self):
""" Opens the window.
This fires the :py:attr:`closing` vetoable event, giving listeners the
opportunity to veto the opening of the window.
If the window is opened, the :py:attr:`opened` event will be fired
with the IWindow instance as the event value.
Returns
-------
opened : bool
Whether or not the window was opened.
"""
self.opening = event = Vetoable()
if not event.veto:
# Create the control, if necessary.
if self.control is None:
self.create()
self.show(True)
self.opened = self
return self.control is not None and not event.veto
def close(self, force=False):
""" Closes the window.
This fires the :py:attr:`closing` vetoable event, giving listeners the
opportunity to veto the closing of the window. If :py:obj:`force` is
:py:obj:`True` then the window will close no matter what.
If the window is closed, the closed event will be fired with the window
object as the event value.
Parameters
----------
force : bool
Whether the window should close despite vetos.
Returns
-------
closed : bool
Whether or not the window is closed.
"""
if self.control is not None:
self.closing = event = Vetoable()
if force or not event.veto:
self.destroy()
self.closed = self
return self.control is None
def confirm(self, message, title=None, cancel=False, default=NO):
""" Convenience method to show a confirmation dialog.
Parameters
----------
message : str
The text of the message to display.
title : str
The text of the dialog title.
cancel : bool
``True`` if the dialog should contain a Cancel button.
default : NO, YES or CANCEL
Which button should be the default button.
"""
from .confirmation_dialog import confirm
return confirm(self.control, message, title, cancel, default)
def information(
self,
message,
title="Information",
detail="",
informative="",
text_format="auto"
):
""" Convenience method to show an information message dialog.
Parameters
----------
message : str
The text of the message to display.
title : str
The text of the dialog title.
detail : str
Further details about the message.
informative : str
Explanatory text to display along with the message.
text_format : str
Specifies what text format to use in the resulting message dialog.
One of "auto", "plain", or "rich". Only supported on the qt
backend.
"""
from .message_dialog import information
information(
self.control, message, title, detail, informative, text_format
)
def warning(
self,
message,
title="Warning",
detail="",
informative="",
text_format="auto"
):
""" Convenience method to show a warning message dialog.
Parameters
----------
message : str
The text of the message to display.
title : str
The text of the dialog title.
detail : str
Further details about the message.
informative : str
Explanatory text to display along with the message.
text_format : str
Specifies what text format to use in the resulting message dialog.
One of "auto", "plain", or "rich". Only supported on the qt
backend.
"""
from .message_dialog import warning
warning(
self.control, message, title, detail, informative, text_format
)
def error(
self,
message,
title="Error",
detail="",
informative="",
text_format="auto"
):
""" Convenience method to show an error message dialog.
Parameters
----------
message : str
The text of the message to display.
title : str
The text of the dialog title.
detail : str
Further details about the message.
informative : str
Explanatory text to display along with the message.
text_format : str
Specifies what text format to use in the resulting message dialog.
One of "auto", "plain", or "rich". Only supported on the qt
backend.
"""
from .message_dialog import error
error(self.control, message, title, detail, informative, text_format)
|
