tk::dirselect(3pm) [debian man page]
Tk::DirSelect(3pm) User Contributed Perl Documentation Tk::DirSelect(3pm) NAME
Tk::DirSelect - Cross-platform directory selection widget. SYNOPSIS
use Tk::DirSelect; my $ds = $mw->DirSelect(); my $dir = $ds->Show(); DESCRIPTION
This module provides a cross-platform directory selection widget. For systems running Microsoft Windows, this includes selection of local and mapped network drives. A context menu (right-click or <Button3>) allows the creation, renaming, and deletion of directories while browsing. Note: Perl/Tk 804 added the "chooseDirectory" method which uses native system dialogs where available. (i.e. Windows) If you want a native feel for your program, you probably want to use that method instead -- possibly using this module as a fallback for systems with older versions of Tk installed. METHODS
"DirSelect([-title => 'title'], [options])" Constructs a new DirSelect widget as a child of the invoking object (usually a MainWindow). The title for the widget can be set by specifying "-title => 'Title'". Any other options provided will be passed through to the DirTree widget that displays directories, so be sure they're appropriate (e.g. "-width") "Show([directory], [options])" Displays the DirSelect widget and returns the user selected directory or "undef" if the operation is canceled. All arguments are optional. The first argument (if defined) is the initial directory to display. The default is to display the current working directory. Any additional options are passed through to the Popup() method. This means that you can do something like $ds->Show(undef, -popover => $mw); to center the dialog over your application. DEPENDENCIES
o Perl 5.004 o Tk 800 o Win32API::File (under Microsoft Windows only) LICENSE AND COPYRIGHT
Copyright 2000-2001 Kristi Thompson <kristi@kristi.ca> Copyright 2002-2005,2010 Michael Carman <mjcarman@cpan.org> This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License. See http://dev.perl.org/licenses/ for more information. perl v5.10.1 2010-02-18 Tk::DirSelect(3pm)
Check Out this Related Man Page
DirTree(3pm) User Contributed Perl Documentation DirTree(3pm) 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 methods, options and subwidgets of its super-class. STANDARD OPTIONS
Tree supports all the standard options of a Tree widget. See Tk::options for details on the standard options. WIDGET-SPECIFIC OPTIONS Name: browseCmd Class: BrowseCmd Switch: -browsecmd 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. Name: command Class: Command Switch: -command 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. Name: dircmd Class: DirCmd Switch: -dircmd 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 -dircmd 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: 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 constructor method creates a new window (given by the $dirtree 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 METHODS
The DirTree method creates a widget object. This object supports the configure and cget 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. The following additional methods are available for DirTree widgets: $dirtree->chdir(dir) Change the current directory to dir. OTHER METHODS
These methods have to be documented or made private: OpenCmd Populate add_to_tree dirnames fullpath has_subdir opencmd set_dir BINDINGS
The mouse and keyboard bindings of the DirTree widget are the same as the bindings of the Tree widget. KEYWORDS
directory, tree, tix SEE ALSO
Tk::Tree Tk::HList AUTHOR
Perl/TK version by Chris Dean <ctdean@cogit.com>. Original Tcl/Tix version by Ioi Kim Lam. perl v5.14.2 2010-05-29 DirTree(3pm)