A minimal document skeleton. See comments inside for details

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

diff --git a/docs/latex/wx/protocol.tex b/docs/latex/wx/protocol.tex
index 7cf0aed0c142cea4cedb9ad06b913922bc6260cb..730514b43f19fdd835cb76b9e434e33774d7a83b 100644 (file)
--- a/docs/latex/wx/protocol.tex
+++ b/docs/latex/wx/protocol.tex
@@ -11,7 +11,6 @@
 % ----------------------------------------------------------------------------
 % Members
 % ----------------------------------------------------------------------------
 % ----------------------------------------------------------------------------
 % Members
 % ----------------------------------------------------------------------------

-

 \latexignore{\rtfignore{\membersection{Members}}}
 
 \membersection{wxProtocol::Reconnect}\label{wxprotoreconnect}
 \latexignore{\rtfignore{\membersection{Members}}}
 
 \membersection{wxProtocol::Reconnect}\label{wxprotoreconnect}


@@ -25,7 +24,6 @@ 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}}
 \membersection{wxProtocol::GetInputStream}\label{wxprotogetinput}
 
 \func{wxInputStream *}{GetInputStream}{\param{const wxString\&}{ path}}


@@ -39,12 +37,12 @@ http or ftp streams doesn't deal with it.
 Returns the initialized stream. You will have to delete it yourself.
 
 % ----------------------------------------------------------------------------
 Returns the initialized stream. You will have to delete it yourself.
 
 % ----------------------------------------------------------------------------

-

 \membersection{wxProtocol::Abort}\label{wxprotoabort}
 
 \membersection{wxProtocol::Abort}\label{wxprotoabort}
 

-\func{bool }{Abort}{\void}
+\func{bool}{Abort}{\void}

 
 Abort the current stream.
 
 Abort the current stream.

+

 \it{WARNING: It is advised to destroy the input stream instead of aborting the stream this way.}
 
 \wxheading{Return value}
 \it{WARNING: It is advised to destroy the input stream instead of aborting the stream this way.}
 
 \wxheading{Return value}


@@ -52,23 +50,34 @@ Abort the current stream.
 Returns TRUE, if successful, else FALSE.
 
 % ----------------------------------------------------------------------------
 Returns TRUE, if successful, else FALSE.
 
 % ----------------------------------------------------------------------------

-

 \membersection{wxProtocol::GetError}
 
 \membersection{wxProtocol::GetError}
 

-\func{wxProtocolError }{GetError}{\void}
+\func{wxProtocolError}{GetError}{\void}

 
 Returns the last occured error.
 
 
 Returns the last occured 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\_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\_STREAM}}{Someone tried to send a command during a transfer.}
+\end{twocollist}

 
 

+% ----------------------------------------------------------------------------

 \membersection{wxProtocol::GetContentType}
 
 \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.
 
 % ----------------------------------------------------------------------------
 
 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}}


@@ -77,6 +86,7 @@ Sets the authentication user. It is mainly useful when FTP is used.
 
 \membersection{wxProtocol::SetPassword}
 
 
 \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.
 
 Sets the authentication password. It is mainly useful when FTP is used.

+