.\" Automatically generated by Pod::Man 4.09 (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 .. .if !\nF .nr F 0 .if \nF>0 \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} .\} .\" .\" 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::LinearBox 3pm" .TH Tickit::Widget::LinearBox 3pm "2018-07-30" "perl v5.26.2" "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::LinearBox" \- abstract base class for "HBox" and "VBox" .SH "DESCRIPTION" .IX Header "DESCRIPTION" This class is a base class for both Tickit::Widget::HBox and Tickit::Widget::VBox. It is not intended to be used directly. .PP It maintains an ordered list of child widgets, and implements the following child widget options: .IP "expand => \s-1NUM\s0" 8 .IX Item "expand => NUM" A number used to control how extra space is distributed among child widgets, if the window containing this widget has more space available to it than the children need. The actual value is unimportant, but extra space will be distributed among the children in proportion with their \f(CW\*(C`expand\*(C'\fR value. .Sp For example, if all the children have a \f(CW\*(C`expand\*(C'\fR value of 1, extra space is distributed evenly. If one child has a value of 2, it will gain twice as much extra space as its siblings. Any child with a value of 0 will obtain no extra space. .IP "force_size => \s-1NUM\s0" 8 .IX Item "force_size => NUM" If provided, forces the size of this child widget, overriding the value returned by \f(CW\*(C`get_child_base\*(C'\fR. .SH "CONSTRUCTOR" .IX Header "CONSTRUCTOR" .ie n .SS "$widget = Tickit::Widget::LinearBox\->new( %args )" .el .SS "\f(CW$widget\fP = Tickit::Widget::LinearBox\->new( \f(CW%args\fP )" .IX Subsection "$widget = Tickit::Widget::LinearBox->new( %args )" Returns a new \f(CW\*(C`Tickit::Widget::LinearBox\*(C'\fR. .PP Takes the following named argmuents: .IP "children => ARRAY[Tickit::Widget]" 8 .IX Item "children => ARRAY[Tickit::Widget]" Optional. If provided, the widgets in this array will be added, with no additional options. .SH "METHODS" .IX Header "METHODS" .ie n .SS "@children = $widget\->children" .el .SS "\f(CW@children\fP = \f(CW$widget\fP\->children" .IX Subsection "@children = $widget->children" In scalar context, returns the number of contained children. In list context, returns a list of all the child widgets. .ie n .SS "%opts = $widget\->child_opts( $child_or_index )" .el .SS "\f(CW%opts\fP = \f(CW$widget\fP\->child_opts( \f(CW$child_or_index\fP )" .IX Subsection "%opts = $widget->child_opts( $child_or_index )" Returns the options currently set for the given child, specified either by reference or by index. .ie n .SS "$widget\->set_child( $index, $child )" .el .SS "\f(CW$widget\fP\->set_child( \f(CW$index\fP, \f(CW$child\fP )" .IX Subsection "$widget->set_child( $index, $child )" Replaces the child widget at the given index with the given new one; preserving any options that are set on it. .ie n .SS "$widget\->set_child_opts( $child_or_index, %newopts )" .el .SS "\f(CW$widget\fP\->set_child_opts( \f(CW$child_or_index\fP, \f(CW%newopts\fP )" .IX Subsection "$widget->set_child_opts( $child_or_index, %newopts )" Sets new options on the given child, specified either by reference or by index. Any options whose value is given as \f(CW\*(C`undef\*(C'\fR are deleted. .ie n .SS "$widget\->add( $child, %opts )" .el .SS "\f(CW$widget\fP\->add( \f(CW$child\fP, \f(CW%opts\fP )" .IX Subsection "$widget->add( $child, %opts )" Adds the widget as a new child of this one, with the given options .ie n .SS "$widget\->remove( $child_or_index )" .el .SS "\f(CW$widget\fP\->remove( \f(CW$child_or_index\fP )" .IX Subsection "$widget->remove( $child_or_index )" Removes the given child widget if present, by reference or index .SH "AUTHOR" .IX Header "AUTHOR" Paul Evans