Fix "depreciated" to "deprecated".

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

diff --git a/docs/latex/wx/protocol.tex b/docs/latex/wx/protocol.tex
index 81c68bc9bbda0a448c0cc9f34a4c12b94b106984..aa10229cbe1da82f3b871ba98795d6c816b1e298 100644 (file)
--- a/docs/latex/wx/protocol.tex
+++ b/docs/latex/wx/protocol.tex
@@ -3,6 +3,12 @@
 \wxheading{Derived from}
 
 \helpref{wxSocketClient}{wxsocketclient}
 \wxheading{Derived from}
 
 \helpref{wxSocketClient}{wxsocketclient}

+\helpref{wxSocketBase}{wxsocketbase}
+\helpref{wxObject}{wxobject}
+
+\wxheading{Include files}
+
+<wx/protocol/protocol.h>

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 


@@ -11,9 +17,10 @@
 % ----------------------------------------------------------------------------
 % Members
 % ----------------------------------------------------------------------------
 % ----------------------------------------------------------------------------
 % Members
 % ----------------------------------------------------------------------------

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

 
 

-\membersection{wxProtocol::Reconnect}\label{wxprotoreconnect}
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+\membersection{wxProtocol::Reconnect}\label{wxprotocolreconnect}

 
 \func{bool}{Reconnect}{\void}
 
 
 \func{bool}{Reconnect}{\void}
 


@@ -21,16 +28,16 @@ Tries to reestablish a previous opened connection (close and renegotiate connect
 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 

-TRUE, if the connection is established, else FALSE.
+true, if the connection is established, else false.

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

-\membersection{wxProtocol::GetInputStream}\label{wxprotogetinput}
+\membersection{wxProtocol::GetInputStream}\label{wxprotocolgetinput}

 
 \func{wxInputStream *}{GetInputStream}{\param{const wxString\&}{ path}}
 
 
 \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. Other functions like StreamSize and
+Creates a new input stream on the specified path. You can use all but seek
+functionality of wxStream. Seek isn't available on all streams. For example,
+HTTP or FTP streams don'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.
 
 Tell aren't available for the moment for this sort of stream.
 You will be notified when the EOF is reached by an error.
 


@@ -44,7 +51,7 @@ don't use it anymore. The destructor closes the network connection.
 \helpref{wxInputStream}{wxinputstream}
 
 % ----------------------------------------------------------------------------
 \helpref{wxInputStream}{wxinputstream}
 
 % ----------------------------------------------------------------------------

-\membersection{wxProtocol::Abort}\label{wxprotoabort}
+\membersection{wxProtocol::Abort}\label{wxprotocolabort}

 
 \func{bool}{Abort}{\void}
 
 
 \func{bool}{Abort}{\void}
 


@@ -56,45 +63,46 @@ It is advised to destroy the input stream instead of aborting the stream this wa
 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 

-Returns TRUE, if successful, else FALSE.
+Returns true, if successful, else false.

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

-\membersection{wxProtocol::GetError}
+\membersection{wxProtocol::GetError}\label{wxprotocolgeterror}

 
 \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.}
 
 \twocolwidtha{7cm}
 \begin{twocollist}\itemsep=0pt
 \twocolitem{{\bf wxPROTO\_NOERR}}{No error.}

-\twocolitem{{\bf wxPROTO\_NETERR}}{A generic network error occured.}
-\twocolitem{{\bf wxPROTO\_PROTERR}}{An error occured during negotiation.}
+\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\_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 occured during reconnection.}
+\twocolitem{{\bf wxPROTO\_RCNCT}}{An error occurred during reconnection.}

 \twocolitem{{\bf wxPROTO\_STREAM}}{Someone tried to send a command during a transfer.}
 \end{twocollist}
 
 % ----------------------------------------------------------------------------
 \twocolitem{{\bf wxPROTO\_STREAM}}{Someone tried to send a command during a transfer.}
 \end{twocollist}
 
 % ----------------------------------------------------------------------------

-\membersection{wxProtocol::GetContentType}
+\membersection{wxProtocol::GetContentType}\label{wxprotocolgetcontenttype}

 
 \func{wxString}{GetContentType}{\void}
 
 Returns the type of the content of the last opened stream. It is a mime-type.
 
 % ----------------------------------------------------------------------------
 
 \func{wxString}{GetContentType}{\void}
 
 Returns the type of the content of the last opened stream. It is a mime-type.
 
 % ----------------------------------------------------------------------------

-\membersection{wxProtocol::SetUser}
+\membersection{wxProtocol::SetUser}\label{wxprotocolsetuser}

 
 \func{void }{SetUser}{\param{const wxString\&}{ user}}
 
 Sets the authentication user. It is mainly useful when FTP is used.
 
 
 \func{void }{SetUser}{\param{const wxString\&}{ user}}
 
 Sets the authentication user. It is mainly useful when FTP is used.
 

-\membersection{wxProtocol::SetPassword}
+\membersection{wxProtocol::SetPassword}\label{wxprotocolsetpassword}

 
 \func{void}{SetPassword}{\param{const wxString\&}{ user}}
 
 Sets the authentication password. It is mainly useful when FTP is used.
 
 \func{void}{SetPassword}{\param{const wxString\&}{ user}}
 
 Sets the authentication password. It is mainly useful when FTP is used.

+