adjusted indentation with astyle; added Id keyword

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52383 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-03-08 14:43:31 +00:00
parent aa6ec1d787
commit 7c913512a4
269 changed files with 9052 additions and 9058 deletions

View File

@@ -9,32 +9,32 @@
/**
@class wxFTP
@headerfile ftp.h wx/protocol/ftp.h
wxFTP can be used to establish a connection to an FTP server and perform all the
usual operations. Please consult the RFC 959 for more details about the FTP
protocol.
To use a commands which doesn't involve file transfer (i.e. directory oriented
commands) you just need to call a corresponding member function or use the
generic wxFTP::SendCommand method. However to actually
transfer files you just get or give a stream to or from this class and the
actual data are read or written using the usual stream methods.
Example of using wxFTP for file downloading:
@code
wxFTP ftp;
// if you don't use these lines anonymous login will be used
ftp.SetUser("user");
ftp.SetPassword("password");
if ( !ftp.Connect("ftp.wxwindows.org") )
{
wxLogError("Couldn't connect");
return;
}
ftp.ChDir("/pub");
wxInputStream *in = ftp.GetInputStream("wxWidgets-4.2.0.tar.gz");
if ( !in )
@@ -54,15 +54,15 @@
// file data is in the buffer
...
}
delete [] data;
delete in;
}
@endcode
To upload a file you would do (assuming the connection to the server was opened
successfully):
@code
wxOutputStream *out = ftp.GetOutputStream("filename");
if ( out )
@@ -71,10 +71,10 @@
delete out;
}
@endcode
@library{wxnet}
@category{net}
@seealso
wxSocketBase
*/
@@ -92,7 +92,7 @@ public:
#define ~wxFTP() /* implementation is private */
/**
Aborts the download currently in process, returns @true if ok, @false
Aborts the download currently in process, returns @true if ok, @false
if an error occurred.
*/
bool Abort();

View File

@@ -9,11 +9,11 @@
/**
@class wxHTTP
@headerfile http.h wx/protocol/http.h
@library{wxnet}
@category{net}
@seealso
wxSocketBase, wxURL
*/
@@ -31,11 +31,11 @@ public:
Creates a new input stream on the specified path. Notice that this stream is
unseekable, i.e. SeekI() and TellI() methods shouldn't be used.
Note that you can still know the size of the file you are getting using
Note that you can still know the size of the file you are getting using
wxStreamBase::GetSize. However there is a
limitation: in HTTP protocol, the size is not always specified so sometimes
@c (size_t)-1 can returned ot indicate that the size is unknown. In such
case, you may want to use wxInputStream::LastRead
case, you may want to use wxInputStream::LastRead
method in a loop to get the total size.
@returns Returns the initialized stream. You must delete it yourself once

View File

@@ -9,11 +9,11 @@
/**
@class wxProtocol
@headerfile protocol.h wx/protocol/protocol.h
@library{wxnet}
@category{FIXME}
@seealso
wxSocketBase, wxURL
*/