updated SetFont() documentation: it returns bool, not void (bug 1705330)

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

diff --git a/docs/latex/wx/ftp.tex b/docs/latex/wx/ftp.tex
index 077787ba4e4d2b859050db8320c7916acf214a65..67925829ef40a2f5f2b8433d755c6f85fe8f65d3 100644 (file)
--- a/docs/latex/wx/ftp.tex
+++ b/docs/latex/wx/ftp.tex
@@ -5,7 +5,7 @@
 %% Modified by:
 %% Created:     ~1997
 %% RCS-ID:      $Id$
-%% Copyright:   (c) wxWindows team
+%% Copyright:   (c) wxWidgets team
 %% License:     wxWindows license
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
@@ -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,26 +103,30 @@ enum TransferMode
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxFTP::wxFTP}
+
+\membersection{wxFTP::wxFTP}\label{wxftpctor}
 
 \func{}{wxFTP}{\void}
 
 Default constructor.
 
-\membersection{wxFTP::\destruct{wxFTP}}
+
+\membersection{wxFTP::\destruct{wxFTP}}\label{wxftpdtor}
 
 \func{}{\destruct{wxFTP}}{\void}
 
 Destructor will close the connection if connected.
 
+
 \membersection{wxFTP::Abort}\label{wxftpabort}
 
 \func{bool}{Abort}{\void}
 
-Aborts the download currently in process, returns {\tt true} if ok, {\tt false} 
-if an error occured.
+Aborts the download currently in process, returns \true if ok, \false 
+if an error occurred.
+
 
-\membersection{wxFTP::CheckCommand}
+\membersection{wxFTP::CheckCommand}\label{wxftpcheckcommand}
 
 \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,7 +145,8 @@ 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}
+
+\membersection{wxFTP::GetLastResult}\label{wxftpgetlastresult}
 
 \func{const wxString\&}{GetLastResult}{\void}
 
@@ -149,28 +155,32 @@ command.
 
 % ----------------------------------------------------------------------------
 
-\membersection{wxFTP::ChDir}
+
+\membersection{wxFTP::ChDir}\label{wxftpchdir}
 
 \func{bool}{ChDir}{\param{const wxString\&}{ dir}}
 
 Change the current FTP working directory.
 Returns true if successful.
 
-\membersection{wxFTP::MkDir}
+
+\membersection{wxFTP::MkDir}\label{wxftpmkdir}
 
 \func{bool}{MkDir}{\param{const wxString\&}{ dir}}
 
 Create the specified directory in the current FTP working directory.
 Returns true if successful.
 
-\membersection{wxFTP::RmDir}
+
+\membersection{wxFTP::RmDir}\label{wxftprmdir}
 
 \func{bool}{RmDir}{\param{const wxString\&}{ dir}}
 
 Remove the specified directory from the current FTP working directory.
 Returns true if successful.
 
-\membersection{wxFTP::Pwd}
+
+\membersection{wxFTP::Pwd}\label{wxftppwd}
 
 \func{wxString}{Pwd}{\void}
 
@@ -178,7 +188,8 @@ Returns the current FTP working directory.
 
 % ----------------------------------------------------------------------------
 
-\membersection{wxFTP::Rename}
+
+\membersection{wxFTP::Rename}\label{wxftprename}
 
 \func{bool}{Rename}{\param{const wxString\&}{ src}, \param{const wxString\&}{ dst}}
 
@@ -186,7 +197,8 @@ Rename the specified {\it src} element to {\it dst}. Returns true if successful.
 
 % ----------------------------------------------------------------------------
 
-\membersection{wxFTP::RmFile}
+
+\membersection{wxFTP::RmFile}\label{wxftprmfile}
 
 \func{bool}{RmFile}{\param{const wxString\&}{ path}}
 
@@ -194,19 +206,32 @@ Delete the file specified by {\it path}. Returns true if successful.
 
 % ----------------------------------------------------------------------------
 
-\membersection{wxFTP::SetAscii}
+
+\membersection{wxFTP::SetAscii}\label{wxftpsetascii}
 
 \func{bool}{SetAscii}{\void}
 
 Sets the transfer mode to ASCII. It will be used for the next transfer.
 
-\membersection{wxFTP::SetBinary}
+
+\membersection{wxFTP::SetBinary}\label{wxftpsetbinary}
 
 \func{bool}{SetBinary}{\void}
 
 Sets the transfer mode to binary (IMAGE). It will be used for the next transfer.
 
-\membersection{wxFTP::SetTransferMode}
+
+\membersection{wxFTP::SetPassive}\label{wxftpsetpassive}
+
+\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}\label{wxftpsettransfermode}
 
 \func{bool}{SetTransferMode}{\param{TransferMode }{mode}}
 
@@ -217,7 +242,8 @@ If this function is never called, binary transfer mode is used by default.
 
 % ----------------------------------------------------------------------------
 
-\membersection{wxFTP::SetUser}
+
+\membersection{wxFTP::SetUser}\label{wxftpsetuser}
 
 \func{void}{SetUser}{\param{const wxString\&}{ user}}
 
@@ -233,7 +259,8 @@ 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}
+
+\membersection{wxFTP::SetPassword}\label{wxftpsetpassword}
 
 \func{void}{SetPassword}{\param{const wxString\&}{ passwd}}
 
@@ -253,11 +280,13 @@ 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.
+Returns \true if the given remote file exists, \false otherwise.
+
 
 \membersection{wxFTP::GetFileSize}\label{wxftpgetfilesize}
 
@@ -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,7 +347,8 @@ otherwise.
 
 % ----------------------------------------------------------------------------
 
-\membersection{wxFTP::GetOutputStream}
+
+\membersection{wxFTP::GetOutputStream}\label{wxftpgetoutputstream}
 
 \func{wxOutputStream *}{GetOutputStream}{\param{const wxString\&}{ file}}
 
@@ -334,13 +366,14 @@ An initialized write-only stream.
 
 % ----------------------------------------------------------------------------
 
-\membersection{wxFTP::GetInputStream}\label{wxftpgetinput}
+
+\membersection{wxFTP::GetInputStream}\label{wxftpgetinputstream}
 
 \func{wxInputStream *}{GetInputStream}{\param{const wxString\&}{ path}}
 
-Creates a new input stream on the the specified path. You can use all but the seek
+Creates a new input stream on the specified path. You can use all but the seek
 functionality of wxStream. Seek isn't available on all streams. For example,
-http or ftp streams do not deal with it. Other functions like Tell
+HTTP or FTP streams do not deal with it. Other functions like Tell
 are not available for this sort of stream, at present.
 You will be notified when the EOF is reached by an error.