NAME

Tickit::Widget::HSplit - an adjustable horizontal split between two widgets

SYNOPSIS

   use Tickit;
   use Tickit::Widget::HSplit;
   use Tickit::Widget::Static;

   my $hsplit = Tickit::Widget::HSplit->new
      ->set_top_child   ( Tickit::Widget::Static->new( text => "Text above" ) )
      ->set_bottom_child( Tickit::Widget::Static->new( text => "Text below" ) );

   Tickit->new( root => $hsplit )->run;

DESCRIPTION

This container widget holds two child widgets, displayed one above the other. The two widgets are displayed with a horizontal split bar between them, which reacts to mouse click-drag events, allowing the user to adjust the proportion of space given to the two widgets.

STYLE

The default style pen is used as the widget pen. The following style pen prefixes are also used:

split => PEN

The pen used to render the horizontal split area

The following style keys are used:

spacing => INT

The number of lines of spacing between the top and bottom child widgets

The following style tags are used:

:active

Set when a mouse drag resize operation is occurring

CONSTRUCTOR

new

   $hsplit = Tickit::Widget::HSplit->new( %args )

Constructs a new Tickit::Widget::HSplit object.

Takes the following named arguments

top_child => WIDGET
bottom_child => WIDGET

Child widgets to use.

These options are now discouraged in favour of the "set_top_child" and "set_bottom_child" methods.

ACCESSORS

top_child

set_top_child

   $child = $hsplit->top_child

   $hsplit->set_top_child( $child )

Accessor for the child widget used in the top half of the display.

bottom_child

set_bottom_child

   $child = $hsplit->bottom_child

   $hsplit->set_bottom_child( $child )

Accessor for the child widget used in the bottom half of the display.

These mutators returning the container widget itself making them suitable to use as chaining mutators; e.g.

   my $container = Tickit::Widget::HSplit->new( ... )
      ->set_top_child   ( Tickit::Widget::Box->new ... )
      ->set_bottom_child( Tickit::Widget::Box->new ... );

These should be preferred over using the top_child and bottom_child constructor arguments, which are now discouraged.

AUTHOR

Paul Evans <leonerd@leonerd.org.uk>