]> git.saurik.com Git - wxWidgets.git/blame_incremental - docs/latex/wx/htfilter.tex
added new wxHF_ flags
[wxWidgets.git] / docs / latex / wx / htfilter.tex
... / ...
CommitLineData
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
8This class is an input filter for \helpref{wxHtmlWindow}{wxhtmlwindow}.
9It allows you to read and display files of different file formats.
10
11\wxheading{Derived from}
12
13wxObject
14
15\wxheading{See Also}
16
17\helpref{Overview}{filters}
18
19\latexignore{\rtfignore{\wxheading{Members}}}
20
21\membersection{wxHtmlFilter::wxHtmlFilter}\label{wxhtmlfilterwxhtmlfilter}
22
23\func{}{wxHtmlFilter}{\void}
24
25Constructor.
26
27\membersection{wxHtmlFilter::CanRead}\label{wxhtmlfiltercanread}
28
29\func{bool}{CanRead}{\param{const wxFSFile\& }{file}}
30
31Returns TRUE if this filter is capable of reading file {\it file}.
32
33Example:
34
35\begin{verbatim}
36bool 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
44\func{wxString}{ReadFile}{\param{const wxFSFile\& }{file}}
45
46Reads the file and returns string with HTML document.
47
48Example:
49
50\begin{verbatim}
51wxString MyImgFilter::ReadFile(const wxFSFile& file)
52{
53 return "<html><body><img src=\"" +
54 file.GetLocation() +
55 "\"></body></html>";
56}
57\end{verbatim}
58