Some documentation enhancements for wxRichTextCtrl

[wxWidgets.git] / docs / latex / wx / htparser.tex

diff --git a/docs/latex/wx/htparser.tex b/docs/latex/wx/htparser.tex
index f198bb9887eecb8a6b3d179ce8df1a5bc3942def..bc373af4be7d1fae66828dedf25457b5263ab87f 100644 (file)
--- a/docs/latex/wx/htparser.tex
+++ b/docs/latex/wx/htparser.tex
@@ -5,7 +5,7 @@
 
 \section{\class{wxHtmlParser}}\label{wxhtmlparser}
 
-This class handles the {\bf generic} parsing of HTML document: it scans
+Classes derived from this handle the {\bf generic} parsing of HTML documents: it scans
 the document and divide it into blocks of tags (where one block
 consists of beginning and ending tag and of text between these
 two tags).
@@ -145,7 +145,8 @@ of {\it OpenURL} in derived class.
 
 \wxheading{Parameters}
 
-\docparam{type}{Indicates type of the resource. Is one of
+\docparam{type}{Indicates type of the resource. Is one of:
+
 \begin{twocollist}\itemsep=0pt
 \twocolitem{{\bf wxHTML\_URL\_PAGE}}{Opening a HTML page.}
 \twocolitem{{\bf wxHTML\_URL\_IMAGE}}{Opening an image.}
@@ -187,11 +188,9 @@ The method does these things:
 
 You shouldn't use InitParser, DoParsing, GetProduct or DoneParser directly.
 
-
-
 \membersection{wxHtmlParser::PushTagHandler}\label{wxhtmlparserpushtaghandler}
 
-\func{void}{PushTagHandler}{\param{wxHtmlTagHandler* }{handler}, \param{wxString }{tags}}
+\func{void}{PushTagHandler}{\param{wxHtmlTagHandler* }{handler}, \param{const wxString\& }{tags}}
 
 Forces the handler to handle additional tags 
 (not returned by \helpref{GetSupportedTags}{wxhtmltaghandlergetsupportedtags}). 
@@ -256,3 +255,12 @@ Sets the virtual file system that will be used to request additional
 files. (For example {\tt <IMG>} tag handler requests wxFSFile with the
 image data.)
 
+\membersection{wxHtmlParser::StopParsing}\label{wxhtmlparserstopparsing}
+
+\func{void}{StopParsing}{\void}
+
+Call this function to interrupt parsing from a tag handler. No more tags
+will be parsed afterward. This function may only be called from
+\helpref{wxHtmlParser::Parse}{wxhtmlparserparse} or any function called
+by it (i.e. from tag handlers).
+