]>
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 | ||
20 | \wxheading{See Also} | |
21 | ||
22 | \helpref{Overview}{filters} | |
23 | ||
24 | \latexignore{\rtfignore{\wxheading{Members}}} | |
25 | ||
26 | \membersection{wxHtmlFilter::wxHtmlFilter}\label{wxhtmlfilterwxhtmlfilter} | |
27 | ||
28 | \func{}{wxHtmlFilter}{\void} | |
29 | ||
30 | Constructor. | |
31 | ||
32 | \membersection{wxHtmlFilter::CanRead}\label{wxhtmlfiltercanread} | |
33 | ||
34 | \func{bool}{CanRead}{\param{const wxFSFile\& }{file}} | |
35 | ||
36 | Returns true if this filter is capable of reading file {\it file}. | |
37 | ||
38 | Example: | |
39 | ||
40 | \begin{verbatim} | |
41 | bool MyFilter::CanRead(const wxFSFile& file) | |
42 | { | |
43 | return (file.GetMimeType() == "application/x-ugh"); | |
44 | } | |
45 | \end{verbatim} | |
46 | ||
47 | \membersection{wxHtmlFilter::ReadFile}\label{wxhtmlfilterreadfile} | |
48 | ||
49 | \func{wxString}{ReadFile}{\param{const wxFSFile\& }{file}} | |
50 | ||
51 | Reads the file and returns string with HTML document. | |
52 | ||
53 | Example: | |
54 | ||
55 | \begin{verbatim} | |
56 | wxString MyImgFilter::ReadFile(const wxFSFile& file) | |
57 | { | |
58 | return "<html><body><img src=\"" + | |
59 | file.GetLocation() + | |
60 | "\"></body></html>"; | |
61 | } | |
62 | \end{verbatim} | |
63 |