]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/protocol.tex
Typos in sizer docs.
[wxWidgets.git] / docs / latex / wx / protocol.tex
index 730514b43f19fdd835cb76b9e434e33774d7a83b..0043092d7f3d1cfc3e066d1dc1bd11c567d0df35 100644 (file)
@@ -4,6 +4,10 @@
 
 \helpref{wxSocketClient}{wxsocketclient}
 
 
 \helpref{wxSocketClient}{wxsocketclient}
 
+\wxheading{Include files}
+
+<wx/protocol/protocol.h>
+
 \wxheading{See also}
 
 \helpref{wxSocketBase}{wxsocketbase}, \helpref{wxURL}{wxurl}
 \wxheading{See also}
 
 \helpref{wxSocketBase}{wxsocketbase}, \helpref{wxURL}{wxurl}
@@ -11,6 +15,7 @@
 % ----------------------------------------------------------------------------
 % Members
 % ----------------------------------------------------------------------------
 % ----------------------------------------------------------------------------
 % Members
 % ----------------------------------------------------------------------------
+
 \latexignore{\rtfignore{\membersection{Members}}}
 
 \membersection{wxProtocol::Reconnect}\label{wxprotoreconnect}
 \latexignore{\rtfignore{\membersection{Members}}}
 
 \membersection{wxProtocol::Reconnect}\label{wxprotoreconnect}
@@ -30,11 +35,18 @@ TRUE, if the connection is established, else FALSE.
 
 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,
 
 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.
+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.
 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 
-Returns the initialized stream. You will have to delete it yourself.
+Returns the initialized stream. You will have to delete it yourself once you
+don't use it anymore. The destructor closes the network connection.
+
+\wxheading{See also}
+
+\helpref{wxInputStream}{wxinputstream}
 
 % ----------------------------------------------------------------------------
 \membersection{wxProtocol::Abort}\label{wxprotoabort}
 
 % ----------------------------------------------------------------------------
 \membersection{wxProtocol::Abort}\label{wxprotoabort}
@@ -43,7 +55,9 @@ Returns the initialized stream. You will have to delete it yourself.
 
 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{Warning}
+
+It is advised to destroy the input stream instead of aborting the stream this way.
 
 \wxheading{Return value}
 
 
 \wxheading{Return value}