.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "DirTree 3"
.TH DirTree 3 2023-07-25 "perl v5.38.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Tk::DirTree \- Create and manipulate DirTree widgets
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\ \ \ \ \fBuse Tk::DirTree;\fR
.PP
\ \ \ \ \fR\f(CI$dirtree\fR\fI\fR = \fI\fR\f(CI$parent\fR\fI\fR\->\fBDirTree\fR(?\fIoptions\fR?);
.SH SUPER-CLASS
.IX Header "SUPER-CLASS"
The \fBDirTree\fR class is derived from the Tree class and inherits
all the methods, options and subwidgets of its super-class.
.SH "STANDARD OPTIONS"
.IX Header "STANDARD OPTIONS"
\&\fBTree\fR supports all the standard options of a Tree widget.  See
Tk::options for details on the standard options.
.SH "WIDGET-SPECIFIC OPTIONS"
.IX Header "WIDGET-SPECIFIC OPTIONS"
.IP "Name:		\fBbrowseCmd\fR" 4
.IX Item "Name: browseCmd"
.PD 0
.IP "Class:		\fBBrowseCmd\fR" 4
.IX Item "Class: BrowseCmd"
.IP "Switch:		\fB\-browsecmd\fR" 4
.IX Item "Switch: -browsecmd"
.PD
Specifies a callback to call whenever the user browses on a directory
(usually by single-clicking on the name of the directory). The callback
is called with one argument, the complete pathname of the directory.
.IP "Name:		\fBcommand\fR" 4
.IX Item "Name: command"
.PD 0
.IP "Class:		\fBCommand\fR" 4
.IX Item "Class: Command"
.IP "Switch:		\fB\-command\fR" 4
.IX Item "Switch: -command"
.PD
Specifies the callback to be called when the user activates on a directory
(usually by double-clicking on the name of the directory). The callback
is called with one argument, the complete pathname of the directory.
.IP "Name:		\fBdircmd\fR" 4
.IX Item "Name: dircmd"
.PD 0
.IP "Class:		\fBDirCmd\fR" 4
.IX Item "Class: DirCmd"
.IP "Switch:		\fB\-dircmd\fR" 4
.IX Item "Switch: -dircmd"
.PD
Specifies the callback to be called when a directory listing is needed
for a particular directory. If this option is not specified, by
default the DirTree widget will attempt to read the directory as a
Unix directory. On special occasions, the application programmer may
want to supply a special method for reading directories: for example,
when he needs to list remote directories. In this case, the \fB\-dircmd\fR
option can be used. The specified callback accepts two arguments: the
first is the name of the directory to be listed; the second is a
Boolean value indicating whether hidden sub-directories should be
listed. This callback returns a list of names of the sub-directories of
this directory. For example:
.Sp
.Vb 5
\&    sub read_dir {
\&        my( $dir, $showhidden ) = @_;
\&        return( qw/DOS NORTON WINDOWS/ ) if $dir eq "C:\e\e";
\&        return();
\&    }
.Ve
.IP "Name:		\fBshowHidden\fR" 4
.IX Item "Name: showHidden"
.PD 0
.IP "Class:		\fBShowHidden\fR" 4
.IX Item "Class: ShowHidden"
.IP "Switch:		\fB\-showhidden\fR" 4
.IX Item "Switch: -showhidden"
.PD
Specifies whether hidden directories should be shown. By default, a
directory name starting with a period "." is considered as a hidden
directory. This rule can be overridden by supplying an alternative
\&\fB\-dircmd\fR option.
.IP "Name:		\fBdirectory\fR" 4
.IX Item "Name: directory"
.PD 0
.IP "Class:		\fBDirectory\fR" 4
.IX Item "Class: Directory"
.IP "Switch:		\fB\-directory\fR" 4
.IX Item "Switch: -directory"
.IP "Alias:		\fB\-value\fR" 4
.IX Item "Alias: -value"
.PD
Specifies the name of the current directory to be displayed in the
DirTree widget.
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The \fBDirTree\fR constructor method creates a new window (given by the \f(CW$dirtree\fR
argument) and makes it into a DirTree widget.  Additional options,
described above, may be specified on the command line or in the
option database to configure aspects of the DirTree such as its
cursor and relief.  The DirTree widget displays a list view of a
directory, its previous directories and its sub-directories. The
user can choose one of the directories displayed in the list or
change to another directory.
.SH "WIDGET METHODS"
.IX Header "WIDGET METHODS"
The \fBDirTree\fR method creates a widget object.
This object supports the \fBconfigure\fR and \fBcget\fR methods
described in Tk::options which can be used to enquire and
modify the options described above.
The widget also inherits all the methods provided by the generic
Tk::Widget class.
.PP
The following additional methods are available for DirTree widgets:
.ie n .IP \fR\fI$dirtree\fR\fI\fR\->\fBchdir\fR(\fIdir\fR) 4
.el .IP \fR\f(CI$dirtree\fR\fI\fR\->\fBchdir\fR(\fIdir\fR) 4
.IX Item "$dirtree->chdir(dir)"
Change the current directory to \fIdir\fR.
.SH "OTHER METHODS"
.IX Header "OTHER METHODS"
These methods have to be documented or made private:
.IP OpenCmd 4
.IX Item "OpenCmd"
.PD 0
.IP Populate 4
.IX Item "Populate"
.IP add_to_tree 4
.IX Item "add_to_tree"
.IP dirnames 4
.IX Item "dirnames"
.IP fullpath 4
.IX Item "fullpath"
.IP has_subdir 4
.IX Item "has_subdir"
.IP opencmd 4
.IX Item "opencmd"
.IP set_dir 4
.IX Item "set_dir"
.PD
.SH BINDINGS
.IX Header "BINDINGS"
The mouse and keyboard bindings of the DirTree widget are the same as
the bindings of the Tree widget.
.SH KEYWORDS
.IX Header "KEYWORDS"
directory, tree, tix
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Tk::Tree
Tk::HList
.SH AUTHOR
.IX Header "AUTHOR"
Perl/TK version by Chris Dean <ctdean@cogit.com>.  Original Tcl/Tix
version by Ioi Kim Lam.