]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/url.tex
fix warning
[wxWidgets.git] / docs / latex / wx / url.tex
index c1515239d93ef383cd1c7cb04708fb3b303e6553..187ab2bc42d2b28f16707c9a4d1e7ac96d596a71 100644 (file)
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxURL::wxURL}\label{wxurlconstr}
+\membersection{wxURL::wxURL}\label{wxurlctor}
 
 \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}
 
 \docparam{url}{Url string to parse.}
 
-\membersection{wxURL::\destruct{wxURL}}
+\membersection{wxURL::\destruct{wxURL}}\label{wxurldtor}
 
 \func{}{\destruct{wxURL}}{\void}
 
@@ -47,7 +51,7 @@ Destroys the URL object.
 %
 % GetProtocolName
 %
-\membersection{wxURL::GetProtocolName}
+\membersection{wxURL::GetProtocolName}\label{wxurlgetprotocolname}
 
 \constfunc{wxString}{GetProtocolName}{\void}
 
@@ -56,7 +60,7 @@ Returns the name of the protocol which will be used to get the URL.
 %
 % GetProtocol
 %
-\membersection{wxURL::GetProtocol}
+\membersection{wxURL::GetProtocol}\label{wxurlgetprotocol}
 
 \func{wxProtocol\&}{GetProtocol}{\void}
 
@@ -65,7 +69,7 @@ Returns a reference to the protocol which will be used to get the URL.
 %
 % GetPath
 %
-\membersection{wxURL::GetPath}
+\membersection{wxURL::GetPath}\label{wxurlgetpath}
 
 \func{wxString}{GetPath}{\void}
 
@@ -74,7 +78,7 @@ Returns the path of the file to fetch. This path was encoded in the URL.
 %
 % GetError
 %
-\membersection{wxURL::GetError}
+\membersection{wxURL::GetError}\label{wxurlgeterror}
 
 \constfunc{wxURLError}{GetError}{\void}
 
@@ -89,18 +93,18 @@ 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}%
 
 %
 % GetInputStream
 %
-\membersection{wxURL::GetInputStream}
+\membersection{wxURL::GetInputStream}\label{wxurlgetinputstream}
 
 \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}
@@ -145,7 +149,7 @@ Sets the proxy to use for this URL.
 %
 % SetProxy
 %
-\membersection{wxURL::ConvertToValidURI}
+\membersection{wxURL::ConvertToValidURI}\label{wxurlconverttovaliduri}
 
 \func{static wxString}{ConvertToValidURI}{\param{const wxString\&}{ uri}}