NAME

Curses::Toolkit::Widget::VBox - a vertical box widget

VERSION

version 0.203

DESCRIPTION

This widget can contain 0 or more widgets. The children are packed vertically.

CONSTRUCTOR

new

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

METHODS

pack_start

Add a widget in the vertical box, at the start of the box. You can call pack_start multiple time to add more widgets.

input  : the child widget
         optionally, a hash containing options
output : the current widget (not the child widget)

The hash containing options can contain :

expand : if set to true, the new child will be given extra space allocated to box. The extra space will be divided evenly between all children of box that use this option

fill : if set to true, the space given to child by the expand option is actually allocated to child, rather than just padding it. This parameter has no effect if expand is set to false. A child is always allocated the full height of a GtkHBox and the full width of a GtkVBox. This option affects the other dimension

padding : NOT SUPPORTED YET. extra space in pixels to put between this child and its neighbors, over and above the global amount specified by "spacing" property. If child is a widget at one of the reference ends of box, then padding pixels are also put between child and the reference edge of box

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.