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

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

/**
    @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;
};
Commit	Line	Data
23324ae1 FM	1	/////////////////////////////////////////////////////////////////////////////
23324ae1 FM	2	// Name: html/htmlfilt.h
e54c96f1	3	// Purpose: interface of wxHtmlFilter
23324ae1 FM	4	// Author: wxWidgets team
	5	// RCS-ID: $Id$
	6	// Licence: wxWindows license
	7	/////////////////////////////////////////////////////////////////////////////
	8
	9	/**
	10	@class wxHtmlFilter
7c913512	11
23324ae1 FM	12	This class is the parent class of input filters for wxHtmlWindow.
23324ae1 FM	13	It allows you to read and display files of different file formats.
7c913512	14
23324ae1	15	@library{wxhtml}
5bddd46d	16	@category{html}
7c913512	17
5bddd46d	18	@see @ref overview_html_filters
23324ae1 FM	19	*/
	20	class wxHtmlFilter : public wxObject
	21	{
	22	public:
	23	/**
	24	Constructor.
	25	*/
	26	wxHtmlFilter();
	27
	28	/**
	29	Returns @true if this filter is capable of reading file @e file.
23324ae1	30	Example:
5bddd46d FM	31	@code
	32	bool MyFilter::CanRead(const wxFSFile& file)
	33	{
	34	return (file.GetMimeType() == "application/x-ugh");
	35	}
	36	@endcode
23324ae1	37	*/
da1ed74c	38	virtual bool CanRead(const wxFSFile& file) const = 0;
23324ae1 FM	39
	40	/**
	41	Reads the file and returns string with HTML document.
23324ae1	42	Example:
5bddd46d FM	43	@code
	44	wxString MyImgFilter::ReadFile(const wxFSFile& file)
	45	{
	46	return "<html><body><img src=\"" + file.GetLocation() +
	47	"\"></body></html>";
	48	}
	49	@endcode
23324ae1	50	*/
da1ed74c	51	virtual wxString ReadFile(const wxFSFile& file) const = 0;
23324ae1	52	};
e54c96f1	53