Skaman Sam Tyler > CPANPLUS-Shell-Wx-0.04 > CPANPLUS::Shell::Wx::PODReader

Download:
CPANPLUS-Shell-Wx-0.04.tar.gz

Annotate this POD

CPAN RT

New  2
Open  0
View/Report Bugs
Source  

NAME ^

CPANPLUS::Shell::Wx::PODReader - GUI POD Reader

SYNOPSIS ^

    use Wx qw[:allclasses];
    use CPANPLUS::Shell::Wx::PODReader;

    local *Wx::App::OnInit = sub{1};
    my $app = Wx::App->new();
    Wx::InitAllImageHandlers();

    my $frame_podreader = CPANPLUS::Shell::Wx::PODReader::Frame->new();

    $app->SetTopWindow($frame_podreader);
    $frame_podreader->Show(1);
    $app->MainLoop();
    .....
    $frame_podreader->Search($module_name,$where)

also

    $podReader=CPANPLUS::Shell::Wx::PODReader::Embed->new($notebook);
    $notebook->AddPage($podReader,"POD Reader");

DESCRIPTION ^

There are two types of PODReader: a windowed version, CPANPLUS::Shell::Wx::PODReader::Frame (a Wx::Frame), and a version which can be embedded within other Wx::Windows, CPANPLUS::Shell::Wx::PODReader::Emed (a Wx::Panel). They both have only one method, Search().

GUI DESCRIPTION ^

The GUI contains 3 basic entities: a Search Bar, the Status Text, and the Tabs.

Search Bar

The search bar contains a Find button, which enacts the Search() facility, a ComboBox, which is where you can type in the text to search for, and the type box, where you can select where you want to search for the documentation. It looks like this: Find $text in $where. The search box displays the previous 10 successful searches between sessions, in $HOME/.wxPODReader/searches.txt. You can type in the location of a file in this box to see the POD for that file.

Status Text

Some status information is displayed here.

Tabs

There are 4 tabs available: "Builtin Methods", "FAQ", "Module" and "Source". They correspond to the values in the 'type' dropdown list. Only the relevant tabs are displayed per search.

METHODS ^

$podreader->Search($text,$where)

This method searches for pod documentation, using the perldoc command.

$text

The text to search for. Can be anything.

$where

The place to look for documentation. Can be any one of "All", "Builtin Methods", "FAQ", "Modules" or "Sources". The default is 'All', which searches through all documentation, and displays only the tabs that contain the result. For example, a search for CPANPLUS will only show the Source and Module tab.

SEE ALSO ^

CPAN, CPANPLUS, CPANPLUS::Shell::Tk

website: http://wxcpan.googlecode.com mailing-list: wxcpan@googlegroups.com mailing-list website: http://groups.google.com/group/wxcpan

AUTHOR ^

Skaman Sam Tyler, <skamansam@gmail.com> website: http://rbe.homeip.net

COPYRIGHT AND LICENSE ^

Copyright (C) 2008 by Skaman Sam Tyler

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.8 or, at your option, any later version of Perl 5 you may have available.

syntax highlighting: