Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Curses::UI::Dialog::DiUserwContributed Perl DCurses::UI::Dialog::Dirbrowser(3)

NAME
       Curses::UI::Dialog::Dirbrowser -	Create and manipulate filebrowser
       dialogs

CLASS HIERARCHY
	Curses::UI::Widget
	   |
	   +----Curses::UI::Container
		   |
		   +----Curses::UI::Window
			   |
			   +----Curses::UI::Dialog::Dirbrowser

SYNOPSIS
	   use Curses::UI;
	   my $cui = new Curses::UI;
	   my $win = $cui->add('window_id', 'Window');

	   # The hard way.
	   # -------------
	   my $dialog =	$win->add(
	       'mydialog', 'Dialog::Dirbrowser'
	   );
	   $dialog->focus;
	   my $file = $dialog->get();
	   $win->delete('mydialog');

	   # The easy way (see Curses::UI documentation).
	   # --------------------------------------------
	   $file = $cui->filebrowser();
	   $file = $cui->loadfilebrowser();
	   $file = $cui->savefilebrowser();

DESCRIPTION
       Curses::UI::Dialog::Dirbrowser is a dirbrowser dialog.  This type of
       dialog can be used to select a directory, anywhere on the filesystem.

       See exampes/demo-Curses::UI::Dialog::Dirbrowser in the distribution for
       a short demo.

OPTIONS
       o   -title < TEXT >

	   Set the title of the	dialog window to TEXT.

       o   -path < PATH	>

	   Set the path	to start with to PATH. If this path does not exist,
	   the filebrowser will	start in the rootdirectory.

       o   -show_hidden	< BOOLEAN >

	   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.

METHODS
       o   new ( OPTIONS )

       o   layout ( )

       o   draw	( BOOLEAN )

       o   focus ( )

	   These are standard methods. See Curses::UI::Container for an
	   explanation of these.

       o   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.

SPECIAL	BINDINGS
       o   escape

	   This	will invoke the	cancel button, so the filebrowser widget
	   returns without selecting any file.

       o   ~

	   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.

SEE ALSO
       Curses::UI, Curses::UI::Container, Curses::UI::Buttonbox

AUTHOR
       Copyright (c) 2001-2002 Maurice Makaay. All rights reserved.

       Maintained by Marcus Thiesen (marcus@cpan.thiesenweb.de)

       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.

perl v5.24.1			  2011-09-01 Curses::UI::Dialog::Dirbrowser(3)

NAME | CLASS HIERARCHY | SYNOPSIS | DESCRIPTION | OPTIONS | METHODS | SPECIAL BINDINGS | SEE ALSO | AUTHOR

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Curses::UI::Dialog::Dirbrowser&sektion=3&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help