X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/296ec7d3ac9047b1655b789506c02b2f5f13cabf..2c6f14e1a7b5062fcf77eda40824d820d9ac288e:/docs/latex/wx/url.tex diff --git a/docs/latex/wx/url.tex b/docs/latex/wx/url.tex index 5b9963ce1f..7c1a4a3b7e 100644 --- a/docs/latex/wx/url.tex +++ b/docs/latex/wx/url.tex @@ -32,7 +32,11 @@ \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} @@ -62,6 +66,15 @@ Returns the name of the protocol which will be used to get the URL. Returns a reference to the protocol which will be used to get the URL. +% +% GetPath +% +\membersection{wxURL::GetPath} + +\func{wxString}{GetPath}{\void} + +Returns the path of the file to fetch. This path was encoded in the URL. + % % GetError % @@ -80,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}% % @@ -91,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} @@ -100,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 @@ -134,3 +146,13 @@ Sets the proxy to use for this URL. \helpref{wxURL::SetDefaultProxy}{wxurlsetdefaultproxy} +% +% SetProxy +% +\membersection{wxURL::ConvertToValidURI} + +\func{static wxString}{ConvertToValidURI}{\param{const wxString\&}{ uri}} + +It converts a non-standardized URI to a valid network URI. It encodes non +standard characters. +