toplevel code transferred to wxTopLevelWindow

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

diff --git a/docs/latex/wx/protocol.tex b/docs/latex/wx/protocol.tex
index 7cf0aed0c142cea4cedb9ad06b913922bc6260cb..fcc9b406c3d7d11bed8f04307c9c24c3ff51231c 100644 (file)
--- a/docs/latex/wx/protocol.tex
+++ b/docs/latex/wx/protocol.tex
@@ -4,6 +4,10 @@
 
 \helpref{wxSocketClient}{wxsocketclient}
 
+\wxheading{Include files}
+
+<wx/protocol/protocol.h>
+
 \wxheading{See also}
 
 \helpref{wxSocketBase}{wxsocketbase}, \helpref{wxURL}{wxurl}
@@ -12,7 +16,7 @@
 % Members
 % ----------------------------------------------------------------------------
 
-\latexignore{\rtfignore{\membersection{Members}}}
+\latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxProtocol::Reconnect}\label{wxprotoreconnect}
 
@@ -25,50 +29,69 @@ Tries to reestablish a previous opened connection (close and renegotiate connect
 TRUE, if the connection is established, else FALSE.
 
 % ----------------------------------------------------------------------------
-
 \membersection{wxProtocol::GetInputStream}\label{wxprotogetinput}
 
 \func{wxInputStream *}{GetInputStream}{\param{const wxString\&}{ path}}
 
 Creates a new input stream on the the specified path. You can use all but seek
 functionnality of wxStream. Seek isn't available on all stream. For example,
-http or ftp streams doesn't deal with it.
+http or ftp streams doesn't deal with it. Other functions like StreamSize and
+Tell aren't available for the moment for this sort of stream.
+You will be notified when the EOF is reached by an error.
 
 \wxheading{Return value}
 
-Returns the initialized stream. You will have to delete it yourself.
+Returns the initialized stream. You will have to delete it yourself once you
+don't use it anymore. The destructor closes the network connection.
 
-% ----------------------------------------------------------------------------
+\wxheading{See also}
+
+\helpref{wxInputStream}{wxinputstream}
 
+% ----------------------------------------------------------------------------
 \membersection{wxProtocol::Abort}\label{wxprotoabort}
 
-\func{bool }{Abort}{\void}
+\func{bool}{Abort}{\void}
 
 Abort the current stream.
-\it{WARNING: It is advised to destroy the input stream instead of aborting the stream this way.}
+
+\wxheading{Warning}
+
+It is advised to destroy the input stream instead of aborting the stream this way.
 
 \wxheading{Return value}
 
 Returns TRUE, if successful, else FALSE.
 
 % ----------------------------------------------------------------------------
-
 \membersection{wxProtocol::GetError}
 
-\func{wxProtocolError }{GetError}{\void}
+\func{wxProtocolError}{GetError}{\void}
 
-Returns the last occured error.
+Returns the last occurred error.
 
-% ----------------------------------------------------------------------------
+\twocolwidtha{7cm}
+\begin{twocollist}\itemsep=0pt
+\twocolitem{{\bf wxPROTO\_NOERR}}{No error.}
+\twocolitem{{\bf wxPROTO\_NETERR}}{A generic network error occurred.}
+\twocolitem{{\bf wxPROTO\_PROTERR}}{An error occurred during negotiation.}
+\twocolitem{{\bf wxPROTO\_CONNERR}}{The client failed to connect the server.}
+\twocolitem{{\bf wxPROTO\_INVVAL}}{Invalid value.}
+\twocolitem{{\bf wxPROTO\_NOHNDLR}}{.}
+\twocolitem{{\bf wxPROTO\_NOFILE}}{The remote file doesn't exist.}
+\twocolitem{{\bf wxPROTO\_ABRT}}{Last action aborted.}
+\twocolitem{{\bf wxPROTO\_RCNCT}}{An error occurred during reconnection.}
+\twocolitem{{\bf wxPROTO\_STREAM}}{Someone tried to send a command during a transfer.}
+\end{twocollist}
 
+% ----------------------------------------------------------------------------
 \membersection{wxProtocol::GetContentType}
 
-\func{wxString }{GetContentType}{\void}
+\func{wxString}{GetContentType}{\void}
 
 Returns the type of the content of the last opened stream. It is a mime-type.
 
 % ----------------------------------------------------------------------------
-
 \membersection{wxProtocol::SetUser}
 
 \func{void }{SetUser}{\param{const wxString\&}{ user}}
@@ -77,6 +100,7 @@ Sets the authentication user. It is mainly useful when FTP is used.
 
 \membersection{wxProtocol::SetPassword}
 
-\func{void }{SetPassword}{\param{const wxString\&}{ user}}
+\func{void}{SetPassword}{\param{const wxString\&}{ user}}
 
 Sets the authentication password. It is mainly useful when FTP is used.
+