File: //usr/local/ssl/local/share/man/man3/Tk::chooseDirectory.3
.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.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
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. | will give a
.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. nr % 0
. rr F
.\}
.\"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
.if n \{\
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
.if t \{\
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "chooseDirectory 3"
.TH chooseDirectory 3 "2010-04-26" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
chooseDirectory \- pops up a dialog box for the user to select a directory.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fI$widget\fR\->\fBchooseDirectory\fR( ?\fIoption value ...\fR? );
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The method \fBchooseDirectory\fR is implemented as a perl wrapper on the
core tk \*(L"command\*(R" \fBtk_chooseDirectory\fR, and \fI$widget\fR is passed as
the argument to the hidden \fB\-parent\fR option.
.PP
The \fBchooseDirectory\fR
method pops up a dialog box for the user to select a directory. The
following \fIoption-value\fR pairs are possible as command line
arguments:
.IP "\fB\-initialdir\fR \fIdirname\fR" 4
.IX Item "-initialdir dirname"
Specifies that the directories in \fIdirectory\fR should be displayed
when the dialog pops up. If this parameter is not specified, then
the directories in the current working directory are displayed. If the
parameter specifies a relative path, the return value will convert the
relative path to an absolute path. This option may not always work on
the Macintosh. This is not a bug. Rather, the \fIGeneral Controls\fR
control panel on the Mac allows the end user to override the
application default directory.
.ie n .IP "\fB\-parent\fR $widget" 4
.el .IP "\fB\-parent\fR \f(CW$widget\fR" 4
.IX Item "-parent $widget"
Makes \f(CW$widget\fR the logical parent of the dialog. The dialog
is displayed on top of its parent window.
.IP "\fB\-title\fR \fItitleString\fR" 4
.IX Item "-title titleString"
Specifies a string to display as the title of the dialog box. If this
option is not specified, then a default title will be displayed.
.IP "\fB\-mustexist\fR \fIboolean\fR" 4
.IX Item "-mustexist boolean"
Specifies whether the user may specify non-existant directories. If
this parameter is true, then the user may only select directories that
already exist. The default value is \fIfalse\fR.
.SH "CAVEATS"
.IX Header "CAVEATS"
Perl does not have a concept of encoded filesystems yet. This means
that operations on filenames like \f(CW\*(C`opendir\*(C'\fR and \f(CW\*(C`open\*(C'\fR still use
byte semantics. Tk however uses character semantics internally, which
means that you can get filenames with the \s-1UTF\-8\s0 flag set in functions
like \f(CW\*(C`chooseDirectory\*(C'\fR, \f(CW\*(C`getOpenFile\*(C'\fR and similar. It's the user's
responsibility to determine the encoding of the underlying filesystem
and convert the result into bytes, e.g.
.PP
.Vb 6
\& use Encode;
\& ...
\& my $dir = $mw->chooseDirectory;
\& $dir = encode("windows-1252", $dir);
\& opendir DIR, $dir or die $!;
\& ...
.Ve
.PP
See also \*(L"When Unicode Does Not Happen\*(R" in perlunicode and
\&\*(L"Unicode in Filenames\*(R" in perltodo.
.SH "EXAMPLE"
.IX Header "EXAMPLE"
.Vb 7
\& my $dir = $mw->chooseDirectory(-initialdir => '~',
\& -title => 'Choose a directory');
\& if (!defined $dir) {
\& warn 'No directory selected';
\& } else {
\& warn "Selected $dir";
\& }
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Tk::getOpenFile, Tk::getOpenFile
.SH "KEYWORDS"
.IX Header "KEYWORDS"
directory selection dialog