]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/protocol.tex
mention that Add/RemoveChild() are internal
[wxWidgets.git] / docs / latex / wx / protocol.tex
index 81c68bc9bbda0a448c0cc9f34a4c12b94b106984..fc02dd57f200277f41b2a20b20143a65a4734455 100644 (file)
@@ -4,6 +4,10 @@
 
 \helpref{wxSocketClient}{wxsocketclient}
 
+\wxheading{Include files}
+
+<wx/protocol/protocol.h>
+
 \wxheading{See also}
 
 \helpref{wxSocketBase}{wxsocketbase}, \helpref{wxURL}{wxurl}
@@ -11,7 +15,8 @@
 % ----------------------------------------------------------------------------
 % Members
 % ----------------------------------------------------------------------------
-\latexignore{\rtfignore{\membersection{Members}}}
+
+\latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxProtocol::Reconnect}\label{wxprotoreconnect}
 
@@ -21,7 +26,7 @@ Tries to reestablish a previous opened connection (close and renegotiate connect
 
 \wxheading{Return value}
 
-TRUE, if the connection is established, else FALSE.
+true, if the connection is established, else false.
 
 % ----------------------------------------------------------------------------
 \membersection{wxProtocol::GetInputStream}\label{wxprotogetinput}
@@ -29,7 +34,7 @@ TRUE, if the connection is established, else FALSE.
 \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,
+functionality 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
 Tell aren't available for the moment for this sort of stream.
 You will be notified when the EOF is reached by an error.
@@ -56,26 +61,26 @@ It is advised to destroy the input stream instead of aborting the stream this wa
 
 \wxheading{Return value}
 
-Returns TRUE, if successful, else FALSE.
+Returns true, if successful, else false.
 
 % ----------------------------------------------------------------------------
 \membersection{wxProtocol::GetError}
 
 \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 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\_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}
 
@@ -98,3 +103,4 @@ Sets the authentication user. 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.
+