]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/htfilter.tex
Documented new constructor and overloaded Create methods.
[wxWidgets.git] / docs / latex / wx / htfilter.tex
index a07f36b53c4e2da153d65098d51f09385b96c31a..22caf024b2781f094a958cfacf50c42a17292e84 100644 (file)
@@ -3,15 +3,19 @@
 % htmlfilter.tex at 29/Mar/99 18:35:09
 %
 
-
 \section{\class{wxHtmlFilter}}\label{wxhtmlfilter}
 
-This class is input filter for \helpref{wxHtmlWindow}{wxhtmlwindow}.
+This class is an input filter for \helpref{wxHtmlWindow}{wxhtmlwindow}.
 It allows you to read and display files of different file formats.
 
 \wxheading{Derived from}
 
-wxObject
+\helpref{wxObject}{wxobject}
+
+\wxheading{Include files}
+
+<wx/html/htmlfilt.h>
+
 
 \wxheading{See Also}
 
@@ -19,7 +23,6 @@ wxObject
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-
 \membersection{wxHtmlFilter::wxHtmlFilter}\label{wxhtmlfilterwxhtmlfilter}
 
 \func{}{wxHtmlFilter}{\void}
@@ -30,7 +33,7 @@ Constructor.
 
 \func{bool}{CanRead}{\param{const wxFSFile\& }{file}}
 
-Returns TRUE if this filter is capable of reading file {\it file}. 
+Returns true if this filter is capable of reading file {\it file}.
 
 Example:
 
@@ -43,7 +46,7 @@ bool MyFilter::CanRead(const wxFSFile& file)
 
 \membersection{wxHtmlFilter::ReadFile}\label{wxhtmlfilterreadfile}
 
-\func{wxString}{ReadFile}{\param{const wxFSFile\& }{file}
+\func{wxString}{ReadFile}{\param{const wxFSFile\& }{file}}
 
 Reads the file and returns string with HTML document.
 
@@ -52,8 +55,9 @@ Example:
 \begin{verbatim}
 wxString MyImgFilter::ReadFile(const wxFSFile& file)
 {
-    return "<html><body><img src=\"" + 
-           file.GetLocation() + 
+    return "<html><body><img src=\"" +
+           file.GetLocation() +
           "\"></body></html>";
 }
 \end{verbatim}
+