X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/ea2a647d388cd9952d2eb1415f038e0ab15151b6..575821fad84c6f60602ffce6f8f6e727247ce651:/interface/wx/uri.h diff --git a/interface/wx/uri.h b/interface/wx/uri.h index 0d1002a7be..962f8e4064 100644 --- a/interface/wx/uri.h +++ b/interface/wx/uri.h @@ -3,7 +3,7 @@ // Purpose: interface of wxURI // Author: wxWidgets team // RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// /** @@ -20,11 +20,9 @@ enum wxURIHostType /** @class wxURI - wxURI is used to extract information from a URI (Uniform Resource - Identifier). + wxURI is used to extract information from a URI (Uniform Resource Identifier). - For information about URIs, see RFC 3986 - . + For information about URIs, see RFC 3986 (http://www.ietf.org/rfc/rfc3986.txt). In short, a URL is a URI. In other words, URL is a subset of a URI - all acceptable URLs are also acceptable URIs. @@ -33,7 +31,7 @@ enum wxURIHostType chance of wxURI "failing" on construction/creation. wxURI supports copy construction and standard assignment operators. wxURI - can also be inherited from to provide furthur functionality. + can also be inherited from to provide further functionality. To obtain individual components you can use one of the GetXXX() methods. However, you should check HasXXX() before calling a get method, which @@ -42,17 +40,16 @@ enum wxURIHostType to a @NULL C string. Example: - @code - //protocol will hold the http protocol (i.e. "http") - wxString protocol; - wxURI myuri("http://mysite.com"); - if( myuri.HasScheme() ) - protocol = myuri.GetScheme(); + // protocol will hold the http protocol (i.e. "http") + wxString protocol; + wxURI myuri("http://mysite.com"); + if( myuri.HasScheme() ) + protocol = myuri.GetScheme(); @endcode @note On URIs with a "file" scheme wxURI does not parse the userinfo, - server, or port portion. This is to keep compatability with + server, or port portion. This is to keep compatibility with wxFileSystem, the old wxURL, and older url specifications. @library{wxbase} @@ -245,7 +242,7 @@ public: /** Returns @true if the User component of the URI exists. */ - bool HasUser() const; + bool HasUserInfo() const; /** Returns @true if a valid [absolute] URI, otherwise this URI is a URI @@ -276,8 +273,7 @@ public: void Resolve(const wxURI& base, int flags = wxURI_STRICT); /** - Translates all escape sequences (normal characters and returns the - result. + Translates all escape sequences (normal characters and returns the result. If you want to unescape an entire wxURI, use BuildUnescapedURI() instead, as it performs some optimizations over this method.