git.saurik.com Git - wxWidgets.git/blame_incremental

... / ...

Commit	Line	Data
	1	%
	2	% automatically generated by HelpGen from
	3	% htmlfilter.tex at 29/Mar/99 18:35:09
	4	%
	5
	6	\section{\class{wxHtmlFilter}}\label{wxhtmlfilter}
	7
	8	This class is the parent class of input filters for \helpref{wxHtmlWindow}{wxhtmlwindow}.
	9	It allows you to read and display files of different file formats.
	10
	11	\wxheading{Derived from}
	12
	13	\helpref{wxObject}{wxobject}
	14
	15	\wxheading{Include files}
	16
	17	<wx/html/htmlfilt.h>
	18
	19	\wxheading{Library}
	20
	21	\helpref{wxHtml}{librarieslist}
	22
	23
	24	\wxheading{See Also}
	25
	26	\helpref{Overview}{filters}
	27
	28	\latexignore{\rtfignore{\wxheading{Members}}}
	29
	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
	40	Returns true if this filter is capable of reading file {\it file}.
	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
	53	\func{wxString}{ReadFile}{\param{const wxFSFile\& }{file}}
	54
	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	{
	62	return "<html><body><img src=\"" +
	63	file.GetLocation() +
	64	"\"></body></html>";
	65	}
	66	\end{verbatim}
	67