.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "UI::Dialog 3pm"
.TH UI::Dialog 3pm "2018-10-27" "perl v5.26.2" "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"
UI::Dialog \- wrapper for various dialog applications.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 4
\&  use UI::Dialog;
\&  my $d = new UI::Dialog ( backtitle => \*(AqDemo\*(Aq, title => \*(AqDefault\*(Aq,
\&                           height => 20, width => 65 , listheight => 5,
\&                           order => [ \*(Aqzenity\*(Aq, \*(Aqxdialog\*(Aq ] );
\&
\&  # Either a Zenity or Xdialog msgbox widget should popup,
\&  # with a preference for Zenity.
\&  $d\->msgbox( title => \*(AqWelcome!\*(Aq, text => \*(AqWelcome one and all!\*(Aq );
.Ve
.SH "ABSTRACT"
.IX Header "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 \s-1ASCII\s0 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.
.SH "DESCRIPTION"
.IX Header "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 \s-1DISPLAY\s0 env): Zenity, GDialog, XDialog, KDialog
  (without \s-1DISPLAY\s0): CDialog, Whiptail, \s-1ASCII\s0
.PP
UI::Dialog is the result of a complete re-write of the \s-1UDPM CPAN\s0 module. This
was done to break away from the bad choice of name (UserDialogPerlModule) and
to implement a cleaner, more detached, OOPerl interface.
.SH "EXPORT"
.IX Header "EXPORT"
.RS 2
None
.RE
.SH "INHERITS"
.IX Header "INHERITS"
.RS 2
None
.RE
.SH "CONSTRUCTOR"
.IX Header "CONSTRUCTOR"
.ie n .SS "new( @options )"
.el .SS "new( \f(CW@options\fP )"
.IX Subsection "new( @options )"
.IP "\s-1EXAMPLE\s0" 4
.IX Item "EXAMPLE"
.RS 4
.Vb 3
\& my $d = new( title => \*(AqDefault Title\*(Aq, backtitle => \*(AqBacktitle\*(Aq,
\&              width => 65, height => 20, listheight => 5,
\&              order => [ \*(Aqzenity\*(Aq, \*(Aqxdialog\*(Aq, \*(Aqgdialog\*(Aq ] );
.Ve
.RE
.RS 4
.RE
.IP "\s-1DESCRIPTION\s0" 4
.IX Item "DESCRIPTION"
.RS 4
.RS 6
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.
.RE
.RE
.RS 4
.RE
.IP "\s-1RETURNS\s0" 4
.IX Item "RETURNS"
.RS 4
.RS 6
A blessed object reference of the UI::Dialog class.
.RE
.RE
.RS 4
.RE
.IP "\s-1OPTIONS\s0" 4
.IX Item "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.
.RS 4
.IP "\fBdebug = 0,1,2\fR (0)" 6
.IX Item "debug = 0,1,2 (0)"
.PD 0
.IP "\fBorder = [ zenity, xdialog, gdialog, kdialog, cdialog, whiptail, ascii ]\fR (as indicated)" 6
.IX Item "order = [ zenity, xdialog, gdialog, kdialog, cdialog, whiptail, ascii ] (as indicated)"
.IP "\fB\s-1PATH\s0 = [ /bin, /usr/bin, /usr/local/bin, /opt/bin ]\fR (as indicated)" 6
.IX Item "PATH = [ /bin, /usr/bin, /usr/local/bin, /opt/bin ] (as indicated)"
.ie n .IP "\fBbacktitle = ""backtitle""\fR ('') *" 6
.el .IP "\fBbacktitle = ``backtitle''\fR ('') *" 6
.IX Item "backtitle = backtitle ('') *"
.ie n .IP "\fBtitle = ""title""\fR ('') *" 6
.el .IP "\fBtitle = ``title''\fR ('') *" 6
.IX Item "title = title ('') *"
.IP "\fBbeepbefore = 0,1\fR (0) *" 6
.IX Item "beepbefore = 0,1 (0) *"
.IP "\fBbeepafter = 0,1\fR (0) *" 6
.IX Item "beepafter = 0,1 (0) *"
.IP "\fBheight = \ed+\fR (20) *" 6
.IX Item "height = d+ (20) *"
.IP "\fBwidth = \ed+\fR (65) *" 6
.IX Item "width = d+ (65) *"
.IP "\fBlistheight = \ed+\fR (5) *" 6
.IX Item "listheight = d+ (5) *"
.RE
.RS 4
.RE
.PD
.SH "STATE METHODS"
.IX Header "STATE METHODS"
.SS "state( )"
.IX Subsection "state( )"
.IP "\s-1EXAMPLE\s0" 4
.IX Item "EXAMPLE"
.RS 4
.Vb 3
\& if ($d\->state() eq "OK") {
\&     $d\->msgbox( text => "that went well" );
\& }
.Ve
.RE
.RS 4
.RE
.IP "\s-1DESCRIPTION\s0" 4
.IX Item "DESCRIPTION"
.RS 4
.RS 6
Returns the state of the last dialog widget command. The value can be one of
\&\*(L"\s-1OK\*(R", \*(L"CANCEL\*(R", \*(L"ESC\*(R".\s0 The return data is based on the exit codes (return value) of the
last widget displayed.
.RE
.RE
.RS 4
.RE
.IP "\s-1RETURNS\s0" 4
.IX Item "RETURNS"
.RS 4
.RS 6
a single \s-1SCALAR.\s0
.RE
.RE
.RS 4
.RE
.SS "ra( )"
.IX Subsection "ra( )"
.IP "\s-1EXAMPLE\s0" 4
.IX Item "EXAMPLE"
.RS 4
.Vb 1
\& my @array = $d\->ra();
.Ve
.RE
.RS 4
.RE
.IP "\s-1DESCRIPTION\s0" 4
.IX Item "DESCRIPTION"
.RS 4
.RS 6
Returns the last widget's data as an array.
.RE
.RE
.RS 4
.RE
.IP "\s-1RETURNS\s0" 4
.IX Item "RETURNS"
.RS 4
.RS 6
an \s-1ARRAY.\s0
.RE
.RE
.RS 4
.RE
.SS "rs( )"
.IX Subsection "rs( )"
.IP "\s-1EXAMPLE\s0" 4
.IX Item "EXAMPLE"
.RS 4
.Vb 1
\& my $string = $d\->rs();
.Ve
.RE
.RS 4
.RE
.IP "\s-1DESCRIPTION\s0" 4
.IX Item "DESCRIPTION"
.RS 4
.RS 6
Returns the last widget's data as a (possibly multiline) string.
.RE
.RE
.RS 4
.RE
.IP "\s-1RETURNS\s0" 4
.IX Item "RETURNS"
.RS 4
.RS 6
a \s-1SCALAR.\s0
.RE
.RE
.RS 4
.RE
.SS "rv( )"
.IX Subsection "rv( )"
.IP "\s-1EXAMPLE\s0" 4
.IX Item "EXAMPLE"
.RS 4
.Vb 1
\& my $string = $d\->rv();
.Ve
.RE
.RS 4
.RE
.IP "\s-1DESCRIPTION\s0" 4
.IX Item "DESCRIPTION"
.RS 4
.RS 6
Returns the last widget's exit status, aka: return value.
.RE
.RE
.RS 4
.RE
.IP "\s-1RETURNS\s0" 4
.IX Item "RETURNS"
.RS 4
.RS 6
a \s-1SCALAR.\s0
.RE
.RE
.RS 4
.RE
.SH "WIDGET METHODS"
.IX Header "WIDGET METHODS"
.SS "yesno( )"
.IX Subsection "yesno( )"
.IP "\s-1EXAMPLE\s0" 4
.IX Item "EXAMPLE"
.RS 4
.Vb 5
\& if ($d\->yesno( text => \*(AqA binary type question?\*(Aq) ) {
\&     # user pressed yes
\& } else {
\&     # user pressed no or cancel
\& }
.Ve
.RE
.RS 4
.RE
.IP "\s-1DESCRIPTION\s0" 4
.IX Item "DESCRIPTION"
.RS 4
.RS 6
Present the end user with a message box that has two buttons, yes and no.
.RE
.RE
.RS 4
.RE
.IP "\s-1RETURNS\s0" 4
.IX Item "RETURNS"
.RS 4
.RS 6
\&\s-1TRUE\s0 (1) for a response of \s-1YES\s0 or \s-1FALSE\s0 (0) for anything else.
.RE
.RE
.RS 4
.RE
.SS "msgbox( )"
.IX Subsection "msgbox( )"
.IP "\s-1EXAMPLE\s0" 4
.IX Item "EXAMPLE"
.RS 4
.Vb 1
\& $d\->msgbox( text => \*(AqA simple message\*(Aq );
.Ve
.RE
.RS 4
.RE
.IP "\s-1DESCRIPTION\s0" 4
.IX Item "DESCRIPTION"
.RS 4
.RS 6
Pesent the end user with a message box that has an \s-1OK\s0 button.
.RE
.RE
.RS 4
.RE
.IP "\s-1RETURNS\s0" 4
.IX Item "RETURNS"
.RS 4
.RS 6
\&\s-1TRUE\s0 (1) for a response of \s-1OK\s0 or \s-1FALSE\s0 (0) for anything else.
.RE
.RE
.RS 4
.RE
.SS "inputbox( )"
.IX Subsection "inputbox( )"
.IP "\s-1EXAMPLE\s0" 4
.IX Item "EXAMPLE"
.RS 4
.Vb 2
\& my $string = $d\->inputbox( text => \*(AqPlease enter some text...\*(Aq,
\&                            entry => \*(Aqthis is the input field\*(Aq );
.Ve
.RE
.RS 4
.RE
.IP "\s-1DESCRIPTION\s0" 4
.IX Item "DESCRIPTION"
.RS 4
.RS 6
Present the end user with a text input field and a message.
.RE
.RE
.RS 4
.RE
.IP "\s-1RETURNS\s0" 4
.IX Item "RETURNS"
.RS 4
.RS 6
a \s-1SCALAR\s0 if the response is \s-1OK\s0 and \s-1FALSE\s0 (0) for anything else.
.RE
.RE
.RS 4
.RE
.SS "password( )"
.IX Subsection "password( )"
.IP "\s-1EXAMPLE\s0" 4
.IX Item "EXAMPLE"
.RS 4
.Vb 1
\& my $string = $d\->password( text => \*(AqEnter some hidden text.\*(Aq );
.Ve
.RE
.RS 4
.RE
.IP "\s-1DESCRIPTION\s0" 4
.IX Item "DESCRIPTION"
.RS 4
.RS 6
Present the end user with a text input field, that has hidden input, and a message.
.Sp
Note that the GDialog backend will provide a regular inputbox instead of a password
box because gdialog doesn't support passwords. GDialog is on it's way to the proverbial
software heaven so this isn't a real problem. Use Zenity instead :)
.RE
.RE
.RS 4
.RE
.IP "\s-1RETURNS\s0" 4
.IX Item "RETURNS"
.RS 4
.RS 6
a \s-1SCALAR\s0 if the response is \s-1OK\s0 and \s-1FALSE\s0 (0) for anything else.
.RE
.RE
.RS 4
.RE
.SS "textbox( )"
.IX Subsection "textbox( )"
.IP "\s-1EXAMPLE\s0" 4
.IX Item "EXAMPLE"
.RS 4
.Vb 1
\& $d\->textbox( path => \*(Aq/path/to/a/text/file\*(Aq );
.Ve
.RE
.RS 4
.RE
.IP "\s-1DESCRIPTION\s0" 4
.IX Item "DESCRIPTION"
.RS 4
.RS 6
Present the end user with a simple scrolling box containing the contents
of the given text file.
.RE
.RE
.RS 4
.RE
.IP "\s-1RETURNS\s0" 4
.IX Item "RETURNS"
.RS 4
.RS 6
\&\s-1TRUE\s0 (1) if the response is \s-1OK\s0 and \s-1FALSE\s0 (0) for anything else.
.RE
.RE
.RS 4
.RE
.SS "menu( )"
.IX Subsection "menu( )"
.IP "\s-1EXAMPLE\s0" 4
.IX Item "EXAMPLE"
.RS 4
.Vb 4
\& my $selection1 = $d\->menu( text => \*(AqSelect one:\*(Aq,
\&                            list => [ \*(Aqtag1\*(Aq, \*(Aqitem1\*(Aq,
\&                                      \*(Aqtag2\*(Aq, \*(Aqitem2\*(Aq,
\&                                      \*(Aqtag3\*(Aq, \*(Aqitem3\*(Aq ] );
.Ve
.RE
.RS 4
.RE
.IP "\s-1DESCRIPTION\s0" 4
.IX Item "DESCRIPTION"
.RS 4
.RS 6
Present the user with a selectable list.
.RE
.RE
.RS 4
.RE
.IP "\s-1RETURNS\s0" 4
.IX Item "RETURNS"
.RS 4
.RS 6
a \s-1SCALAR\s0 of the chosen tag if the response is \s-1OK\s0 and \s-1FALSE\s0 (0) for
anything else.
.RE
.RE
.RS 4
.RE
.SS "checklist( )"
.IX Subsection "checklist( )"
.IP "\s-1EXAMPLE\s0" 4
.IX Item "EXAMPLE"
.RS 4
.Vb 5
\& my @selection1 = $d\->checklist( text => \*(AqSelect one:\*(Aq,
\&                                 list => [ \*(Aqtag1\*(Aq, [ \*(Aqitem1\*(Aq, 0 ],
\&                                           \*(Aqtag2\*(Aq, [ \*(Aqitem2\*(Aq, 1 ],
\&                                           \*(Aqtag3\*(Aq, [ \*(Aqitem3\*(Aq, 1 ] ]
\&                               );
.Ve
.RE
.RS 4
.RE
.IP "\s-1DESCRIPTION\s0" 4
.IX Item "DESCRIPTION"
.RS 4
.RS 6
Present the user with a selectable checklist.
.RE
.RE
.RS 4
.RE
.IP "\s-1RETURNS\s0" 4
.IX Item "RETURNS"
.RS 4
.RS 6
an \s-1ARRAY\s0 of the chosen tags if the response is \s-1OK\s0 and \s-1FALSE\s0 (0) for
anything else.
.RE
.RE
.RS 4
.RE
.SS "radiolist( )"
.IX Subsection "radiolist( )"
.IP "\s-1EXAMPLE\s0" 4
.IX Item "EXAMPLE"
.RS 4
.Vb 5
\& my $selection1 = $d\->radiolist( text => \*(AqSelect one:\*(Aq,
\&                                 list => [ \*(Aqtag1\*(Aq, [ \*(Aqitem1\*(Aq, 0 ],
\&                                           \*(Aqtag2\*(Aq, [ \*(Aqitem2\*(Aq, 1 ],
\&                                           \*(Aqtag3\*(Aq, [ \*(Aqitem3\*(Aq, 0 ] ]
\&                               );
.Ve
.RE
.RS 4
.RE
.IP "\s-1DESCRIPTION\s0" 4
.IX Item "DESCRIPTION"
.RS 4
.RS 6
Present the user with a selectable radiolist.
.RE
.RE
.RS 4
.RE
.IP "\s-1RETURNS\s0" 4
.IX Item "RETURNS"
.RS 4
.RS 6
a \s-1SCALAR\s0 of the chosen tag if the response is \s-1OK\s0 and \s-1FALSE\s0 (0) for
anything else.
.RE
.RE
.RS 4
.RE
.SS "fselect( )"
.IX Subsection "fselect( )"
.IP "\s-1EXAMPLE\s0" 4
.IX Item "EXAMPLE"
.RS 4
.Vb 1
\& my $text = $d\->fselect( path => \*(Aq/path/to/a/file/or/directory\*(Aq );
.Ve
.RE
.RS 4
.RE
.IP "\s-1DESCRIPTION\s0" 4
.IX Item "DESCRIPTION"
.RS 4
.RS 6
Present the user with a file selection widget preset with the given path.
.RE
.RE
.RS 4
.RE
.IP "\s-1RETURNS\s0" 4
.IX Item "RETURNS"
.RS 4
.RS 6
a \s-1SCALAR\s0 if the response is \s-1OK\s0 and \s-1FALSE\s0 (0) for anything else.
.RE
.RE
.RS 4
.RE
.SS "dselect( )"
.IX Subsection "dselect( )"
.IP "\s-1EXAMPLE\s0" 4
.IX Item "EXAMPLE"
.RS 4
.Vb 1
\& my $text = $d\->dselect( path => \*(Aq/path/to/a/file/or/directory\*(Aq );
.Ve
.RE
.RS 4
.RE
.IP "\s-1DESCRIPTION\s0" 4
.IX Item "DESCRIPTION"
.RS 4
.RS 6
Present the user with a file selection widget preset with the given path.
Unlike \fIfselect()\fR this widget will only return a directory selection.
.RE
.RE
.RS 4
.RE
.IP "\s-1RETURNS\s0" 4
.IX Item "RETURNS"
.RS 4
.RS 6
a \s-1SCALAR\s0 if the response is \s-1OK\s0 and \s-1FALSE\s0 (0) for anything else.
.RE
.RE
.RS 4
.RE
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP "\s-1PERLDOC\s0" 2
.IX Item "PERLDOC"
.Vb 10
\& UI::Dialog::GNOME
\& UI::Dialog::KDE
\& UI::Dialog::Console
\& UI::Dialog::Backend
\& UI::Dialog::Backend::ASCII
\& UI::Dialog::Backend::CDialog
\& UI::Dialog::Backend::GDialog
\& UI::Dialog::Backend::KDialog
\& UI::Dialog::Backend::Nautilus
\& UI::Dialog::Backend::Whiptail
\& UI::Dialog::Backend::XDialog
\& UI::Dialog::Backend::XOSD
\& UI::Dialog::Backend::Zenity
.Ve
.IP "\s-1MAN FILES\s0" 2
.IX Item "MAN FILES"
.Vb 2
\& dialog(1), whiptail(1), zenity(1), gdialog(1), Xdialog(1),
\& osd_cat(1), kdialog(1) and nautilus(1)
.Ve
.SH "BUGS"
.IX Header "BUGS"
Please email the author with any bug reports. Include the name of the
module in the subject line.
.SH "AUTHOR"
.IX Header "AUTHOR"
Kevin C. Krinke, <kevin@krinke.ca>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
.Vb 1
\& 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
.Ve