NAME

Tk::DirTree - Create and manipulate DirTree widgets

SYNOPSIS

    use Tk::DirTree;

    $dirtree = $parent->DirTree(?options?);

SUPER-CLASS

The DirTree class is derived from the Tree class and inherits all the commands, options and subwidgets of its super-class.

STANDARD OPTIONS

Tree supports all the standard options of a Tree widget. See options for details on the standard options.

WIDGET-SPECIFIC OPTIONS

Name: browseCmd

Class: BrowseCmd

Switch: -browsecmd

Specifies a command to call whenever the user browses on a directory (usually by single-clicking on the name of the directory). The command is called with one argument, the complete pathname of the directory.

Name: command

Class: Command

Switch: -command

Specifies the command to be called when the user activates on a directory (usually by double-clicking on the name of the directory). The command is called with one argument, the complete pathname of the directory.

Name: dircmd

Class: DirCmd

Switch: -dircmd

Specifies the command 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 -dircmd option can be used. The specified command 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 command returns a list of names of the sub-directories of this directory. For example:

    sub read_dir {
        my( $dir, $showhidden ) = @_;
        return( qw/DOS NORTON WINDOWS/ ) if $dir eq "C:\\";
        return();
    }

Name: showHidden

Class: ShowHidden

Switch: -showhidden

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 -dircmd option.

Name: directory

Class: Directory

Switch: -directory

Alias: -value

Specifies the name of the current directory to be displayed in the DirTree widget.

DESCRIPTION

The DirTree command creates a new window (given by the $widget 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.

WIDGET COMMANDS

The DirTree command creates a widget object whose name is the same as the path name of the DirTree's window. This command may be used to invoke various operations on the widget. It has the following general form:

 I<$widget>-E<gt>B<method>(?I<arg arg ...>?)

PathName is the name of the command, which is the same as the DirTree widget's path name. Option and the args determine the exact behavior of the command. The following commands are possible for DirTree widgets:

$widget->cget(option)

Returns the current value of the configuration option given by option. Option may have any of the values accepted by the DirTree command.

$widget->chdir(dir)

Change the current directory to dir.

$widget->configure(?option?, ?value, option, value, ...?)

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

BINDINGS

The mouse and keyboard bindings of the DirTree widget are the same as the bindings of the Tree widget.

KEYWORDS

Tix(n)

SEE ALSO

Tk::HList, Tk::Tree, Tix(n)

AUTHOR

Perl/TK version by Chris Dean <ctdean@cogit.com>. Original Tcl/Tix version by Ioi Kim Lam.