# You may distribute under the terms of either the GNU General Public License
# or the Artistic License (the same terms as Perl itself)
#
# (C) Paul Evans, 2009-2013 -- leonerd@leonerd.org.uk
use strict;
our $VERSION = '0.38';
use List::Util qw( sum max );
=head1 NAME
C<Tickit::Widget::VBox> - distribute child widgets in a vertical column
=head1 SYNOPSIS
use Tickit;
use Tickit::Widget::VBox;
use Tickit::Widget::Static;
my $vbox = Tickit::Widget::VBox->new;
foreach my $position (qw( top middle bottom )) {
$vbox->add(
Tickit::Widget::Static->new(
text => $position,
align => "centre",
valign => $position,
),
expand => 1
);
}
Tickit->new( root => $vbox )->run;
=head1 DESCRIPTION
This subclass of L<Tickit::Widget::LinearBox> distributes its children in a
vertical column. Its width will be the width of the widest child, and its
height will be the sum of the heights of all the children, plus the
inter-child spacing.
=head1 STYLE
The default style pen is used as the widget pen.
Note that while the widget pen is mutable and changes to it will result in
immediate redrawing, any changes made will be lost if the widget style is
changed.
The following style keys are used:
=over 4
=item spacing => INT
The number of lines of spacing between children
=back
=cut
style_definition base =>
spacing => 0;
style_reshape_keys qw( spacing );
use constant WIDGET_PEN_FROM_STYLE => 1;
sub lines
{
my $self = shift;
my $spacing = $self->get_style_values( "spacing" );
return ( sum( map { $_->lines } $self->children ) || 1 ) +
$spacing * ( $self->children - 1 );
}
sub cols
{
my $self = shift;
return max( 1, map { $_->cols } $self->children );
}
sub get_total_quota
{
my $self = shift;
my ( $window ) = @_;
return $window->lines;
}
sub get_child_base
{
my $self = shift;
my ( $child ) = @_;
return $child->lines;
}
sub set_child_window
{
my $self = shift;
my ( $child, $top, $lines, $window ) = @_;
if( $window and $lines ) {
if( my $childwin = $child->window ) {
$childwin->change_geometry( $top, 0, $lines, $window->cols );
}
else {
my $childwin = $window->make_sub( $top, 0, $lines, $window->cols );
$child->set_window( $childwin );
}
}
else {
if( $child->window ) {
$child->set_window( undef );
}
}
}
=head1 AUTHOR
Paul Evans <leonerd@leonerd.org.uk>
=cut
0x55AA;