]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/strmsock.tex
don't use _T() inside wxGetTranslation() and related macros (wxTRANSLATE, _, ......
[wxWidgets.git] / docs / latex / wx / strmsock.tex
index 08a6e8157e9ecd2e01814b9ebce46b046e52fb54..e2bf61f987df85567996b42a4accb3a48c6db596 100644 (file)
@@ -1,44 +1,81 @@
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% Name:        socket.tex
+%% Purpose:     wxSocket docs
+%% Author:      Guillermo Rodriguez Garcia <guille@iies.es>
+%% Modified by:
+%% Created:     1999
+%% RCS-ID:      $Id$
+%% Copyright:   (c) wxWidgets team
+%% License:     wxWindows license
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
 % -----------------------------------------------------------------------------
 % wxSocketInputStream
 % -----------------------------------------------------------------------------
 % -----------------------------------------------------------------------------
 % wxSocketInputStream
 % -----------------------------------------------------------------------------
-\section{\class{wxSocketInputStream}}
+\section{\class{wxSocketInputStream}}\label{wxsocketinputstream}
+
+This class implements an input stream which reads data from
+a connected socket. Note that this stream is purely sequential
+and it does not support seeking.
 
 \wxheading{Derived from}
 
 
 \wxheading{Derived from}
 
-\helpref{wxInputStream}{wxinputStream}
+\helpref{wxInputStream}{wxinputstream}\\
+\helpref{wxStreamBase}{wxstreambase}
+
+\wxheading{Include files}
+
+<wx/sckstrm.h>
+
+\wxheading{Library}
+
+\helpref{wxNet}{librarieslist}
 
 \wxheading{See also}
 
 
 \wxheading{See also}
 
-\helpref{wxStreamBuffer}{wxstreamBuffer}, \helpref{wxSocketBase}{wxsocketbase}
+\helpref{wxSocketBase}{wxsocketbase}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxSocketInputStream::wxSocketInputStream}
+\membersection{wxSocketInputStream::wxSocketInputStream}\label{wxsocketinputstreamctor}
 
 \func{}{wxSocketInputStream}{\param{wxSocketBase\&}{ s}}
 
 
 \func{}{wxSocketInputStream}{\param{wxSocketBase\&}{ s}}
 
-Initializes a new read-only socket stream using the specified initialized
-socket connection.
+Creates a new read-only socket stream using the specified initialized
+socket connection. 
 
 % -----------------------------------------------------------------------------
 % wxSocketOutputStream
 % -----------------------------------------------------------------------------
 
 % -----------------------------------------------------------------------------
 % wxSocketOutputStream
 % -----------------------------------------------------------------------------
-\section{\class{wxSocketInputStream}}
+\section{\class{wxSocketOutputStream}}\label{wxsocketoutputstream}
+
+This class implements an output stream which writes data from
+a connected socket. Note that this stream is purely sequential
+and it does not support seeking.
 
 \wxheading{Derived from}
 
 
 \wxheading{Derived from}
 
-\helpref{wxOutputStream}{wxoutputStream}
+\helpref{wxOutputStream}{wxoutputstream}\\
+\helpref{wxStreamBase}{wxstreambase}
+
+\wxheading{Include files}
+
+<wx/sckstrm.h>
+
+\wxheading{Library}
+
+\helpref{wxNet}{librarieslist}
 
 \wxheading{See also}
 
 
 \wxheading{See also}
 
-\helpref{wxStreamBuffer}{wxstreamBuffer}, \helpref{wxSocketBase}{wxsocketbase}
+\helpref{wxSocketBase}{wxsocketbase}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxSocketOutputStream::wxSocketOutputStream}
+\membersection{wxSocketOutputStream::wxSocketOutputStream}\label{wxsocketoutputstreamctor}
 
 
-\func{}{wxSocketInputStream}{\param{wxSocketBase\&}{ s}}
+\func{}{wxSocketOutputStream}{\param{wxSocketBase\&}{ s}}
 
 
-Initializes a new write-only socket stream using the specified initialized
+Creates a new write-only socket stream using the specified initialized
 socket connection.
 
 socket connection.