X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/588066b7a39629e44bb39f1ab436b80f38c13f33..d3f00f59938d4801a95afa1cd638b8f15c481ee3:/docs/latex/wx/strmbase.tex diff --git a/docs/latex/wx/strmbase.tex b/docs/latex/wx/strmbase.tex index 1e7f6d824e..57f20bf291 100644 --- a/docs/latex/wx/strmbase.tex +++ b/docs/latex/wx/strmbase.tex @@ -14,6 +14,10 @@ None +\wxheading{Library} + +\helpref{wxBase}{librarieslist} + \wxheading{See also} \helpref{wxStreamBuffer}{wxstreambuffer} @@ -47,7 +51,7 @@ Destructor. \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 +(this is always the case for socket streams for example), returns \texttt{wxInvalidOffset}. \newsince{2.5.4} @@ -72,7 +76,7 @@ This function returns the last error. \constfunc{size\_t}{GetSize}{\void} -\deprecated{\helpref{GetLength}{wxstreambasegetlength}} +\helpref{GetLength}{wxstreambasegetlength} This function returns the size of the stream. For example, for a file it is the size of the file. @@ -85,7 +89,7 @@ In that cases, GetSize returns $0$ so you should always test its return value. \membersection{wxStreamBase::IsOk}\label{wxstreambaseisok} -\constfunc{wxStreamError}{IsOk}{\void} +\constfunc{virtual bool}{IsOk}{\void} Returns true if no error occurred on the stream. @@ -94,6 +98,13 @@ Returns true if no error occurred on the stream. \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}} @@ -120,8 +131,7 @@ real position. \membersection{wxStreamBase::OnSysWrite}\label{wxstreambaseonsyswrite} -\func{size\_t}{OnSysWrite}{\param{void *}{buffer}, \param{size\_t}{ bufsize}} +\func{size\_t}{OnSysWrite}{\param{const void *}{buffer}, \param{size\_t}{ bufsize}} See \helpref{OnSysRead}{wxstreambaseonsysread}. -