Documented new menu label functions

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

diff --git a/docs/latex/wx/protocol.tex b/docs/latex/wx/protocol.tex
index fcc9b406c3d7d11bed8f04307c9c24c3ff51231c..e1ba47af072f0abd79b4200369cbcda4f00c0cc0 100644 (file)
--- a/docs/latex/wx/protocol.tex
+++ b/docs/latex/wx/protocol.tex
@@ -3,11 +3,17 @@
 \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{Include files}
 
 <wx/protocol/protocol.h>
 

+\wxheading{Library}
+
+\helpref{wxNet}{librarieslist}
+

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


@@ -18,7 +24,7 @@
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

-\membersection{wxProtocol::Reconnect}\label{wxprotoreconnect}
+\membersection{wxProtocol::Reconnect}\label{wxprotocolreconnect}

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


@@ -26,16 +32,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.
 


@@ -49,7 +55,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}
 


@@ -61,10 +67,10 @@ 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}
 


@@ -85,20 +91,20 @@ Returns the last occurred error.
 \end{twocollist}
 
 % ----------------------------------------------------------------------------
 \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}}
 
 
 \func{void}{SetPassword}{\param{const wxString\&}{ user}}