wxRuby Documentation Home

Wx::HtmlFilter

This class is the parent class of input filters for HtmlWindow. It allows you to read and display files of different file formats.

Derived from

Object

See Also

Overview

Methods

HtmlFilter.new

HtmlFilter#can_read

Boolean can_read(FSFile file)

Returns true if this filter is capable of reading file file.

Example:

bool MyFilter::CanRead(const FSFile& file)
{
    return (file.GetMimeType() == "application/x-ugh");
}

HtmlFilter#read_file

String read_file(FSFile file)

Reads the file and returns string with HTML document.

Example:

String MyImgFilter::ReadFile(const FSFile& file)
{
    return "<img src=\"" +
           file.GetLocation() +
       "\">";
}

[This page automatically generated from the Textile source at Thu Aug 28 20:29:11 +0100 2008]