view release on metacpan or  search on metacpan

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

package Tk::PodViewer;

use strict;
use warnings;
use vars qw($VERSION);
$VERSION = '0.08';
use base qw(Tk::Derived Tk::Frame);

Construct Tk::Widget 'PodViewer';

use Tk;
require Tk::ROText;
require Tk::Font;
use Pod::Simple::PullParser;

use Config;
my $mswin = 0;
$mswin = 1 if $Config{'osname'} eq 'MSWin32';

my @derivedtags = ('B', 'C', 'F', 'I', 'L', 'S');
my $derivedreg = qr/^([^BCFILS]*)([BCFILS]*)$/;

=head1 NAME

Tk::PodViewer - Simple ROText based pod viewer.

=head1 SYNOPSIS

 my $podviewer = $app->PodViewer->pack;
 $podviewer->load('SomePerlFileWithPod.pm');

=head1 DESCRIPTION

Tk::PodViewer is a simple pod viewer.
It inherits L<Tk::Frame>, but delegates all options and many
methods to L<Tk::ROText>.

It supports most of the pod tags. It ignores the following tags:

=over 4

 =begin
 =end
 =for
 X<>
 Z<>

=back

=head1 OPTIONS

=over 4

=item Switch: B<-fixedfontfamily>

Default value 'Hack'. Specifies the font family for tags that require a fixed font
family.

=item Switch: B<-loadcall>

Callback called at the end of each load. Receives the source determinator
as parameter.

=item Name: B<linkColor>

=item Class: B<LinkColor>