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
|
<!-- manual page source format generated by RosettaMan v2.5a6, -->
<!-- available via anonymous ftp from ftp.cs.berkeley.edu:/ucb/people/phelps/tcltk/rman.tar.Z -->
<HTML>
<HEAD>
<TITLE>man page(1) manual page</TITLE>
</HEAD>
<BODY>
<A HREF="#toc">Table of Contents</A><P>
_________________________________________________________________
<P>
<H2><A NAME="sect1" HREF="#toc1"><B>NAME</B></A></H2>
messagebox - Create and manipulate a messagebox text widget
<P>
<H2><A NAME="sect2" HREF="#toc2"><B>SYNOPSIS</B></A></H2>
<B>messagebox</B> <I>pathName</I> ?<I>options</I>?
<P>
<H2><A NAME="sect3" HREF="#toc3"><B>INHERITANCE</B></A></H2>
itk::Widget <- Labeledwidget <- Scrolledwidget <- Messagebox
<P>
<H2><A NAME="sect4" HREF="#toc4"><B>STANDARD</B> <B>OPTIONS</B></A></H2>
<DL>
<DT><B>activeBackground</B> <DD> <B>activeForegroundbackgroundborderWidth</B>
<B>cursor</B> <B>exportSelection</B> <B>fontforeground</B>
<B>highlightColor</B> <B>highlightThickness</B> <B>padXpadY</B>
</DD>
</DL>
<DL>
<DT><B>relief</B> <DD> <B>setGrid</B>
<P>
</DD>
</DL>
See the "options" manual entry for details on the standard
options.
<P>
<H2><A NAME="sect5" HREF="#toc5"><B>ASSOCIATED</B> <B>OPTIONS</B></A></H2>
<B>labelBitmap</B> <B>labelFont</B> <B>labelImage</B> <B>labelMargin</B>
<DL>
<DT><B>labelPos</B> <DD> <B>labelText</B> <B>labelVariable</B>
<P>
</DD>
</DL>
See the "labeledwidget" class manual entry for details on
the above associated options.
<P>
<B>activeRelief</B> <B>elementBorderWidth</B> <B>jumptroughColor</B>
<P>
See the "scrollbar" widget manual entry for details on the
above associated options.
<P>
<DL>
<DT><B>height</B> <DD> <B>hscrollMode</B> <B>sbWidth</B> <B>scrollMargin</B>
<B>textBackground</B> <B>visibleItems</B> <B>vscrollMode</B> <B>width</B>
<P>
</DD>
</DL>
See the "scrolledtext" widget manual entry for details on
the above associated options.
<P>
<B>spacing1</B> <B>spacing2</B> <B>spacing3</B>
<P>
See the "text" widget manual entry for details on the above
associated options.
<P>
<H2><A NAME="sect6" HREF="#toc6"><B>WIDGET-SPECIFIC</B> <B>OPTIONS</B></A></H2>
<DL>
<DT>Name: <DD> <B>fileName</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>FileName</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-filename</B>
<P>
</DD>
</DL>
Specifies the filename to be displayed in the file
selection dialog when it pops up during a save of the
messagebox contents operation.
<P>
<DL>
<DT>Name: <DD> <B>maxLines</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>MaxLines</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-maxlines</B>
<P>
</DD>
</DL>
Specifies the maximum number of lines allowed in the
text area of the messagebox. When this limit is
reached, the oldest line will be deleted such that the
total number of lines remains <I>maxlines</I>.
<P>
<DL>
<DT>Name: <DD> <B>saveDir</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>SaveDir</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-savedir</B>
<P>
</DD>
</DL>
Specifies the default directory to display when the
file selection dialog pops up during a save of the messagebox
contents operation. If this parameter is not
specified, then the files in the current working directory
are displayed.
<P>
_________________________________________________________________
<P>
<H2><A NAME="sect7" HREF="#toc7"><B>DESCRIPTION</B></A></H2>
The <B>messagebox</B> command creates a scrolled information messages
area widget. Message types can be user defined and
configured. Their options include foreground, background,
font, bell, and their display mode of on or off. This
allows message types to defined as needed, removed when no
longer so, and modified when necessary. An export method is
provided for file I/O.
<P>
The number of lines displayed may be limited with the
default being 1000. When this limit is reached, the oldest
line is removed. A popup menu which appears when the right
mouse button has been pressed in the message area has been
predefined. The contents of the popup menu by default support
clearing the area and saving its contents to a file.
Additional operations may be defined or existing operations
removed by using the component command to access the popup
menu.
<P>
<H2><A NAME="sect8" HREF="#toc8"><B>MESSAGE</B> <B>TYPES</B></A></H2>
The display characteristics of messages issued to the messagebox
vary with the message type. Types are defined by
the user and they may be added, removed, and configured.
The options of the message type control the display include
the following:
<P>
<DL>
<DT><B>-background</B> <I>color</I><DD>
<I>Color</I> specifies the background color to use for
characters associated with the message type. It may
have any of the forms accepted by <B>Tk_GetColor</B>.
<P>
</DD>
</DL>
<DL>
<DT><B>-bell</B> <I>boolean</I><DD>
Specifies whether or not to ring the bell whenenver a
message of this type is issued. <I>Boolean</I> may have any
of the forms accepted by <B>Tk_GetBoolean</B>. The default is
0.
<P>
</DD>
</DL>
<DL>
<DT><B>-font</B> <I>fontName</I><DD>
<I>FontName</I> is the name of a font to use for drawing characters.
It may have any of the forms accepted by
Tk_GetFontStruct.
<P>
</DD>
</DL>
<DL>
<DT><B>-foreground</B> <I>color</I><DD>
<I>Color</I> specifies the foreground color to use for characters
associated with the message type. It may have any
of the forms accepted by <B>Tk_GetColor</B>.
<P>
</DD>
</DL>
<DL>
<DT><B>-show</B> <I>boolean</I><DD>
Specifies whether of not to display this message type
when issued. <I>Boolean</I> may have any of the forms
accepted by <B>Tk_GetBoolean</B>. The default is 1.
<P>
</DD>
</DL>
<H2><A NAME="sect9" HREF="#toc9"><B>METHODS</B></A></H2>
The <B>messagebox</B> command creates a new Tcl command whose name
is <I>pathName</I>. This command may be used to invoke various
operations on the widget. It has the following general
form:
<P>
<I>pathName</I> <I>option</I> ?<I>arg</I> <I>arg</I> ...?
<P>
<I>Option</I> and the <I>arg</I>s determine the exact behavior of the command.
The following commands are possible for messagebox
widgets:
<P>
<H2><A NAME="sect10" HREF="#toc10"><B>WIDGET-SPECIFIC</B> <B>METHODS</B></A></H2>
<I>pathName</I> <B>cget</B> <I>option</I><BR>
Returns the current value of the configuration option
given by <I>option</I>. <I>Option</I> may have any of the values
accepted by the <B>messagebox</B> command.
<P>
<I>pathName</I> <B>clear</B><BR>
Clear the messagebox of all messages.
<P>
<I>pathName</I> <B>export</B> <I>filename</I><BR>
Write text to a file. If <I>filename</I> exists then contents
are replaced with text widget contents.
<P>
<I>pathName</I> <B>configure</B> ?<I>option</I>? ?<I>value</I> <I>option</I> <I>value</I> ...?
<P>
Query or modify the configuration options of the
widget. If no <I>option</I> is specified, returns a list
describing all of the available options for <I>pathName</I>
(see <B>Tk_ConfigureInfo</B> for information on the format of
this list). If <I>option</I> is specified with no <I>value</I>, then
the command returns a list describing the one named
option (this list will be identical to the corresponding
sublist of the value returned if no <I>option</I> is
specified). If one or more <I>option</I> - <I>value</I> pairs are
specified, then the command modifies the given widget
option(s) to have the given value(s); in this case the
command returns an empty string. <I>Option</I> may have any
of the values accepted by the <B>messagebox</B> command.
<P>
<I>pathName</I> <B>type</B> <I>option</I> <I>msgtype</I> ?<I>arg</I> <I>arg</I> ...?
This command is used to manipulate message types.
The behavior of the command depends on the option argument
that follows the type keyword. The following forms
of the command are supported:
<P>
<DL>
<DT>Name: <DD> <B>itemMenu</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Menu</B>
<P>
</DD>
</DL>
This is the popup menu that gets displayed when you
right-click in the text area of the messagebox. Its
contents may be modified via the component command.
<P>
<DL>
<DT>Name: <DD> <B>text</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Scrolledtext</B>
<P>
</DD>
</DL>
The text component is the scrolledtext widget. See the
"scrolledtext" widget manual entry for details on the
text component item.
<P>
<H2><A NAME="sect11" HREF="#toc11"><B>EXAMPLE</B></A></H2>
messagebox .mb -hscrollmode dynamic -labeltext "Messages" -labelpos n \
-height 120 -width 550 -savedir "/tmp" -textbackground #d9d9d9
<P>
pack .mb -padx 5 -pady 5 -fill both -expand yes
<P>
<DL>
<DT>.mb type add ERROR -background red -foreground white -bell 1<DD>
.mb type add WARNING -background yellow -foreground black
.mb type add INFO -background white -foreground black
<P>
</DD>
</DL>
<DL>
<DT>.mb issue "This is an error message in red with a beep" ERROR<DD>
.mb issue "This warning message in yellow" WARNING
.mb issue "This is an informational message" INFO
<P>
</DD>
</DL>
<H2><A NAME="sect12" HREF="#toc12"><B>AUTHOR</B></A></H2>
Alfredo Jahn V
<P>
Mark L. Ulferts
<P>
<H2><A NAME="sect13" HREF="#toc13"><B>KEYWORDS</B></A></H2>
messagebox, scrolledtext, text, widget
<P>
<HR><P>
<A NAME="toc"><B>Table of Contents</B></A><P>
<UL>
<LI><A NAME="toc1" HREF="#sect1">NAME</A></LI>
<LI><A NAME="toc2" HREF="#sect2">SYNOPSIS</A></LI>
<LI><A NAME="toc3" HREF="#sect3">INHERITANCE</A></LI>
<LI><A NAME="toc4" HREF="#sect4">STANDARD OPTIONS</A></LI>
<LI><A NAME="toc5" HREF="#sect5">ASSOCIATED OPTIONS</A></LI>
<LI><A NAME="toc6" HREF="#sect6">WIDGET-SPECIFIC OPTIONS</A></LI>
<LI><A NAME="toc7" HREF="#sect7">DESCRIPTION</A></LI>
<LI><A NAME="toc8" HREF="#sect8">MESSAGE TYPES</A></LI>
<LI><A NAME="toc9" HREF="#sect9">METHODS</A></LI>
<LI><A NAME="toc10" HREF="#sect10">WIDGET-SPECIFIC METHODS</A></LI>
<LI><A NAME="toc11" HREF="#sect11">EXAMPLE</A></LI>
<LI><A NAME="toc12" HREF="#sect12">AUTHOR</A></LI>
<LI><A NAME="toc13" HREF="#sect13">KEYWORDS</A></LI>
</UL>
</BODY></HTML>
|
