NAME

Curses::Toolkit::Widget::Border - a border widget

VERSION

version 0.211

SYNOPSIS

my $border = Curses::Toolkit::Widget::Border->new; $border->add_widget($some_other_widget);

DESCRIPTION

This widget consists of a border, and a child widget in that border

This widget can contain 0 or 1 other widget.

Appearence

  +----------+
  |          |
  +----------+

CONSTRUCTOR

new

  input : none
  output : a Curses::Toolkit::Widget::Border

get_desired_space

Given a coordinate representing the available space, returns the space desired The Border desires as much as its children desires, plus its width

  input : a Curses::Toolkit::Object::Coordinates object
  output : a Curses::Toolkit::Object::Coordinates object

get_minimum_space

Given a coordinate representing the available space, returns the minimum space needed to properly display itself

  input : a Curses::Toolkit::Object::Coordinates object
  output : a Curses::Toolkit::Object::Coordinates object

Theme related properties

To set/get a theme properties, you should do :

  $border->set_theme_property(property_name => $property_value);
  $value = $border->get_theme_property('property_name');

Here is the list of properties related to the border, that can be changed in the associated theme. See the Curses::Toolkit::Theme class used for the default (default class to look at is Curses::Toolkit::Theme::Default)

Don't forget to look at properties from the parent class, as these are also inherited from !

border_width

Sets the width of the border. If not set, the border will be invisible

AUTHOR

Damien "dams" Krotkine

COPYRIGHT AND LICENSE

This software is copyright (c) 2011 by Damien "dams" Krotkine.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

cpanm Curses::Toolkit

perl -MCPAN -e shell
install Curses::Toolkit