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

NAME

FLTK::HelpView - Basic HTML viewer

Description

Most HTML 2.0 elements are supported, as well as a primitive implementation of tables. GIF, JPEG, and PNG images are displayed inline.

Functions

directory

my $dir = $helpview->directory( );

filename

my $file = $helpview->filename( );

find

my $ok = $helpview->find( $string, $start );

Find the specified string in the current help text. This is a plain text search.

Returns 0 on success. Returns -1 on failure.

leftline

$helpview->leftline( $col );

Set the left position.

my $col = $helpview->leftline( );

Get the left position.

load

my $result = $helpview->load( $filename );

Load the specified file. Returns 0 on success and -1 on error

new

my $hv = $helpview->new( $x, $y, $w, $h, $label );

Creates a new HelpView.

size

my $pixels = $helpview->size( );

textcolor

$helpview->textcolor( $color );
my $color = $helpview->textcolor( );

textfont

$helpview->textfont( $font );
my $font = $helpview->textfont( );

textsize

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

title

my $str = $helpview->title( );

topline

$helpview->topline( $string );

Sets the top line to the named line.

$helpview->topline( $index );

Sets the top line to the indexth line.

my $num = $helpview->topline( );

Retusn the index of the current top line.

value

$helpview->value( $string );

Set the help text directly.

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

Get the current help text.

Subclassing

Note that HelpView may not be subclassed like every other widget in FLTK because fltk::HelpView::draw( ) and fltk::HelpView::handle( ... ) are private. If I subclass them, I lose basic functionality because I cannot access those functions from a child class.

This is a "bug" and I'll report it when I have the time.

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.