/////////////////////////////////////////////////////////////////////////////
// Name: url.h
-// Purpose: documentation for wxURL class
+// Purpose: interface of wxURL
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
@library{wxnet}
@category{net}
- @seealso
- wxSocketBase, wxProtocol
+ @see wxSocketBase, wxProtocol
*/
class wxURL : public wxURI
{
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. @c file:///somepath/myfile).
-
+
@param url
Url string to parse.
*/
/**
Returns the last error. This error refers to the URL parsing or to the protocol.
It can be one of these errors:
-
+
@b wxURL_NOERR
-
+
No error.
-
+
@b wxURL_SNTXERR
-
+
Syntax error in the URL string.
-
+
@b wxURL_NOPROTO
-
+
Found no protocol which can get this URL.
-
+
@b wxURL_NOHOST
-
+
A host name is required for this protocol.
-
+
@b wxURL_NOPATH
-
+
A path is required for this protocol.
-
+
@b wxURL_CONNERR
-
+
Connection error.
-
+
@b wxURL_PROTOERR
-
+
An error occurred during negotiation.
*/
- wxURLError GetError();
+ wxURLError GetError() const;
/**
Creates a new input stream on the specified URL. You can use all but seek
Note that this method is somewhat deprecated, all future wxWidgets applications
should really use wxFileSystem instead.
Example:
-
+
@returns Returns the initialized stream. You will have to delete it
yourself.
-
+
@see wxInputStream
*/
wxInputStream* GetInputStream();
Returns @true if this object is correctly initialized, i.e. if
GetError() returns @c wxURL_NOERR.
*/
- bool IsOk();
+ bool IsOk() const;
/**
Sets the default proxy server to use to get the URL. The string specifies
the proxy like this: hostname:port number.
-
+
@param url_proxy
Specifies the proxy to use
-
+
@see SetProxy()
*/
static void SetDefaultProxy(const wxString& url_proxy);
/**
Sets the proxy to use for this URL.
-
+
@see SetDefaultProxy()
*/
void SetProxy(const wxString& url_proxy);
*/
wxURLError SetURL(const wxString& url);
};
+