[wxWidgets.git] / interface / html / htmlfilt.h

/////////////////////////////////////////////////////////////////////////////
// Name:        html/htmlfilt.h
// Purpose:     documentation for wxHtmlFilter class
// Author:      wxWidgets team
// RCS-ID:      $Id$
// Licence:     wxWindows license
/////////////////////////////////////////////////////////////////////////////

/**
    @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}
    
    @seealso
    Overview
*/
class wxHtmlFilter : public wxObject
{
public:
    /**
        Constructor.
    */
    wxHtmlFilter();

    /**
        Returns @true if this filter is capable of reading file @e file.
        
        Example:
    */
    bool CanRead(const wxFSFile& file);

    /**
        Reads the file and returns string with HTML document.
        
        Example:
    */
    wxString ReadFile(const wxFSFile& file);
};
Commit	Line	Data
23324ae1 FM	1	/////////////////////////////////////////////////////////////////////////////
	2	// Name: html/htmlfilt.h
	3	// Purpose: documentation for wxHtmlFilter class
	4	// Author: wxWidgets team
	5	// RCS-ID: $Id$
	6	// Licence: wxWindows license
	7	/////////////////////////////////////////////////////////////////////////////
	8
	9	/**
	10	@class wxHtmlFilter
	11	@headerfile htmlfilt.h wx/html/htmlfilt.h
	12
	13	This class is the parent class of input filters for wxHtmlWindow.
	14	It allows you to read and display files of different file formats.
	15
	16	@library{wxhtml}
	17	@category{FIXME}
	18
	19	@seealso
	20	Overview
	21	*/
	22	class wxHtmlFilter : public wxObject
	23	{
	24	public:
	25	/**
	26	Constructor.
	27	*/
	28	wxHtmlFilter();
	29
	30	/**
	31	Returns @true if this filter is capable of reading file @e file.
	32
	33	Example:
	34	*/
	35	bool CanRead(const wxFSFile& file);
	36
	37	/**
	38	Reads the file and returns string with HTML document.
	39
	40	Example:
	41	*/
	42	wxString ReadFile(const wxFSFile& file);
	43	};