[wxWidgets.git] / docs / latex / wx / htfilter.tex

%
% automatically generated by HelpGen from
% htmlfilter.tex at 29/Mar/99 18:35:09
%

\section{\class{wxHtmlFilter}}\label{wxhtmlfilter}

This class is an input filter for \helpref{wxHtmlWindow}{wxhtmlwindow}.
It allows you to read and display files of different file formats.

\wxheading{Derived from}

wxObject

\wxheading{See Also}

\helpref{Overview}{filters}

\latexignore{\rtfignore{\wxheading{Members}}}

\membersection{wxHtmlFilter::wxHtmlFilter}\label{wxhtmlfilterwxhtmlfilter}

\func{}{wxHtmlFilter}{\void}

Constructor.

\membersection{wxHtmlFilter::CanRead}\label{wxhtmlfiltercanread}

\func{bool}{CanRead}{\param{const wxFSFile\& }{file}}

Returns TRUE if this filter is capable of reading file {\it file}.

Example:

\begin{verbatim}
bool MyFilter::CanRead(const wxFSFile& file)
{
    return (file.GetMimeType() == "application/x-ugh");
}
\end{verbatim}

\membersection{wxHtmlFilter::ReadFile}\label{wxhtmlfilterreadfile}

\func{wxString}{ReadFile}{\param{const wxFSFile\& }{file}}

Reads the file and returns string with HTML document.

Example:

\begin{verbatim}
wxString MyImgFilter::ReadFile(const wxFSFile& file)
{
    return "<html><body><img src=\"" +
           file.GetLocation() +
	   "\"></body></html>";
}
\end{verbatim}
Commit	Line	Data
704a4b75 VS	1	%
	2	% automatically generated by HelpGen from
	3	% htmlfilter.tex at 29/Mar/99 18:35:09
	4	%
	5
704a4b75 VS	6	\section{\class{wxHtmlFilter}}\label{wxhtmlfilter}
704a4b75 VS	7
448af9a4	8	This class is an input filter for \helpref{wxHtmlWindow}{wxhtmlwindow}.
704a4b75 VS	9	It allows you to read and display files of different file formats.
	10
	11	\wxheading{Derived from}
	12
	13	wxObject
	14
	15	\wxheading{See Also}
	16
	17	\helpref{Overview}{filters}
	18
	19	\latexignore{\rtfignore{\wxheading{Members}}}
	20
704a4b75 VS	21	\membersection{wxHtmlFilter::wxHtmlFilter}\label{wxhtmlfilterwxhtmlfilter}
	22
	23	\func{}{wxHtmlFilter}{\void}
	24
	25	Constructor.
	26
	27	\membersection{wxHtmlFilter::CanRead}\label{wxhtmlfiltercanread}
	28
	29	\func{bool}{CanRead}{\param{const wxFSFile\& }{file}}
	30
3660fc40	31	Returns TRUE if this filter is capable of reading file {\it file}.
704a4b75 VS	32
	33	Example:
	34
	35	\begin{verbatim}
	36	bool MyFilter::CanRead(const wxFSFile& file)
	37	{
	38	return (file.GetMimeType() == "application/x-ugh");
	39	}
	40	\end{verbatim}
	41
	42	\membersection{wxHtmlFilter::ReadFile}\label{wxhtmlfilterreadfile}
	43
3660fc40 RD	44	\func{wxString}{ReadFile}{\param{const wxFSFile\& }{file}}
3660fc40 RD	45
704a4b75 VS	46	Reads the file and returns string with HTML document.
	47
	48	Example:
	49
	50	\begin{verbatim}
	51	wxString MyImgFilter::ReadFile(const wxFSFile& file)
	52	{
3660fc40 RD	53	return "<html><body><img src=\"" +
3660fc40 RD	54	file.GetLocation() +
704a4b75 VS	55	"\"></body></html>";
	56	}
	57	\end{verbatim}
3660fc40	58