File: dialogshell.n.html

package info (click to toggle)
itcl3.0 3.0.1-6
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 10,128 kB
  • ctags: 3,519
  • sloc: tcl: 32,416; ansic: 12,683; sh: 3,917; makefile: 692; awk: 273; perl: 265
file content (337 lines) | stat: -rw-r--r-- 8,779 bytes parent folder | download | duplicates (8)
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
<!-- 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>

dialogshell - Create and manipulate a dialog shell widget
<P>

<H2><A NAME="sect2" HREF="#toc2"><B>SYNOPSIS</B></A></H2>

<B>dialogshell</B> <I>pathName</I> ?<I>options</I>?
<P>

<H2><A NAME="sect3" HREF="#toc3"><B>INHERITANCE</B></A></H2>

itk::Toplevel &lt;- Shell &lt;- Dialogshell
<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 &quot;options&quot; manual entry for details on the standard
options.
<P>

<H2><A NAME="sect5" HREF="#toc5"><B>INHERITED</B> <B>OPTIONS</B></A></H2>

<B>height</B>          <B>master</B>         <B>modality</B>        <B>width</B>
<P>
See the &quot;shell&quot; manual entry for details on the above inherited
options.
<P>
<B>title</B>
<P>
See the &quot;Toplevel&quot; 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>buttonBoxPadX</B>
</DD>
</DL>
<DL>
<DT>Class: <DD>         <B>Pad</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD>          <B>-buttonboxpadx</B>
<P>
</DD>
</DL>
Specifies a non-negative padding distance to leave
between the button group and the outer edge of the button
box in the x direction. The value may be given in
any of the forms accpetable to <B>Tk_GetPixels</B>. The
default is 5 pixels.
<P>
<DL>
<DT>Name: <DD>          <B>buttonBoxPadY</B>
</DD>
</DL>
<DL>
<DT>Class: <DD>         <B>Pad</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD>          <B>-buttonboxpady</B>
<P>
</DD>
</DL>
Specifies a non-negative padding distance to leave
between the button group and the outer edge of the button
box in the y direction. The value may be given in
any of the forms accpetable to <B>Tk_GetPixels</B>. The
default is 5 pixels.
<P>
<DL>
<DT>Name: <DD>          <B>buttonBoxPos</B>
</DD>
</DL>
<DL>
<DT>Class: <DD>         <B>Position</B>
<P>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD>          <B>-buttonboxpos</B>
<P>
</DD>
</DL>
Attaches buttons to the given side of the dialog: <B>n</B>, <B>s</B>,
<B>e</B> or <B>w</B>. The default is s.
<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>separator</B>
</DD>
</DL>
<DL>
<DT>Class: <DD>         <B>Separator</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD>          <B>-separator</B>
<P>
</DD>
</DL>
Specifies whether a line is drawn to separate the buttons
from the dialog box contents in any of the forms
acceptable to <B>Tcl_GetBoolean</B>. The default is true.
<P>
<DL>
<DT>Name: <DD>          <B>thickness</B>
</DD>
</DL>
<DL>
<DT>Class: <DD>         <B>Thickness</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD>          <B>-thickness</B>
<P>
</DD>
</DL>
Specifies the thickness of the separator in any of the
forms acceptable to <B>Tk_GetPixels</B>. The default is 3
pixels.<BR>

_________________________________________________________________
<P>

<H2><A NAME="sect7" HREF="#toc7"><B>DESCRIPTION</B></A></H2>

The <B>dialogshell</B> command creates a dialog shell which is a
top level widget composed of a button box, separator, and
child site area. The class also has methods to control button
construction.
<P>

<H2><A NAME="sect8" HREF="#toc8"><B>METHODS</B></A></H2>

The <B>dialogshell</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 dialogshell
widgets:
<P>

<H2><A NAME="sect9" HREF="#toc9"><B>INHERITED</B> <B>METHODS</B></A></H2>

<B>activate</B>        <B>center</B>         <B>deactivate</B>
<P>
See the &quot;shell&quot; manual entry for details on the above inherited
methods.
<P>

<H2><A NAME="sect10" HREF="#toc10"><B>ASSOCIATED</B> <B>METHODS</B></A></H2>

<B>add</B>             <B>buttonconfigure</B>                <B>defaultdelete</B>
<DL>
<DT><B>hide</B> <DD>           <B>index</B>          <B>insert</B>          <B>invoke</B>
<B>show</B>
<P>
</DD>
</DL>
See the &quot;buttonbox&quot; manual entry for details on the associated
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>dialogshell</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>dialogshell</B> command.
<P>

<H2><A NAME="sect12" HREF="#toc12"><B>COMPONENTS</B></A></H2>

<DL>
<DT>Name: <DD>          <B>dschildsite</B>
</DD>
</DL>
<DL>
<DT>Class: <DD>         <B>frame</B>
<P>
</DD>
</DL>
The dschildsite component is the user child site for
the dialog shell. See the &quot;frame&quot; widget manual entry
for details on the dschildsite component item.
<P>
<DL>
<DT>Name: <DD>          <B>separator</B>
</DD>
</DL>
<DL>
<DT>Class: <DD>         <B>frame</B>
<P>
</DD>
</DL>
The separator component devides the area between the
user child site and the button box. See the &quot;frame"
widget manual entry for details on the separator component
item.
<P>
<DL>
<DT>Name: <DD>          <B>bbox</B>
</DD>
</DL>
<DL>
<DT>Class: <DD>         <B>ButtonBox</B>
<P>
</DD>
</DL>
The bbox component is the button box containing the
buttons for the dialog shell. See the &quot;ButtonBox"
widget manual entry for details on the bbox component
item.
<P>

<H2><A NAME="sect13" HREF="#toc13"><B>EXAMPLE</B></A></H2>

dialogshell .ds -modality none
<P>
<DL>
<DT>.ds add OK -text &quot;OK"<DD>
.ds add Cancel -text &quot;Cancel"
.ds default OK
<P>
</DD>
</DL>
<DL>
<DT>.ds activate<DD>
<P>
</DD>
</DL>

<H2><A NAME="sect14" HREF="#toc14"><B>AUTHOR</B></A></H2>

Mark L. Ulferts
<P>

<H2><A NAME="sect15" HREF="#toc15"><B>KEYWORDS</B></A></H2>

dialogshell, dialog, 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">INHERITED METHODS</A></LI>
<LI><A NAME="toc10" HREF="#sect10">ASSOCIATED 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>