Tk::Pod::Text - Pod browser widget
use Tk::Pod::Text; $pod = $parent->Scrolled("PodText", -file => $file, -scrollbars => "osoe", ); $file = $pod->cget('-path'); # ?? the name path is confusing :-(
Tk::Pod::Text is a readonly text widget that can display Pod documentation.
The named (pod) file to be displayed.
Return the expanded path of the currently displayed Pod. Useable only with the
A callback to be called if parsing and displaying of the Pod is done.
Set the wrap mode. Default is
The position of the scrollbars, see also Tk::Scrolled. By default, the vertical scrollbar is on the right on Windows systems and on the left on X11 systems.
Note that it is not necessary and usually will do the wrong thing if you put a
Tk::Pod::Text widget into a
Other options are propagated to the embedded Tk::More widget.
Turn debugging mode on if set to a true value.
Use the specified program for printing the current pod. If the string contains a
%s, then filename substitution is used, otherwise the filename of the Pod document is appended to the value of
TKPODPRINT. Here is a silly example to send the Pod to a web browser:
env TKPODPRINT="pod2html %s > %s.html; galeon %s.html" tkpod ...
Use the specified program for editing the current pod. If
TKPODEDITOR is not specified then the first defined value of
EDITOR is used on Unix. As a last fallback,
vi are used, depending on platform and existance of a terminal.
Use the specified program as the manpage viewer. The manpage viewer should accept a manpage URL (
man://manpage(section)). Alternatively the special viewer "internal" may be used. As fallback, the default GNOME and/or KDE manpage viewer will be called.
See TODO file of Tk-Pod distribution
For PodText see Tk::Pod::Text.
fixed width font.
Text in slant italics.
A <=for> paragraph is hidden between here
A file: /usr/local/bin/perl. A variable $a without markup.
boofar is in S<>.
Indexed items are not supported in Tk::Pod.
Unicode outside Latin1 range: € (euro sign).
Pod with umlaut: ExtUtils::MakeMaker.
Details: perlpod or perl, perlfunc.
Here some code in a as is paragraph
use Tk; my $mw = MainWindow->new; ... MainLoop __END__
fixed, bold, italics, normal, or file /path/to/a/file
Non-breakable text: The quick brown fox jumps over the lazy fox.
Modern Pod constructs (multiple <>): italic,
fixed with embedded < and >.
Itemize with numbers:
Itemize with bullets:
Other Pod docu: Tk::Font, Tk::BrowseEntry (not underlined, but double-clickable in Tk::Pod)
Nick Ing-Simmons <email@example.com>
Current maintainer is Slaven Rezić <firstname.lastname@example.org>.
Copyright (c) 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.