X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/9704b2509ac4fd7b9fccd5299e0b377accb2b59e..552861bf308cf2fd12f786a5443d379b55f63d81:/docs/latex/wx/htparser.tex

diff --git a/docs/latex/wx/htparser.tex b/docs/latex/wx/htparser.tex
index fea721c027..f198bb9887 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).
@@ -30,7 +30,6 @@ wxObject
 
 <wx/html/htmlpars.h>
 
-
 \wxheading{See also}
 
 \helpref{Cells Overview}{cells},
@@ -49,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}
@@ -77,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
@@ -104,7 +103,7 @@ This must be called after DoParsing().
 \constfunc{wxFileSystem*}{GetFS}{\void}
 
 Returns pointer to the file system. Because each tag handler has
-reference to it's parent parser it can easily request the file by
+reference to it is parent parser it can easily request the file by
 calling
 
 \begin{verbatim}
@@ -132,9 +131,43 @@ Returns pointer to the source being parsed.
 
 \func{virtual void}{InitParser}{\param{const wxString\& }{source}}
 
-Setups the parser for parsing the {\it source} string. (Should be overriden
+Setups the parser for parsing the {\it source} string. (Should be overridden
 in derived class)
 
+\membersection{wxHtmlParser::OpenURL}\label{wxhtmlparseropenurl}
+
+\func{virtual wxFSFile*}{OpenURL}{\param{wxHtmlURLType }{type}, \param{const wxString\& }{url}}
+
+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 overridden implementation
+of {\it OpenURL} in derived class.
+
+\wxheading{Parameters}
+
+\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.}
+\twocolitem{{\bf wxHTML\_URL\_OTHER}}{Opening a resource that doesn't fall into
+any other category.}
+\end{twocollist}}
+
+\docparam{url}{URL being opened.}
+
+\wxheading{Notes}
+
+Always use this method in tag handlers instead of {\tt GetFS()->OpenFile()} 
+because it can block the URL and is thus more secure.
+
+Default behaviour is to call \helpref{wxHtmlWindow::OnOpeningURL}{wxhtmlwindowonopeningurl}
+of the associated wxHtmlWindow object (which may decide to block the URL or
+redirect it to another one),if there's any, and always open the URL if the 
+parser is not used with wxHtmlWindow.
+
+Returned {\tt wxFSFile} object is not guaranteed to point to {\it url}, it might
+have been redirected!
+
 \membersection{wxHtmlParser::Parse}\label{wxhtmlparserparse}
 
 \func{wxObject*}{Parse}{\param{const wxString\& }{source}}
@@ -189,7 +222,7 @@ It is obvious that you cannot use only one tag handler for <param> tag.
 Instead you must use context-sensitive handlers for <param> inside <myitems>
 and <param> inside <execute>.        
 
-This is the prefered solution:
+This is the preferred solution:
 
 \begin{verbatim}
 TAG_HANDLER_BEGIN(MYITEM, "MYITEMS")
