Synchronize wxPropertyGridManager documentation with the real API.

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

diff --git a/interface/wx/protocol/ftp.h b/interface/wx/protocol/ftp.h
index 12bbca605f099d4189504b33d3a4c7548a1b2682..b6a7992ffcb37a9930f9cb2a7c1339dbe5751010 100644 (file)
--- a/interface/wx/protocol/ftp.h
+++ b/interface/wx/protocol/ftp.h
@@ -3,19 +3,9 @@
 // Purpose:     interface of wxFTP
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
-/**
-    Transfer modes used by wxFTP.
-*/
-enum TransferMode
-{
-    NONE,       //!< not set by user explicitly.
-    ASCII,
-    BINARY
-};
-
 /**
     @class wxFTP
 
@@ -47,14 +37,20 @@ enum TransferMode
         }
 
         ftp.ChDir("/pub/2.8.9");
-        wxInputStream *i = ftp.GetInputStream("wxWidgets-2.8.9.tar.bz2");
+        const char *filename = "wxWidgets-2.8.9.tar.bz2";
+        int size = ftp.GetFileSize(filename);
+        if ( size == -1 )
+        {
+            wxLogError("Couldn't get the file size for \"%s\"", filename);
+        }
+
+        wxInputStream *in = ftp.GetInputStream(filename);
         if ( !in )
         {
             wxLogError("Couldn't get the file");
         }
         else
         {
-            size_t size = in->GetSize();
             char *data = new char[size];
             if ( !in->Read(data, size) )
             {
@@ -94,6 +90,16 @@ enum TransferMode
 class wxFTP : public wxProtocol
 {
 public:
+    /**
+        Transfer modes used by wxFTP.
+    */
+    enum TransferMode
+    {
+        NONE,       //!< not set by user explicitly.
+        ASCII,
+        BINARY
+    };
+
     /**
         Default constructor.
     */
@@ -106,6 +112,22 @@ public:
 
 
 
+    //@{
+    /**
+        Connect to the FTP server to default port (21) of the specified @a host.
+     */
+    virtual bool Connect(const wxString& host);
+
+    /**
+        Connect to the FTP server to any port of the specified @a host.
+        By default (@a port = 0), connection is made to default FTP port (21)
+        of the specified @a host.
+
+        @since 2.9.1
+     */
+    virtual bool Connect(const wxString& host, unsigned short port);
+    //@}
+
     /**
         @name Functions for managing the FTP connection
      */