]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/protocol.tex
test indeterminate wxGauge mode (part of patch 1551409)
[wxWidgets.git] / docs / latex / wx / protocol.tex
index e3cfe359d23e146838ae2b9314f7bc9437585c76..aa10229cbe1da82f3b871ba98795d6c816b1e298 100644 (file)
@@ -3,6 +3,8 @@
 \wxheading{Derived from}
 
 \helpref{wxSocketClient}{wxsocketclient}
+\helpref{wxSocketBase}{wxsocketbase}
+\helpref{wxObject}{wxobject}
 
 \wxheading{Include files}
 
@@ -18,7 +20,7 @@
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxProtocol::Reconnect}\label{wxprotoreconnect}
+\membersection{wxProtocol::Reconnect}\label{wxprotocolreconnect}
 
 \func{bool}{Reconnect}{\void}
 
@@ -26,16 +28,16 @@ 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}
+\membersection{wxProtocol::GetInputStream}\label{wxprotocolgetinput}
 
 \func{wxInputStream *}{GetInputStream}{\param{const wxString\&}{ path}}
 
-Creates a new input stream on the the specified path. You can use all but seek
-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
+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.
 
@@ -49,7 +51,7 @@ don't use it anymore. The destructor closes the network connection.
 \helpref{wxInputStream}{wxinputstream}
 
 % ----------------------------------------------------------------------------
-\membersection{wxProtocol::Abort}\label{wxprotoabort}
+\membersection{wxProtocol::Abort}\label{wxprotocolabort}
 
 \func{bool}{Abort}{\void}
 
@@ -61,10 +63,10 @@ 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}
+\membersection{wxProtocol::GetError}\label{wxprotocolgeterror}
 
 \func{wxProtocolError}{GetError}{\void}
 
@@ -85,20 +87,20 @@ Returns the last occurred error.
 \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.
 
 % ----------------------------------------------------------------------------
-\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.
 
-\membersection{wxProtocol::SetPassword}
+\membersection{wxProtocol::SetPassword}\label{wxprotocolsetpassword}
 
 \func{void}{SetPassword}{\param{const wxString\&}{ user}}