[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 the parent class of input filters for \helpref{wxHtmlWindow}{wxhtmlwindow}.
It allows you to read and display files of different file formats.

\wxheading{Derived from}

\helpref{wxObject}{wxobject}

\wxheading{Include files}

<wx/html/htmlfilt.h>

\wxheading{Library}

\helpref{wxHtml}{librarieslist}


\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
f6e9a818	8	This class is the parent class of input filters 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
9704b250 VS	13	\helpref{wxObject}{wxobject}
	14
	15	\wxheading{Include files}
	16
	17	<wx/html/htmlfilt.h>
	18
a7af285d VZ	19	\wxheading{Library}
	20
	21	\helpref{wxHtml}{librarieslist}
	22
704a4b75 VS	23
	24	\wxheading{See Also}
	25
	26	\helpref{Overview}{filters}
	27
	28	\latexignore{\rtfignore{\wxheading{Members}}}
	29
704a4b75 VS	30	\membersection{wxHtmlFilter::wxHtmlFilter}\label{wxhtmlfilterwxhtmlfilter}
	31
	32	\func{}{wxHtmlFilter}{\void}
	33
	34	Constructor.
	35
	36	\membersection{wxHtmlFilter::CanRead}\label{wxhtmlfiltercanread}
	37
	38	\func{bool}{CanRead}{\param{const wxFSFile\& }{file}}
	39
cc81d32f	40	Returns true if this filter is capable of reading file {\it file}.
704a4b75 VS	41
	42	Example:
	43
	44	\begin{verbatim}
	45	bool MyFilter::CanRead(const wxFSFile& file)
	46	{
	47	return (file.GetMimeType() == "application/x-ugh");
	48	}
	49	\end{verbatim}
	50
	51	\membersection{wxHtmlFilter::ReadFile}\label{wxhtmlfilterreadfile}
	52
3660fc40 RD	53	\func{wxString}{ReadFile}{\param{const wxFSFile\& }{file}}
3660fc40 RD	54
704a4b75 VS	55	Reads the file and returns string with HTML document.
	56
	57	Example:
	58
	59	\begin{verbatim}
	60	wxString MyImgFilter::ReadFile(const wxFSFile& file)
	61	{
3660fc40 RD	62	return "<html><body><img src=\"" +
3660fc40 RD	63	file.GetLocation() +
704a4b75 VS	64	"\"></body></html>";
	65	}
	66	\end{verbatim}
3660fc40	67