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
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
|
<!-- 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>
mainwindow - Create and manipulate a mainwindow widget
<P>
<H2><A NAME="sect2" HREF="#toc2"><B>SYNOPSIS</B></A></H2>
<B>mainwindow</B> <I>pathName</I> ?<I>options</I>?
<P>
<H2><A NAME="sect3" HREF="#toc3"><B>INHERITANCE</B></A></H2>
itk::Toplevel <- shell <- mainwindow
<P>
<H2><A NAME="sect4" HREF="#toc4"><B>STANDARD</B> <B>OPTIONS</B></A></H2>
<B>background</B> <B>cursor</B> <B>disabledForegroundfont</B>
<B>foreground</B> <B>highlightBackground</B> <B>highlightColorhighlightThickness</B>
<P>
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>
<DL>
<DT><B>balloonBackground</B> <DD> <B>balloonDelay1</B> <B>balloonDelay2ballonFont</B>
<B>balloonForeground</B>
<P>
</DD>
</DL>
See the "toolbar" manual entry for details on the above
associated options.
<P>
<H2><A NAME="sect6" HREF="#toc6"><B>INHERITED</B> <B>OPTIONS</B></A></H2>
<B>title</B>
<P>
See the "Toplevel" manual entry for details on the above
inherited options.
<P>
<B>height</B> <B>master</B> <B>modality</B> <B>padX</B>
<DL>
<DT><B>padY</B> <DD> <B>width</B>
<P>
</DD>
</DL>
See the "shell" manual entry for details on the above inherited
options.
<P>
<H2><A NAME="sect7" HREF="#toc7"><B>WIDGET-SPECIFIC</B> <B>OPTIONS</B></A></H2>
<DL>
<DT>Name: <DD> <B>helpLine</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>HelpLine</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-helpline</B>
<P>
</DD>
</DL>
Specifies whether or not to display the help line. The
value may be given in any of the forms acceptable to
Tk_GetBoolean. The default is yes.
<P>
<DL>
<DT>Name: <DD> <B>menuBarBackground</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Background</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-menubarbackground</B>
<P>
</DD>
</DL>
Specifies the normal background color for the menubar.
<P>
<DL>
<DT>Name: <DD> <B>menuBarFont</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Font</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-menubarfont</B>
<P>
</DD>
</DL>
Specifies the font to use when drawing text inside the
menubar.
<P>
<DL>
<DT>Name: <DD> <B>menuBarForeround</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Foreground</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-menubarforeground</B>
<P>
</DD>
</DL>
Specifies the normal foreground color for the menubar.
<P>
<DL>
<DT>Name: <DD> <B>statusLine</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>StatusLine</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-statusline</B>
<P>
</DD>
</DL>
Specifies whether or not to display the status line.
The value may be given in any of the forms acceptable
to Tk_GetBoolean. The default is yes.
<P>
<DL>
<DT>Name: <DD> <B>toolBarBackground</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Background</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-toolbarbackground</B>
<P>
</DD>
</DL>
Specifies the normal background color for the toolbar.
<P>
<DL>
<DT>Name: <DD> <B>toolBarFont</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Font</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-toolbarfont</B>
<P>
</DD>
</DL>
Specifies the font to use when drawing text inside the
toolbar.
<P>
<DL>
<DT>Name: <DD> <B>toolBarForeround</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Foreground</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-toolbarforeground</B>
<P>
</DD>
</DL>
Specifies the normal foreground color for the toolbar.
_________________________________________________________________
<P>
<H2><A NAME="sect8" HREF="#toc8"><B>DESCRIPTION</B></A></H2>
The <B>mainwindow</B> command creates a mainwindow shell which contains
a menubar, toolbar, mousebar, childsite, status line,
and help line. Each item may be filled and configured to
suit individual needs.
<P>
<H2><A NAME="sect9" HREF="#toc9"><B>METHODS</B></A></H2>
The <B>mainwindow</B> command create 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 mainwindow
widgets:
<P>
<H2><A NAME="sect10" HREF="#toc10"><B>INHERITED</B> <B>METHODS</B></A></H2>
<B>activate</B> <B>center</B> <B>deactivate</B>
<P>
See the "shell" manual entry for details on the above inherited
methods.
<P>
<H2><A NAME="sect11" HREF="#toc11"><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>mainwindow</B> command.
<P>
<I>pathName</I> <B>childsite</B><BR>
Returns the pathname of the child site widget.
<P>
<I>pathName</I> <B>configure</B> ?<I>option</I>? ?<I>value</I> <I>option</I> <I>value</I> ...?
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>mainwindow</B> command.
<P>
<I>pathName</I> <B>menubar</B> ?<I>args</I>?<BR>
The <B>menubar</B> method provides access to the menubar.
Invoked with no arguments it returns the pathname of
the menubar. With arguments, they are evaluated
against the menubar which in effect provides access to
the entire API of the menubar. See the "menubar"
manual entry for details on the commands available in
the menubar.
<P>
<I>pathName</I> <B>mousebar</B> ?<I>args</I>?<BR>
The <B>mousebar</B> method provides access to the mousebar
which is a vertical toolbar. Invoked with no arguments
it returns the pathname of the mousebar. With
arguments, they are evaluated against the mousebar
which in effect provides access to the entire API of
the underlying toolbar. See the "toolbar" manual entry
for details on the commands available in the mousebar.
<P>
<I>pathName</I> <B>msgd</B> ?<I>args</I>?<BR>
The <B>msgd</B> method provides access to the messagedialog
contained in the mainwindow. Invoked with no arguments
it returns the pathname of the messagedialog. With
arguments, they are evaluated against the messagedialog
which in effect provides access to the entire API of
the messagedialog. See the "messagedialog" manual
entry for details on the commands available in the messagedialog.
<P>
<I>pathName</I> <B>toolbar</B> ?<I>args</I>?<BR>
The <B>toolbar</B> method provides access to the toolbar.
Invoked with no arguments it returns the pathname of
the toolbar. With arguments, they are evaluated
against the toolbar which in effect provides access to
the entire API of the toolbar. See the "toolbar"
manual entry for details on the commands available in
the toolbar.
<P>
<H2><A NAME="sect12" HREF="#toc12"><B>COMPONENTS</B></A></H2>
<DL>
<DT>Name: <DD> <B>help</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Label</B>
<P>
</DD>
</DL>
The help component provides a location for displaying
any help strings provided in the menubar, toolbar, or
mousebar. See the "label" widget manual entry for
details on the help component item.
<P>
<DL>
<DT>Name: <DD> <B>menubar</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Menubar</B>
<P>
</DD>
</DL>
The menubar component is the menubar located at the top
of the window. See the "menubar" widget manual entry
for details on the menubar component item.
<P>
<DL>
<DT>Name: <DD> <B>mousebar</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Toolbar</B>
<P>
</DD>
</DL>
The mousebar component is the vertical toolbar located
on the right side of the window. See the "toolbar"
widget manual entry for details on the mousebar component
item.
<P>
<DL>
<DT>Name: <DD> <B>msgd</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Messagedialog</B>
<P>
</DD>
</DL>
The msgd component is a messagedialog which may be
reconfigured as needed and used repeatedly throughout
the application. See the "messagedialog" widget manual
entry for details on the messagedialog component item.
<P>
<DL>
<DT>Name: <DD> <B>status</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Label</B>
<P>
</DD>
</DL>
The status component provides a location for displaying
application status information. See the "label" widget
manual entry for details on the status component item.
<P>
<DL>
<DT>Name: <DD> <B>toolbar</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Toolbar</B>
<P>
</DD>
</DL>
The toolbar component is the horizontal toolbar located
on the top of the window. See the "toolbar" widget
manual entry for details on the toolbar component item.
<P>
<H2><A NAME="sect13" HREF="#toc13"><B>EXAMPLE</B></A></H2>
mainwindow .mw
<P>
#<BR>
# Add a File menubutton<BR>
#<BR>
.mw menubar add menubutton file -text "File" -underline 0 -padx 8 -pady 2 \
-menu {options -tearoff no<BR>
command new -label "New" -underline 0 \
-helpstr "Create a new file"
command open -label "Open ..." -underline 0 \
-helpstr "Open an existing file"
command save -label "Save" -underline 0 \
-helpstr "Save the current file"
command saveas -label "Save As ..." -underline 5 \
-helpstr "Save the file as a differnet name"
command print -label "Print" -underline 0 \
-helpstr "Print the file"
separator sep1<BR>
command close -label "Close" -underline 0 \
-helpstr "Close the file"
separator sep2<BR>
command exit -label "Exit" -underline 1 \
-helpstr "Exit this application"
}
<P>
#<BR>
# Install a scrolledtext widget in the childsite.
#<BR>
scrolledtext [.mw childsite].st<BR>
pack [.mw childsite].st -fill both -expand yes
#<BR>
# Activate the main window.<BR>
#<BR>
.mw activate
<P>
<H2><A NAME="sect14" HREF="#toc14"><B>AUTHOR</B></A></H2>
Mark L. Ulferts
<P>
John A. Tucker
<P>
<H2><A NAME="sect15" HREF="#toc15"><B>KEYWORDS</B></A></H2>
mainwindow, shell, 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">INHERITED OPTIONS</A></LI>
<LI><A NAME="toc7" HREF="#sect7">WIDGET-SPECIFIC OPTIONS</A></LI>
<LI><A NAME="toc8" HREF="#sect8">DESCRIPTION</A></LI>
<LI><A NAME="toc9" HREF="#sect9">METHODS</A></LI>
<LI><A NAME="toc10" HREF="#sect10">INHERITED METHODS</A></LI>
<LI><A NAME="toc11" HREF="#sect11">WIDGET-SPECIFIC METHODS</A></LI>
<LI><A NAME="toc12" HREF="#sect12">COMPONENTS</A></LI>
<LI><A NAME="toc13" HREF="#sect13">EXAMPLE</A></LI>
<LI><A NAME="toc14" HREF="#sect14">AUTHOR</A></LI>
<LI><A NAME="toc15" HREF="#sect15">KEYWORDS</A></LI>
</UL>
</BODY></HTML>
|
