X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/6cc4e6b81a9f2a0275d7fa0c6171658b24a2af8a..bcf576ccfe754a634034203aa133c02fb5d2f964:/docs/latex/wx/htparser.tex diff --git a/docs/latex/wx/htparser.tex b/docs/latex/wx/htparser.tex index 91dd28305d..b5a4f47a60 100644 --- a/docs/latex/wx/htparser.tex +++ b/docs/latex/wx/htparser.tex @@ -7,7 +7,7 @@ This class handles the {\bf generic} parsing of HTML document: it scans the document and divide it into blocks of tags (where one block -consists of begining and ending tag and of text between these +consists of beginning and ending tag and of text between these two tags). It is independent from wxHtmlWindow and can be used as stand-alone parser @@ -15,7 +15,7 @@ It is independent from wxHtmlWindow and can be used as stand-alone parser see InetGet sample for example). It uses system of tag handlers to parse the HTML document. Tag handlers -are not staticaly shared by all instances but are created for each +are not statically shared by all instances but are created for each wxHtmlParser instance. The reason is that the handler may contain document-specific temporary data used during parsing (e.g. complicated structures like tables). @@ -48,7 +48,7 @@ Constructor. \func{void}{AddTag}{\param{const wxHtmlTag\& }{tag}} -This may (and may not) be overwriten in derived class. +This may (and may not) be overwritten in derived class. This method is called each time new tag is about to be added. {\it tag} contains information about the tag. (See \helpref{wxHtmlTag}{wxhtmltag} @@ -76,7 +76,7 @@ All handlers are deleted on object deletion. \func{virtual void}{AddWord}{\param{const char* }{txt}} -Must be overwriten in derived class. +Must be overwritten in derived class. This method is called by \helpref{DoParsing}{wxhtmlparserdoparsing} each time a part of text is parsed. {\it txt} is NOT only one word, it is @@ -140,12 +140,13 @@ in derived class) Opens given URL and returns {\tt wxFSFile} object that can be used to read data from it. This method may return NULL in one of two cases: either the URL doesn't -point to any valid resource or the URL is blocked by overriden implementation +point to any valid resource or the URL is blocked by overridden implementation 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,8 +188,6 @@ 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}} @@ -256,3 +255,12 @@ Sets the virtual file system that will be used to request additional files. (For example {\tt } 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). +