CW5.2 Pro Adaptions, wxMac starting to move in

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

diff --git a/docs/latex/wx/strmbase.tex b/docs/latex/wx/strmbase.tex
index 5902315c4e450513184e10d204eb88b746b25996..5cc9320525c64c24cee8b6d4e0ecf57072122377 100644 (file)
--- a/docs/latex/wx/strmbase.tex
+++ b/docs/latex/wx/strmbase.tex
@@ -7,6 +7,10 @@
 
 None
 
+\wxheading{Include files}
+
+<wx/stream.h>
+
 \wxheading{See also}
 
 \helpref{wxStreamBuffer}{wxstreambuffer}
@@ -24,7 +28,7 @@ None
 
 \func{}{wxStreamBase}{\void}
 
-Creates a dummy stream object.
+Creates a dummy stream object. It doesn't do anything.
 
 \membersection{wxStreamBase::\destruct{wxStreamBase}}
 
@@ -37,39 +41,54 @@ Destructor.
 \constfunc{wxStreamError}{LastError}{\void}
 
 This function returns the last error.
-% It is of the form:
-% TODO
-
-\membersection{wxStreamBase::StreamSize}
-\constfunc{size_t}{StreamSize}{\void}
-
-This function returns the size of the stream. For example, for a file it is the size of
-the file). Warning! There are streams which do not have size by definition, such as a socket.
+\twocolwidtha{5cm}
+\begin{twocollist}\itemsep=0pt
+\twocolitem{{\bf wxStream\_NOERROR}}{No error occured.}
+\twocolitem{{\bf wxStream\_EOF}}{An End-Of-File occured.}
+\twocolitem{{\bf wxStream\_WRITE\_ERR}}{A generic error occured on the last write call.}
+\twocolitem{{\bf wxStream\_READ\_ERR}}{A generic error occured on the last read call.}
+\end{twocollist}
 
 \membersection{wxStreamBase::OnSysRead}\label{wxstreambaseonsysread}
 
-\func{size_t}{OnSysRead}{\param{void*}{ buffer}, \param{size_t}{ bufsize}}
+\func{size\_t}{OnSysRead}{\param{void*}{ buffer}, \param{size\_t}{ bufsize}}
 
 Internal function. It is called when the stream buffer needs a buffer of the
 specified size. It should return the size that was actually read.
 
-\membersection{wxStreamBase::OnSysWrite}
-
-\func{size_t}{OnSysWrite}{\param{void *}{buffer}, \param{size_t}{ bufsize}}
-
-See \helpref{OnSysRead}{wxstreambaseonsysread}.
-
 \membersection{wxStreamBase::OnSysSeek}
 
-\func{off_t}{OnSysSeek}{\param{off_t}{ pos}, \param{wxSeekMode}{ mode}}
+\func{off\_t}{OnSysSeek}{\param{off\_t}{ pos}, \param{wxSeekMode}{ mode}}
 
 Internal function. It is called when the stream buffer needs to change the
 current position in the stream. See \helpref{wxStreamBuffer::Seek}{wxstreambufferseek}
 
 \membersection{wxStreamBase::OnSysTell}
 
-\constfunc{off_t}{OnSysTell}{\void}
+\constfunc{off\_t}{OnSysTell}{\void}
 
 Internal function. Is is called when the stream buffer needs to know the
-current position in the stream.
+real position in the stream.
+
+\membersection{wxStreamBase::OnSysWrite}
+
+\func{size\_t}{OnSysWrite}{\param{void *}{buffer}, \param{size\_t}{ bufsize}}
+
+See \helpref{OnSysRead}{wxstreambaseonsysread}.
+
+\membersection{wxStreamBase::GetSize}\label{wxstreambasegetsize}
+
+\constfunc{size\_t}{GetSize}{\void}
+
+This function returns the size of the stream. For example, for a file it is the size of
+the file).
+
+\wxheading{Warning}
+
+There are streams which do not have size by definition, such as socket streams.
+In that cases, GetSize returns an invalid size represented by
+
+\begin{verbatim}
+~(size_t)0
+\end{verbatim}