final wxURI API changes. Changed Get to BuildURI to better reflect what its doing. Added wxURI::Unescape to unescape characters in a url or uri. Added wxURI::BuildUnescapedURI. Changed the wxURL convertXXXuri methods to use uri methods instead, and depreciated these methods.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@30138 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Ryan Norton
2004-10-28 09:57:43 +00:00
parent cedea72ffa
commit 86470d432f
8 changed files with 126 additions and 116 deletions

View File

@@ -296,6 +296,7 @@ These are the data structure classes supported by wxWidgets.
\twocolitem{\helpref{wxRealPoint}{wxrealpoint}}{Representation of a point using floating point numbers}
\twocolitem{\helpref{wxSize}{wxsize}}{Representation of a size}
\twocolitem{\helpref{wxTimeSpan}{wxtimespan}}{A time interval.}
\twocolitem{\helpref{wxURI}{wxuri}}{Represents a Uniform Resource Identifier}
\twocolitem{\helpref{wxVariant}{wxvariant}}{A class for storing arbitrary types that may change at run-time}
\end{twocollist}

View File

@@ -88,6 +88,28 @@ Copies this URI from another URI.
\docparam{uri}{URI (Uniform Resource Identifier) to initialize with}
\membersection{wxURI::BuildURI}\label{wxuribuilduri}
\constfunc{wxString}{BuildURI}{\void}
Builds the URI from its individual components and adds proper seperators.
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::BuildUnescapedURI}\label{wxuribuildunescapeduri}
\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
BuildUnescapedURI performs some optimizations over the plain method.
\membersection{wxURI::Create}\label{wxuricreate}
\func{void}{Create}{\param{const wxChar* }{uri}}
@@ -96,15 +118,6 @@ Creates this URI from the string \arg{uri}.
\docparam{uri}{string to initialize from}
\membersection{wxURI::Get}\label{wxuriget}
\constfunc{wxString}{Get}{\void}
Obtains the full URI.
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}
@@ -300,3 +313,18 @@ of the base's is merged with this URI's path, resulting in the URI
mode some compatability 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 wxURL::ConvertFromURI.
If you want to unescape an entire wxURI, use BuildUnescapedURI instead,
as it performs some optimizations over this method.
\docparam{uri}{string with escaped characters to convert}

View File

@@ -151,13 +151,3 @@ Sets the proxy to use for this URL.
\helpref{wxURL::SetDefaultProxy}{wxurlsetdefaultproxy}
%
% SetProxy
%
\membersection{wxURL::ConvertToValidURI}\label{wxurlconverttovaliduri}
\func{static wxString}{ConvertToValidURI}{\param{const wxString\&}{ uri}}
It converts a non-standardized URI to a valid network URI. It encodes non
standard characters.