UI::Dialog (3)

Leading comments

Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)

Standard preamble:
========================================================================

(The comments found at the beginning of the groff file "man3/UI::Dialog.3pm".)

NAME

UI::Dialog - wrapper for various dialog applications.

SYNOPSIS

  use UI::Dialog;
  my $d = new UI::Dialog ( backtitle => 'Demo', title => 'Default',
                           height => 20, width => 65 , listheight => 5,
                           order => [ 'zenity', 'xdialog' ] );

  # Either a Zenity or Xdialog msgbox widget should popup,
  # with a preference for Zenity.
  $d->msgbox( title => 'Welcome!', text => 'Welcome one and all!' );

ABSTRACT

UI::Dialog is a OOPerl wrapper for the various dialog applications. These dialog backends are currently supported: Zenity, XDialog, GDialog, KDialog, CDialog, and Whiptail. There is also an backend provided as a last resort interface for the console based dialog variants. UI::Dialog is a class that provides a strict interface to these various backend modules. By using UI:Dialog (with it's imposed limitations on the widgets) you can ensure that your Perl program will function with any available interfaces.

DESCRIPTION

UI::Dialog supports priority ordering of the backend detection process. So if you'd prefer that Xdialog should be used first if available, simply designate the desired order when creating the new object. The default order for detecting and utilization of the backends are as follows:
  (with  env): Zenity, GDialog, XDialog, KDialog
  (without ): CDialog, Whiptail, 

UI::Dialog is the result of a complete re-write of the

module. This was done to break away from the bad choice of name (UserDialogPerlModule) and to implement a cleaner, more detached, OOPerl interface.

EXPORT

None

INHERITS

None

CONSTRUCTOR

new( @options )

EXAMPLE

 my $d = new( title => 'Default Title', backtitle => 'Backtitle',
              width => 65, height => 20, listheight => 5,
              order => [ 'zenity', 'xdialog', 'gdialog' ] );

DESCRIPTION

This is the Class Constructor method. It accepts a list of key => value pairs and uses them as the defaults when interacting with the various widgets.

RETURNS

A blessed object reference of the UI::Dialog 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.

debug = 0,1,2 (0)

order = [ zenity, xdialog, gdialog, kdialog, cdialog, whiptail, ascii ] (as indicated)

PATH

= [ /bin, /usr/bin, /usr/local/bin, /opt/bin ] (as indicated)

backtitle = backtitle ('') *

title = title ('') *

beepbefore = 0,1 (0) *

beepafter = 0,1 (0) *

height = \d+ (20) *

width = \d+ (65) *

listheight = \d+ (5) *

STATE METHODS

state( )

EXAMPLE

 if ($d->state() eq "OK") {
     $d->msgbox( text => "that went well" );
 }

DESCRIPTION

Returns the state of the last dialog widget command. The value can be one of ``

OK'', ``CANCEL'', ``ESC''.

The return data is based on the exit codes (return value) of the last widget displayed.

RETURNS

a single

SCALAR.

ra( )

EXAMPLE

 my @array = $d->ra();

DESCRIPTION

Returns the last widget's data as an array.

RETURNS

an

ARRAY.

rs( )

EXAMPLE

 my $string = $d->rs();

DESCRIPTION

Returns the last widget's data as a (possibly multiline) string.

RETURNS

a

SCALAR.

rv( )

EXAMPLE

 my $string = $d->rv();

DESCRIPTION

Returns the last widget's exit status, aka: return value.

RETURNS

a

SCALAR.

WIDGET METHODS

yesno( )

EXAMPLE

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

DESCRIPTION

Present the end user with a message box that has two buttons, yes and no.

RETURNS

TRUE \fIs0(1) for a response of

YES

or

FALSE \fIs0(0) for anything else.