X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/47261ba05fa6fcc3cc304a3746363956ed67a3ff..1de1196ab3ad5c0f143870b1bf5568adcf383424:/docs/latex/wx/uri.tex diff --git a/docs/latex/wx/uri.tex b/docs/latex/wx/uri.tex index 6b06deb7f0..3fcdb05674 100644 --- a/docs/latex/wx/uri.tex +++ b/docs/latex/wx/uri.tex @@ -45,7 +45,7 @@ To obtain individual components you can use one of the following methods \helpref{GetScheme}{wxurigetscheme}\\ -\helpref{GetUser}{wxurigetuser}\\ +\helpref{GetUserInfo}{wxurigetuserinfo}\\ \helpref{GetServer}{wxurigetserver}\\ \helpref{GetPort}{wxurigetserver}\\ \helpref{GetPath}{wxurigetpath}\\ @@ -56,11 +56,11 @@ 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}\\ -\helpref{HasUser}{wxurihasuser}\\ +\helpref{HasUserInfo}{wxurihasuserinfo}\\ \helpref{HasServer}{wxurihasserver}\\ \helpref{HasPort}{wxurihasserver}\\ \helpref{HasPath}{wxurihaspath}\\ @@ -119,7 +119,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}. @@ -156,6 +156,18 @@ wxURI::HostType: \twocolitem{{\bf wxURI\_IPVFUTURE}}{Server is an IP address, but not versions 4 or 6} \end{twocollist} + +\membersection{wxURI::GetPassword}\label{wxurigetpassword} + +\constfunc{const wxString&}{GetPassword}{\void} + +Returns the password part of the userinfo component of +this URI. Note that this is explicitly depreciated by +RFC 1396 and should generally be avoided if possible. + +\tt{http://:@mysite.com/mypath} + + \membersection{wxURI::GetPath}\label{wxurigetpath} \constfunc{const wxString&}{GetPath}{\void} @@ -229,12 +241,24 @@ server component. \constfunc{const wxString&}{GetUser}{\void} -Returns the User component of the URI. +Returns the username part of the userinfo component of +this URI. Note that this is explicitly depreciated by +RFC 1396 and should generally be avoided if possible. + +\tt{http://:@mysite.com/mypath} + + +\membersection{wxURI::GetUserInfo}\label{wxurigetuserinfo} + +\constfunc{const wxString&}{GetUserInfo}{\void} + +Returns the UserInfo component of the URI. The component of a URI before the server component that is postfixed by a '@' character. -\tt{http://@mysite.com/mypath} +\tt{http://@mysite.com/mypath} + \membersection{wxURI::HasFragment}\label{wxurihasfragment} @@ -242,12 +266,14 @@ that is postfixed by a '@' character. Returns \true if the Fragment component of the URI exists. + \membersection{wxURI::HasPath}\label{wxurihaspath} \constfunc{bool}{HasPath}{\void} Returns \true if the Path component of the URI exists. + \membersection{wxURI::HasPort}\label{wxurihasport} \constfunc{bool}{HasPort}{\void} @@ -276,7 +302,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} @@ -320,7 +346,7 @@ of the base's is merged with this URI's path, resulting in the URI \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 -mode some compatability layers are enabled to allow loopholes from RFCs prior +mode some compatibility layers are enabled to allow loopholes from RFCs prior to 2396} \membersection{wxURI::Unescape}\label{wxuriunescape}