The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

Tk::AppWindow::Ext::Help - about box and help facilities

SYNOPSIS

 my $app = new Tk::AppWindow(@options,
    -extensions => ['Help'],
 );
 $app->MainLoop;

DESCRIPTION

Adds a help facility and an about box to your application. Initiates menu entries for them.

CONFIG VARIABLES

Switch: -aboutinfo

Specify the link to a hash. Possible keys:

author

Your name

components

Specify a list of modules you want the version numbers displayed. Opens a new tab.

email

Who to contact

http

The website that supports this application

license

Specify your license. By default it is set to Same as Perl. Set it to undef if you do not want it to show.

licensefile

Specify a plain text file as your license file. It is displayed in a new tab with a Tk::ROText widget.

Works only if the license key is defined. Specify the weblink to your license. By default it is set to https://dev.perl.org/licenses/. Set it to undef if you do not want it to show.

version

Specify the version of your application. By default it is set to the version numer of the main window widget. Set it to undef if you do not want it to show.

Switch: -helpfile

Point to your help file. Can be a weblink. If it is a .pod file it will launch a dialog box with a PodText widget.

COMMANDS

The following commands are defined.

about

Pops the about box.

help

Loads the helpfile in your system's default application or browser.

METHODS

moduleVersion($module)

Returns the version number of $module. Returns undef if the module is not found.

AUTHOR

Hans Jeuken (hanje at cpan dot org)

BUGS

Unknown. If you find any, please contact the author.

SEE ALSO

Tk::AppWindow
Tk::AppWindow::BaseClasses::Extension