526954c596
Use "wxWindows licence" and not "wxWidgets licence" (the latter doesn't exist) and consistently spell "licence" using British spelling. See #12165. git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@64940 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
54 lines
1.4 KiB
Objective-C
54 lines
1.4 KiB
Objective-C
/////////////////////////////////////////////////////////////////////////////
|
|
// Name: html/htmlfilt.h
|
|
// Purpose: interface of wxHtmlFilter
|
|
// Author: wxWidgets team
|
|
// RCS-ID: $Id$
|
|
// Licence: wxWindows licence
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
/**
|
|
@class wxHtmlFilter
|
|
|
|
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{html}
|
|
|
|
@see @ref overview_html_filters
|
|
*/
|
|
class wxHtmlFilter : public wxObject
|
|
{
|
|
public:
|
|
/**
|
|
Constructor.
|
|
*/
|
|
wxHtmlFilter();
|
|
|
|
/**
|
|
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;
|
|
};
|
|
|