Your IP : 216.73.216.182
| Current Path : /usr/local/man/man3/ |
|
|
| Current File : //usr/local/man/man3/UI::Dialog::Console.3pm |
.\" Automatically generated by Pod::Man 4.11 (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
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
. if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "UI::Dialog::Console 3pm"
.TH UI::Dialog::Console 3pm "2016-02-03" "perl v5.30.0" "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::Console \- console meta\-class for UI::Dialog.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 4
\& use UI::Dialog::Console;
\& my $d = new UI::Dialog::Console ( title => \*(AqDefault\*(Aq,
\& height => 20, width => 65,
\& listheight => 5 );
\&
\& # Either a CDialog, Whiptail or ASCII msgbox widget should be displayed
\& # with a preference for CDialog.
\& $d\->msgbox( title => \*(AqWelcome!\*(Aq, text => \*(AqWelcome one and all!\*(Aq );
.Ve
.SH "ABSTRACT"
.IX Header "ABSTRACT"
UI::Dialog::Console is simply another meta-class for UI::Dialog. This
class simply has a different order of priority than UI::Dialog and no
\&\s-1GUI\s0 support.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This class is simply a nice way to try and ensure a Console based widget set.
.SH "EXPORT"
.IX Header "EXPORT"
.RS 2
None
.RE
.SH "INHERITS"
.IX Header "INHERITS"
.RS 2
UI::Dialog
.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 => [ \*(Aqcdialog\*(Aq, \*(Aqwhiptail\*(Aq, \*(Aqascii\*(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::Console 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 "\fBorder = [ kdialog, xdialog ]\fR (as indicated)" 6
.IX Item "order = [ kdialog, xdialog ] (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 "SEE ALSO"
.IX Header "SEE ALSO"
.IP "\s-1PERLDOC\s0" 2
.IX Item "PERLDOC"
.Vb 5
\& UI::Dialog
\& UI::Dialog::Backend
\& UI::Dialog::Backend::ASCII
\& UI::Dialog::Backend::CDialog
\& UI::Dialog::Backend::Whiptail
.Ve
.IP "\s-1MAN FILES\s0" 2
.IX Item "MAN FILES"
.Vb 1
\& dialog(1), whiptail(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