X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/7f42cff13eaba35dda3527b2ca658dd00b9e7a46..3f8e5072f7391db2158f44c6b9209bbb3db6eb06:/docs/latex/wx/strmbase.tex diff --git a/docs/latex/wx/strmbase.tex b/docs/latex/wx/strmbase.tex index 70eaf82689..40ce15f24f 100644 --- 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 wxWindows. It must +not be used directly. + \wxheading{Derived from} None +\wxheading{Include files} + + + \wxheading{See also} \helpref{wxStreamBuffer}{wxstreambuffer} @@ -32,6 +39,16 @@ Creates a dummy stream object. It doesn't do anything. 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} @@ -39,50 +56,52 @@ Destructor. 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 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::StreamSize} -\constfunc{size_t}{StreamSize}{\void} +\membersection{wxStreamBase::OnSysRead}\label{wxstreambaseonsysread} -This function returns the size of the stream. For example, for a file it is the size of -the file). +\func{size\_t}{OnSysRead}{\param{void*}{ buffer}, \param{size\_t}{ bufsize}} -\wxheading{Warning} +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. -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} +\membersection{wxStreamBase::OnSysSeek} -\membersection{wxStreamBase::OnSysRead}\label{wxstreambaseonsysread} +\func{off\_t}{OnSysSeek}{\param{off\_t}{ pos}, \param{wxSeekMode}{ mode}} -\func{size_t}{OnSysRead}{\param{void*}{ buffer}, \param{size_t}{ bufsize}} +Internal function. It is called when the stream needs to change the +current position. -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::OnSysTell} + +\constfunc{off\_t}{OnSysTell}{\void} + +Internal function. Is is called when the stream needs to know the +real position. \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}. -\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 -real position in the stream. +\begin{verbatim} +~(size_t)0 +\end{verbatim}