NAME

Curses::Widgets::Label - Label Widgets

MODULE VERSION

$Id: Label.pm,v 1.102 2002/11/03 23:36:21 corliss Exp corliss $

SYNOPSIS

  use Curses::Widgets::Label;

  $lbl = Curses::Widgets::Label->new({
    COLUMNS      => 10,
    LINES       => 1,
    VALUE       => 'Name:',
    FOREGROUND  => undef,
    BACKGROUND  => 'black',
    X           => 1,
    Y           => 1,
    ALIGNMENT   => 'R',
    });

  $tf->draw($mwh);

  See the Curses::Widgets pod for other methods.

REQUIREMENTS

Curses
Curses::Widgets

DESCRIPTION

Curses::Widgets::Label provides simplified OO access to Curses-based single or multi-line labels.

METHODS

new (inherited from Curses::Widgets)

  $lbl = Curses::Widgets::Label->new({
    COLUMNS      => 10,
    LINES       => 1,
    VALUE       => 'Name:',
    FOREGROUND  => undef,
    BACKGROUND  => 'black',
    X           => 1,
    Y           => 1,
    ALIGNMENT   => 'R',
    });

The new method instantiates a new Label object. The only mandatory key/value pairs in the configuration hash are X and Y. All others have the following defaults:

  Key         Default   Description
  ============================================================
  COLUMNS           10   Number of columns displayed
  LINES             1   Number of lines displayed
  VALUE            ''   Label text
  FOREGROUND    undef   Default foreground colour
  BACKGROUND    undef   Default background colour
  ALIGNMENT         L   'R'ight, 'L'eft, or 'C'entered

If the label is a multi-line label it will filter the current VALUE through the Curses::Widgets::textwrap function to break it along whitespace and newlines.

draw

  $tf->draw($mwh);

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.

HISTORY

2002/10/18 -- First implementation