Peter Lavender > Padre-1.00 > Padre::Wx::HtmlWindow

Download:
Padre-1.00.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 1.00   Source  

NAME ^

Padre::Wx::HtmlWindow - Padre-enhanced version of Wx::HtmlWindow

DESCRIPTION ^

Padre::Wx::HtmlWindow provides a Padre-specific subclass of Wx::HtmlWindow that adds some additional features, primarily default support for pod2html functionality.

METHODS ^

Padre::Wx::HtmlWindow implements all the methods described in the documentation for Wx::HtmlWindow, and adds some additional methods.

load_file

  $html_window->load_file('my.pod');

The load_file method takes a file name, loads the file, transforms it to HTML via the default Padre::Pod2HTML processor, and then loads the HTML into the window.

Returns true on success, or throws an exception on error.

load_file

  $html_window->load_pod( "=head1 NAME\n" );

The load_file method takes a string of POD content, transforms it to HTML via the default Padre::Pod2HTML processor, and then loads the HTML into the window.

Returns true on success, or throws an exception on error.

load_html

  $html_window->load_html( "<head><body>Hello World!</body></html>" );

The load_html method takes a string of HTML content, and loads the HTML into the window.

The method is provided mainly as a convenience, it's main role is to act as the callback handler for background rendering tasks.

SUPPORT ^

See the main Padre documentation.

AUTHOR ^

Adam Kennedy <adamk@cpan.org>

COPYRIGHT ^

Copyright 2008-2013 The Padre development team as listed in Padre.pm.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

The full text of the license can be found in the LICENSE file included with this module.

syntax highlighting: