.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Tickit::Widget::HSplit 3pm"
.TH Tickit::Widget::HSplit 3pm "2020-11-04" "perl v5.30.3" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
"Tickit::Widget::HSplit" \- an adjustable horizontal split between two widgets
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\&   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;
.Ve
.SH "DESCRIPTION"
.IX Header "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.
.SH "STYLE"
.IX Header "STYLE"
The default style pen is used as the widget pen. The following style pen
prefixes are also used:
.IP "split => \s-1PEN\s0" 4
.IX Item "split => PEN"
The pen used to render the horizontal split area
.PP
The following style keys are used:
.IP "spacing => \s-1INT\s0" 4
.IX Item "spacing => INT"
The number of lines of spacing between the top and bottom child widgets
.PP
The following style tags are used:
.IP ":active" 4
.IX Item ":active"
Set when a mouse drag resize operation is occurring
.SH "CONSTRUCTOR"
.IX Header "CONSTRUCTOR"
.SS "new"
.IX Subsection "new"
.Vb 1
\&   $hsplit = Tickit::Widget::HSplit\->new( %args )
.Ve
.PP
Constructs a new \f(CW\*(C`Tickit::Widget::HSplit\*(C'\fR object.
.PP
Takes the following named arguments
.IP "top_child => \s-1WIDGET\s0" 8
.IX Item "top_child => WIDGET"
.PD 0
.IP "bottom_child => \s-1WIDGET\s0" 8
.IX Item "bottom_child => WIDGET"
.PD
Child widgets to use.
.Sp
These options are now discouraged in favour of the \*(L"set_top_child\*(R" and
\&\*(L"set_bottom_child\*(R" methods.
.SH "ACCESSORS"
.IX Header "ACCESSORS"
.SS "top_child"
.IX Subsection "top_child"
.SS "set_top_child"
.IX Subsection "set_top_child"
.Vb 1
\&   $child = $hsplit\->top_child
\&
\&   $hsplit\->set_top_child( $child )
.Ve
.PP
Accessor for the child widget used in the top half of the display.
.SS "bottom_child"
.IX Subsection "bottom_child"
.SS "set_bottom_child"
.IX Subsection "set_bottom_child"
.Vb 1
\&   $child = $hsplit\->bottom_child
\&
\&   $hsplit\->set_bottom_child( $child )
.Ve
.PP
Accessor for the child widget used in the bottom half of the display.
.PP
These mutators returning the container widget itself making them suitable to
use as chaining mutators; e.g.
.PP
.Vb 3
\&   my $container = Tickit::Widget::HSplit\->new( ... )
\&      \->set_top_child   ( Tickit::Widget::Box\->new ... )
\&      \->set_bottom_child( Tickit::Widget::Box\->new ... );
.Ve
.PP
These should be preferred over using the \f(CW\*(C`top_child\*(C'\fR and \f(CW\*(C`bottom_child\*(C'\fR
constructor arguments, which are now discouraged.
.SH "AUTHOR"
.IX Header "AUTHOR"
Paul Evans <leonerd@leonerd.org.uk>