Slaven Rezić > Tk-Pod-0.9942 > Tk::Pod

Download:
Tk-Pod-0.9942.tar.gz

Dependencies

Annotate this POD

Related Modules

Text::English
Module::Build
HTML::Parser
AI::NNFlex
IO::Handle
more...
By perlmonks.org

CPAN RT

Open  1
View/Report Bugs
Module Version: 5.40   Source  

NAME ^

Tk::Pod - Pod browser toplevel widget

SYNOPSIS ^

    use Tk::Pod

    Tk::Pod->Dir(@dirs)                 # add dirs to search path for Pod

    $pod = $parent->Pod(
                -file = > $name,        # search and display Pod for name
                -tree = > $bool         # display pod file tree
                );

DESCRIPTION ^

Simple Pod browser with hypertext capabilities in a Toplevel widget

OPTIONS ^

-tree

Set tree view by default on or off. Default is false.

-exitbutton

Add to the menu an exit entry. This is only useful for standalone pod readers. Default is false. This option can only be set on construction time.

Other options are propagated to the embedded Tk::Pod::Text widget.

BUGS ^

If you set -file while creating the Pod widget,

    $parent->Pod(-tree => 1, -file => $pod);

then the title will not be displayed correctly. This is because the internal setting of -title may override the title setting caused by -file. So it is better to configure -file separately:

    $pod = $parent->Pod(-tree => 1);
    $pod->configure(-file => $pod);

SEE ALSO ^

Tk::Pod_usage, Tk::Pod::Text, tkpod, perlpod, Gtk2::Ex::PodViewer, Prima::PodView.

AUTHOR ^

Nick Ing-Simmons <nick@ni-s.u-net.com>

Current maintainer is Slaven Rezic <slaven@rezic.de>.

Copyright (c) 1997-1998 Nick Ing-Simmons. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

syntax highlighting: