X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/e2a6f23364aefcd5095dc6558e3ab8144363fa96..c266eff98c5e44012647f54f38a1e29ecabd8759:/docs/latex/wx/strmbase.tex?ds=sidebyside diff --git a/docs/latex/wx/strmbase.tex b/docs/latex/wx/strmbase.tex index 5902315c4e..57f20bf291 100644 --- a/docs/latex/wx/strmbase.tex +++ b/docs/latex/wx/strmbase.tex @@ -3,10 +3,21 @@ % ----------------------------------------------------------------------------- \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} + + + +\wxheading{Library} + +\helpref{wxBase}{librarieslist} + \wxheading{See also} \helpref{wxStreamBuffer}{wxstreambuffer} @@ -20,56 +31,107 @@ 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} -\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. -% It is of the form: -% TODO -\membersection{wxStreamBase::StreamSize} -\constfunc{size_t}{StreamSize}{\void} +\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::GetSize}\label{wxstreambasegetsize} + +\constfunc{size\_t}{GetSize}{\void} + +\helpref{GetLength}{wxstreambasegetlength} + +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, GetSize returns $0$ so you should always test its return value. + + +\membersection{wxStreamBase::IsOk}\label{wxstreambaseisok} + +\constfunc{virtual bool}{IsOk}{\void} + +Returns true if no error occurred on the stream. + +\wxheading{See also} + +\helpref{GetLastError}{wxstreambasegetlasterror} + + +\membersection{wxStreamBase::IsSeekable}\label{wxstreambaseisseekable} + +\constfunc{bool}{IsSeekable}{\void} + +Returns true if the streams supports seeking to arbitrary offsets. -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::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} -\func{size_t}{OnSysWrite}{\param{void *}{buffer}, \param{size_t}{ bufsize}} +\membersection{wxStreamBase::OnSysSeek}\label{wxstreambaseonsysseek} -See \helpref{OnSysRead}{wxstreambaseonsysread}. +\func{off\_t}{OnSysSeek}{\param{off\_t}{ pos}, \param{wxSeekMode}{ mode}} -\membersection{wxStreamBase::OnSysSeek} +Internal function. It is called when the stream needs to change the +current position. -\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}\label{wxstreambaseonsystell} -\membersection{wxStreamBase::OnSysTell} +\constfunc{off\_t}{OnSysTell}{\void} -\constfunc{off_t}{OnSysTell}{\void} +Internal function. Is is called when the stream needs to know the +real position. -Internal function. Is is called when the stream buffer needs to know the -current position in the stream. + +\membersection{wxStreamBase::OnSysWrite}\label{wxstreambaseonsyswrite} + +\func{size\_t}{OnSysWrite}{\param{const void *}{buffer}, \param{size\_t}{ bufsize}} + +See \helpref{OnSysRead}{wxstreambaseonsysread}.