]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/url.tex
Applied patch [ 827011 ] Event-based processing of item tooltips in wxTreeCtrl
[wxWidgets.git] / docs / latex / wx / url.tex
index 4f845db4be76b6808e055d7951caefd420590f5a..7c1a4a3b7ee4fbd195d92a750dd37db9dabfbec1 100644 (file)
 
 \func{}{wxURL}{\param{const wxString\&}{ url}}
 
-Constructs an URL object from the string.
+Constructs a URL object from the string.  The URL must be valid according
+to RFC 1738.  In particular, file URLs must be of the format
+'file://hostname/path/to/file'.  It is valid to leave out the hostname
+but slashes must remain in place-- i.e. a file URL without a hostname must
+contain three consecutive slashes.
 
 \wxheading{Parameters}
 
@@ -89,7 +93,7 @@ It can be one of these errors:
 \twocolitem{{\bf wxURL\_NOHOST}}{An host name is required for this protocol.}
 \twocolitem{{\bf wxURL\_NOPATH}}{A path is required for this protocol.}
 \twocolitem{{\bf wxURL\_CONNERR}}{Connection error.}
-\twocolitem{{\bf wxURL\_PROTOERR}}{An error occured during negotiation.}
+\twocolitem{{\bf wxURL\_PROTOERR}}{An error occurred during negotiation.}
 \end{twocollist}%
 
 %
@@ -100,7 +104,7 @@ It can be one of these errors:
 \func{wxInputStream *}{GetInputStream}{\void}
 
 Creates a new input stream on the the specified URL. You can use all but seek
-functionnality of wxStream. Seek isn't available on all stream. For example,
+functionality of wxStream. Seek isn't available on all stream. For example,
 http or ftp streams doesn't deal with it.
 
 \wxheading{Return value}
@@ -109,8 +113,7 @@ Returns the initialized stream. You will have to delete it yourself.
 
 \wxheading{See also}
 
-%\helpref{wxInputStream}{wxinputstream}
-wxInputStream
+\helpref{wxInputStream}{wxinputstream}
 
 %
 % SetDefaultProxy
@@ -152,3 +155,4 @@ Sets the proxy to use for this URL.
 
 It converts a non-standardized URI to a valid network URI. It encodes non
 standard characters.
+