File: htfilter.tex

package info (click to toggle)
wxwidgets2.8 2.8.10.1-3
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 239,052 kB
  • ctags: 289,550
  • sloc: cpp: 1,838,857; xml: 396,717; python: 282,506; ansic: 126,171; makefile: 51,406; sh: 14,581; asm: 299; sql: 258; lex: 194; perl: 139; yacc: 128; pascal: 95; php: 39; lisp: 38; tcl: 24; haskell: 20; java: 18; cs: 18; erlang: 17; ruby: 16; ada: 9; ml: 9; csh: 9
file content (63 lines) | stat: -rw-r--r-- 1,336 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
%
% 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{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}