wxWINE things.

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

diff --git a/docs/latex/wx/strmbase.tex b/docs/latex/wx/strmbase.tex
index f35be6e23ca0dc6b50c75645aa679ee8a1b66e71..7876d607b59a8d373a77314a8d2b725c16e8e06b 100644 (file)
--- a/docs/latex/wx/strmbase.tex
+++ b/docs/latex/wx/strmbase.tex
@@ -7,6 +7,10 @@
 
 None
 
 
 None
 

+\wxheading{Include files}
+
+<wx/stream.h>
+

 \wxheading{See also}
 
 \helpref{wxStreamBuffer}{wxstreambuffer}
 \wxheading{See also}
 
 \helpref{wxStreamBuffer}{wxstreambuffer}


@@ -39,50 +43,52 @@ Destructor.
 This function returns the last error.
 \twocolwidtha{5cm}
 \begin{twocollist}\itemsep=0pt
 This function returns the last error.
 \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.}
+\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}
 
 \end{twocollist}
 

-\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).
-
-\wxheading{Warning}
-
-There are streams which do not have size by definition, such as socket streams.
-In that cases, StreamSize returns an invalid size represented by
-\begin{verbatim}
-~(size_t)0
-\end{verbatim}
-

 \membersection{wxStreamBase::OnSysRead}\label{wxstreambaseonsysread}
 
 \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.
 
 
 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}
 
 \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}
 
 
 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
 real position in the stream.
 
 
 Internal function. Is is called when the stream buffer needs to know the
 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::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).
+
+\wxheading{Warning}
+
+There are streams which do not have size by definition, such as socket streams.
+In that cases, StreamSize returns an invalid size represented by
+
+\begin{verbatim}
+~(size_t)0
+\end{verbatim}
+