Tickit::WidgetRole::Alignable - implement widgets with adjustable alignment
Mixing this parametric role into a Tickit::Widget subclass adds behaviour to implement alignment of content within a possibly-larger space.
The following methods are provided parametrically on the caller package when the module is imported by
name => NAME,
style => STYLE,
reshape => RESHAPE;
The parameters are
Optional. The name to use for NAME in the following generated methods. Defaults to 'align' if not provided.
Optional. The direction, horizontal or vertical, that the alignment represents. Used to parse symbolic names into fractions. Defaults to 'h' if not provided.
Optional. If true, the widget will be reshaped after the value has been set by calling the reshape method. If false or absent then it will just be redrawn by calling redraw.
$align = $widget->NAME
Return the current alignment value
$widget->set_NAME( $value )
Set the new alignment value
Gives a value in the range from 0.0 to 1.0 to align the content display within the window.
For vertical direction alignments, the symbolic values top, middle and bottom can be supplied instead of 0.0, 0.5 and 1.0 respectively.
For horizontal direction alignments, the symbolic values left, centre and right can be supplied instead of 0.0, 0.5 and 1.0 respectively.
( $before, $alloc, $after ) = $widget->_NAME_allocation( $value, $total )
Returns a list of three integers created by aligning the $value to the given alignment position within the $total. See also align in Tickit::Utils.
Paul Evans <firstname.lastname@example.org>
To install Tickit::Widgets, copy and paste the appropriate command in to your terminal.
perl -MCPAN -e shell
For more information on module installation, please visit the detailed CPAN module installation guide.