Commit | Line | Data |
---|---|---|
86530b38 AT |
1 | .\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13 |
2 | .\" | |
3 | .\" Standard preamble: | |
4 | .\" ======================================================================== | |
5 | .de Sh \" Subsection heading | |
6 | .br | |
7 | .if t .Sp | |
8 | .ne 5 | |
9 | .PP | |
10 | \fB\\$1\fR | |
11 | .PP | |
12 | .. | |
13 | .de Sp \" Vertical space (when we can't use .PP) | |
14 | .if t .sp .5v | |
15 | .if n .sp | |
16 | .. | |
17 | .de Vb \" Begin verbatim text | |
18 | .ft CW | |
19 | .nf | |
20 | .ne \\$1 | |
21 | .. | |
22 | .de Ve \" End verbatim text | |
23 | .ft R | |
24 | .fi | |
25 | .. | |
26 | .\" Set up some character translations and predefined strings. \*(-- will | |
27 | .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left | |
28 | .\" double quote, and \*(R" will give a right double quote. | will give a | |
29 | .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to | |
30 | .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' | |
31 | .\" expand to `' in nroff, nothing in troff, for use with C<>. | |
32 | .tr \(*W-|\(bv\*(Tr | |
33 | .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' | |
34 | .ie n \{\ | |
35 | . ds -- \(*W- | |
36 | . ds PI pi | |
37 | . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch | |
38 | . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch | |
39 | . ds L" "" | |
40 | . ds R" "" | |
41 | . ds C` "" | |
42 | . ds C' "" | |
43 | 'br\} | |
44 | .el\{\ | |
45 | . ds -- \|\(em\| | |
46 | . ds PI \(*p | |
47 | . ds L" `` | |
48 | . ds R" '' | |
49 | 'br\} | |
50 | .\" | |
51 | .\" If the F register is turned on, we'll generate index entries on stderr for | |
52 | .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index | |
53 | .\" entries marked with X<> in POD. Of course, you'll have to process the | |
54 | .\" output yourself in some meaningful fashion. | |
55 | .if \nF \{\ | |
56 | . de IX | |
57 | . tm Index:\\$1\t\\n%\t"\\$2" | |
58 | .. | |
59 | . nr % 0 | |
60 | . rr F | |
61 | .\} | |
62 | .\" | |
63 | .\" For nroff, turn off justification. Always turn off hyphenation; it makes | |
64 | .\" way too many mistakes in technical documents. | |
65 | .hy 0 | |
66 | .if n .na | |
67 | .\" | |
68 | .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). | |
69 | .\" Fear. Run. Save yourself. No user-serviceable parts. | |
70 | . \" fudge factors for nroff and troff | |
71 | .if n \{\ | |
72 | . ds #H 0 | |
73 | . ds #V .8m | |
74 | . ds #F .3m | |
75 | . ds #[ \f1 | |
76 | . ds #] \fP | |
77 | .\} | |
78 | .if t \{\ | |
79 | . ds #H ((1u-(\\\\n(.fu%2u))*.13m) | |
80 | . ds #V .6m | |
81 | . ds #F 0 | |
82 | . ds #[ \& | |
83 | . ds #] \& | |
84 | .\} | |
85 | . \" simple accents for nroff and troff | |
86 | .if n \{\ | |
87 | . ds ' \& | |
88 | . ds ` \& | |
89 | . ds ^ \& | |
90 | . ds , \& | |
91 | . ds ~ ~ | |
92 | . ds / | |
93 | .\} | |
94 | .if t \{\ | |
95 | . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" | |
96 | . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' | |
97 | . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' | |
98 | . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' | |
99 | . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' | |
100 | . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' | |
101 | .\} | |
102 | . \" troff and (daisy-wheel) nroff accents | |
103 | .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' | |
104 | .ds 8 \h'\*(#H'\(*b\h'-\*(#H' | |
105 | .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] | |
106 | .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' | |
107 | .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' | |
108 | .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] | |
109 | .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] | |
110 | .ds ae a\h'-(\w'a'u*4/10)'e | |
111 | .ds Ae A\h'-(\w'A'u*4/10)'E | |
112 | . \" corrections for vroff | |
113 | .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' | |
114 | .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' | |
115 | . \" for low resolution devices (crt and lpr) | |
116 | .if \n(.H>23 .if \n(.V>19 \ | |
117 | \{\ | |
118 | . ds : e | |
119 | . ds 8 ss | |
120 | . ds o a | |
121 | . ds d- d\h'-1'\(ga | |
122 | . ds D- D\h'-1'\(hy | |
123 | . ds th \o'bp' | |
124 | . ds Th \o'LP' | |
125 | . ds ae ae | |
126 | . ds Ae AE | |
127 | .\} | |
128 | .rm #[ #] #H #V #F C | |
129 | .\" ======================================================================== | |
130 | .\" | |
131 | .IX Title "FILESELECT 1" | |
132 | .TH FILESELECT 1 "2000-12-30" "perl v5.8.0" "User Contributed Perl Documentation" | |
133 | .SH "NAME" | |
134 | Tk::FileSelect \- a widget for choosing files | |
135 | .SH "SYNOPSIS" | |
136 | .IX Header "SYNOPSIS" | |
137 | .Vb 1 | |
138 | \& use Tk::FileSelect; | |
139 | .Ve | |
140 | .PP | |
141 | .Vb 11 | |
142 | \& $FSref = $top->FileSelect(-directory => $start_dir); | |
143 | \& $top - a window reference, e.g. MainWindow->new | |
144 | \& $start_dir - the starting point for the FileSelect | |
145 | \& $file = $FSref->Show; | |
146 | \& Executes the fileselector until either a filename is | |
147 | \& accepted or the user hits Cancel. Returns the filename | |
148 | \& or the empty string, respectively, and unmaps the | |
149 | \& FileSelect. | |
150 | \& $FSref->configure(option => value[, ...]) | |
151 | \& Please see the Populate subroutine as the configuration | |
152 | \& list changes rapidly. | |
153 | .Ve | |
154 | .SH "DESCRIPTION" | |
155 | .IX Header "DESCRIPTION" | |
156 | This Module pops up a Fileselector box, with a directory entry on | |
157 | top, a list of directories in the current directory, a list of | |
158 | files in the current directory, an entry for entering/modifying a | |
159 | file name, an accept button and a cancel button. | |
160 | .PP | |
161 | You can enter a starting directory in the directory entry. After | |
162 | hitting Return, the listboxes get updated. Double clicking on any | |
163 | directory shows you the respective contents. Single clicking on a | |
164 | file brings it into the file entry for further consideration, | |
165 | double clocking on a file pops down the file selector and calls | |
166 | the optional command with the complete path for the selected file. | |
167 | Hitting return in the file selector box or pressing the accept | |
168 | button will also work. *NOTE* the file selector box will only then | |
169 | get destroyed if the file name is not zero length. If you want | |
170 | yourself take care of it, change the if(length(.. in sub | |
171 | accept_file. | |
172 | .SH "AUTHORS" | |
173 | .IX Header "AUTHORS" | |
174 | Based on original FileSelect by | |
175 | Klaus Lichtenwalder, Lichtenwalder@ACM.org, Datapat GmbH, Munich, | |
176 | April 22, 1995 adapted by | |
177 | Frederick L. Wagner, derf@ti.com, Texas Instruments Incorporated, Dallas, | |
178 | 21Jun95 | |
179 | .SH "HISTORY" | |
180 | .IX Header "HISTORY" | |
181 | .Sh "950621 \*(-- The following changes were made:" | |
182 | .IX Subsection "950621 The following changes were made:" | |
183 | .IP "\(bu" 4 | |
184 | Rewrote Tk stuff to take advantage of new Compound widget module, so | |
185 | FileSelect is now composed of 2 LabEntry and 2 ScrlListbox2 | |
186 | subwidgets. | |
187 | .IP "\(bu" 4 | |
188 | Moved entry labels (from to the left of) to above the entry fields. | |
189 | .IP "\(bu" 4 | |
190 | Caller is now able to control these aspects of widget, in both | |
191 | FileSelect (new) and configure : | |
192 | .Sp | |
193 | (Please see subroutine Populate for details, as these options | |
194 | change rapidly!) | |
195 | .IP "\(bu" 4 | |
196 | I changed from Double\-Button\-1 to Button\-1 in the Files listbox, | |
197 | to work with multiple mode in addition to browse mode. I also | |
198 | made some name changes (LastPath \-\-> saved_path, ...). | |
199 | .IP "\(bu" 4 | |
200 | The show method is not yet updated. | |
201 | .IP "\(bu" 4 | |
202 | The topLevel stuff is not done yet. I took it out while I toy with | |
203 | the idea of FileSelect as a subwidget. Then the 'normal' topLevel | |
204 | thing with Buttons along the bottom could be build on top of it. | |
205 | .IP "\(bu" 4 | |
206 | By request of Henry Katz <katz@fs09.webo.dg.com>, I added the functionality | |
207 | of using the Directory entry as a filter. So, if you want to only see the | |
208 | *.c files, you add a .c (the *'s already there :) and hit return. | |
209 | .Sh "95/10/17, \s-1SOL\s0, \s-1LUCC\s0. lusol@Lehigh.EDU" | |
210 | .IX Subsection "95/10/17, SOL, LUCC. lusol@Lehigh.EDU" | |
211 | .IP "\(bu" 4 | |
212 | .Vb 1 | |
213 | \& Allow either file or directory names to be accepted. | |
214 | .Ve | |
215 | .IP "\(bu" 4 | |
216 | Require double click to move into a new directory rather than a single | |
217 | click. This allows a single click to select a directory name so it can | |
218 | be accepted. | |
219 | .IP "\(bu" 4 | |
220 | Add \-verify list option so that standard Perl file test operators (like | |
221 | \&\-d and \-x) can be specified for further name validation. The default | |
222 | value is the special value '!\-d' (not a directory), so any name can be | |
223 | selected as long as it's not a directory \- after all, this \s-1IS\s0 FileSelect! | |
224 | .Sp | |
225 | For example: | |
226 | .Sp | |
227 | .Vb 1 | |
228 | \& $fs->configure(-verify => ['-d', [\e&verify_code, $P1, $P2, ... $Pn]]); | |
229 | .Ve | |
230 | .Sp | |
231 | ensures that the selected name is a directory. Further, if an element of | |
232 | the list is an array reference, the first element is a code reference to a | |
233 | subroutine and the remaining optional elements are it's parameters. The | |
234 | subroutine is called like this: | |
235 | .Sp | |
236 | .Vb 1 | |
237 | \& &verify_code($cd, $leaf, $P1, $P2, ... $Pn); | |
238 | .Ve | |
239 | .Sp | |
240 | where \f(CW$cd\fR is the current directory, \f(CW$leaf\fR is a directory or file name, and | |
241 | \&\f(CW$P1\fR .. \f(CW$Pn\fR are your optional parameters. The subroutine should return \s-1TRUE\s0 | |
242 | if success or \s-1FALSE\s0 if failure. | |
243 | .Sh "961008 \*(-- derf@ti.com :" | |
244 | .IX Subsection "961008 derf@ti.com :" | |
245 | By request of Jim Stern <js@world.northgrum.com> and Brad Vance | |
246 | <bvance@ti.com>, I updated the Accept and Show functions to support | |
247 | selection of multiple files. I also corrected a typo in the \-verify code. |