.\" -*- 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 "Curses::UI::Dialog::Filebrowser 3"
.TH Curses::UI::Dialog::Filebrowser 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
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(\*(Aqwindow_id\*(Aq, \*(AqWindow\*(Aq);
\&
\&    # The hard way.
\&    # \-\-\-\-\-\-\-\-\-\-\-\-\-
\&    my $dialog = $win\->add(
\&        \*(Aqmydialog\*(Aq, \*(AqDialog::Filebrowser\*(Aq
\&    );
\&    $dialog\->focus;
\&    my $file = $dialog\->get();
\&    $win\->delete(\*(Aqmydialog\*(Aq);
\&
\&    # 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 \(bu 4
\&\fB\-title\fR < TEXT >
.Sp
Set the title of the dialog window to TEXT.
.IP \(bu 4
\&\fB\-path\fR < PATH >
.Sp
Set the path to start with to PATH. If this path
does not exist, the filebrowser will start in the
rootdirectory.
.IP \(bu 4
\&\fB\-file\fR < FILE >
.Sp
Set the filename to start with to FILE.
.IP \(bu 4
\&\fB\-editfilename\fR < BOOLEAN >
.Sp
If BOOLEAN 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 \(bu 4
\&\fB\-show_hidden\fR < BOOLEAN >
.Sp
If BOOLEAN 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 \(bu 4
\&\fB\-mask\fR < ARRAYREF >
.Sp
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 ARRAYREF 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 = [
\&        [ \*(Aq.\*(Aq,        \*(AqAll files (*)\*(Aq       ],
\&        [ \*(Aq\e.txt$\*(Aq,   \*(AqText files (*.txt)\*(Aq  ]
\&        [ \*(Aqhowto\*(Aq,    \*(AqHOWTO documentation\*(Aq ],
\&        [ \*(Aqcore\*(Aq,     \*(AqCore files\*(Aq          ],
\&    ];
.Ve
.IP \(bu 4
\&\fB\-mask_selected\fR < INDEX >
.Sp
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 "howto"
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 \(bu 4
\&\fBnew\fR ( OPTIONS )
.IP \(bu 4
\&\fBlayout\fR ( )
.IP \(bu 4
\&\fBdraw\fR ( BOOLEAN )
.IP \(bu 4
\&\fBfocus\fR ( )
.Sp
These are standard methods. See Curses::UI::Container 
for an explanation of these.
.IP \(bu 4
\&\fBget\fR ( )
.Sp
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 \(bu 4
\&\fBescape\fR
.Sp
This will invoke the cancel button, so the filebrowser widget
returns without selecting any file.
.IP \(bu 4
\&\fB~\fR
.Sp
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 "as is" without express
or implied warranty. It may be used, redistributed and/or modified
under the same terms as perl itself.