view release on metacpan or  search on metacpan

lib/Tk/YANoteBook.pm  view on Meta::CPAN

package Tk::YANoteBook;

=head1 NAME

Tk::YANoteBook - Yet another NoteBook widget

=cut

use strict;
use warnings;
use Carp;
use vars qw($VERSION);
$VERSION = '0.10';

use Tk;
require Tk::YANoteBook::NameTab;

use base qw(Tk::Derived Tk::Frame);
Construct Tk::Widget 'YANoteBook';

=head1 SYNOPSIS

 require Tk::YANoteBook;
 my $nb = $window->YANoteBook(@options)->pack;

=head1 DESCRIPTION

A more flexible notebook widget. It does well in a multi document environment.

You can select any side where the tabs will be placed.

You can drag tabs with your mouse.

It has an overload if tabs won't fit any more.

You can specify a close button for a tab. Besides that every
tab contains an indicator that is hidden by default. You can
set it to alert the end user for pending actions on the tab.

=head1 CONFIG VARIABLES

=over 4

=item Switch: B<-autoupdate>

Default value 1. The widget automatically updates the tab bar after
a change is made. You can switch this off, make some massive changes,
then change it back on to have only one update call.

Corresponds with the B<autoupdate> method below.

=item Name: B<-backPageColor>

=item Class: B<-BackPageColor>

=item Switch: B<-backpagecolor>

Background color for the tab frame.

=item Switch: B<-closeimage>

Image for the close button on each tab.
Default value is the I<close_icon.xpm> in this distribution.

=item Switch: B<-closetabcall>

Calback, called when you press the close button on a tab. By default it calls B<deletePage>.
If you replace it, you should call B<deletePage> in your callback for the page to actually be removed.

=item Switch: B<-indicatorimage>

Image for the indicator. Not defined by default.

=item Switch: B<-indicatortext>

Text for the indicator. Not defined by default.

=item Switch: B<-closetabcall>