X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/22d6efa851642c6a69174278fc50f712f41e2271..027aa6fa77e5b4643d2296f63d6911beb496c5bc:/docs/latex/wx/url.tex diff --git a/docs/latex/wx/url.tex b/docs/latex/wx/url.tex index 664c004f99..187ab2bc42 100644 --- a/docs/latex/wx/url.tex +++ b/docs/latex/wx/url.tex @@ -28,17 +28,21 @@ \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} @@ -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 @@ -146,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}}