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
|
# (C) Copyright 2004-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!
""" Displays a message to the user as a modal window.
"""
from traits.api import HasPrivateTraits, Str, Float
from .view import View
from .group import HGroup
from .item import Item, spring
from pyface.timer.api import do_after
# -------------------------------------------------------------------------
# 'Message' class:
# -------------------------------------------------------------------------
class Message(HasPrivateTraits):
# -------------------------------------------------------------------------
# Trait definitions:
# -------------------------------------------------------------------------
#: The message to be displayed
message = Str()
# -------------------------------------------------------------------------
# Displays a user specified message:
# -------------------------------------------------------------------------
def message(message="", title="Message", buttons=["OK"], parent=None):
"""Displays a message to the user as a model window with the specified
title and buttons.
If *buttons* is not specified, a single **OK** button is used, which is
appropriate for notifications, where no further action or decision on the
user's part is required.
"""
msg = Message(message=message)
ui = msg.edit_traits(
parent=parent,
view=View(
["message~", "|<>"], title=title, buttons=buttons, kind="modal"
),
)
return ui.result
def error(message="", title="Message", buttons=["OK", "Cancel"], parent=None):
"""Displays a message to the user as a modal window with the specified
title and buttons.
If *buttons* is not specified, **OK** and **Cancel** buttons are used,
which is appropriate for confirmations, where the user must decide whether
to proceed. Be sure to word the message so that it is clear that clicking
**OK** continues the operation.
"""
msg = Message(message=message)
ui = msg.edit_traits(
parent=parent,
view=View(
["message~", "|<>"], title=title, buttons=buttons, kind="modal"
),
)
return ui.result
# -------------------------------------------------------------------------
# 'AutoCloseMessage' class:
# -------------------------------------------------------------------------
class AutoCloseMessage(HasPrivateTraits):
#: The message to be shown:
message = Str("Please wait")
#: The time (in seconds) to show the message:
time = Float(2.0)
def show(self, parent=None, title=""):
"""Display the wait message for a limited duration."""
view = View(
HGroup(
spring,
Item("message", show_label=False, style="readonly"),
spring,
),
title=title,
)
do_after(
int(1000.0 * self.time),
self.edit_traits(parent=parent, view=view).dispose,
)
# -------------------------------------------------------------------------
# Displays a user specified message that closes automatically after a
# specified time interval:
# -------------------------------------------------------------------------
def auto_close_message(
message="Please wait", time=2.0, title="Please wait", parent=None
):
"""Displays a message to the user as a modal window with no buttons. The
window closes automatically after a specified time interval (specified
in seconds).
"""
msg = AutoCloseMessage(message=message, time=time)
msg.show(parent=parent, title=title)
|
