NAME

App::MathImage::Wx::Perl::PodBrowser -- POD browser window

SYNOPSIS

use App::MathImage::Wx::Perl::PodBrowser;
my $browser = App::MathImage::Wx::Perl::PodBrowser->new;
$browser->Show;
$browser->goto_pod (module => 'Foo::Bar');

CLASS HIERARCHY

App::MathImage::Wx::Perl::PodBrowser
  Wx::Frame

DESCRIPTION

In progress, mostly working ...

This is a simple POD documentation browser using Wx::RichTextCtrl. The menus and any links in the text can be followed to other documents.

+-------------------------------------------+
| File  Section  Help                       |
+-------------------------------------------+
| NAME                                      |
|   Foo - some thing                        |
| DESCRIPTION                               |
|   Blah blah.                              |
| SEE ALSO                                  |
|   Bar                                     |
+-------------------------------------------+
|                                           |
+-------------------------------------------+

Programming

The initial window size follows the 80x30 initial size of the PodRichText widget. Program code or user interaction can make it bigger or smaller later as desired.

The menubar is available from the usual frame $browser->GetMenuBar to make additions or modifications. The quit menu item is Wx::wxID_EXIT and closes the window with the usual frame $browser->Close(). In a multi-window program this just closes the PodBrowser window, it doesn't exit the whole program.

FUNCTIONS

$browser = App::MathImage::Wx::Perl::PodBrowser->new ()

$browser = App::MathImage::Wx::Perl::PodBrowser->new ($parent, $id, $title)

Create and return a new browser window widget.

The $parent, $id and $title arguments are per Wx::Frame->new().

The default $title is "POD Browser". An application using it for a help display could give something more specific if desired, either at creation or later with $window->SetTitle() in the usual way.

SEE ALSO

Wx, Wx::Perl::PodEditor Tk::Pod, Gtk2::Ex::PodViewer

HOME PAGE

http://user42.tuxfamily.org/math-image/index.html

LICENSE

Copyright 2012 Kevin Ryde

Math-Image is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3, or (at your option) any later version.

Math-Image is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with Math-Image. If not, see <http://www.gnu.org/licenses/>.