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
|
<html>
<head>
<meta name="description" content="Pmw - a toolkit for building high-level compound widgets in Python">
<meta name="content" content="python, megawidget, mega widget, compound widget, gui, tkinter">
<title>Pmw.MessageBar reference manual</title>
</head>
<body bgcolor="#ffffff" text="#000000" link="#0000ee"
vlink="551a8b" alink="ff0000">
<h1 ALIGN="CENTER">Pmw.MessageBar</h1>
<p>
<center><IMG SRC=MessageBar.gif ALT="" WIDTH=398 HEIGHT=44></center>
<dl>
<dt> <h3>Name</h3><dd>
<p>Pmw.MessageBar() -
information line for displaying short messages
</p>
<dt> <h3>Inherits</h3><dd>
<a href="MegaWidget.html">Pmw.MegaWidget</a><br>
<dt> <h3>Description</h3><dd>
<p>
This class creates a single-line message display area. Messages
of several different types may displayed. Messages are cleared
after a period defined for each message type. Each message type
has a priority so that if the application attempts to display more
than one message at a time, the message with the highest priority
will be displayed. Messages may be accompanied by a number of
audible bells.</p>
<p></p>
<dt> <h3>Options</h3><dd>
Options for this megawidget and its base
classes are described below.<p>
<a name=option.labelmargin></a>
<dl><dt> <strong>labelmargin
</strong><dd>
Initialisation option. If the <strong>labelpos</strong> option is not <strong>None</strong>, this specifies the
distance between the <strong>label</strong> component and the rest of the
megawidget. The default is <strong>0</strong>.</p>
</dt></dl>
<a name=option.labelpos></a>
<dl><dt> <strong>labelpos
</strong><dd>
Initialisation option. Specifies where to place the <strong>label</strong> component. If not
<strong>None</strong>, it should be a concatenation of one or two of the
letters <strong>'n'</strong>, <strong>'s'</strong>, <strong>'e'</strong> and <strong>'w'</strong>. The first letter
specifies on which side of the megawidget to place the label.
If a second letter is specified, it indicates where on that
side to place the label. For example, if <strong>labelpos</strong> is <strong>'w'</strong>,
the label is placed in the center of the left hand side; if
it is <strong>'wn'</strong>, the label is placed at the top of the left
hand side; if it is <strong>'ws'</strong>, the label is placed at the
bottom of the left hand side.</p>
<p> If <strong>None</strong>, a label component is not created. The default is <strong>None</strong>.</p>
</dt></dl>
<a name=option.messagetypes></a>
<dl><dt> <strong>messagetypes
</strong><dd>
Initialisation option. This defines what message types are supported by the message bar
and the characteristics of those message types. It is a
dictionary where the key is a string specifying a message type and
the value is a tuple of four integers, (<em>priority</em>, <em>showtime</em>,
<em>bells</em>, <em>logmessage</em>), where <em>priority</em> is the rank of the
message type, <em>showtime</em> is the number of seconds to display
messages of this message type, <em>bells</em> is the number of audible
bells to ring and <em>logmessage</em> is a boolean
specifying whether this message should be logged for retrieval
later. Messages with a higher priority are displayed in
preference to those with lower priority. If a high priority
message times out (because it has been displayed for <em>showtime</em>
seconds), then a lower priority message may be displayed. A
<em>showtime</em> of <strong>0</strong> means that the message will never time out and
is useful for displaying messages describing the current state of
the application as opposed to messages describing events. Logging
is not currently implemented. The default is</p>
<dl><dd><pre> {
'systemerror' : (5, 10, 2, 1),
'usererror' : (4, 5, 1, 0),
'busy' : (3, 0, 0, 0),
'systemevent' : (2, 5, 0, 0),
'userevent' : (2, 5, 0, 0),
'help' : (1, 5, 0, 0),
'state' : (0, 0, 0, 0),
}</pre></dl>
</dt></dl>
<a name=option.silent></a>
<dl><dt> <strong>silent
</strong><dd>
If true, no audible bells will sound, regardless of the value for
<em>bells</em> defined in the <strong>messagetypes</strong> option. The default is <strong>0</strong>.</p>
</dt></dl>
<dt> <h3>Components</h3><dd>
Components created by this megawidget and its base
classes are described below.<p>
<a name=component.entry></a>
<dl><dt> <strong>entry
</strong><dd>
The widget where the messages are displayed. Long messages may be
scrolled horizontally by dragging with the middle mouse button. By default, this component is a Tkinter.Entry.</p>
</dt></dl>
<a name=component.hull></a>
<dl><dt> <strong>hull
</strong><dd>
This acts as the body for the entire megawidget. Other components
are created as children of the hull to further specialise the
widget. By default, this component is a Tkinter.Frame.</p>
</dt></dl>
<a name=component.label></a>
<dl><dt> <strong>label
</strong><dd>
If the <strong>labelpos</strong> option is not <strong>None</strong>, this component is
created as a text label for the megawidget. See the
<strong>labelpos</strong> option for details. Note that to set, for example,
the <strong>text</strong> option of the label, you need to use the <strong>label_text</strong>
component option. By default, this component is a Tkinter.Label.</p>
</dt></dl>
<a name=methods></a>
<dt> <h3>Methods</h3><dd>
Only methods specific to this megawidget are described below.
For a description of its inherited methods, see the
manuals for its base classes.
In addition, methods from the
<strong>Tkinter.Entry</strong> class
are forwarded by this megawidget to the
<strong>entry</strong> component.
<p>
<a name=method.helpmessage></a>
<dl><dt> <strong>helpmessage</strong>(<em>text</em>)<dd>
A convenience method to display <em>text</em> in the message bar
according to the characteristics defined by the <strong>help</strong> message type.
Equivalent to <code>message('help', text)</code>.</p>
</dt></dl>
<a name=method.message></a>
<dl><dt> <strong>message</strong>(<em>type</em>, <em>text</em>)<dd>
Display <em>text</em> in the message bar according to the characteristics
defined by the <em>type</em> message type, as discussed under
<strong>messagetypes</strong>.</p>
</dt></dl>
<a name=method.resetmessages></a>
<dl><dt> <strong>resetmessages</strong>(<em>type</em>)<dd>
Clear the <em>type</em> message and all message types with a lower
priority, except permanent messages, such as <strong>state</strong>. This is
useful to clear the <strong>busy</strong> message and any outstanding event and
help messages.</p>
</dt></dl>
<dt> <h3>Example</h3><dd>
The image at the top of this manual is a snapshot
of the window (or part of the window) produced
by the following code.<p>
<pre>
class Demo:
def __init__(self, parent):
# Create and pack the MessageBar.
self._messagebar = Pmw.MessageBar(parent,
entry_width = 40,
entry_relief='groove',
labelpos = 'w',
label_text = 'Status:')
self._messagebar.pack(side = 'bottom', fill = 'x',
expand = 1, padx = 10, pady = 10)
# Create and pack the ScrolledListBox to change the MessageBar.
self.box = Pmw.ScrolledListBox(parent,
listbox_selectmode='single',
items=('state', 'help', 'userevent', 'systemevent',
'usererror', 'systemerror', 'busy',),
label_text='Message type',
labelpos='n',
selectioncommand=self.selectionCommand)
self.box.pack(fill = 'both', expand = 'yes', padx = 10, pady = 10)
self._index = 0
self._stateCounter = 0
def selectionCommand(self):
sels = self.box.getcurselection()
if len(sels) > 0:
self._index = self._index + 1
messagetype = sels[0]
if messagetype == 'state':
self._stateCounter = (self._stateCounter + 1) % 3
text = stateMessages[self._stateCounter]
if text != '':
text = text + ' (' + messagetype + ')'
self._messagebar.message('state', text)
else:
text = messages[messagetype]
text = text + ' (' + messagetype + ')'
self._messagebar.message(messagetype, text)
if messagetype == 'busy':
Pmw.showbusycursor()
self.box.after(2000)
Pmw.hidebusycursor()
self._messagebar.resetmessages('busy')
text = 'All files successfully removed'
text = text + ' (userevent)'
self._messagebar.message('userevent', text)
messages = {
'help': 'Save current file',
'userevent': 'Saving file "foo"',
'busy': 'Busy deleting all files from file system ...',
'systemevent': 'File "foo" saved',
'usererror': 'Invalid file name "foo/bar"',
'systemerror': 'Failed to save file: file system full',
}
stateMessages = {
0: '',
1: 'Database is down',
2: 'Waiting for reply from database',
}
</pre>
</dl>
<center><P ALIGN="CENTER">
<IMG SRC = blue_line.gif ALT = "" WIDTH=320 HEIGHT=5>
</p></center>
<font size=-1>
<center><P ALIGN="CENTER">
<a href="index.html">Home</a>.
Pmw 0.8.5
Maintainer
<a href="mailto:gregm@iname.com">gregm@iname.com</a>.
9 Feb 2001
</p></center>
</font>
</body>
</html>
|
