// Purpose: interface of wxHtmlFilter
// Author: wxWidgets team
// RCS-ID: $Id$
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/**
It allows you to read and display files of different file formats.
@library{wxhtml}
- @category{FIXME}
+ @category{html}
- @see Overview()
+ @see @ref overview_html_filters
*/
class wxHtmlFilter : public wxObject
{
/**
Returns @true if this filter is capable of reading file @e file.
Example:
+ @code
+ bool MyFilter::CanRead(const wxFSFile& file)
+ {
+ return (file.GetMimeType() == "application/x-ugh");
+ }
+ @endcode
*/
- bool CanRead(const wxFSFile& file);
+ virtual bool CanRead(const wxFSFile& file) const = 0;
/**
Reads the file and returns string with HTML document.
Example:
+ @code
+ wxString MyImgFilter::ReadFile(const wxFSFile& file)
+ {
+ return "<html><body><img src=\"" + file.GetLocation() +
+ "\"></body></html>";
+ }
+ @endcode
*/
- wxString ReadFile(const wxFSFile& file);
+ virtual wxString ReadFile(const wxFSFile& file) const = 0;
};