Blame lib/Pod/Perldoc/ToTk.pm

Packit a38e86
package Pod::Perldoc::ToTk;
Packit a38e86
use strict;
Packit a38e86
use warnings;
Packit a38e86
Packit a38e86
use vars qw($VERSION);
Packit a38e86
$VERSION = '3.28';
Packit a38e86
Packit a38e86
use parent qw(Pod::Perldoc::BaseTo);
Packit a38e86
Packit a38e86
sub is_pageable        { 1 }
Packit a38e86
sub write_with_binmode { 0 }
Packit a38e86
sub output_extension   { 'txt' } # doesn't matter
Packit a38e86
sub if_zero_length { }  # because it will be 0-length!
Packit a38e86
sub new { return bless {}, ref($_[0]) || $_[0] }
Packit a38e86
Packit a38e86
# TODO: document these and their meanings...
Packit a38e86
sub tree      { shift->_perldoc_elem('tree'    , @_) }
Packit a38e86
sub tk_opt    { shift->_perldoc_elem('tk_opt'  , @_) }
Packit a38e86
sub forky     { shift->_perldoc_elem('forky'   , @_) }
Packit a38e86
Packit a38e86
use Pod::Perldoc ();
Packit a38e86
use File::Spec::Functions qw(catfile);
Packit a38e86
Packit a38e86
BEGIN{ # Tk is not core, but this is
Packit a38e86
  eval { require Tk } ||
Packit a38e86
  __PACKAGE__->die( <<"HERE" );
Packit a38e86
You must have the Tk module to use Pod::Perldoc::ToTk.
Packit a38e86
If you have it installed, ensure it's in your Perl library
Packit a38e86
path.
Packit a38e86
HERE
Packit a38e86
Packit a38e86
  __PACKAGE__->die(
Packit a38e86
    __PACKAGE__,
Packit a38e86
    " doesn't work nice with Tk.pm version $Tk::VERSION"
Packit a38e86
    ) if $Tk::VERSION eq '800.003';
Packit a38e86
  }
Packit a38e86
Packit a38e86
Packit a38e86
BEGIN { eval { require Tk::FcyEntry; }; };
Packit a38e86
BEGIN{ # Tk::Pod is not core, but this is
Packit a38e86
  eval { require Tk::Pod } ||
Packit a38e86
  __PACKAGE__->die( <<"HERE" );
Packit a38e86
You must have the Tk::Pod module to use Pod::Perldoc::ToTk.
Packit a38e86
If you have it installed, ensure it's in your Perl library
Packit a38e86
path.
Packit a38e86
HERE
Packit a38e86
  }
Packit a38e86
Packit a38e86
# The following was adapted from "tkpod" in the Tk-Pod dist.
Packit a38e86
Packit a38e86
sub parse_from_file {
Packit a38e86
Packit a38e86
    my($self, $Input_File) = @_;
Packit a38e86
    if($self->{'forky'}) {
Packit a38e86
      return if fork;  # i.e., parent process returns
Packit a38e86
    }
Packit a38e86
Packit a38e86
    $Input_File =~ s{\\}{/}g
Packit a38e86
     if $self->is_mswin32 or $self->is_dos
Packit a38e86
     # and maybe OS/2
Packit a38e86
    ;
Packit a38e86
Packit a38e86
    my($tk_opt, $tree);
Packit a38e86
    $tree   = $self->{'tree'  };
Packit a38e86
    $tk_opt = $self->{'tk_opt'};
Packit a38e86
Packit a38e86
    #require Tk::ErrorDialog;
Packit a38e86
Packit a38e86
    # Add 'Tk' subdirectories to search path so, e.g.,
Packit a38e86
    # 'Scrolled' will find doc in 'Tk/Scrolled'
Packit a38e86
Packit a38e86
    if( $tk_opt ) {
Packit a38e86
      push @INC, grep -d $_, map catfile($_,'Tk'), @INC;
Packit a38e86
    }
Packit a38e86
Packit a38e86
    my $mw = MainWindow->new();
Packit a38e86
    #eval 'use blib "/home/e/eserte/src/perl/Tk-App";require Tk::App::Debug';
Packit a38e86
    $mw->withdraw;
Packit a38e86
Packit a38e86
    # CDE use Font Settings if available
Packit a38e86
    my $ufont = $mw->optionGet('userFont','UserFont');     # fixed width
Packit a38e86
    my $sfont = $mw->optionGet('systemFont','SystemFont'); # proportional
Packit a38e86
    if (defined($ufont) and defined($sfont)) {
Packit a38e86
        foreach ($ufont, $sfont) { s/:$//; };
Packit a38e86
        $mw->optionAdd('*Font',       $sfont);
Packit a38e86
        $mw->optionAdd('*Entry.Font', $ufont);
Packit a38e86
        $mw->optionAdd('*Text.Font',  $ufont);
Packit a38e86
    }
Packit a38e86
Packit a38e86
    $mw->optionAdd('*Menu.tearOff', $Tk::platform ne 'MSWin32' ? 1 : 0);
Packit a38e86
Packit a38e86
    $mw->Pod(
Packit a38e86
      '-file' => $Input_File,
Packit a38e86
      (($Tk::Pod::VERSION >= 4) ? ('-tree' => $tree) : ())
Packit a38e86
    )->focusNext;
Packit a38e86
Packit a38e86
    # xxx dirty but it works. A simple $mw->destroy if $mw->children
Packit a38e86
    # does not work because Tk::ErrorDialogs could be created.
Packit a38e86
    # (they are withdrawn after Ok instead of destory'ed I guess)
Packit a38e86
Packit a38e86
    if ($mw->children) {
Packit a38e86
        $mw->repeat(1000, sub {
Packit a38e86
                    # ErrorDialog is withdrawn not deleted :-(
Packit a38e86
                    foreach ($mw->children) {
Packit a38e86
                            return if "$_" =~ /^Tk::Pod/  # ->isa('Tk::Pod')
Packit a38e86
                    }
Packit a38e86
                    $mw->destroy;
Packit a38e86
                });
Packit a38e86
    } else {
Packit a38e86
        $mw->destroy;
Packit a38e86
    }
Packit a38e86
    #$mw->WidgetDump;
Packit a38e86
    MainLoop();
Packit a38e86
Packit a38e86
    exit if $self->{'forky'}; # we were the child!  so exit now!
Packit a38e86
    return;
Packit a38e86
}
Packit a38e86
Packit a38e86
1;
Packit a38e86
__END__
Packit a38e86
Packit a38e86
Packit a38e86
=head1 NAME
Packit a38e86
Packit a38e86
Pod::Perldoc::ToTk - let Perldoc use Tk::Pod to render Pod
Packit a38e86
Packit a38e86
=head1 SYNOPSIS
Packit a38e86
Packit a38e86
  perldoc -o tk Some::Modulename &
Packit a38e86
Packit a38e86
=head1 DESCRIPTION
Packit a38e86
Packit a38e86
This is a "plug-in" class that allows Perldoc to use
Packit a38e86
Tk::Pod as a formatter class.
Packit a38e86
Packit a38e86
You have to have installed Tk::Pod first, or this class won't load.
Packit a38e86
Packit a38e86
=head1 SEE ALSO
Packit a38e86
Packit a38e86
L<Tk::Pod>, L<Pod::Perldoc>
Packit a38e86
Packit a38e86
=head1 AUTHOR
Packit a38e86
Packit a38e86
Current maintainer: Mark Allen C<< <mallen@cpan.org> >>
Packit a38e86
Packit a38e86
Past contributions from:
Packit a38e86
brian d foy C<< <bdfoy@cpan.org> >>
Packit a38e86
Adriano R. Ferreira C<< <ferreira@cpan.org> >>;
Packit a38e86
Sean M. Burke C<< <sburke@cpan.org> >>;
Packit a38e86
significant portions copied from
Packit a38e86
F<tkpod> in the Tk::Pod dist, by Nick Ing-Simmons, Slaven Rezic, et al.
Packit a38e86
Packit a38e86
=cut
Packit a38e86