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