fix warning

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

diff --git a/docs/latex/wx/strmbase.tex b/docs/latex/wx/strmbase.tex
index 5902315c4e450513184e10d204eb88b746b25996..23d8b3defaf1058cf48c27fbfcb9fbe498c4516d 100644 (file)
--- a/docs/latex/wx/strmbase.tex
+++ b/docs/latex/wx/strmbase.tex
@@ -3,10 +3,17 @@
 % -----------------------------------------------------------------------------
 \section{\class{wxStreamBase}}\label{wxstreambase}
 
+This class is the base class of most stream related classes in wxWidgets. It must
+not be used directly.
+
 \wxheading{Derived from}
 
 None
 
+\wxheading{Include files}
+
+<wx/stream.h>
+
 \wxheading{See also}
 
 \helpref{wxStreamBuffer}{wxstreambuffer}
@@ -20,56 +27,78 @@ None
 % ctor & dtor
 % -----------
 
-\membersection{wxStreamBase::wxStreamBase}
+\membersection{wxStreamBase::wxStreamBase}\label{wxstreambasector}
 
 \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}}\label{wxstreambasedtor}
 
 \func{}{\destruct{wxStreamBase}}{\void}
 
 Destructor.
 
-\membersection{wxStreamBase::LastError}\label{wxstreambaselasterror}
+\membersection{wxStreamBase::IsOk}\label{wxstreambaseisok}
 
-\constfunc{wxStreamError}{LastError}{\void}
+\constfunc{wxStreamError}{IsOk}{\void}
 
-This function returns the last error.
-% It is of the form:
-% TODO
+Returns true if no error occurred on the stream.
+
+\wxheading{See also}
 
-\membersection{wxStreamBase::StreamSize}
-\constfunc{size_t}{StreamSize}{\void}
+\helpref{GetLastError}{wxstreambasegetlasterror}
 
-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::GetLastError}\label{wxstreambasegetlasterror}
+
+\constfunc{wxStreamError}{GetLastError}{\void}
+
+This function returns the last error.
+
+\twocolwidtha{5cm}
+\begin{twocollist}\itemsep=0pt
+\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}
 
 \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.
 
-\membersection{wxStreamBase::OnSysWrite}
+\membersection{wxStreamBase::OnSysSeek}\label{wxstreambaseonsysseek}
 
-\func{size_t}{OnSysWrite}{\param{void *}{buffer}, \param{size_t}{ bufsize}}
+\func{off\_t}{OnSysSeek}{\param{off\_t}{ pos}, \param{wxSeekMode}{ mode}}
 
-See \helpref{OnSysRead}{wxstreambaseonsysread}.
+Internal function. It is called when the stream needs to change the
+current position.
+
+\membersection{wxStreamBase::OnSysTell}\label{wxstreambaseonsystell}
 
-\membersection{wxStreamBase::OnSysSeek}
+\constfunc{off\_t}{OnSysTell}{\void}
 
-\func{off_t}{OnSysSeek}{\param{off_t}{ pos}, \param{wxSeekMode}{ mode}}
+Internal function. Is is called when the stream needs to know the
+real position.
 
-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::OnSysWrite}\label{wxstreambaseonsyswrite}
 
-\membersection{wxStreamBase::OnSysTell}
+\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.
 
-\constfunc{off_t}{OnSysTell}{\void}
+\wxheading{Warning}
 
-Internal function. Is is called when the stream buffer needs to know the
-current position in the stream.
+There are streams which do not have size by definition, such as socket streams.
+In that cases, GetSize returns $0$ so you should always test its return value.