NAME

Tk::StatusBar - A statusbar widget for Perl/Tk

SYNOPSIS

    use Tk;
    use Tk::StatusBar;

    my $mw = new MainWindow;

    my $Label1 = "Welcome to the statusbar";
    my $Label2 = "On";
    my $Progress = 0;

    $mw->Text()->pack(-expand => 1, -fill => 'both');

    $sb = $mw->StatusBar();

    $sb->addLabel(
        -relief         => 'flat',
        -textvariable   => \$Label1,
    );

    $sb->addLabel(
        -text           => 'double-click that -->',
        -width          => '20',
        -anchor         => 'center',
    );

    $sb->addLabel(
        -width          => 4,
        -anchor         => 'center',
        -textvariable   => \$Label2,
        -foreground     => 'blue',
        -command        => sub {$Label2 = $Label2 eq 'On' ? 'Off' : 'On';},
    );

    $sb->addLabel(
        -width          => 5,
        -anchor         => 'center',
        -textvariable   => \$Progress,
    );

    $p = $sb->addProgressBar(
        -length         => 60,
        -from           => 0,
        -to             => 100,
        -variable       => \$Progress,
    );

    $mw->repeat('50', sub {
        if ($Label2 eq 'On') {
            $Progress = 0 if (++$Progress > 100);
        }
    });

    MainLoop();

DESCRIPTION

This module implements a configurable statusbar. The statusbar can be configured with any number of label sections and progressbar sections. Each label and/or progressbar section can be configured and controlled independantly. The entire statusbar can be hidden or displayed as needed.

WIDGET-SPECIFIC OPTIONS

There are currently no widget-specific options. The StatusBar widget will accept all of the same options allowable by a Tk-Frame.

WIDGET METHODS

$sb->addLabel(options)

This method is used to add a label section to the status bar widget, and can therefore accept all the same arguments that a Tk-Label can accept. Some widget-specific options and options of interest are listed below.

-width -- Sets a fixed width for the label. If no width is specifid, the label will expand as needed to fill the remainder of the statusbar. If more than one label section exists without a fixed width, they will equally share the space of the statusbar.

-side -- Be default, all widgets are packed from the left. If you would like to alter the packing order, you can choose to pack an item on the right. Default is 'left'.

-relief -- Specifies the 3-D effect desired for the widget. Acceptable values are raised, sunken, flat, ridge, solid, and groove. The value indicates how the interior of the widget should appear relative to its exterior; for example, raised means the interior of the widget should appear to protrude from the screen, relative to the exterior of the widget. Default is 'sunken'.

-borderwidth -- Specifies a non-negative value indicating the width of the 3-D border to draw around the outside of the label. The value may have any of the forms acceptable to Tk_GetPixels. Default is 1.

-anchor -- Specifies how the text in a label is to be displayed. Must be one of the values e, w, center. For example, 'center' means display the information such that it is centered in the label area. Default is 'w'.

-command -- Specifies a perl/Tk callback to associate with the label area.

-event -- The event associated with the -command. Any valid event pattern defined in the Tk/bind man page should be valid. If no callback is specified by the -command option, this value is ignored. Default is '<Double-Button-1>'.

$sb->addProgressBar(options)

This method is used to add a progress bar section to the status bar widget, and can therefore accept all the same arguments that a Tk-Progressbar can accept. Some widget-specific options and options of interest are listed below.

-length -- Specifies the desired narrow dimension of the ProgressBar in screen units (i.e. any of the forms acceptable to Tk_GetPixels). If specified, sets a fixed length for the progress bar. If no length is specifid, the progress bar will expand as needed to fill the remainder of the statusbar. If more than one statusbar section exists without a fixed width, those sections will equally share the space of the statusbar.

-borderwidth -- Specifies a non-negative value indicating the width of the 3-D border to draw around the outside of the progress bar. The value may have any of the forms acceptable to Tk_GetPixels. Default is 1.

-relief -- Specifies the 3-D effect desired for the widget. Acceptable values are raised, sunken, flat, ridge, solid, and groove. The value indicates how the interior of the widget should appear relative to its exterior; for example, raised means the interior of the widget should appear to protrude from the screen, relative to the exterior of the widget. Default is 'sunken'.

-side -- Be default, all widgets are packed from the left. If you would like to alter the packing order, you can choose to pack an item on the right. Default is 'left'.

$sb->hide()

Hides the statusbar.

$sb->show()

Shows the statusbar if previously hidden.

TODO

    - Allow icons to be embedded in the status bar.

    - Improve this documentation.

INSTALLATION

    perl Makefile.PL
    make
    make install

or

    Just put the StatusBar.pm file somewhere where Perl can find it.
    The StatusBar is written in pure perl.

AUTHOR

Shawn Zabel -- zabel@cpan.org

COPYRIGHT AND LICENSE

Copyright (C) 2004 by Shawn Zabel

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.2 or, at your option, any later version of Perl 5 you may have available.