Doc updates.

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

% -----------------------------------------------------------------------------
% wxStreamBase
% -----------------------------------------------------------------------------
\section{\class{wxStreamBase}}\label{wxstreambase}

\wxheading{Derived from}

None

\wxheading{Include files}

<wx/stream.h>

\wxheading{See also}

\helpref{wxStreamBuffer}{wxstreambuffer}

% -----------------------------------------------------------------------------
% Members
% -----------------------------------------------------------------------------
\latexignore{\rtfignore{\wxheading{Members}}} 

% -----------
% ctor & dtor
% -----------

\membersection{wxStreamBase::wxStreamBase}

\func{}{wxStreamBase}{\void}

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

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

\func{}{\destruct{wxStreamBase}}{\void}

Destructor.

\membersection{wxStreamBase::LastError}\label{wxstreambaselasterror}

\constfunc{wxStreamError}{LastError}{\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.}
\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
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}

\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.

\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}