.\" 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::Backend::KDialog 3pm"
.TH UI::Dialog::Backend::KDialog 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::Backend::KDialog \- backend for the KDE dialog variant.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\&  use UI::Dialog::Backend::KDialog;
\&  my $d = new UI::Dialog::Backend::KDialog ( backtitle => \*(AqDemo\*(Aq,
\&                                             title => \*(AqDefault\*(Aq );
\&
\&  $d\->msgbox( title => \*(AqWelcome!\*(Aq, text => \*(AqWelcome one and all!\*(Aq );
.Ve
.SH "ABSTRACT"
.IX Header "ABSTRACT"
UI::Dialog::Backend::KDialog is the UI::Dialog backend for the \s-1KDE\s0 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 \s-1SYNOPSIS\s0 example) you are
given access to all the options and features of the real \fIkdialog\fR\|(1) application.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Although this dialog variant doesn't have any progress meters, it does have the
benefits of many different file/uri/directory widgets. It's a shame that this is
the only dialog variant for \s-1KDE.\s0
.SH "EXPORT"
.IX Header "EXPORT"
.RS 2
None
.RE
.SH "INHERITS"
.IX Header "INHERITS"
.RS 2
UI::Dialog::Backend
.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 2
\& my $d = new( title => \*(AqDefault Title\*(Aq, backtitle => \*(AqBacktitle\*(Aq,
\&              width => 65, height => 20, listheight => 5 );
.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::Backend::KDialog 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 "\fBliteral = 0,1\fR (0)" 6
.IX Item "literal = 0,1 (0)"
.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 "\fBnocancel = 0,1\fR (0) *" 6
.IX Item "nocancel = 0,1 (0) *"
.IP "\fBdefaultno = 0,1\fR (0) *" 6
.IX Item "defaultno = 0,1 (0) *"
.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 "\fBextrabutton = 0,1\fR (0) *" 6
.IX Item "extrabutton = 0,1 (0) *"
.ie n .IP "\fBextralabel = ""extra label""\fR (0) *" 6
.el .IP "\fBextralabel = ``extra label''\fR (0) *" 6
.IX Item "extralabel = extra label (0) *"
.IP "\fBhelpbutton = 0,1\fR (0) *" 6
.IX Item "helpbutton = 0,1 (0) *"
.ie n .IP "\fBhelplabel = ""help label""\fR (0) *" 6
.el .IP "\fBhelplabel = ``help label''\fR (0) *" 6
.IX Item "helplabel = help label (0) *"
.IP "\fBmaxinput = \ed+\fR (0) *" 6
.IX Item "maxinput = d+ (0) *"
.RE
.RS 4
.RE
.PD
.SH "WIDGET METHODS"
.IX Header "WIDGET METHODS"
.SS "yesno( ) yesnocancel( ) warningyesno( ) warningyesnocancel( )"
.IX Subsection "yesno( ) yesnocancel( ) warningyesno( ) warningyesnocancel( )"
.IP "\s-1EXAMPLE\s0" 4
.IX Item "EXAMPLE"
.RS 4
.Vb 8
\& # if ($d\->warningyesnocancel( text => \*(AqA question?\*(Aq) ) {
\& # if ($d\->warningyesno( text => \*(AqA question?\*(Aq) ) {
\& # if ($d\->yesnocancel( text => \*(AqA question?\*(Aq) ) {
\& 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 "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 doesn't reveal the input
(except to the script) 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 "inputbox( )"
.IX Subsection "inputbox( )"
.IP "\s-1EXAMPLE\s0" 4
.IX Item "EXAMPLE"
.RS 4
.Vb 2
\& my $string = $d\->inputbox( text => \*(AqEnter 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 "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 5
\& 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 @selection = $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 $selection = $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( ) getopenfilename( ) getsavefilename( ) getopenurl( ) getsaveurl( )"
.IX Subsection "fselect( ) getopenfilename( ) getsavefilename( ) getopenurl( ) getsaveurl( )"
.IP "\s-1EXAMPLE\s0" 4
.IX Item "EXAMPLE"
.RS 4
.Vb 5
\& # my $text = $d\->getsaveurl( path => \*(Aq/path/\*(Aq );
\& # my $text = $d\->getopenurl( path => \*(Aq/path/\*(Aq );
\& # my $text = $d\->getsavefilename( path => \*(Aq/path/\*(Aq );
\& # my $text = $d\->getopenfilename( path => \*(Aq/path/\*(Aq );
\& 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( ) getexistingdirectory( )"
.IX Subsection "dselect( ) getexistingdirectory( )"
.IP "\s-1EXAMPLE\s0" 4
.IX Item "EXAMPLE"
.RS 4
.Vb 2
\& # my $text = $d\->getexistingdirectory( path => \*(Aq/path/to/a/dir\*(Aq );
\& my $text = $d\->dselect( path => \*(Aq/path/to/a/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 4
\& UI::Dialog
\& UI::Dialog::KDE
\& UI::Dialog::Backend
\& UI::Dialog::Backend::XOSD
.Ve
.IP "\s-1MAN FILES\s0" 2
.IX Item "MAN FILES"
None. Use `kdialog \-\-help` from a command line.
.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