X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/4860d40db4a78d8c2fd20d0b7b75136d749050eb..aa0ff209bc82d0f7c48263bb28609769d09f051b:/docs/latex/wx/uri.tex diff --git a/docs/latex/wx/uri.tex b/docs/latex/wx/uri.tex index 604188ada6..ee47d04936 100644 --- a/docs/latex/wx/uri.tex +++ b/docs/latex/wx/uri.tex @@ -15,8 +15,7 @@ wxURI is used to extract information from a URI (Uniform Resource Identifier). For information about URIs, see -\urlref{RFC 2396}{http://www.ietf.org/rfc/rfc2396.txt} or -\urlref{RFC 2396.bis (Updated draft of RFC 2396)}{http://www.gbiv.com/protocols/uri/rev-2002/rfc2396bis.html}. +\urlref{RFC 3986}{http://www.ietf.org/rfc/rfc3986.txt}. In short, a URL \em{is} a URI. In other words, URL is a subset of a URI - all @@ -35,7 +34,11 @@ furthur functionality. \wxheading{Include files} - + + +\wxheading{See also} + +\helpref{wxURL}{wxurl} \latexignore{\rtfignore{\wxheading{Members}}} @@ -47,7 +50,7 @@ one of the following methods \helpref{GetScheme}{wxurigetscheme}\\ \helpref{GetUserInfo}{wxurigetuserinfo}\\ \helpref{GetServer}{wxurigetserver}\\ -\helpref{GetPort}{wxurigetserver}\\ +\helpref{GetPort}{wxurigetport}\\ \helpref{GetPath}{wxurigetpath}\\ \helpref{GetQuery}{wxurigetquery}\\ \helpref{GetFragment}{wxurigetfragment} @@ -56,7 +59,7 @@ However, you should check HasXXX before calling a get method, which determines whether or not the component referred to by the method is defined according to RFC 2396. -Consider an undefined component equivilent to a +Consider an undefined component equivalent to a NULL C string.\\ \\ \helpref{HasScheme}{wxurihasscheme}\\ @@ -76,6 +79,12 @@ if(myuri.HasScheme()) protocol = myuri.GetScheme(); \end{verbatim} +\membersection{Deviations from the RFC}\label{deviationsfromrfc} + +Note that on URIs with a "file" scheme wxURI does not +parse the userinfo, server, or port portion. This is to keep +compatability with wxFileSystem, the old wxURL, and older url specifications. + \membersection{wxURI::wxURI}\label{wxuriwxuri} \func{}{wxURI}{\void} @@ -99,7 +108,7 @@ Copies this URI from another URI. \constfunc{wxString}{BuildURI}{\void} -Builds the URI from its individual components and adds proper seperators. +Builds the URI from its individual components and adds proper separators. If the URI is not a reference or is not resolved, the URI that is returned from Get is the same one @@ -110,7 +119,7 @@ passed to Create. \constfunc{wxString}{BuildUnescapedURI}{\void} -Builds the URI from its individual components, adds proper seperators, and +Builds the URI from its individual components, adds proper separators, and returns escape sequences to normal characters. Note that it is preferred to call this over Unescape(BuildURI()) since @@ -119,7 +128,7 @@ Note that it is preferred to call this over Unescape(BuildURI()) since \membersection{wxURI::Create}\label{wxuricreate} -\func{const wxChar*}{Create}{\param{const wxChar* }{uri}} +\func{const wxChar*}{Create}{\param{const wxString&}{uri}} Creates this URI from the string \arg{uri}. @@ -302,7 +311,7 @@ Returns \true if the Scheme component of the URI exists. Returns \true if the Server component of the URI exists. -\membersection{wxURI::HasUser}\label{wxurihasuser} +\membersection{wxURI::HasUser}\label{wxurihasuserinfo} \constfunc{bool}{HasUser}{\void} @@ -345,7 +354,7 @@ of the base's is merged with this URI's path, resulting in the URI "http://mysite.com/john/mydir". \docparam{base}{Base URI to inherit from. Must be a full URI and not a reference} -\docparam{flags}{Currently either \texttt{wxURI\_STRICT} or $0$, in non strict +\docparam{flags}{Currently either \texttt{wxURI\_STRICT} or $0$, in non-strict mode some compatibility layers are enabled to allow loopholes from RFCs prior to 2396}