File: //usr/local/ssl/local/share/man/man3/Curses::UI::Dialog::Filebrowser.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 "Curses::UI::Dialog::Filebrowser 3"
.TH Curses::UI::Dialog::Filebrowser 3 "2011-08-31" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
Curses::UI::Dialog::Filebrowser \- Create and manipulate filebrowser dialogs
.SH "CLASS HIERARCHY"
.IX Header "CLASS HIERARCHY"
.Vb 7
\& Curses::UI::Widget
\& |
\& +----Curses::UI::Container
\& |
\& +----Curses::UI::Window
\& |
\& +----Curses::UI::Dialog::Filebrowser
.Ve
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\& use Curses::UI;
\& my $cui = new Curses::UI;
\& my $win = $cui->add('window_id', 'Window');
.Ve
.PP
.Vb 8
\& # The hard way.
\& # -------------
\& my $dialog = $win->add(
\& 'mydialog', 'Dialog::Filebrowser'
\& );
\& $dialog->focus;
\& my $file = $dialog->get();
\& $win->delete('mydialog');
.Ve
.PP
.Vb 5
\& # The easy way (see Curses::UI documentation).
\& # --------------------------------------------
\& $file = $cui->filebrowser();
\& $file = $cui->loadfilebrowser();
\& $file = $cui->savefilebrowser();
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Curses::UI::Dialog::Filebrowser is a filebrowser dialog.
This type of dialog can be used to select a file, anywhere
on the filesystem.
.PP
See exampes/demo\-Curses::UI::Dialog::Filebrowser in the
distribution for a short demo.
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "* \fB\-title\fR < \s-1TEXT\s0 >" 4
.IX Item "-title < TEXT >"
Set the title of the dialog window to \s-1TEXT\s0.
.IP "* \fB\-path\fR < \s-1PATH\s0 >" 4
.IX Item "-path < PATH >"
Set the path to start with to \s-1PATH\s0. If this path
does not exist, the filebrowser will start in the
rootdirectory.
.IP "* \fB\-file\fR < \s-1FILE\s0 >" 4
.IX Item "-file < FILE >"
Set the filename to start with to \s-1FILE\s0.
.IP "* \fB\-editfilename\fR < \s-1BOOLEAN\s0 >" 4
.IX Item "-editfilename < BOOLEAN >"
If \s-1BOOLEAN\s0 has a true value, the user may edit
the filename. This is for example useful for a
filebrowser that is used to select a filename to
save to. By default this option is set to false.
.IP "* \fB\-show_hidden\fR < \s-1BOOLEAN\s0 >" 4
.IX Item "-show_hidden < BOOLEAN >"
If \s-1BOOLEAN\s0 has a true value, hidden files (the filename
starts with a dot) will also be shown. By default this
option is set to false.
.IP "* \fB\-mask\fR < \s-1ARRAYREF\s0 >" 4
.IX Item "-mask < ARRAYREF >"
If \fB\-mask\fR is defined, a filemask popupbox will be added
to the filebrowser dialog window. This popupbox will filter
the list of files that is displayed, using a regular expression
(case insensitive). The \s-1ARRAYREF\s0 contains a list of array
references. Each array reference has two elements: a regexp and
a description. Here's an example \fB\-mask\fR:
.Sp
.Vb 6
\& my $mask = [
\& [ '.', 'All files (*)' ],
\& [ '\e.txt$', 'Text files (*.txt)' ]
\& [ 'howto', 'HOWTO documentation' ],
\& [ 'core', 'Core files' ],
\& ];
.Ve
.IP "* \fB\-mask_selected\fR < \s-1INDEX\s0 >" 4
.IX Item "-mask_selected < INDEX >"
Normally the first mask in the list of masks will be made
active upon creation of the filebrowser. If you want
another mask to be active, use the \fB\-mask_selected\fR
option. Set this value to the index of the mask you want
to be active. For example: if you would want the \*(L"howto\*(R"
mask in the above example to be active, you would use
the value 2 for \fB\-mask_selected\fR.
.SH "METHODS"
.IX Header "METHODS"
.IP "* \fBnew\fR ( \s-1OPTIONS\s0 )" 4
.IX Item "new ( OPTIONS )"
.PD 0
.IP "* \fBlayout\fR ( )" 4
.IX Item "layout ( )"
.IP "* \fBdraw\fR ( \s-1BOOLEAN\s0 )" 4
.IX Item "draw ( BOOLEAN )"
.IP "* \fBfocus\fR ( )" 4
.IX Item "focus ( )"
.PD
These are standard methods. See Curses::UI::Container
for an explanation of these.
.IP "* \fBget\fR ( )" 4
.IX Item "get ( )"
This method will return the complete path to the file that was
selected using the filebrowser. If no file was selected, this
method will return an undefined value.
.SH "SPECIAL BINDINGS"
.IX Header "SPECIAL BINDINGS"
.IP "* \fBescape\fR" 4
.IX Item "escape"
This will invoke the cancel button, so the filebrowser widget
returns without selecting any file.
.IP "* \fB~\fR" 4
.IX Item "~"
If the directory\- or filelistbox of the dialog window has the
focus and the tilde (~) button is pressed, the filebrowser
will chdir to the homedirectory of the current user.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Curses::UI,
Curses::UI::Container,
Curses::UI::Buttonbox
.SH "AUTHOR"
.IX Header "AUTHOR"
Copyright (c) 2001\-2002 Maurice Makaay. All rights reserved.
.PP
Maintained by Marcus Thiesen (marcus@cpan.thiesenweb.de)
.PP
This package is free software and is provided \*(L"as is\*(R" without express
or implied warranty. It may be used, redistributed and/or modified
under the same terms as perl itself.