Applied [ 1555974 ] small wxURL improvements

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@41263 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Robert Roebling 2006-09-17 10:59:18 +00:00
parent 3ab296d9eb
commit 7d90da2b4c
3 changed files with 46 additions and 8 deletions

View File

@ -36,6 +36,10 @@ furthur functionality.
<wx/uri.h> <wx/uri.h>
\wxheading{See also}
\helpref{wxURL}{wxurl}
\latexignore{\rtfignore{\wxheading{Members}}} \latexignore{\rtfignore{\wxheading{Members}}}
\membersection{Obtaining individual components}\label{obtainingwxuricomponents} \membersection{Obtaining individual components}\label{obtainingwxuricomponents}
@ -46,7 +50,7 @@ one of the following methods
\helpref{GetScheme}{wxurigetscheme}\\ \helpref{GetScheme}{wxurigetscheme}\\
\helpref{GetUserInfo}{wxurigetuserinfo}\\ \helpref{GetUserInfo}{wxurigetuserinfo}\\
\helpref{GetServer}{wxurigetserver}\\ \helpref{GetServer}{wxurigetserver}\\
\helpref{GetPort}{wxurigetserver}\\ \helpref{GetPort}{wxurigetport}\\
\helpref{GetPath}{wxurigetpath}\\ \helpref{GetPath}{wxurigetpath}\\
\helpref{GetQuery}{wxurigetquery}\\ \helpref{GetQuery}{wxurigetquery}\\
\helpref{GetFragment}{wxurigetfragment} \helpref{GetFragment}{wxurigetfragment}

View File

@ -1,13 +1,16 @@
\section{\class{wxURL}}\label{wxurl} \section{\class{wxURL}}\label{wxurl}
Parses URLs. wxURL is a specialization of \helpref{wxURI}{wxuri} for parsing URLs.
Please look at \helpref{wxURI}{wxuri} documentation for more info about the functions
you can use to retrieve the various parts of the URL (scheme, server, port, etc).
Supports standard assignment operators, copy constructors, Supports standard assignment operators, copy constructors,
and comparison operators. and comparison operators.
\wxheading{Derived from} \wxheading{Derived from}
\helpref{wxURI}{wxuri} \helpref{wxURI}{wxuri}\\
\helpref{wxObject}{wxobject}
\wxheading{Include files} \wxheading{Include files}
@ -25,13 +28,16 @@ and comparison operators.
\membersection{wxURL::wxURL}\label{wxurlctor} \membersection{wxURL::wxURL}\label{wxurlctor}
\func{}{wxURL}{\param{const wxString\&}{ url}} \func{}{wxURL}{\param{const wxString\&}{ url = wxEmptyString}}
Constructs a URL object from the string. The URL must be valid according Constructs a URL object from the string. The URL must be valid according
to RFC 1738. In particular, file URLs must be of the format to RFC 1738. In particular, file URLs must be of the format
'file://hostname/path/to/file'. It is valid to leave out the hostname {\tt file://hostname/path/to/file} otherwise \helpref{GetError}{wxurlgeterror}
but slashes must remain in place-- i.e. a file URL without a hostname must will return a value different from {\tt wxURL_NOERR}.
contain three consecutive slashes.
It is valid to leave out the hostname but slashes must remain in place -
i.e. a file URL without a hostname must contain three consecutive slashes
(e.g. {\tt file:///somepath/myfile}).
\wxheading{Parameters} \wxheading{Parameters}
@ -108,6 +114,18 @@ Returns the initialized stream. You will have to delete it yourself.
\helpref{wxInputStream}{wxinputstream} \helpref{wxInputStream}{wxinputstream}
%
% IsOk
%
\membersection{wxURL::IsOk}\label{wxurlgetisok}
\constfunc{bool}{IsOk}{\void}
Returns \true if this object is correctly initialized, i.e. if
\helpref{GetError}{wxurlgeterror} returns {\tt wxURL_NOERR}.
% %
% SetDefaultProxy % SetDefaultProxy
% %
@ -139,3 +157,13 @@ Sets the proxy to use for this URL.
\helpref{wxURL::SetDefaultProxy}{wxurlsetdefaultproxy} \helpref{wxURL::SetDefaultProxy}{wxurlsetdefaultproxy}
%
% SetURL
%
\membersection{wxURL::SetURL}\label{wxurlseturl}
\func{wxURLError}{SetURL}{\param{const wxString\&}{ url}}
Initializes this object with the given URL and returns {\tt wxURL_NOERR}
if it's valid (see \helpref{GetError}{wxurlgeterror} for more info).

View File

@ -47,7 +47,7 @@ public:
class WXDLLIMPEXP_NET wxURL : public wxURI class WXDLLIMPEXP_NET wxURL : public wxURI
{ {
public: public:
wxURL(const wxString& sUrl); wxURL(const wxString& sUrl = wxEmptyString);
wxURL(const wxURI& url); wxURL(const wxURI& url);
virtual ~wxURL(); virtual ~wxURL();
@ -58,6 +58,12 @@ public:
wxURLError GetError() const { return m_error; } wxURLError GetError() const { return m_error; }
wxString GetURL() const { return m_url; } wxString GetURL() const { return m_url; }
wxURLError SetURL(const wxString &url)
{ *this = url; return m_error; }
bool IsOk() const
{ return m_error == wxURL_NOERR; }
wxInputStream *GetInputStream(); wxInputStream *GetInputStream();
#if wxUSE_PROTOCOL_HTTP #if wxUSE_PROTOCOL_HTTP