WWWWWW

Current Directory: /usr/local/share/man/man3
Viewing File: /usr/local/share/man/man3/Curses::UI::Label.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 "Curses::UI::Label 3"
.TH Curses::UI::Label 3 "2011-09-01" "perl v5.26.3" "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::UI::Label \- Create and manipulate label widgets
.SH "CLASS HIERARCHY"
.IX Header "CLASS HIERARCHY"
.Vb 3
\& Curses::UI::Widget
\&    |
\&    +\-\-\-\-Curses::UI::Label
.Ve
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\&    use Curses::UI;
\&    my $cui = new Curses::UI;
\&    my $win = $cui\->add(\*(Aqwindow_id\*(Aq, \*(AqWindow\*(Aq);
\&
\&    my $label = $win\->add(
\&        \*(Aqmylabel\*(Aq, \*(AqLabel\*(Aq,
\&        \-text      => \*(AqHello, world!\*(Aq,
\&        \-bold      => 1,
\&    );
\&
\&    $label\->draw;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Curses::UI::Label is a widget that shows a textstring.
This textstring can be drawn using these special
features: bold, dimmed, reverse, underlined, and blinking.
.PP
See exampes/demo\-Curses::UI::Label in the distribution
for a short demo.
.SH "STANDARD OPTIONS"
.IX Header "STANDARD OPTIONS"
\&\fB\-parent\fR, \fB\-x\fR, \fB\-y\fR, \fB\-width\fR, \fB\-height\fR, 
\&\fB\-pad\fR, \fB\-padleft\fR, \fB\-padright\fR, \fB\-padtop\fR, \fB\-padbottom\fR,
\&\fB\-ipad\fR, \fB\-ipadleft\fR, \fB\-ipadright\fR, \fB\-ipadtop\fR, \fB\-ipadbottom\fR,
\&\fB\-title\fR, \fB\-titlefullwidth\fR, \fB\-titlereverse\fR, \fB\-onfocus\fR,
\&\fB\-onblur\fR
.PP
For an explanation of these standard options, see 
Curses::UI::Widget.
.SH "WIDGET-SPECIFIC OPTIONS"
.IX Header "WIDGET-SPECIFIC OPTIONS"
.IP "\(bu" 4
\&\fB\-height\fR < \s-1VALUE\s0 >
.Sp
If you do not define \fB\-height\fR, the label will compute 
its needed height using the initial \fB\-text\fR.
.IP "\(bu" 4
\&\fB\-text\fR < \s-1TEXT\s0 >
.Sp
This will set the text on the label to \s-1TEXT.\s0
.IP "\(bu" 4
\&\fB\-textalignment\fR < \s-1VALUE\s0 >
.Sp
This option controls how the text should be aligned inside
the label. \s-1VALUE\s0 can be 'left', 'middle' and 'right'. The 
default value for this option is 'left'.
.IP "\(bu" 4
\&\fB\-paddingspaces\fR < \s-1BOOLEAN\s0 >
.Sp
This option controls if padding spaces should be added
to the text if the text does not fill the complete width
of the widget. The default value for \s-1BOOLEAN\s0 is false.
An example use of this option is:
.Sp
.Vb 6
\&    $win\->add(
\&        \*(Aqlabel\*(Aq, \*(AqLabel\*(Aq, 
\&        \-width         => \-1, 
\&        \-paddingspaces => 1,
\&        \-text          => \*(AqA bit of text\*(Aq, 
\&    );
.Ve
.Sp
This will create a label that fills the complete width of 
your screen and which will be completely in reverse font
(also the part that has no text on it). See the demo
in the distribution (examples/demo\-Curses::UI::Label)
for a clear example of this)
.IP "\(bu" 4
\&\fB\-bold\fR < \s-1BOOLEAN\s0 >
.Sp
If \s-1BOOLEAN\s0 is true, text on the label will be drawn in 
a bold font.
.IP "\(bu" 4
\&\fB\-dim\fR < \s-1BOOLEAN\s0 >
.Sp
If \s-1BOOLEAN\s0 is true, text on the label will be drawn in 
a dim font.
.IP "\(bu" 4
\&\fB\-reverse\fR < \s-1BOOLEAN\s0 >
.Sp
If \s-1BOOLEAN\s0 is true, text on the label will be drawn in
a reverse font.
.IP "\(bu" 4
\&\fB\-underline\fR < \s-1BOOLEAN\s0 >
.Sp
If \s-1BOOLEAN\s0 is true, text on the label will be drawn in
an underlined font.
.IP "\(bu" 4
\&\fB\-blink\fR < \s-1BOOLEAN\s0 >
.Sp
If \s-1BOOLEAN\s0 is option is true, text on the label will be 
drawn in a blinking font.
.SH "METHODS"
.IX Header "METHODS"
.IP "\(bu" 4
\&\fBnew\fR ( \s-1OPTIONS\s0 )
.IP "\(bu" 4
\&\fBlayout\fR ( )
.IP "\(bu" 4
\&\fBdraw\fR ( \s-1BOOLEAN\s0 )
.IP "\(bu" 4
\&\fBintellidraw\fR ( )
.IP "\(bu" 4
\&\fBfocus\fR ( )
.IP "\(bu" 4
\&\fBonFocus\fR ( \s-1CODEREF\s0 )
.IP "\(bu" 4
\&\fBonBlur\fR ( \s-1CODEREF\s0 )
.Sp
These are standard methods. See Curses::UI::Widget 
for an explanation of these.
.IP "\(bu" 4
\&\fBbold\fR ( \s-1BOOLEAN\s0 )
.IP "\(bu" 4
\&\fBdim\fR ( \s-1BOOLEAN\s0 )
.IP "\(bu" 4
\&\fBreverse\fR ( \s-1BOOLEAN\s0 )
.IP "\(bu" 4
\&\fBunderline\fR ( \s-1BOOLEAN\s0 )
.IP "\(bu" 4
\&\fBblink\fR ( \s-1BOOLEAN\s0 )
.Sp
These methods can be used to control the font in which the text on
the label is drawn, after creating the widget. The font option
will be turned on for a true value of \s-1BOOLEAN.\s0
.IP "\(bu" 4
\&\fBtextalignment\fR ( \s-1VALUE\s0 )
.Sp
Set the textalignment. \s-1VALUE\s0 can be 'left',
\&'middle' or 'right'.
.IP "\(bu" 4
\&\fBtext\fR ( [\s-1TEXT\s0] )
.Sp
Without the \s-1TEXT\s0 argument, this method will return the current 
text of the widget. With a \s-1TEXT\s0 argument, the text on the widget
will be set to \s-1TEXT.\s0
.IP "\(bu" 4
\&\fBget\fR ( )
.Sp
This will call the \fBtext\fR method without any argument and thus
it will return the current text of the label.
.SH "DEFAULT BINDINGS"
.IX Header "DEFAULT BINDINGS"
Since a Label is a non-interacting widget, it does not have
any bindings.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Curses::UI, 
Curses::UI::Widget,
.SH "AUTHOR"
.IX Header "AUTHOR"
Copyright (c) 2001\-2002 Maurice Makaay. All rights reserved.
.PP
Maintained by Marcus Thiesen (marcus@cpan.thiesenweb.de)
.PP
This package is free software and is provided \*(L"as is\*(R" without express
or implied warranty. It may be used, redistributed and/or modified
under the same terms as perl itself.
F1l3 Manager
