Add doc TODOs for wxVariant. You know, Convert wasn't documented _at all_, heh :).

[wxWidgets.git] / docs / latex / wx / ftp.tex

diff --git a/docs/latex/wx/ftp.tex b/docs/latex/wx/ftp.tex
index 077787ba4e4d2b859050db8320c7916acf214a65..d098f5a6c3ef0e94011d156a3b11978f1b5272f6 100644 (file)
--- a/docs/latex/wx/ftp.tex
+++ b/docs/latex/wx/ftp.tex
@@ -5,8 +5,8 @@
 %% Modified by:
 %% Created:     ~1997
 %% RCS-ID:      $Id$
-%% Copyright:   (c) wxWindows team
-%% License:     wxWindows license
+%% Copyright:   (c) wxWidgets team
+%% License:     wxWidgets license
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \section{\class{wxFTP}}\label{wxftp}
@@ -37,7 +37,7 @@ Example of using wxFTP for file downloading:
     }
 
     ftp.ChDir("/pub");
-    wxInputStream *in = ftp.GetInputStream("wxWindows-4.2.0.tar.gz");
+    wxInputStream *in = ftp.GetInputStream("wxWidgets-4.2.0.tar.gz");
     if ( !in )
     {
         wxLogError("Coudln't get file");
@@ -103,18 +103,21 @@ enum TransferMode
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
+
 \membersection{wxFTP::wxFTP}
 
 \func{}{wxFTP}{\void}
 
 Default constructor.
 
+
 \membersection{wxFTP::\destruct{wxFTP}}
 
 \func{}{\destruct{wxFTP}}{\void}
 
 Destructor will close the connection if connected.
 
+
 \membersection{wxFTP::Abort}\label{wxftpabort}
 
 \func{bool}{Abort}{\void}
@@ -122,6 +125,7 @@ Destructor will close the connection if connected.
 Aborts the download currently in process, returns {\tt true} if ok, {\tt false} 
 if an error occured.
 
+
 \membersection{wxFTP::CheckCommand}
 
 \func{bool}{CheckCommand}{\param{const wxString\&}{ command}, \param{char }{ret}}
@@ -133,6 +137,7 @@ the expected result.
 
 true if the command has been sent successfully, else false.
 
+
 \membersection{wxFTP::SendCommand}\label{wxftpsendcommand}
 
 \func{char}{SendCommand}{\param{const wxString\&}{ command}}
@@ -140,6 +145,7 @@ true if the command has been sent successfully, else false.
 Send the specified {\it command} to the FTP server and return the first
 character of the return code.
 
+
 \membersection{wxFTP::GetLastResult}
 
 \func{const wxString\&}{GetLastResult}{\void}
@@ -149,6 +155,7 @@ command.
 
 % ----------------------------------------------------------------------------
 
+
 \membersection{wxFTP::ChDir}
 
 \func{bool}{ChDir}{\param{const wxString\&}{ dir}}
@@ -156,6 +163,7 @@ command.
 Change the current FTP working directory.
 Returns true if successful.
 
+
 \membersection{wxFTP::MkDir}
 
 \func{bool}{MkDir}{\param{const wxString\&}{ dir}}
@@ -163,6 +171,7 @@ Returns true if successful.
 Create the specified directory in the current FTP working directory.
 Returns true if successful.
 
+
 \membersection{wxFTP::RmDir}
 
 \func{bool}{RmDir}{\param{const wxString\&}{ dir}}
@@ -170,6 +179,7 @@ Returns true if successful.
 Remove the specified directory from the current FTP working directory.
 Returns true if successful.
 
+
 \membersection{wxFTP::Pwd}
 
 \func{wxString}{Pwd}{\void}
@@ -178,6 +188,7 @@ Returns the current FTP working directory.
 
 % ----------------------------------------------------------------------------
 
+
 \membersection{wxFTP::Rename}
 
 \func{bool}{Rename}{\param{const wxString\&}{ src}, \param{const wxString\&}{ dst}}
@@ -186,6 +197,7 @@ Rename the specified {\it src} element to {\it dst}. Returns true if successful.
 
 % ----------------------------------------------------------------------------
 
+
 \membersection{wxFTP::RmFile}
 
 \func{bool}{RmFile}{\param{const wxString\&}{ path}}
@@ -194,18 +206,31 @@ Delete the file specified by {\it path}. Returns true if successful.
 
 % ----------------------------------------------------------------------------
 
+
 \membersection{wxFTP::SetAscii}
 
 \func{bool}{SetAscii}{\void}
 
 Sets the transfer mode to ASCII. It will be used for the next transfer.
 
+
 \membersection{wxFTP::SetBinary}
 
 \func{bool}{SetBinary}{\void}
 
 Sets the transfer mode to binary (IMAGE). It will be used for the next transfer.
 
+
+\membersection{wxFTP::SetPassive}
+
+\func{void}{SetPassive}{\param{bool }{pasv}}
+
+If \arg{pasv} is \true, passive connection to the FTP server is used. This is
+the default as it works with practically all firewalls. If the server doesn't
+support passive move, you may call this function with \false argument to use
+active connection.
+
+
 \membersection{wxFTP::SetTransferMode}
 
 \func{bool}{SetTransferMode}{\param{TransferMode }{mode}}
@@ -217,6 +242,7 @@ If this function is never called, binary transfer mode is used by default.
 
 % ----------------------------------------------------------------------------
 
+
 \membersection{wxFTP::SetUser}
 
 \func{void}{SetUser}{\param{const wxString\&}{ user}}
@@ -233,6 +259,7 @@ This parameter can be included in a URL if you want to use the URL manager.
 For example, you can use: "ftp://a\_user:a\_password@a.host:service/a\_directory/a\_file"
 to specify a user and a password.
 
+
 \membersection{wxFTP::SetPassword}
 
 \func{void}{SetPassword}{\param{const wxString\&}{ passwd}}
@@ -253,12 +280,14 @@ to specify a user and a password.
 
 % ----------------------------------------------------------------------------
 
+
 \membersection{wxFTP::FileExists}\label{wxftpfileexists}
 
 \func{bool}{FileExists}{\param{const wxString\&}{ filename}}
 
 Returns {\tt true} if the given remote file exists, {\tt false} otherwise.
 
+
 \membersection{wxFTP::GetFileSize}\label{wxftpgetfilesize}
 
 \func{int}{GetFileSize}{\param{const wxString\&}{ filename}}
@@ -268,6 +297,7 @@ couldn't be determined. Notice that this size can be approximative size only
 and shouldn't be used for allocating the buffer in which the remote file is
 copied, for example.
 
+
 \membersection{wxFTP::GetDirList}\label{wxftpgetdirlist}
 
 \func{bool}{GetDirList}{\param{wxArrayString\& }{files}, \param{const wxString\&}{ wildcard = ""}}
@@ -302,6 +332,7 @@ otherwise.
 
 \helpref{GetFilesList}{wxftpgetfileslist}
 
+
 \membersection{wxFTP::GetFilesList}\label{wxftpgetfileslist}
 
 \func{bool}{GetFilesList}{\param{wxArrayString\& }{files}, \param{const wxString\&}{ wildcard = ""}}
@@ -316,6 +347,7 @@ otherwise.
 
 % ----------------------------------------------------------------------------
 
+
 \membersection{wxFTP::GetOutputStream}
 
 \func{wxOutputStream *}{GetOutputStream}{\param{const wxString\&}{ file}}
@@ -334,6 +366,7 @@ An initialized write-only stream.
 
 % ----------------------------------------------------------------------------
 
+
 \membersection{wxFTP::GetInputStream}\label{wxftpgetinput}
 
 \func{wxInputStream *}{GetInputStream}{\param{const wxString\&}{ path}}