document that under wxMSW slant == italic

[wxWidgets.git] / interface / wx / protocol / http.h

diff --git a/interface/wx/protocol/http.h b/interface/wx/protocol/http.h
index 6cd1332ae82e5308cc9cbb05b26fbf99a366f25e..cdad04236d0fcfdb7dccead9a88f0b92aa13ca6c 100644 (file)
--- a/interface/wx/protocol/http.h
+++ b/interface/wx/protocol/http.h
@@ -8,10 +8,11 @@
 
 /**
     @class wxHTTP
-    @headerfile http.h wx/protocol/http.h
 
     wxHTTP can be used to establish a connection to an HTTP server.
 
+    wxHTTP can thus be used to create a (basic) HTTP @b client.
+
     @library{wxnet}
     @category{net}
 
@@ -21,14 +22,36 @@ class wxHTTP : public wxProtocol
 {
 public:
     /**
-        Returns the data attached with a field whose name is specified by @e header.
+        Default constructor.
+    */
+    wxHTTP();
+
+    /**
+        Destructor will close the connection if connected.
+    */
+    virtual ~wxHTTP();
+
+    //@{
+    /**
+        Connect to the HTTP server.
+
+        By default, connection is made to the port 80 of the specified @a host.
+        You may connect to a non-default port by specifying it explicitly using
+        the second overload.
+     */
+    virtual bool Connect(const wxString& host);
+    virtual bool Connect(const wxString& host, unsigned short port);
+    //@}
+
+    /**
+        Returns the data attached with a field whose name is specified by @a header.
         If the field doesn't exist, it will return an empty string and not a @NULL string.
 
         @note
         The header is not case-sensitive, i.e. "CONTENT-TYPE" and "content-type"
         represent the same header.
     */
-    wxString GetHeader(const wxString& header);
+    wxString GetHeader(const wxString& header) const;
 
     /**
         Creates a new input stream on the specified path.
@@ -53,7 +76,7 @@ public:
 
         @see wxInputStream
     */
-    wxInputStream* GetInputStream(const wxString& path);
+    virtual wxInputStream* GetInputStream(const wxString& path);
 
     /**
         Returns the HTTP response code returned by the server.
@@ -65,7 +88,7 @@ public:
     /**
         It sets data of a field to be sent during the next request to the HTTP server.
 
-        The field name is specified by @a header and the content by @e h_data.
+        The field name is specified by @a header and the content by @a h_data.
         This is a low level function and it assumes that you know what you are doing.
     */
     void SetHeader(const wxString& header, const wxString& h_data);