some wxArtProv docs

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

diff --git a/docs/latex/wx/strmbase.tex b/docs/latex/wx/strmbase.tex
index 4ff8ade705eedf3630ef7611a3281ebc10c9e951..243e5a48ef01a74d20e6687b967a21c8322db6cc 100644 (file)
--- a/docs/latex/wx/strmbase.tex
+++ b/docs/latex/wx/strmbase.tex
@@ -3,10 +3,17 @@
 % -----------------------------------------------------------------------------
 \section{\class{wxStreamBase}}\label{wxstreambase}
 
 % -----------------------------------------------------------------------------
 \section{\class{wxStreamBase}}\label{wxstreambase}
 

+This class is the base class of most stream related classes in wxWindows. It must
+not be used directly.
+

 \wxheading{Derived from}
 
 None
 
 \wxheading{Derived from}
 
 None
 

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

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


@@ -24,7 +31,7 @@ None
 
 \func{}{wxStreamBase}{\void}
 
 
 \func{}{wxStreamBase}{\void}
 

-Creates a dummy stream object.
+Creates a dummy stream object. It doesn't do anything.

 
 \membersection{wxStreamBase::\destruct{wxStreamBase}}
 
 
 \membersection{wxStreamBase::\destruct{wxStreamBase}}
 


@@ -32,49 +39,70 @@ Creates a dummy stream object.
 
 Destructor.
 
 
 Destructor.
 

+\membersection{wxStreamBase::IsOk}\label{wxstreambaseisok}
+
+\constfunc{wxStreamError}{IsOk}{\void}
+
+Returns TRUE if no error occurred on the stream.
+
+\wxheading{See also}
+
+\helpref{LastError}{wxstreambaselasterror}
+

 \membersection{wxStreamBase::LastError}\label{wxstreambaselasterror}
 
 \constfunc{wxStreamError}{LastError}{\void}
 
 This function returns the last error.
 \membersection{wxStreamBase::LastError}\label{wxstreambaselasterror}
 
 \constfunc{wxStreamError}{LastError}{\void}
 
 This function returns the last error.

+

 \twocolwidtha{5cm}
 \begin{twocollist}\itemsep=0pt
 \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\_NO\_ERROR}}{No error occurred.}
+\twocolitem{{\bf wxSTREAM\_EOF}}{An End-Of-File occurred.}
+\twocolitem{{\bf wxSTREAM\_WRITE\_ERROR}}{A generic error occurred on the last write call.}
+\twocolitem{{\bf wxSTREAM\_READ\_ERROR}}{A generic error occurred 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). Warning! There are streams which do not have size by definition, such as a socket.
-

 \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
+Internal function. It is called when the stream wants to read data of the

 specified size. It should return the size that was actually read.
 
 specified size. It should return the size that was actually read.
 

+\membersection{wxStreamBase::OnSysSeek}
+
+\func{off\_t}{OnSysSeek}{\param{off\_t}{ pos}, \param{wxSeekMode}{ mode}}
+
+Internal function. It is called when the stream needs to change the
+current position.
+
+\membersection{wxStreamBase::OnSysTell}
+
+\constfunc{off\_t}{OnSysTell}{\void}
+
+Internal function. Is is called when the stream needs to know the
+real position.
+

 \membersection{wxStreamBase::OnSysWrite}
 
 \membersection{wxStreamBase::OnSysWrite}
 

-\func{size_t}{OnSysWrite}{\param{void *}{buffer}, \param{size_t}{ bufsize}}
+\func{size\_t}{OnSysWrite}{\param{void *}{buffer}, \param{size\_t}{ bufsize}}

 
 See \helpref{OnSysRead}{wxstreambaseonsysread}.
 
 
 See \helpref{OnSysRead}{wxstreambaseonsysread}.
 

-\membersection{wxStreamBase::OnSysSeek}
+\membersection{wxStreamBase::GetSize}\label{wxstreambasegetsize}

 
 

-\func{off_t}{OnSysSeek}{\param{off_t}{ pos}, \param{wxSeekMode}{ mode}}
+\constfunc{size\_t}{GetSize}{\void}

 
 

-Internal function. It is called when the stream buffer needs to change the
-current position in the stream. See \helpref{wxStreamBuffer::Seek}{wxstreambufferseek}
+This function returns the size of the stream. For example, for a file it is the size of
+the file.

 
 

-\membersection{wxStreamBase::OnSysTell}
+\wxheading{Warning}

 
 

-\constfunc{off_t}{OnSysTell}{\void}
+There are streams which do not have size by definition, such as socket streams.
+In that cases, GetSize returns an invalid size represented by

 
 

-Internal function. Is is called when the stream buffer needs to know the
-current position in the stream.
+\begin{verbatim}
+~(size_t)0
+\end{verbatim}