summaryrefslogtreecommitdiff
path: root/itcl/iwidgets3.0.0/demos/html/fileselectiondialog.n.html
blob: aeea455cd31ae44c9550b38d32ecdcf90d1595e2 (plain)
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
<HTML>
<HEAD>
<TITLE>iwidgets2.2.0 User Commands - fileselectiondialog</TITLE>
</HEAD>
<BODY BGCOLOR="#FFFFFF">
<H1>iwidgets2.2.0 User Commands - fileselectiondialog</H1>
<HR>
<PRE>

</PRE>
<H2><HR ALIGN=LEFT WIDTH=70% SIZE=3></H2><PRE>


</PRE>
<H2>NAME</H2><PRE>
     fileselectiondialog - Create and manipulate a file selection
     dialog widget


</PRE>
<H2>SYNOPSIS</H2><PRE>
     <STRONG>fileselectiondialog</STRONG> <EM>pathName</EM> ?<EM>options</EM>?


</PRE>
<H2>INHERITANCE</H2><PRE>
     itk::Toplevel  &lt;-  Shell  &lt;-  Dialogshell   &lt;-   Dialog   &lt;-
     Fileselectiondialog


</PRE>
<H2>STANDARD OPTIONS</H2><PRE>
     <STRONG>activeBackground</STRONG>               <STRONG>background</STRONG>      <STRONG>borderWidthcursor</STRONG>
     <STRONG>foreground</STRONG>      <STRONG>highlightColor</STRONG> <STRONG>highlightThicknessinsertBackground</STRONG>
     <STRONG>insertBorderWidth</STRONG>              <STRONG>insertOffTime</STRONG>   <STRONG>insertOnTimeinsertWidth</STRONG>
     <STRONG>relief</STRONG>          <STRONG>repeatDelay</STRONG>    <STRONG>repeatInterval</STRONG>  <STRONG>selectBackground</STRONG>
     <STRONG>selectBorderWidth</STRONG>              <STRONG>selectForeground</STRONG>

     See the "options" manual entry for details on  the  standard
     options.


</PRE>
<H2>ASSOCIATED OPTIONS</H2><PRE>
     <STRONG>textBackground</STRONG>  <STRONG>textFont</STRONG>

     See the "entryfield" widget manual entry for details on  the
     above associated options.

     <STRONG>childSitePos</STRONG>    <STRONG>directory</STRONG>      <STRONG>dirsLabel</STRONG>       <STRONG>dirSearchCommand</STRONG>
     <STRONG>dirsFraction</STRONG>    <STRONG>dirsLabelPos</STRONG>   <STRONG>dirsOn</STRONG>          <STRONG>filesLabel</STRONG>
     <STRONG>filesLabelOn</STRONG>    <STRONG>fileSearchCommand</STRONG>              <STRONG>filesLabelPosfilesOn</STRONG>
     <STRONG>fileType</STRONG>        <STRONG>filterLabel</STRONG>    <STRONG>filterLabelPos</STRONG>  <STRONG>filterOn</STRONG>
     <STRONG>invalid</STRONG>         <STRONG>mask</STRONG>           <STRONG>noMatchString</STRONG>   <STRONG>selectionCommand</STRONG>
     <STRONG>selectionLabel</STRONG>  <STRONG>selectionLabelPos</STRONG>              <STRONG>selectionOnstyle</STRONG>
     <STRONG>vertMargin</STRONG>

     See the "fileselectionbox" widget manual entry  for  details
     on the above associated options.

     <STRONG>labelFont</STRONG>       <STRONG>labelMargin</STRONG>

     See the "labeledwidget" widget manual entry for  details  on
     the above associated options.

     <STRONG>horizMargin</STRONG>     <STRONG>hscrollMode</STRONG>    <STRONG>sbWidth</STRONG>         <STRONG>scrollMargin</STRONG>
     <STRONG>textBackground</STRONG>  <STRONG>textFont</STRONG>       <STRONG>vScrollMode</STRONG>

     See the "scrolledlistbox" widget manual entry for details on
     the above associated options.


     <STRONG>activeRelief</STRONG>    <STRONG>elementBorderWidth</STRONG>             <STRONG>jumptroughColor</STRONG>

     See the "scrollbar" widget class manual entry for details on
     the above associated options.



</PRE>
<H2>INHERITED OPTIONS</H2><PRE>
     <STRONG>buttonBoxPadX</STRONG>   <STRONG>buttonBoxPadY</STRONG>  <STRONG>buttonBoxPos</STRONG>    <STRONG>padX</STRONG>
     <STRONG>padY</STRONG>            <STRONG>separator</STRONG>      <STRONG>thickness</STRONG>

     See the "dialogshell" widget manual entry for details on the
     above inherited options.

     <STRONG>master</STRONG>          <STRONG>modality</STRONG>       <STRONG>title</STRONG>

     See the "shell" widget manual entry for details on the above
     inherited options.


</PRE>
<H2>WIDGET-SPECIFIC OPTIONS</H2><PRE>
     Name:           <STRONG>height</STRONG>
     Class:          <STRONG>Height</STRONG>
     Command-Line Switch:           <STRONG>-height</STRONG>

          Specifies the height of the file selection dialog.  The
          value  may  be specified in any of the forms acceptable
          to Tk_GetPixels.  The default is 435 pixels.

     Name:           <STRONG>width</STRONG>
     Class:          <STRONG>Width</STRONG>
     Command-Line Switch:           <STRONG>-width</STRONG>

          Specifies the width of the file selection dialog.   The
          value  may  be specified in any of the forms acceptable
          to Tk_GetPixels.  The default is 450 pixels.


</PRE>
<H2><HR ALIGN=LEFT WIDTH=70% SIZE=3></H2><PRE>



</PRE>
<H2>DESCRIPTION</H2><PRE>
     The <STRONG>fileselectiondialog</STRONG> command  creates  a  file  selection
     dialog  similar  to the OSF/Motif standard composite widget.
     The fileselectiondialog is derived from the Dialog class and
     is  composed  of  a  FileSelectionBox with attributes set to
     manipulate the dialog buttons.



</PRE>
<H2>METHODS</H2><PRE>
     The <STRONG>fileselectiondialog</STRONG> command creates a  new  Tcl  command
     whose  name is <EM>pathName</EM>.  This command may be used to invoke
     various operations on the widget.  It has the following gen-
     eral form:

          <EM>pathName</EM> <EM>option</EM> ?<EM>arg</EM> <EM>arg</EM> ...?

     <EM>Option</EM> and the <EM>arg</EM>s determine the exact behavior of the com-
     mand.   The  following  commands are possible for fileselec-
     tiondialog widgets:


</PRE>
<H2>ASSOCIATED METHODS</H2><PRE>
     <STRONG>get</STRONG>             <STRONG>childsite</STRONG>      <STRONG>filter</STRONG>

     See the "fileselectionbox" class manual entry for details on
     the associated methods.


</PRE>
<H2>INHERITED METHODS</H2><PRE>
     <STRONG>add</STRONG>             <STRONG>buttonconfigure</STRONG>                <STRONG>defaulthide</STRONG>
     <STRONG>insert</STRONG>          <STRONG>invoke</STRONG>         <STRONG>show</STRONG>

     See the "buttonbox" widget manual entry for details  on  the
     above inherited methods.

     <STRONG>activate</STRONG>        <STRONG>center</STRONG>         <STRONG>deactivate</STRONG>

     See the "shell" widget manual entry for details on the above
     inherited methods.



</PRE>
<H2>WIDGET-SPECIFIC METHODS</H2><PRE>
     <EM>pathName</EM> <STRONG>cget</STRONG> <EM>option</EM>
          Returns the current value of the  configuration  option
          given  by  <EM>option</EM>.   <EM>Option</EM>  may have any of the values
          accepted by the <STRONG>fileselectiondialog</STRONG> command.

     <EM>pathName</EM> <STRONG>configure</STRONG> ?<EM>option</EM>? ?<EM>value</EM> <EM>option</EM> <EM>value</EM> ...?
          Query  or  modify  the  configuration  options  of  the
          widget.   If  no  <EM>option</EM>  is  specified, returns a list
          describing all of the available  options  for  <EM>pathName</EM>
          (see  <STRONG>Tk_ConfigureInfo</STRONG> for information on the format of
          this list).  If <EM>option</EM> is specified with no <EM>value</EM>, then
          the  command  returns  a  list describing the one named
          option (this list will be identical to the  correspond-
          ing  sublist  of  the  value  returned  if no <EM>option</EM> is
          specified).  If one or more  <EM>option</EM> - <EM>value</EM>  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.  <EM>Option</EM> may have any
          of the values accepted by the <STRONG>fileselectiondialog</STRONG>  com-
          mand.



</PRE>
<H2>COMPONENTS</H2><PRE>
     Name:           <STRONG>fsb</STRONG>
     Class:          <STRONG>Fileselectionbox</STRONG>

          The fsb component is the file  selection  box  for  the
          file  selection  dialog.   See  the  "fileselectionbox"
          widget manual entry for details on  the  fsb  component
          item.



</PRE>
<H2>EXAMPLE</H2><PRE>
           option add *textBackground white

           fileselectiondialog .fsd
           .fsd activate



</PRE>
<H2>AUTHOR</H2><PRE>
     Mark L. Ulferts


</PRE>
<H2>KEYWORDS</H2><PRE>
     fileselectiondialog, fileselectionbox, dialog,  dialogshell,
     shell, widget

































</PRE>
</BODY>
</HTML>