Doc tweaks

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

diff --git a/docs/latex/wx/strmbase.tex b/docs/latex/wx/strmbase.tex
index 368252e9a7d9d01d864e279032b2f7270201f880..0a6a5a38efb94c49296bb0c4506ae29bf5ad5405 100644 (file)
--- a/docs/latex/wx/strmbase.tex
+++ b/docs/latex/wx/strmbase.tex
@@ -3,6 +3,9 @@
 % -----------------------------------------------------------------------------
 \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


@@ -36,39 +39,50 @@ Creates a dummy stream object. It doesn't do anything.
 
 Destructor.
 
 
 Destructor.
 

+\membersection{wxStreamBase::IsOk}\label{wxstreambaseisok}
+
+\constfunc{wxStreamError}{IsOk}{\void}
+
+Returns TRUE if no error occured 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 occured.}
+\twocolitem{{\bf wxSTREAM\_EOF}}{An End-Of-File occured.}
+\twocolitem{{\bf wxSTREAM\_WRITE\_ERROR}}{A generic error occured on the last write call.}
+\twocolitem{{\bf wxSTREAM\_READ\_ERROR}}{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}}
 
 \end{twocollist}
 
 \membersection{wxStreamBase::OnSysRead}\label{wxstreambaseonsysread}
 
 \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.
 
 \membersection{wxStreamBase::OnSysSeek}
 
 \func{off\_t}{OnSysSeek}{\param{off\_t}{ pos}, \param{wxSeekMode}{ mode}}
 
 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 buffer needs to change the
-current position in the stream. See \helpref{wxStreamBuffer::Seek}{wxstreambufferseek}
+Internal function. It is called when the stream needs to change the
+current position.

 
 \membersection{wxStreamBase::OnSysTell}
 
 \constfunc{off\_t}{OnSysTell}{\void}
 
 
 \membersection{wxStreamBase::OnSysTell}
 
 \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 needs to know the
+real position.

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


@@ -76,17 +90,17 @@ real position in the stream.
 
 See \helpref{OnSysRead}{wxstreambaseonsysread}.
 
 
 See \helpref{OnSysRead}{wxstreambaseonsysread}.
 

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

 
 

-\constfunc{size\_t}{StreamSize}{\void}
+\constfunc{size\_t}{GetSize}{\void}

 
 This function returns the size of the stream. For example, for a file it is the size of
 
 This function returns the size of the stream. For example, for a file it is the size of

-the file).
+the file.

 
 \wxheading{Warning}
 
 There are streams which do not have size by definition, such as socket streams.
 
 \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
+In that cases, GetSize returns an invalid size represented by

 
 \begin{verbatim}
 ~(size_t)0
 
 \begin{verbatim}
 ~(size_t)0