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
|
<!-- 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>
shell - Create and manipulate a shell widget
<P>
<H2><A NAME="sect2" HREF="#toc2"><B>SYNOPSIS</B></A></H2>
<B>shell</B> <I>pathName</I> ?<I>options</I>?
<P>
<H2><A NAME="sect3" HREF="#toc3"><B>INHERITANCE</B></A></H2>
itk::Toplevel <- shell
<P>
<H2><A NAME="sect4" HREF="#toc4"><B>STANDARD</B> <B>OPTIONS</B></A></H2>
<B>background</B> <B>cursor</B> <B>foreground</B>
<P>
See the "options" manual entry for details on the standard
options.
<P>
<H2><A NAME="sect5" HREF="#toc5"><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>
<H2><A NAME="sect6" HREF="#toc6"><B>WIDGET-SPECIFIC</B> <B>OPTIONS</B></A></H2>
<DL>
<DT>Name: <DD> <B>height</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Height</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-height</B>
<P>
</DD>
</DL>
Specifies the height of the shell. The value may be
specified in any of the forms acceptable to
<B>Tk_GetPixels</B>. A value of zero causes the height to be
adjusted to the required value based on the size
requests of the components placed in the childsite.
Otherwise, the height is fixed. The default is zero.
NOTE: This may cause some amount of flickering on
slower machines. To prevent it simply set the width
and height to a appropriate value.
<P>
<DL>
<DT>Name: <DD> <B>master</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Window</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-master</B>
<P>
</DD>
</DL>
Defines the shell as being a transient window with the
master window given by the master option. The master
window should be either another existing toplevel window
or {} for no master. The default is {} for shells
and "." for dialogs.
<P>
<DL>
<DT>Name: <DD> <B>modality</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Modality</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-modality</B>
<P>
</DD>
</DL>
Allows the shell to grab control of the screen in one
of three different ways: <B>application</B>, <B>system</B>, or <B>none</B>.
Application modal prevents any other toplevel windows
within the application which are direct children of `.'
from gaining focus. System modal locks the screen and
prevents all windows from gaining focus regardless of
application. A modality of none performs no grabs at
all. The default is none.
<P>
<DL>
<DT>Name: <DD> <B>padX</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Pad</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-padx</B>
<P>
</DD>
</DL>
Specifies a padding distance for the childsite in the
X-direction in any of the forms acceptable to
<B>Tk_GetPixels</B>. The default is 10.
<P>
<DL>
<DT>Name: <DD> <B>padY</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Pad</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-pady</B>
<P>
</DD>
</DL>
Specifies a padding distance for the childsite in the
Y-direction in any of the forms acceptable to
<B>Tk_GetPixels</B>. The default is 10.
<P>
<DL>
<DT>Name: <DD> <B>width</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Width</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-width</B>
<P>
</DD>
</DL>
Specifies the width of the shell. The value may be
specified in any of the forms acceptable to
<B>Tk_GetPixels</B>. A value of zero causes the width to be
adjusted to the required value based on the size
requests of the components placed in the childsite.
Otherwise, the width is fixed. The default is zero.
NOTE: This may cause some amount of flickering on
slower machines. To prevent it simply set the width
and height to a appropriate value.<BR>
_________________________________________________________________
<P>
<H2><A NAME="sect7" HREF="#toc7"><B>DESCRIPTION</B></A></H2>
The <B>shell</B> command creates a shell which is a top level
widget which supports modal operation.
<P>
<H2><A NAME="sect8" HREF="#toc8"><B>METHODS</B></A></H2>
The <B>shell</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 shell widgets:
<P>
<H2><A NAME="sect9" HREF="#toc9"><B>WIDGET-SPECIFIC</B> <B>METHODS</B></A></H2>
<I>pathName</I> <B>activate</B><BR>
Display the shell and wait based on the modality. For
application and system modal activations, perform a
grab operation, and wait for the result. The result
may be returned via an argument to the <B>deactivate</B>
method.
<P>
<I>pathName</I> <B>center</B> ?<I>widget</I>?<BR>
Centers the shell with respect to another widget. The
widget argument is optional. If provided, it should be
the path of another widget with to center upon. If
absent, then the shell will be centered on the screen
as a whole.
<P>
<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>shell</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>shell</B> command.
<P>
<I>pathName</I> <B>deactivate</B> ?<I>arg</I>?<BR>
Deactivate the display of the shell. The method takes
an optional argument to be passed to the <B>activate</B>
method which returns the value. The optional argument
is only effective for application and system modal dialogs.
<P>
<H2><A NAME="sect10" HREF="#toc10"><B>COMPONENTS</B></A></H2>
<P>
<DL>
<DT>Name: <DD> <B>shellchildsite</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>frame</B>
<P>
</DD>
</DL>
The shellchildsite component is the user child site for
the shell. See the "frame" widget manual entry for
details on the shellchildsite component item.
<P>
<H2><A NAME="sect11" HREF="#toc11"><B>EXAMPLE</B></A></H2>
shell .sh -modality application -padx 20 -pady 20 -title Shell
<P>
pack [label [.sh childsite].l -text SHELL]
<P>
<DL>
<DT>.sh center<DD>
.sh activate
<P>
</DD>
</DL>
<H2><A NAME="sect12" HREF="#toc12"><B>AUTHOR</B></A></H2>
Mark L. Ulferts
<P>
Kris Raney
<P>
<H2><A NAME="sect13" HREF="#toc13"><B>KEYWORDS</B></A></H2>
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">INHERITED 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">METHODS</A></LI>
<LI><A NAME="toc9" HREF="#sect9">WIDGET-SPECIFIC METHODS</A></LI>
<LI><A NAME="toc10" HREF="#sect10">COMPONENTS</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>
|
