other interface revisions of html headers

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@56518 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-10-25 20:44:52 +00:00
parent 4e10de45a6
commit 5bddd46dde
7 changed files with 667 additions and 748 deletions

View File

@@ -13,9 +13,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 +28,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 "<html><body><img src=\"" + file.GetLocation() +
"\"></body></html>";
}
@endcode
*/
virtual wxString ReadFile(const wxFSFile& file) const = 0;
};