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

 my $d = new( title => 'Default Title', backtitle => 'Backtitle',
              width => 65, height => 20, listheight => 5 );

 A blessed object reference of the UI::Dialog::Backend::Whiptail class.

WIDGET METHODS

 if ($d->yesno( text => 'A binary type question?') ) {
     # user pressed yes
 } else {
     # user pressed no or cancel
 }

 TRUE (1) for a response of YES or FALSE (0) for anything else.

 $d->msgbox( text => 'A simple message' );

 $d->infobox( text => 'A simple 6 second message.', timeout => 6000 );

 my $string = $d->password( text => 'Enter some (hidden) text.' );

 my $string = $d->inputbox( text => 'Enter some text.',
                            entry => 'this is the input field' );

 $d->textbox( path => '/path/to/a/text/file' );

 my $selection1 = $d->menu( text => 'Select one:',
                            list => [ 'tag1', 'item1',
                                      'tag2', 'item2',
                                      'tag3', 'item3' ]
                          );

 my @selection = $d->checklist( text => 'Select one:',
                                list => [ 'tag1', [ 'item1', 0 ],
                                          'tag2', [ 'item2', 1 ],
                                          'tag3', [ 'item3', 1 ] ]
                              );

 my $selection = $d->radiolist( text => 'Select one:',
                                list => [ 'tag1', [ 'item1', 0 ],
                                          'tag2', [ 'item2', 1 ],
                                          'tag3', [ 'item3', 0 ] ]
                              );

 my $text = $d->fselect( path => '/path/to/a/file/or/directory' );

 my $text = $d->dselect( path => '/path/to/a/directory' );

 $d->gauge_start( text => 'gauge...', percentage => 1 );

 $d->gauge_inc( 1 );

 $d->gauge_dec( 1 );

 $d->gauge_set( 99 );

 $d->gauge_text( 'string' );

 $d->gauge_stop();

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