Several changes and updates

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

diff --git a/docs/latex/wx/protocol.tex b/docs/latex/wx/protocol.tex
index c7ae36ef1672a32d7e0a277207327349039283a9..0043092d7f3d1cfc3e066d1dc1bd11c567d0df35 100644 (file)
--- a/docs/latex/wx/protocol.tex
+++ b/docs/latex/wx/protocol.tex
@@ -4,6 +4,10 @@
 
 \helpref{wxSocketClient}{wxsocketclient}
 
 
 \helpref{wxSocketClient}{wxsocketclient}
 

+\wxheading{Include files}
+
+<wx/protocol/protocol.h>
+

 \wxheading{See also}
 
 \helpref{wxSocketBase}{wxsocketbase}, \helpref{wxURL}{wxurl}
 \wxheading{See also}
 
 \helpref{wxSocketBase}{wxsocketbase}, \helpref{wxURL}{wxurl}


@@ -25,35 +29,41 @@ Tries to reestablish a previous opened connection (close and renegotiate connect
 TRUE, if the connection is established, else FALSE.
 
 % ----------------------------------------------------------------------------
 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,
 \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}
 
 
 \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}
 
 Abort the current stream.
 
 \membersection{wxProtocol::Abort}\label{wxprotoabort}
 
 \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.
 
 % ----------------------------------------------------------------------------
 
 \wxheading{Return value}
 
 Returns TRUE, if successful, else FALSE.
 
 % ----------------------------------------------------------------------------

-

 \membersection{wxProtocol::GetError}
 
 \func{wxProtocolError}{GetError}{\void}
 \membersection{wxProtocol::GetError}
 
 \func{wxProtocolError}{GetError}{\void}


@@ -72,10 +82,9 @@ Returns the last occured error.
 \twocolitem{{\bf wxPROTO\_ABRT}}{Last action aborted.}
 \twocolitem{{\bf wxPROTO\_RCNCT}}{An error occured during reconnection.}
 \twocolitem{{\bf wxPROTO\_STREAM}}{Someone tried to send a command during a transfer.}
 \twocolitem{{\bf wxPROTO\_ABRT}}{Last action aborted.}
 \twocolitem{{\bf wxPROTO\_RCNCT}}{An error occured during reconnection.}
 \twocolitem{{\bf wxPROTO\_STREAM}}{Someone tried to send a command during a transfer.}

-\end{twocollist}%
+\end{twocollist}

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

-

 \membersection{wxProtocol::GetContentType}
 
 \func{wxString}{GetContentType}{\void}
 \membersection{wxProtocol::GetContentType}
 
 \func{wxString}{GetContentType}{\void}


@@ -83,7 +92,6 @@ Returns the last occured error.
 Returns the type of the content of the last opened stream. It is a mime-type.
 
 % ----------------------------------------------------------------------------
 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}}
 \membersection{wxProtocol::SetUser}
 
 \func{void }{SetUser}{\param{const wxString\&}{ user}}