.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32 .\" .\" Standard preamble: .\" ======================================================================== .de Sh \" Subsection heading .br .if t .Sp .ne 5 .PP \fB\\$1\fR .PP .. .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" '' 'br\} .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .\" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .hy 0 .if n .na .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "UI::Dialog::Backend::ASCII 3pm" .TH UI::Dialog::Backend::ASCII 3pm "2004-08-01" "perl v5.8.8" "User Contributed Perl Documentation" .SH "NAME" UI::Dialog::Backend::ASCII .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 3 \& use UI::Dialog::Backend::ASCII; \& my $d = new UI::Dialog::Backend::ASCII ( backtitle => \(aqDemo\(aq, \& title => \(aqDefault\(aq ); .Ve .PP .Vb 1 \& $d\->msgbox( title => \(aqWelcome!\(aq, text => \(aqWelcome one and all!\(aq ); .Ve .SH "ABSTRACT" .IX Header "ABSTRACT" UI::Dialog::Backend::ASCII is the UI::Dialog backend for the native Perl mode of basic text. The widgets are very much \*(L"rigid\*(R" in that the width and height arguments are completely ignored. .SH "DESCRIPTION" .IX Header "DESCRIPTION" This backend is intended as a last resort mechanism in that no other dialog variant has been found and so this, the most absolute of bargain basement dialog variant interfaces, is used instead. .SH "EXPORT" .IX Header "EXPORT" .IP "None" 2 .IX Item "None" .SH "INHERITS" .IX Header "INHERITS" .PD 0 .IP "UI::Dialog::Backend" 2 .IX Item "UI::Dialog::Backend" .PD .SH "CONSTRUCTOR" .IX Header "CONSTRUCTOR" .ie n .Sh "new( @options )" .el .Sh "new( \f(CW@options\fP )" .IX Subsection "new( @options )" .IP "\s-1EXAMPLE\s0" 4 .IX Item "EXAMPLE" .RS 4 .Vb 3 \& my $d = new UI::Dialog::Backend::ASCII ( title => \(aqDefault Title\(aq, \& backtitle => \(aqBacktitle\(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::Backend::ASCII 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. .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 "\fBextra-button = 0,1\fR (0)" 6 .IX Item "extra-button = 0,1 (0)" .ie n .IP "\fBextra-label = ""extra label""\fR (0)" 6 .el .IP "\fBextra-label = ``extra label''\fR (0)" 6 .IX Item "extra-label = extra label (0)" .IP "\fBhelp-button = 0,1\fR (0)" 6 .IX Item "help-button = 0,1 (0)" .ie n .IP "\fBhelp-label = ""help label""\fR (0)" 6 .el .IP "\fBhelp-label = ``help label''\fR (0)" 6 .IX Item "help-label = help label (0)" .IP "\fBmaxinput = \ed+\fR (0)" 6 .IX Item "maxinput = d+ (0)" .IP "\fBautoclear = 0,1\fR (0)" 6 .IX Item "autoclear = 0,1 (0)" .ie n .IP "\fBpager = ""/usr/bin/pager""\fR ('/usr/bin/pager')" 6 .el .IP "\fBpager = ``/usr/bin/pager''\fR ('/usr/bin/pager')" 6 .IX Item "pager = /usr/bin/pager ('/usr/bin/pager')" .ie n .IP "\fBstty = ""/usr/bin/stty""\fR ('/usr/bin/stty')" 6 .el .IP "\fBstty = ``/usr/bin/stty''\fR ('/usr/bin/stty')" 6 .IX Item "stty = /usr/bin/stty ('/usr/bin/stty')" .RE .RS 4 .RE .PD .SH "WIDGET METHODS" .IX Header "WIDGET METHODS" .Sh "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 .Sh "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 .Sh "infobox( )" .IX Subsection "infobox( )" .IP "\s-1EXAMPLE\s0" 4 .IX Item "EXAMPLE" .RS 4 .Vb 1 \& $d\->infobox( text => \(aqA simple 6 second message.\(aq, timeout => 6000 ); .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 for a limited duration of time. The timeout is specified in thousandths of a second, ie: 1000 = 1 second. .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 .Sh "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 .Sh "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 .Sh "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 .Sh "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 .Sh "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 .Sh "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 .Sh "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 .Sh "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 "spinner( )" .IX Subsection "spinner( )" .IP "\s-1EXAMPLE\s0" 4 .IX Item "EXAMPLE" .RS 4 .Vb 3 \& print STDOUT "spinner... "; \& for (20,40,60,80,100) { print $d\->spinner(); sleep(1); } \& print STDOUT "\ebdone.\en"; .Ve .RE .RS 4 .RE .IP "\s-1DESCRIPTION\s0" 4 .IX Item "DESCRIPTION" .RS 4 .RS 6 Return the next character in the spin sequence prefixed with a backspace (\eb) character. The spinner is made up of four \s-1ASCII\s0 characters; | (pipe), \&\e (back slash), / (forward slash), \- (hyphen). .Sp The complete sequence is as follows: .Sp .Vb 8 \& | \& / \& \- \& \e \& | \& / \& \- \& \e .Ve .RE .RE .RS 4 .RE .IP "\s-1RETURNS\s0" 4 .IX Item "RETURNS" .RS 4 .RS 6 A two character \s-1SCALAR\s0. .RE .RE .RS 4 .RE .Sh "draw_gauge( )" .IX Subsection "draw_gauge( )" .IP "\s-1EXAMPLE\s0" 4 .IX Item "EXAMPLE" .RS 4 .Vb 5 \& foreach my $i (20,40,60,80,100) { \& last unless $d\->draw_gauge( bar => "\-", mark => "|", length => 74, \& percent => $i ); \& sleep(1); \& } .Ve .Sp .Vb 5 \& foreach my $i (200,500,10000,12000,12345) { \& last unless $d\->draw_gauge( bar => "\-", mark => "|", length => 74, \& current => $i, total => 12345 ); \& sleep(1); \& } .Ve .RE .RS 4 .RE .IP "\s-1DESCRIPTION\s0" 4 .IX Item "DESCRIPTION" .RS 4 .RS 6 Draw a meter bar with a position indicator. You can specify alternate characters for use as the meter bar itself (default is \*(L"\-\*(R") and the positional marker (default to \*(L"|\*(R") as well as an arbitrary length to the bar itself. .Sp There are two different ways to present the bar, either by specifying the percentage to display or by specifying the current and total values and and the widget will figure out the percentage for you. .RE .RE .RS 4 .RE .IP "\s-1RETURNS\s0" 4 .IX Item "RETURNS" .RS 4 .RS 6 None. .RE .RE .RS 4 .RE .Sh "end_gauge( )" .IX Subsection "end_gauge( )" .IP "\s-1EXAMPLE\s0" 4 .IX Item "EXAMPLE" .RS 4 .Vb 1 \& $d\->end_gauge(); .Ve .RE .RS 4 .RE .IP "\s-1DESCRIPTION\s0" 4 .IX Item "DESCRIPTION" .RS 4 .RS 6 Simply print a newline for use when the finished with the \fIdraw_gauge()\fR widget as that leaves the cursor at the end of the last line of output. .RE .RE .RS 4 .RE .IP "\s-1RETURNS\s0" 4 .IX Item "RETURNS" .RS 4 .RS 6 None. .RE .RE .RS 4 .RE .SH "SEE ALSO" .IX Header "SEE ALSO" .IP "\s-1PERLDOC\s0" 2 .IX Item "PERLDOC" .Vb 3 \& UI::Dialog \& UI::Dialog::Backend \& UI::Dialog::Console .Ve .IP "\s-1MAN\s0 \s-1FILES\s0" 2 .IX Item "MAN FILES" \&\fIpager\fR\|(1), \fIless\fR\|(1), \fImore\fR\|(1), \fIstty\fR\|(1) .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, .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" .Vb 1 \& Copyright (C) 2003 Kevin C. Krinke .Ve .PP .Vb 4 \& 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. .Ve .PP .Vb 4 \& 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. .Ve .PP .Vb 3 \& 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