MF_BYCOMMAND is zero so don't try to test it

[wxWidgets.git] / docs / latex / wx / uri.tex

diff --git a/docs/latex/wx/uri.tex b/docs/latex/wx/uri.tex
index 761fd76830d79541c9a86efca77df77007131ba5..3fcdb0567418bbf24941a051dd80942301afea03 100644 (file)
--- a/docs/latex/wx/uri.tex
+++ b/docs/latex/wx/uri.tex
@@ -22,13 +22,16 @@ In short, a URL \em{is} a URI.  In other
 words, URL is a subset of a URI - all 
 acceptable URLs are also acceptable URIs.
 
 words, URL is a subset of a URI - all 
 acceptable URLs are also acceptable URIs.
 

+wxURI automatically escapes invalid characters in a string,
+so there is no 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.
 
 \wxheading{Derived from}
 
 wxURI supports copy construction and standard assignment
 operators.  wxURI can also be inherited from to provide
 furthur functionality.
 
 \wxheading{Derived from}
 

-No base class
+\helpref{wxObject}{wxobject}

 
 \wxheading{Include files}
 
 
 \wxheading{Include files}
 


@@ -36,13 +39,13 @@ No base class
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

-\membersection{Obtaining individual components}
+\membersection{Obtaining individual components}\label{obtainingwxuricomponents}

 
 To obtain individual components you can use 
 
 To obtain individual components you can use 

-one of the following methods:
+one of the following methods

 
 \helpref{GetScheme}{wxurigetscheme}\\
 
 \helpref{GetScheme}{wxurigetscheme}\\

-\helpref{GetUser}{wxurigetuser}\\
+\helpref{GetUserInfo}{wxurigetuserinfo}\\

 \helpref{GetServer}{wxurigetserver}\\
 \helpref{GetPort}{wxurigetserver}\\
 \helpref{GetPath}{wxurigetpath}\\
 \helpref{GetServer}{wxurigetserver}\\
 \helpref{GetPort}{wxurigetserver}\\
 \helpref{GetPath}{wxurigetpath}\\


@@ -50,10 +53,14 @@ one of the following methods:
 \helpref{GetFragment}{wxurigetfragment}
 
 However, you should check HasXXX before
 \helpref{GetFragment}{wxurigetfragment}
 
 However, you should check HasXXX before

-calling a get method:\\
- 
+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 equivalent to a 
+NULL C string.\\
+\\ 

 \helpref{HasScheme}{wxurihasscheme}\\
 \helpref{HasScheme}{wxurihasscheme}\\

-\helpref{HasUser}{wxurihasuser}\\
+\helpref{HasUserInfo}{wxurihasuserinfo}\\

 \helpref{HasServer}{wxurihasserver}\\
 \helpref{HasPort}{wxurihasserver}\\
 \helpref{HasPath}{wxurihaspath}\\
 \helpref{HasServer}{wxurihasserver}\\
 \helpref{HasPort}{wxurihasserver}\\
 \helpref{HasPath}{wxurihaspath}\\


@@ -88,23 +95,39 @@ Copies this URI from another URI.
 \docparam{uri}{URI (Uniform Resource Identifier) to initialize with}
 
 
 \docparam{uri}{URI (Uniform Resource Identifier) to initialize with}
 
 

-\membersection{wxURI::Create}\label{wxuricreate}
+\membersection{wxURI::BuildURI}\label{wxuribuilduri}

 
 

-\func{void}{Create}{\param{const wxChar* }{uri}}
+\constfunc{wxString}{BuildURI}{\void}

 
 

-Creates this URI from the string {\tt uri}.
+Builds the URI from its individual components and adds proper seperators.

 
 

-\docparam{uri}{string to initialize from}
+If the URI is not a reference or is not resolved, 
+the URI that is returned from Get is the same one 
+passed to Create.

 
 

-\membersection{wxURI::Get}\label{wxuriget}

 
 

-\constfunc{wxString}{Get}{\void}
+\membersection{wxURI::BuildUnescapedURI}\label{wxuribuildunescapeduri}

 
 

-Obtains the full URI.
+\constfunc{wxString}{BuildUnescapedURI}{\void}
+
+Builds the URI from its individual components, adds proper seperators, and
+returns escape sequences to normal characters.
+
+Note that it is preferred to call this over Unescape(BuildURI()) since
+\helpref{BuildUnescapedURI}{wxuribuildunescapeduri} performs some optimizations over the plain method.
+
+
+\membersection{wxURI::Create}\label{wxuricreate}
+
+\func{const wxChar*}{Create}{\param{const wxString&}{uri}}
+
+Creates this URI from the string \arg{uri}.
+
+Returns the position at which parsing stopped (there 
+is no such thing as an "invalid" wxURI).
+
+\docparam{uri}{string to initialize from}

 
 

-If the URI is not a reference or is not resolved, 
-the URI that is returned from Get is the same one 
-passed to Create.

 
 \membersection{wxURI::GetFragment}\label{wxurigetfragment}
 
 
 \membersection{wxURI::GetFragment}\label{wxurigetfragment}
 


@@ -133,6 +156,18 @@ wxURI::HostType:
 \twocolitem{{\bf wxURI\_IPVFUTURE}}{Server is an IP address, but not versions 4 or 6}
 \end{twocollist}
 
 \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://<user>:<password>@mysite.com/mypath}
+
+

 \membersection{wxURI::GetPath}\label{wxurigetpath}
 
 \constfunc{const wxString&}{GetPath}{\void}
 \membersection{wxURI::GetPath}\label{wxurigetpath}
 
 \constfunc{const wxString&}{GetPath}{\void}


@@ -206,82 +241,96 @@ server component.
 
 \constfunc{const wxString&}{GetUser}{\void}
 
 
 \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://<user>:<password>@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.
 
 
 The component of a URI before the server component
 that is postfixed by a '@' character.
 

-\tt{http://<user>@mysite.com/mypath}
+\tt{http://<userinfo>@mysite.com/mypath}
+

 
 \membersection{wxURI::HasFragment}\label{wxurihasfragment}
 
 \constfunc{bool}{HasFragment}{\void}
 
 
 \membersection{wxURI::HasFragment}\label{wxurihasfragment}
 
 \constfunc{bool}{HasFragment}{\void}
 

-Returns true if the Fragment component of the URI exists.
+Returns \true if the Fragment component of the URI exists.
+

 
 \membersection{wxURI::HasPath}\label{wxurihaspath}
 
 \constfunc{bool}{HasPath}{\void}
 
 
 \membersection{wxURI::HasPath}\label{wxurihaspath}
 
 \constfunc{bool}{HasPath}{\void}
 

-Returns true if the Path component of the URI exists.
+Returns \true if the Path component of the URI exists.
+

 
 \membersection{wxURI::HasPort}\label{wxurihasport}
 
 \constfunc{bool}{HasPort}{\void}
 
 
 \membersection{wxURI::HasPort}\label{wxurihasport}
 
 \constfunc{bool}{HasPort}{\void}
 

-Returns true if the Port component of the URI exists.
+Returns \true if the Port component of the URI exists.

 
 
 \membersection{wxURI::HasQuery}\label{wxurihasquery}
 
 \constfunc{bool}{HasQuery}{\void}
 
 
 
 \membersection{wxURI::HasQuery}\label{wxurihasquery}
 
 \constfunc{bool}{HasQuery}{\void}
 

-Returns true if the Query component of the URI exists.
+Returns \true if the Query component of the URI exists.

 
 
 \membersection{wxURI::HasScheme}\label{wxurihasscheme}
 
 \constfunc{bool}{HasScheme}{\void}
 
 
 
 \membersection{wxURI::HasScheme}\label{wxurihasscheme}
 
 \constfunc{bool}{HasScheme}{\void}
 

-Returns true if the Scheme component of the URI exists.
+Returns \true if the Scheme component of the URI exists.

 
 
 \membersection{wxURI::HasServer}\label{wxurihasserver}
 
 \constfunc{bool}{HasServer}{\void}
 
 
 
 \membersection{wxURI::HasServer}\label{wxurihasserver}
 
 \constfunc{bool}{HasServer}{\void}
 

-Returns true if the Server 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}
 
 
 \constfunc{bool}{HasUser}{\void}
 

-Returns true if the User component of the URI exists.
+Returns \true if the User component of the URI exists.

 
 
 \membersection{wxURI::IsReference}\label{wxuriisreference}
 
 \constfunc{bool}{IsReference}{\void}
 
 
 
 \membersection{wxURI::IsReference}\label{wxuriisreference}
 
 \constfunc{bool}{IsReference}{\void}
 

-Returns true if a valid [absolute] URI, otherwise this URI
+Returns \true if a valid [absolute] URI, otherwise this URI

 is a URI reference and not a full URI, and IsReference
 is a URI reference and not a full URI, and IsReference

-returns false.
+returns \false.

 
 
 \membersection{wxURI::operator ==}\label{wxurioperatorcompare}
 
 \func{void}{operator ==}{\param{const wxURI\& }{uricomp}}
 
 
 
 \membersection{wxURI::operator ==}\label{wxurioperatorcompare}
 
 \func{void}{operator ==}{\param{const wxURI\& }{uricomp}}
 

-Compares this URI to another URI, and returns true if 
-this URI equals {\tt uricomp}, otherwise it returns false.
+Compares this URI to another URI, and returns \true if 
+this URI equals \arg{uricomp}, otherwise it returns \false.

 
 \docparam{uricomp}{URI to compare to}
 
 
 \membersection{wxURI::Resolve}\label{wxuriresolve}
 
 
 \docparam{uricomp}{URI to compare to}
 
 
 \membersection{wxURI::Resolve}\label{wxuriresolve}
 

-\func{void}{Resolve}{\param{const wxURI\& }{base}, \param{const bool\& }{bStrict = true}}
+\func{void}{Resolve}{\param{const wxURI\& }{base}, \param{int }{flags = \texttt{wxURI\_STRICT}}}

 
 Inherits this URI from a base URI - components that do not
 exist in this URI are copied from the base, and if this URI's
 
 Inherits this URI from a base URI - components that do not
 exist in this URI are copied from the base, and if this URI's


@@ -296,6 +345,22 @@ 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}
 "http://mysite.com/john/mydir".
 
 \docparam{base}{Base URI to inherit from.  Must be a full URI and not a reference}

-\docparam{bStrict}{If false, some compatability layers are enabled to allow 
-                   loopholes from RFCs prior to 2396}
+\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}
+
+\membersection{wxURI::Unescape}\label{wxuriunescape}
+
+\func{wxString}{Unescape}{\param{const wxString\& }{uri}}
+
+Translates all escape sequences (% hex hex) of \arg{uri} into
+normal characters and returns the result.
+
+This is the preferred over deprecated wxURL::ConvertFromURI.
+
+If you want to unescape an entire wxURI, use \helpref{BuildUnescapedURI}{wxuribuildunescapeduri} instead,
+as it performs some optimizations over this method.
+
+\docparam{uri}{string with escaped characters to convert}
+