Set/GetWindowMenu added to MDI parent frame under MSW

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

diff --git a/docs/latex/wx/ftp.tex b/docs/latex/wx/ftp.tex
index 039bb10cd127b504b66f5b37e822c816a400a006..e5e591b1e0cbce01436822dea44a88d131c62239 100644 (file)
--- a/docs/latex/wx/ftp.tex
+++ b/docs/latex/wx/ftp.tex
@@ -16,13 +16,13 @@
 % Members
 % ----------------------------------------------------------------------------
 
 % Members
 % ----------------------------------------------------------------------------
 

-\latexignore{\rtfignore{\membersection{Members}}}
+\latexignore{\rtfignore{\wxheading{Members}}}

 
 \membersection{wxFTP::SendCommand}
 
 \func{bool}{SendCommand}{\param{const wxString\&}{ command}, \param{char }{ret}}
 
 
 \membersection{wxFTP::SendCommand}
 
 \func{bool}{SendCommand}{\param{const wxString\&}{ command}, \param{char }{ret}}
 

-Send the specified \it{command} to the FTP server. \it{ret} specifies
+Send the specified {\it command} to the FTP server. {\it ret} specifies

 the expected result.
 
 \wxheading{Return value}
 the expected result.
 
 \wxheading{Return value}


@@ -72,7 +72,7 @@ Returns the current FTP working directory.
 
 \func{bool}{Rename}{\param{const wxString\&}{ src}, \param{const wxString\&}{ dst}}
 
 
 \func{bool}{Rename}{\param{const wxString\&}{ src}, \param{const wxString\&}{ dst}}
 

-Rename the specified \it{src} element to \it{dst}. Returns TRUE if successful.
+Rename the specified {\it src} element to {\it dst}. Returns TRUE if successful.

 
 % ----------------------------------------------------------------------------
 
 
 % ----------------------------------------------------------------------------
 


@@ -80,11 +80,12 @@ Rename the specified \it{src} element to \it{dst}. Returns TRUE if successful.
 
 \func{bool}{RmFile}{\param{const wxString\&}{ path}}
 
 
 \func{bool}{RmFile}{\param{const wxString\&}{ path}}
 

-Delete the file specified by \it{path}. Returns TRUE if successful.
+Delete the file specified by {\it path}. Returns TRUE if successful.

 
 % ----------------------------------------------------------------------------
 
 \membersection{wxFTP::SetUser}
 
 % ----------------------------------------------------------------------------
 
 \membersection{wxFTP::SetUser}

+

 \func{void}{SetUser}{\param{const wxString\&}{ user}}
 
 Sets the user name to be sent to the FTP server to be allowed to log in.
 \func{void}{SetUser}{\param{const wxString\&}{ user}}
 
 Sets the user name to be sent to the FTP server to be allowed to log in.


@@ -96,10 +97,11 @@ The default value of the user name is "anonymous".
 \wxheading{Remark}
 
 This parameter can be included in a URL if you want to use the URL manager.
 \wxheading{Remark}
 
 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"
+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}
 to specify a user and a password.
 
 \membersection{wxFTP::SetPassword}

+

 \func{void}{SetPassword}{\param{const wxString\&}{ passwd}}
 
 Sets the password to be sent to the FTP server to be allowed to log in.
 \func{void}{SetPassword}{\param{const wxString\&}{ passwd}}
 
 Sets the password to be sent to the FTP server to be allowed to log in.


@@ -113,20 +115,21 @@ user name and the host name of the local machine from the system.
 \wxheading{Remark}
 
 This parameter can be included in a URL if you want to use the URL manager.
 \wxheading{Remark}
 
 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"
+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::GetList}
 to specify a user and a password.
 
 % ----------------------------------------------------------------------------
 \membersection{wxFTP::GetList}

+

 \func{wxList *}{GetList}{\param{const wxString\&}{ wildcard}}
 
 The GetList function is quite low-level. It returns the list of the files in
 \func{wxList *}{GetList}{\param{const wxString\&}{ wildcard}}
 
 The GetList function is quite low-level. It returns the list of the files in

-the current directory. The list can be filtered using the \it{wildcard} string.
-If \it{wildcard} is a NULL string, it will return all files in directory.
+the current directory. The list can be filtered using the {\it wildcard} string.
+If {\it wildcard} is a NULL string, it will return all files in directory.

 
 The form of the list can change from one peer system to another. For example,
 for a UNIX peer system, it will look like this:
 
 The form of the list can change from one peer system to another. For example,
 for a UNIX peer system, it will look like this:

+

 \begin{verbatim}
 -r--r--r--   1 guilhem  lavaux      12738 Jan 16 20:17 cmndata.cpp
 -r--r--r--   1 guilhem  lavaux      10866 Jan 24 16:41 config.cpp
 \begin{verbatim}
 -r--r--r--   1 guilhem  lavaux      12738 Jan 16 20:17 cmndata.cpp
 -r--r--r--   1 guilhem  lavaux      10866 Jan 24 16:41 config.cpp


@@ -137,6 +140,7 @@ for a UNIX peer system, it will look like this:
 \end{verbatim}
 
 But on Windows system, it will look like this:
 \end{verbatim}
 
 But on Windows system, it will look like this:

+

 \begin{verbatim}
 winamp~1 exe    520196 02-25-1999  19:28  winamp204.exe
         1 file(s)           520 196 bytes
 \begin{verbatim}
 winamp~1 exe    520196 02-25-1999  19:28  winamp204.exe
         1 file(s)           520 196 bytes


@@ -150,7 +154,7 @@ The list is a string list and one node corresponds to a line sent by the peer.
 
 \func{wxOutputStream *}{GetOutputStream}{\param{const wxString\&}{ file}}
 
 
 \func{wxOutputStream *}{GetOutputStream}{\param{const wxString\&}{ file}}
 

-Initializes an output stream to the specified \it{file}. The returned
+Initializes an output stream to the specified {\it file}. The returned

 stream has all but the seek functionality of wxStreams. When the user finishes
 writing data, he has to delete the stream to close it.
 
 stream has all but the seek functionality of wxStreams. When the user finishes
 writing data, he has to delete the stream to close it.
 


@@ -188,21 +192,21 @@ can send new commands without reconnecting.
 
 \begin{verbatim}
   wxFTP ftp;
 
 \begin{verbatim}
   wxFTP ftp;

-  wxInputStream *in\_stream;
+  wxInputStream *in_stream;

   char *data;
 
   ftp.Connect("a.host.domain");
   char *data;
 
   ftp.Connect("a.host.domain");

-  ftp.ChDir("a\_directory");
-  in\_stream = ftp.GetInputStream("a\_file\_to\_get");
+  ftp.ChDir("a_directory");
+  in_stream = ftp.GetInputStream("a_file_to_get");

 
 

-  data = new char[in\_stream->StreamSize()];
+  data = new char[in_stream->StreamSize()];

 
 

-  in\_stream->Read(data, in\_stream->StreamSize());
-  if (in\_stream->LastError() != wxStream\_NOERROR) {
+  in_stream->Read(data, in_stream->StreamSize());
+  if (in_stream->LastError() != wxStream_NOERROR) {

     // Do something.
   }
 
     // Do something.
   }
 

-  delete in\_stream; /* Close the DATA connection */
+  delete in_stream; /* Close the DATA connection */

 
   ftp.Close(); /* Close the COMMAND connection */
 \end{verbatim}
 
   ftp.Close(); /* Close the COMMAND connection */
 \end{verbatim}


@@ -210,3 +214,4 @@ can send new commands without reconnecting.
 \wxheading{See also}
 
 \helpref{wxInputStream}{wxinputstream}
 \wxheading{See also}
 
 \helpref{wxInputStream}{wxinputstream}

+