1<TITLE>dialogshell - Create and manipulate a dialog shell widget</TITLE>
2<H1>dialogshell - Create and manipulate a dialog shell widget</H1>
3
4</pre><H2>SYNOPSIS</H2>
5<B>dialogshell<I> <I>pathName </I>?<I>options</I>?
6</pre><H2>INHERITANCE</H2>
7itk::Toplevel &lt;- Shell &lt;- Dialogshell
8</pre><H2>STANDARD OPTIONS</H2>
9<P>
10<table cellpadding=5>
11<td valign=top>
12<B>background</B><br>
13</td>
14<td valign=top>
15<B>cursor</B><br>
16</td>
17<td valign=top>
18<B>foreground</B><br>
19</td>
20<td valign=top>
21</td>
22</table>
23<P>
24See the <A HREF="http://www.sco.com/Technology/tcl/man/tk_man/options.n.html"> "options" </A> manual entry for details on the standard options.
25</pre><H2>INHERITED OPTIONS</H2>
26<P>
27<table cellpadding=5>
28<td valign=top>
29<B>height</B><br>
30</td>
31<td valign=top>
32<B>master</B><br>
33</td>
34<td valign=top>
35<B>modality</B><br>
36</td>
37<td valign=top>
38<B>width</B><br>
39</td>
40</table>
41<P>
42See the "shell" manual entry for details on the above inherited options.
43<P>
44<table cellpadding=5>
45<td valign=top>
46<B>title</B><br>
47</td>
48<td valign=top>
49</td>
50<td valign=top>
51</td>
52<td valign=top>
53</td>
54</table>
55<P>
56See the "Toplevel" manual entry for details on the above inherited options.
57
58</pre><H2>WIDGET-SPECIFIC OPTIONS</H2>
59<P>
60<pre>
61Name:                   <B>buttonBoxPadX</B>
62Class:                  <B>Pad</B>
63Command-Line Switch:	<B>-buttonboxpadx</B>
64</pre>
65<UL>
66Specifies a non-negative padding distance to leave between the button group and
67the outer edge of the button box in the x direction.  The value may be 
68given in any of the forms accpetable to <B>Tk_GetPixels</B>.  The default 
69is 5 pixels.
70</UL>
71<P>
72<pre>
73Name:                   <B>buttonBoxPadY</B>
74Class:                  <B>Pad</B>
75Command-Line Switch:	<B>-buttonboxpady</B>
76</pre>
77<UL>
78Specifies a non-negative padding distance to leave between the button group and
79the outer edge of the button box in the y direction.  The value may be 
80given in any of the forms accpetable to <B>Tk_GetPixels</B>.  The default 
81is 5 pixels.
82</UL>
83<P>
84<pre>
85Name:                   <B>buttonBoxPos</B>
86Class:                  <B>Position</B>
87Command-Line Switch:	<B>-buttonboxpos</B>
88</pre>
89<UL>
90Attaches buttons to the given side of the dialog: <B>n</B>, <B>s</B>, 
91<B>e</B> or <B>w</B>.  The default is s.
92</UL>
93<P>
94<pre>
95Name:                   <B>padX</B>
96Class:                  <B>Pad</B>
97Command-Line Switch:	<B>-padx</B>
98</pre>
99<UL>
100Specifies a padding distance for the childsite in the X-direction in
101any of the forms acceptable to <B>Tk_GetPixels</B>.  The default is 10.
102</UL>
103<P>
104<pre>
105Name:                   <B>padY</B>
106Class:                  <B>Pad</B>
107Command-Line Switch:	<B>-pady</B>
108</pre>
109<UL>
110Specifies a padding distance for the childsite in the Y-direction in
111any of the forms acceptable to <B>Tk_GetPixels</B>.  The default is 10.
112</UL>
113<P>
114<pre>
115Name:                   <B>separator</B>
116Class:                  <B>Separator</B>
117Command-Line Switch:	<B>-separator</B>
118</pre>
119<UL>
120Specifies whether a line is drawn to separate the 
121buttons from the dialog box contents in any of the forms
122acceptable to <B>Tcl_GetBoolean</B>.  The default is true.
123</UL>
124<P>
125<pre>
126Name:                   <B>thickness</B>
127Class:                  <B>Thickness</B>
128Command-Line Switch:	<B>-thickness</B>
129</pre>
130<UL>
131Specifies the thickness of the separator in any of the forms acceptable
132to <B>Tk_GetPixels</B>.  The default is 3 pixels.
133</UL>
134</pre><HR>
135
136</pre><H2>DESCRIPTION</H2>
137<P>
138The <B>dialogshell</B> command creates a dialog shell which is a top 
139level widget composed of a button box, separator, and child site area.
140The class also has methods to control button construction.
141
142</pre><H2>METHODS</H2>
143<P>
144The <B>dialogshell</B> command create a new Tcl command whose
145name is <I>pathName</I>.  This command may be used to invoke various
146operations on the widget.  It has the following general form:
147<pre>
148<I>pathName option </I>?<I>arg arg ...</I>?
149</pre>
150<I>Option</I> and the <I>arg</I>s
151determine the exact behavior of the command.  The following
152commands are possible for dialogshell widgets:
153</pre><H2>INHERITED METHODS</H2>
154<P>
155<table cellpadding=5>
156<td valign=top>
157<B>activate</B><br>
158</td>
159<td valign=top>
160<B>center</B><br>
161</td>
162<td valign=top>
163<B>deactivate</B><br>
164</td>
165<td valign=top>
166</td>
167</table>
168<P>
169See the "shell" manual entry for details on the above inherited methods.
170</pre><H2>ASSOCIATED METHODS</H2>
171<P>
172<table cellpadding=5>
173<td valign=top>
174<B>add</B><br>
175<B>hide</B><br>
176<B>show</B><br>
177</td>
178<td valign=top>
179<B>buttonconfigure</B><br>
180<B>index</B><br>
181</td>
182<td valign=top>
183<B>default</B><br>
184<B>insert</B><br>
185</td>
186<td valign=top>
187<B>delete</B><br>
188<B>invoke</B><br>
189</td>
190</table>
191<P>
192See the <A HREF="buttonbox.n.html"> "buttonbox" </A> manual entry for details on the associated methods.
193</pre><H2>WIDGET-SPECIFIC METHODS</H2>
194<DL>
195<DT> <I>pathName <B>cget</B> <I>option</I>
196</I></B>
197<DD> Returns the current value of the configuration option given
198by <I>option</I>.
199<I>Option</I> may have any of the values accepted by the <B>dialogshell</B>
200command.
201</DL>
202<DL>
203<DT> <I>pathName <B>childsite</B>
204</I></B>
205<DD> Returns the pathname of the child site widget.
206</DL>
207<DL>
208<DT> <I>pathName</I> <B>configure</B> ?<I>option</I>? ?<I>value option value ...</I>?
209</I></B>
210<DD> Query or modify the configuration options of the widget.
211If no <I>option</I> is specified, returns a list describing all of
212the available options for <I>pathName</I> (see <B>Tk_ConfigureInfo</B> for
213information on the format of this list).  If <I>option</I> is specified
214with no <I>value</I>, then the command returns a list describing the
215one named option (this list will be identical to the corresponding
216sublist of the value returned if no <I>option</I> is specified).  If
217one or more <I>option-value</I> pairs are specified, then the command
218modifies the given widget option(s) to have the given value(s);  in
219this case the command returns an empty string.
220<I>Option</I> may have any of the values accepted by the <B>dialogshell</B>
221command.
222
223</DL>
224</pre><H2>COMPONENTS</H2>
225<P>
226<pre>
227Name:                   <B>dschildsite</B>
228Class:                  <B>frame</B>
229</pre>
230<UL>
231The dschildsite component is the user child site for the dialog shell.  See 
232the "frame" widget manual entry for details on the dschildsite component item.
233</UL>
234<P>
235<pre>
236Name:                   <B>separator</B>
237Class:                  <B>frame</B>
238</pre>
239<UL>
240The separator component devides the area between the user child site and
241the button box.  See the "frame" widget manual entry for details on the 
242separator component item.
243</UL>
244<P>
245<pre>
246Name:                   <B>bbox</B>
247Class:                  <B>ButtonBox</B>
248</pre>
249<UL>
250The bbox component is the button box containing the buttons for the dialog 
251shell.  See the "ButtonBox" widget manual entry for details on the 
252bbox component item.
253</UL>
254</table>
255
256</pre><H2>EXAMPLE</H2>
257<pre>
258 dialogshell .ds -modality none
259 
260 .ds add OK -text "OK" 
261 .ds add Cancel -text "Cancel"
262 .ds default OK
263 
264 .ds activate
265</pre>
266</pre><H2>AUTHOR</H2>
267Mark L. Ulferts
268</pre><H2>KEYWORDS</H2>
269dialogshell, dialog, shell, widget
270