Slaven Rezić > Tk-Pod-0.9941 > Tk::Pod::Tree

Download:
Tk-Pod-0.9941.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  1
View/Report Bugs
Module Version: 5.10   Source   Latest Release: Tk-Pod-0.9942

NAME ^

Tk::Pod::Tree - list Pod file hierarchy

SYNOPSIS ^

    use Tk::Pod::Tree;

    $parent->PodTree;

WIDGET-SPECIFIC OPTIONS ^

Name: -showcommand

Specifies a callback for selecting a Pod module (Button-1 binding).

Name: -showcommand2

Specifies a callback for selecting a Pod module in a different window (Button-2 binding).

Name: -usecache

True, if a cache of Pod modules should be created and used. The default is true.

DESCRIPTION ^

The Tk::Pod::Tree widget shows all available Perl Pod documentation in a tree.

WIDGET METHODS ^

$tree->Fill(?-nocache => 1?, ?-forked => 0|1?, ?-fillcb => ...?)

Find Pod modules and fill the tree widget. If -nocache is specified, then no cache will be used for loading.

A cache of Pod modules is written unless the -usecache configuration option of the widget is set to false.

If -forked is specified, then searching for Pods is done in the background, if possible. Note that the default is currently unspecified.

A callback may be specified with the -fillcb option and will be called after the tree is filled.

$tree->SeePath($path)

Move the anchor/selection and view to the given $path and open subtrees to make the $path visible, if necessary.

SEE ALSO ^

Tk::Tree, Tk::Pod, tkpod, Tk::Pod::FindPods.

AUTHOR ^

Slaven Rezić <slaven@rezic.de>

Copyright (c) 2001,2004 Slaven Rezić. 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: