X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/da1ed74c85f53a75a193c7dcbd2013aa266a222c..92c0fc34c104c8d7c12d6a3b78ea232690fc23f4:/interface/wx/html/htmlfilt.h diff --git a/interface/wx/html/htmlfilt.h b/interface/wx/html/htmlfilt.h index 695ab88d7c..db317bf3eb 100644 --- a/interface/wx/html/htmlfilt.h +++ b/interface/wx/html/htmlfilt.h @@ -2,8 +2,7 @@ // Name: html/htmlfilt.h // Purpose: interface of wxHtmlFilter // Author: wxWidgets team -// RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// /** @@ -13,9 +12,9 @@ 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 { @@ -28,12 +27,25 @@ 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 */ 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 */ virtual wxString ReadFile(const wxFSFile& file) const = 0; };