/ 
FLTK-0.532008
River stage zero No dependents
/ FLTK::HelpDialog

NAME

FLTK::HelpDialog - Help dialog with basic HTML viewing capabilities

Description

Uses HelpView to display basic HTML in a standard dialog.

Functions

destroy

$helpdialog->destroy( );

Destroy the HelpDialog.

h

my $h = $helpdialog->h( );

Returns the vertical size of the help dialog.

hide

$helpdialog->hide( );

Hides the HelpDialog.

load

$helpdialog->load( $filename );

Load the specified HTML file into the HelpView.

new

my $hd = $helpdialog->new( );

Creates a new HelpDialog.

position

$helpdialog->position( $x, $y );

Move the HelpDialog to a new position.

resize

$helpdialog->resize( $x, $y, $w, $h );

Set the screen position and size of the HelpDialog of the dialog.

show

$helpdialog->show( );

Shows the main HelpDialog's window.

textsize

$helpdialog->textsize( $size );

Sets the default text size for the help view.

my $size = $helpdialog->textsize( );

Gets the default text size for the help view.

topline

$helpdialog->topline( $string );

Sets the top line in the HelpView widget to the named line.

$helpdialog->topline( $index );

Sets the top line in the HelpView widget to the indexth line.

value

$helpdialog->value( $string );

Sets the current buffer to the string provided and reformats the text.

my $string = $helpdialog->value( );

Returns the current buffer.

visible

my $visible = $helpdialog->visible( );

Returns 1 if the HelpDialog window is visible.

w

my $w = $helpdialog->w( );

Returns the horizontal size of the help dialog.

x

my $x = $helpdialog->x( );

Returns the position of the help dialog.

y

my $y = $helpdialog->y( );

Returns the position of the help dialog.

Author

Sanko Robinson <sanko@cpan.org> - http://sankorobinson.com/

License and Legal

Copyright (C) 2008-2010 by Sanko Robinson <sanko@cpan.org>

This program is free software; you can redistribute it and/or modify it under the terms of The Artistic License 2.0. See the LICENSE file included with this distribution or notes on the Artistic License 2.0 for clarification.

When separated from the distribution, all original POD documentation is covered by the Creative Commons Attribution-Share Alike 3.0 License. See the clarification of the CCA-SA3.0.