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 "DIRTREE 1" | |
132 | .TH DIRTREE 1 "2000-12-30" "perl v5.8.0" "User Contributed Perl Documentation" | |
133 | .SH "NAME" | |
134 | Tk::DirTree \- Create and manipulate DirTree widgets | |
135 | .SH "SYNOPSIS" | |
136 | .IX Header "SYNOPSIS" | |
137 | \&\ \fBuse Tk::DirTree;\fR | |
138 | .PP | |
139 | \&\ \fI$dirtree\fR = \fI$parent\fR\->\fBDirTree\fR(?\fIoptions\fR?); | |
140 | .SH "SUPER-CLASS" | |
141 | .IX Header "SUPER-CLASS" | |
142 | The \fBDirTree\fR class is derived from the Tree class and inherits | |
143 | all the methods, options and subwidgets of its super\-class. | |
144 | .SH "STANDARD OPTIONS" | |
145 | .IX Header "STANDARD OPTIONS" | |
146 | \&\fBTree\fR supports all the standard options of a Tree widget. See | |
147 | Tk::options for details on the standard options. | |
148 | .SH "WIDGET-SPECIFIC OPTIONS" | |
149 | .IX Header "WIDGET-SPECIFIC OPTIONS" | |
150 | .IP "Name: \fBbrowseCmd\fR" 4 | |
151 | .IX Item "Name: browseCmd" | |
152 | .PD 0 | |
153 | .IP "Class: \fBBrowseCmd\fR" 4 | |
154 | .IX Item "Class: BrowseCmd" | |
155 | .IP "Switch: \fB\-browsecmd\fR" 4 | |
156 | .IX Item "Switch: -browsecmd" | |
157 | .PD | |
158 | Specifies a callback to call whenever the user browses on a directory | |
159 | (usually by single-clicking on the name of the directory). The callback | |
160 | is called with one argument, the complete pathname of the directory. | |
161 | .IP "Name: \fBcommand\fR" 4 | |
162 | .IX Item "Name: command" | |
163 | .PD 0 | |
164 | .IP "Class: \fBCommand\fR" 4 | |
165 | .IX Item "Class: Command" | |
166 | .IP "Switch: \fB\-command\fR" 4 | |
167 | .IX Item "Switch: -command" | |
168 | .PD | |
169 | Specifies the callback to be called when the user activates on a directory | |
170 | (usually by double-clicking on the name of the directory). The callback | |
171 | is called with one argument, the complete pathname of the directory. | |
172 | .IP "Name: \fBdircmd\fR" 4 | |
173 | .IX Item "Name: dircmd" | |
174 | .PD 0 | |
175 | .IP "Class: \fBDirCmd\fR" 4 | |
176 | .IX Item "Class: DirCmd" | |
177 | .IP "Switch: \fB\-dircmd\fR" 4 | |
178 | .IX Item "Switch: -dircmd" | |
179 | .PD | |
180 | Specifies the callback to be called when a directory listing is needed | |
181 | for a particular directory. If this option is not specified, by | |
182 | default the DirTree widget will attempt to read the directory as a | |
183 | Unix directory. On special occasions, the application programmer may | |
184 | want to supply a special method for reading directories: for example, | |
185 | when he needs to list remote directories. In this case, the \fB\-dircmd\fR | |
186 | option can be used. The specified callback accepts two arguments: the | |
187 | first is the name of the directory to be listed; the second is a | |
188 | Boolean value indicating whether hidden sub-directories should be | |
189 | listed. This callback returns a list of names of the sub-directories of | |
190 | this directory. For example: | |
191 | .Sp | |
192 | .Vb 5 | |
193 | \& sub read_dir { | |
194 | \& my( $dir, $showhidden ) = @_; | |
195 | \& return( qw/DOS NORTON WINDOWS/ ) if $dir eq "C:\e\e"; | |
196 | \& return(); | |
197 | \& } | |
198 | .Ve | |
199 | .IP "Name: \fBshowHidden\fR" 4 | |
200 | .IX Item "Name: showHidden" | |
201 | .PD 0 | |
202 | .IP "Class: \fBShowHidden\fR" 4 | |
203 | .IX Item "Class: ShowHidden" | |
204 | .IP "Switch: \fB\-showhidden\fR" 4 | |
205 | .IX Item "Switch: -showhidden" | |
206 | .PD | |
207 | Specifies whether hidden directories should be shown. By default, a | |
208 | directory name starting with a period \*(L".\*(R" is considered as a hidden | |
209 | directory. This rule can be overridden by supplying an alternative | |
210 | \&\fB\-dircmd\fR option. | |
211 | .IP "Name: \fBdirectory\fR" 4 | |
212 | .IX Item "Name: directory" | |
213 | .PD 0 | |
214 | .IP "Class: \fBDirectory\fR" 4 | |
215 | .IX Item "Class: Directory" | |
216 | .IP "Switch: \fB\-directory\fR" 4 | |
217 | .IX Item "Switch: -directory" | |
218 | .IP "Alias: \fB\-value\fR" 4 | |
219 | .IX Item "Alias: -value" | |
220 | .PD | |
221 | Specifies the name of the current directory to be displayed in the | |
222 | DirTree widget. | |
223 | .SH "DESCRIPTION" | |
224 | .IX Header "DESCRIPTION" | |
225 | The \fBDirTree\fR constructor method creates a new window (given by the \f(CW$dirtree\fR | |
226 | argument) and makes it into a DirTree widget. Additional options, | |
227 | described above, may be specified on the command line or in the | |
228 | option database to configure aspects of the DirTree such as its | |
229 | cursor and relief. The DirTree widget displays a list view of a | |
230 | directory, its previous directories and its sub\-directories. The | |
231 | user can choose one of the directories displayed in the list or | |
232 | change to another directory. | |
233 | .SH "WIDGET METHODS" | |
234 | .IX Header "WIDGET METHODS" | |
235 | The \fBDirTree\fR method creates a widget object. | |
236 | This object supports the \fBconfigure\fR and \fBcget\fR methods | |
237 | described in Tk::options which can be used to enquire and | |
238 | modify the options described above. | |
239 | The widget also inherits all the methods provided by the generic | |
240 | Tk::Widget class. | |
241 | .PP | |
242 | The following additional methods are available for DirTree widgets: | |
243 | .IP "\fI$dirtree\fR\->\fBchdir\fR(\fIdir\fR)" 4 | |
244 | .IX Item "$dirtree->chdir(dir)" | |
245 | Change the current directory to \fIdir\fR. | |
246 | .SH "BINDINGS" | |
247 | .IX Header "BINDINGS" | |
248 | The mouse and keyboard bindings of the DirTree widget are the same as | |
249 | the bindings of the Tree widget. | |
250 | .SH "KEYWORDS" | |
251 | .IX Header "KEYWORDS" | |
252 | directory, tree, tix | |
253 | .SH "SEE ALSO" | |
254 | .IX Header "SEE ALSO" | |
255 | Tk::Tree | |
256 | Tk::HList | |
257 | .SH "AUTHOR" | |
258 | .IX Header "AUTHOR" | |
259 | Perl/TK version by Chris Dean <ctdean@cogit.com>. Original Tcl/Tix | |
260 | version by Ioi Kim Lam. |