Damien Krotkine > Curses-Toolkit > Curses::Toolkit::Widget::VPaned

Download:
Curses-Toolkit-0.211.tar.gz

Dependencies

Annotate this POD

Website

CPAN RT

New  1
Open  2
View/Report Bugs
Module Version: 0.211   Source  

NAME ^

Curses::Toolkit::Widget::VPaned - a container with two panes arranged horizontally

VERSION ^

version 0.211

DESCRIPTION ^

This widget contain 2 widgets. The children are packed horizontally.

Appearence ^

With a border

  +----------+-----------+
  |          |           |
  | Widget 1 | Widget 2  |
  |          |           |
  |          |           |
  +----------+-----------+

CONSTRUCTOR ^

new

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

METHODS ^

add1

Add a widget in the upper box

  input  : the child widget
  output : the current widget (not the child widget)

add2

Add a widget in the lower box

  input  : the child widget
  output : the current widget (not the child widget)

set_gutter_position

Set the position of the gutter from the top

  input  : the position (an integer)
  output : the current widget (not the child widget)

get_gutter_position

Return the position of the gutter from the top

  input  : none
  output : the current gutter position

get_desired_space

Given a coordinate representing the available space, returns the space desired

  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

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.

syntax highlighting: