X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/ae3c17b4013e80b99976c750c19fca47729517f6..92c0fc34c104c8d7c12d6a3b78ea232690fc23f4:/interface/wx/html/htmlfilt.h diff --git a/interface/wx/html/htmlfilt.h b/interface/wx/html/htmlfilt.h index 9a40dbcff1..db317bf3eb 100644 --- a/interface/wx/html/htmlfilt.h +++ b/interface/wx/html/htmlfilt.h @@ -2,21 +2,19 @@ // Name: html/htmlfilt.h // Purpose: interface of wxHtmlFilter // Author: wxWidgets team -// RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// /** @class wxHtmlFilter - @headerfile htmlfilt.h wx/html/htmlfilt.h This class is the parent class of input filters for wxHtmlWindow. 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 { @@ -29,13 +27,26 @@ public: /** 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 "

"; + } + @endcode */ - wxString ReadFile(const wxFSFile& file); + virtual wxString ReadFile(const wxFSFile& file) const = 0; };