table of contents
UI::Dialog::Backend::Whiptail(3pm) | User Contributed Perl Documentation | UI::Dialog::Backend::Whiptail(3pm) |
NAME¶
UI::Dialog::Backend::Whiptail - Backend for the Whiptail dialog variant
SYNOPSIS¶
use UI::Dialog::Backend::Whiptail; my $d = new UI::Dialog::Backend::Whiptail ( backtitle => 'Demo', title => 'Default' ); $d->msgbox( title => 'Welcome!', text => 'Welcome one and all!' );
ABSTRACT¶
UI::Dialog::Backend::Whiptail is the UI::Dialog backend for the Whiptail dialog variant. While this module is used through UI::Dialog or any other loader module only the compatible methods are ever accessible. However, when using this module directly in your application (as in the SYNOPSIS example) you are given access to all the options and features of the real whiptail(1) application.
DESCRIPTION¶
This dialog variant is the staple of the Debian console apt/dpkg interface. There isn't very much interesting about this particular backend. This is very much a basic dialog variant in comparison to things like Xdialog and cDialog.
EXPORT¶
None
INHERITS¶
UI::Dialog::Backend
CONSTRUCTOR¶
new( @options )¶
my $d = new( title => 'Default Title', backtitle => 'Backtitle', width => 65, height => 20, listheight => 5 );
- DESCRIPTION
A blessed object reference of the UI::Dialog::Backend::Whiptail class.
- OPTIONS
- The (...)'s after each option indicate the default for the option. An * denotes support by all the widget methods on a per-use policy defaulting to the values decided during object creation.
WIDGET METHODS¶
yesno( )¶
if ($d->yesno( text => 'A binary type question?') ) { # user pressed yes } else { # user pressed no or cancel }
- DESCRIPTION
TRUE (1) for a response of YES or FALSE (0) for anything else.
msgbox( )¶
$d->msgbox( text => 'A simple message' );
- DESCRIPTION
infobox( )¶
$d->infobox( text => 'A simple 6 second message.', timeout => 6000 );
- DESCRIPTION
password( )¶
my $string = $d->password( text => 'Enter some (hidden) text.' );
- DESCRIPTION
inputbox( )¶
my $string = $d->inputbox( text => 'Enter some text.', entry => 'this is the input field' );
- DESCRIPTION
textbox( )¶
$d->textbox( path => '/path/to/a/text/file' );
- DESCRIPTION
menu( )¶
my $selection1 = $d->menu( text => 'Select one:', list => [ 'tag1', 'item1', 'tag2', 'item2', 'tag3', 'item3' ] );
- DESCRIPTION
checklist( )¶
my @selection = $d->checklist( text => 'Select one:', list => [ 'tag1', [ 'item1', 0 ], 'tag2', [ 'item2', 1 ], 'tag3', [ 'item3', 1 ] ] );
- DESCRIPTION
radiolist( )¶
my $selection = $d->radiolist( text => 'Select one:', list => [ 'tag1', [ 'item1', 0 ], 'tag2', [ 'item2', 1 ], 'tag3', [ 'item3', 0 ] ] );
- DESCRIPTION
fselect( )¶
my $text = $d->fselect( path => '/path/to/a/file/or/directory' );
- DESCRIPTION
dselect( )¶
my $text = $d->dselect( path => '/path/to/a/directory' );
- DESCRIPTION
gauge_start( )¶
$d->gauge_start( text => 'gauge...', percentage => 1 );
- DESCRIPTION
gauge_inc( )¶
$d->gauge_inc( 1 );
- DESCRIPTION
gauge_dec( )¶
$d->gauge_dec( 1 );
- DESCRIPTION
gauge_set( )¶
$d->gauge_set( 99 );
- DESCRIPTION
gauge_text( )¶
$d->gauge_text( 'string' );
- DESCRIPTION
gauge_stop( )¶
$d->gauge_stop();
- DESCRIPTION
SEE ALSO¶
- PERLDOC
-
UI::Dialog UI::Dialog::Console UI::Dialog::Backend
- MAN FILES
-
whiptail(1)
BUGS¶
Please email the author with any bug reports. Include the name of the module in the subject line.
AUTHOR¶
Kevin C. Krinke, E<lt>kevin@krinke.caE<gt>
COPYRIGHT AND LICENSE¶
Copyright (C) 2004-2016 Kevin C. Krinke <kevin@krinke.ca> This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
2018-10-27 | perl v5.26.2 |