<wx/uri.h>
+\wxheading{See also}
+
+\helpref{wxURL}{wxurl}
+
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{Obtaining individual components}\label{obtainingwxuricomponents}
\helpref{GetScheme}{wxurigetscheme}\\
\helpref{GetUserInfo}{wxurigetuserinfo}\\
\helpref{GetServer}{wxurigetserver}\\
-\helpref{GetPort}{wxurigetserver}\\
+\helpref{GetPort}{wxurigetport}\\
\helpref{GetPath}{wxurigetpath}\\
\helpref{GetQuery}{wxurigetquery}\\
\helpref{GetFragment}{wxurigetfragment}
\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,
and comparison operators.
\wxheading{Derived from}
-\helpref{wxURI}{wxuri}
+\helpref{wxURI}{wxuri}\\
+\helpref{wxObject}{wxobject}
\wxheading{Include files}
\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
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
-but slashes must remain in place-- i.e. a file URL without a hostname must
-contain three consecutive slashes.
+{\tt file://hostname/path/to/file} otherwise \helpref{GetError}{wxurlgeterror}
+will return a value different from {\tt wxURL_NOERR}.
+
+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}
\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
%
\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).
class WXDLLIMPEXP_NET wxURL : public wxURI
{
public:
- wxURL(const wxString& sUrl);
+ wxURL(const wxString& sUrl = wxEmptyString);
wxURL(const wxURI& url);
virtual ~wxURL();
wxURLError GetError() const { return m_error; }
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();
#if wxUSE_PROTOCOL_HTTP