.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28) .\" .\" 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 turned on, 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 .\" .\" 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 "Widgets::Label 3pm" .TH Widgets::Label 3pm "2002-11-14" "perl v5.20.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" Curses::Widgets::Label \- Label Widgets .SH "MODULE VERSION" .IX Header "MODULE VERSION" \&\f(CW$Id:\fR Label.pm,v 1.102 2002/11/03 23:36:21 corliss Exp corliss $ .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use Curses::Widgets::Label; \& \& $lbl = Curses::Widgets::Label\->new({ \& COLUMNS => 10, \& LINES => 1, \& VALUE => \*(AqName:\*(Aq, \& FOREGROUND => undef, \& BACKGROUND => \*(Aqblack\*(Aq, \& X => 1, \& Y => 1, \& ALIGNMENT => \*(AqR\*(Aq, \& }); \& \& $tf\->draw($mwh); \& \& See the Curses::Widgets pod for other methods. .Ve .SH "REQUIREMENTS" .IX Header "REQUIREMENTS" .IP "Curses" 4 .IX Item "Curses" .PD 0 .IP "Curses::Widgets" 4 .IX Item "Curses::Widgets" .PD .SH "DESCRIPTION" .IX Header "DESCRIPTION" Curses::Widgets::Label provides simplified \s-1OO\s0 access to Curses-based single or multi-line labels. .SH "METHODS" .IX Header "METHODS" .SS "new (inherited from Curses::Widgets)" .IX Subsection "new (inherited from Curses::Widgets)" .Vb 10 \& $lbl = Curses::Widgets::Label\->new({ \& COLUMNS => 10, \& LINES => 1, \& VALUE => \*(AqName:\*(Aq, \& FOREGROUND => undef, \& BACKGROUND => \*(Aqblack\*(Aq, \& X => 1, \& Y => 1, \& ALIGNMENT => \*(AqR\*(Aq, \& }); .Ve .PP The new method instantiates a new Label object. The only mandatory key/value pairs in the configuration hash are \fBX\fR and \fBY\fR. All others have the following defaults: .PP .Vb 8 \& Key Default Description \& ============================================================ \& COLUMNS 10 Number of columns displayed \& LINES 1 Number of lines displayed \& VALUE \*(Aq\*(Aq Label text \& FOREGROUND undef Default foreground colour \& BACKGROUND undef Default background colour \& ALIGNMENT L \*(AqR\*(Aqight, \*(AqL\*(Aqeft, or \*(AqC\*(Aqentered .Ve .PP If the label is a multi-line label it will filter the current \s-1VALUE\s0 through the Curses::Widgets::textwrap function to break it along whitespace and newlines. .SS "draw" .IX Subsection "draw" .Vb 1 \& $tf\->draw($mwh); .Ve .PP The draw method renders the text field in its current state. This requires a valid handle to a curses window in which it will render itself. .SH "HISTORY" .IX Header "HISTORY" .IP "2002/10/18 \*(-- First implementation" 4 .IX Item "2002/10/18 First implementation" .SH "AUTHOR/COPYRIGHT" .IX Header "AUTHOR/COPYRIGHT" (c) 2001 Arthur Corliss (corliss@digitalmages.com)