Prima::ScrollBar - scroll bars
Prima::ScrollBar implements standard vertical and horizontal scrollbars
Prima::ScrollBar
use Prima::ScrollBar; my $sb = Prima::ScrollBar->new( owner => $group, %rest_of_profile); my $sb = $group-> insert( 'ScrollBar', %rest_of_profile); my $isAutoTrack = $sb-> autoTrack; $sb-> autoTrack( $yesNo); my $val = $sb-> value; $sb-> value( $value); my $min = $sb-> min; my $max = $sb-> max; $sb-> min( $min); $sb-> max( $max); $sb-> set_bounds( $min, $max); my $step = $sb-> step; my $pageStep = $sb-> pageStep; $sb-> step( $step); $sb-> pageStep( $pageStep); my $partial = $sb-> partial; my $whole = $sb-> whole; $sb-> partial( $partial); $sb-> whole( $whole); $sb-> set_proportion( $partial, $whole); my $size = $sb-> minThumbSize; $sb-> minThumbSize( $size); my $isVertical = $sb-> vertical; $sb-> vertical( $yesNo); my ($width,$height) = $sb-> get_default_size;
Tells the widget if it should send the Change notification during mouse tracking events. Generally, it should only be set to 0 on very slow computers.
Change
The default value: 1
The default value is gm::GrowHiX, i.e. the scrollbar will try to maintain the constant distance from its right edge to its owner's right edge as the owner changes its size. This is useful for horizontal scrollbars.
gm::GrowHiX
The default value is $Prima::ScrollBar::stdMetrics[1], which is an operating system-dependent value determined with a call to Prima::Application-> get_default_scrollbar_metrics. The height is affected because by default the horizontal ScrollBar will be created.
Prima::Application-> get_default_scrollbar_metrics
ScrollBar
Sets the upper limit for value.
value
The default value: 100.
Sets the lower limit for value.
The default value: 0
A minimal thumb breadth in pixels. The thumb cannot have a main dimension lesser than this.
The default value: 21
This determines the increment/decrement to value during the operations that suppose to scroll by pages, for example clicking the mouse on the strip outside the thumb, or pressing PgDn or PgUp.
PgDn
PgUp
The default value: 10
This tells the scrollbar how many imaginary units the thumb should occupy. See whole below.
whole
The default value is 0. If set to 1 the widget receives keyboard focus; when in focus, the thumb bar is blinking.
This determines the minimal increment/decrement to value during mouse/keyboard interaction.
The default value is 1
A basic scrollbar property; reflects the imaginary position between min and max, which corresponds directly to the position of the thumb.
min
max
The default value is 0
Determines the main scrollbar style. Set this to 1 when the scrollbar style is vertical, 0 - horizontal. The property can be changed at run-time, so the scrollbars can morph from horizontal to vertical and vice versa.
This tells the scrollbar how many imaginary units correspond to the whole length of the scrollbar. This value has nothing in common with min and max. You may think of the combination of partial and whole as the proportion between the visible size of something (document, for example) and the whole size of that "something".
partial
The default value is 100.
Returns two integers, the default platform-dependant width of a vertical scrollbar and the height of a horizontal scrollbar.
The Change notification is sent whenever the thumb position of the scrollbar is changed, subject to certain limitations when autoTrack is 0. The notification is sent when appropriate, regardless of whether due to the user interaction or a side effect of some method the programmer has called.
autoTrack
If autoTrack is 0, called when the user changes the thumb position with the mouse.
use Prima; use Prima::Application name => 'ScrollBar test'; use Prima::ScrollBar; my $w = Prima::Window->new( text => 'ScrollBar test', size => [300,200]); my $sb = $w-> insert( ScrollBar => width => 280, left => 10, bottom => 50, onChange => sub { $w-> text( $_[0]-> value); }); run Prima;
Prima, Prima::Widget, examples/scrollbar.pl, examples/scrollbar2.pl
Dmitry Karasik <dk@plab.ku.dk>, Anton Berezin <tobez@plab.ku.dk> - documentation
To install Prima, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Prima
CPAN shell
perl -MCPAN -e shell install Prima
For more information on module installation, please visit the detailed CPAN module installation guide.