X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/7468b994be5579ff57516f07e2d771831e73f65e..c266eff98c5e44012647f54f38a1e29ecabd8759:/docs/latex/wx/strmbase.tex diff --git a/docs/latex/wx/strmbase.tex b/docs/latex/wx/strmbase.tex index 1bcd9ec56b..57f20bf291 100644 --- a/docs/latex/wx/strmbase.tex +++ b/docs/latex/wx/strmbase.tex @@ -3,7 +3,7 @@ % ----------------------------------------------------------------------------- \section{\class{wxStreamBase}}\label{wxstreambase} -This class is the base class of most stream related classes in wxWindows. It must +This class is the base class of most stream related classes in wxWidgets. It must not be used directly. \wxheading{Derived from} @@ -14,6 +14,10 @@ None +\wxheading{Library} + +\helpref{wxBase}{librarieslist} + \wxheading{See also} \helpref{wxStreamBuffer}{wxstreambuffer} @@ -27,31 +31,80 @@ 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\_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.} +\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. + + \membersection{wxStreamBase::OnSysRead}\label{wxstreambaseonsysread} \func{size\_t}{OnSysRead}{\param{void*}{ buffer}, \param{size\_t}{ bufsize}} @@ -59,39 +112,26 @@ This function returns the last error. 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::OnSysSeek} + +\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} + +\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} -\func{size\_t}{OnSysWrite}{\param{void *}{buffer}, \param{size\_t}{ bufsize}} +\membersection{wxStreamBase::OnSysWrite}\label{wxstreambaseonsyswrite} -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). +\func{size\_t}{OnSysWrite}{\param{const void *}{buffer}, \param{size\_t}{ bufsize}} -\wxheading{Warning} - -There are streams which do not have size by definition, such as socket streams. -In that cases, GetSize returns an invalid size represented by - -\begin{verbatim} -~(size_t)0 -\end{verbatim} +See \helpref{OnSysRead}{wxstreambaseonsysread}.