sorting support for generic version (patch 1765087 from Bo)

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

diff --git a/docs/latex/wx/strmbase.tex b/docs/latex/wx/strmbase.tex
index ff108b3b9355083191f54ac8ebba468e40e23227..57f20bf29153274bd94ee8f9bf3ff5705b3c52f0 100644 (file)
--- a/docs/latex/wx/strmbase.tex
+++ b/docs/latex/wx/strmbase.tex
@@ -3,6 +3,9 @@
 % -----------------------------------------------------------------------------
 \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
@@ -11,6 +14,10 @@ None
 
 <wx/stream.h>
 
+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}
+
 \wxheading{See also}
 
 \helpref{wxStreamBuffer}{wxstreambuffer}
@@ -24,71 +31,107 @@ None
 % ctor & dtor
 % -----------
 
-\membersection{wxStreamBase::wxStreamBase}
+
+\membersection{wxStreamBase::wxStreamBase}\label{wxstreambasector}
 
 \func{}{wxStreamBase}{\void}
 
 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}
 
-\constfunc{wxStreamError}{LastError}{\void}
+\membersection{wxStreamBase::GetLength}\label{wxstreambasegetlength}
+
+\constfunc{wxFileOffset}{GetLength}{\void}
+
+Returns the length of the stream in bytes. If the length cannot be determined
+(this is always the case for socket streams for example), returns 
+\texttt{wxInvalidOffset}.
+
+\newsince{2.5.4}
+
+
+\membersection{wxStreamBase::GetLastError}\label{wxstreambasegetlasterror}
+
+\constfunc{wxStreamError}{GetLastError}{\void}
 
 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\_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}}
+\membersection{wxStreamBase::GetSize}\label{wxstreambasegetsize}
 
-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.
+\constfunc{size\_t}{GetSize}{\void}
 
-\membersection{wxStreamBase::OnSysSeek}
+\helpref{GetLength}{wxstreambasegetlength}
 
-\func{off\_t}{OnSysSeek}{\param{off\_t}{ pos}, \param{wxSeekMode}{ mode}}
+This function returns the size of the stream. For example, for a file it is the
+size of the file.
 
-Internal function. It is called when the stream buffer needs to change the
-current position in the stream. See \helpref{wxStreamBuffer::Seek}{wxstreambufferseek}
+\wxheading{Warning}
 
-\membersection{wxStreamBase::OnSysTell}
+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.
 
-\constfunc{off\_t}{OnSysTell}{\void}
 
-Internal function. Is is called when the stream buffer needs to know the
-real position in the stream.
+\membersection{wxStreamBase::IsOk}\label{wxstreambaseisok}
 
-\membersection{wxStreamBase::OnSysWrite}
+\constfunc{virtual bool}{IsOk}{\void}
 
-\func{size\_t}{OnSysWrite}{\param{void *}{buffer}, \param{size\_t}{ bufsize}}
+Returns true if no error occurred on the stream.
 
-See \helpref{OnSysRead}{wxstreambaseonsysread}.
+\wxheading{See also}
 
-\membersection{wxStreamBase::GetSize}
+\helpref{GetLastError}{wxstreambasegetlasterror}
 
-\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).
+\membersection{wxStreamBase::IsSeekable}\label{wxstreambaseisseekable}
 
-\wxheading{Warning}
+\constfunc{bool}{IsSeekable}{\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
+Returns true if the streams supports seeking to arbitrary offsets.
+
+
+\membersection{wxStreamBase::OnSysRead}\label{wxstreambaseonsysread}
+
+\func{size\_t}{OnSysRead}{\param{void*}{ buffer}, \param{size\_t}{ bufsize}}
+
+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.
 
-\begin{verbatim}
-~(size_t)0
-\end{verbatim}
+
+\membersection{wxStreamBase::OnSysSeek}\label{wxstreambaseonsysseek}
+
+\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}\label{wxstreambaseonsystell}
+
+\constfunc{off\_t}{OnSysTell}{\void}
+
+Internal function. Is is called when the stream needs to know the
+real position.
+
+
+\membersection{wxStreamBase::OnSysWrite}\label{wxstreambaseonsyswrite}
+
+\func{size\_t}{OnSysWrite}{\param{const void *}{buffer}, \param{size\_t}{ bufsize}}
+
+See \helpref{OnSysRead}{wxstreambaseonsysread}.