X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/a84e46f23169fc203099c23643219d1a8b562b50..81c882b613b5d99ddb1e5ab69fcd7ebccc287025:/docs/latex/wx/inputstr.tex diff --git a/docs/latex/wx/inputstr.tex b/docs/latex/wx/inputstr.tex index 05f45a1884..62b7a750ff 100644 --- a/docs/latex/wx/inputstr.tex +++ b/docs/latex/wx/inputstr.tex @@ -18,19 +18,26 @@ wxInputStream is an abstract base class which may not be used directly. % ----------- % ctor & dtor % ----------- -\membersection{wxInputStream::wxInputStream} +\membersection{wxInputStream::wxInputStream}\label{wxinputstreamctor} \func{}{wxInputStream}{\void} Creates a dummy input stream. -\membersection{wxInputStream::\destruct{wxInputStream}} +\membersection{wxInputStream::\destruct{wxInputStream}}\label{wxinputstreamdtor} \func{}{\destruct{wxInputStream}}{\void} Destructor. -\membersection{wxInputStream::GetC} +\membersection{wxInputStream::CanRead}\label{wxinputstreamcanread} + +\constfunc{bool}{CanRead}{\void} + +Returns true if some data is available in the stream right now, so that +calling \helpref{Read()}{wxinputstreamread} wouldn't block. + +\membersection{wxInputStream::GetC}\label{wxinputstreamgetc} \func{char}{GetC}{\void} @@ -43,14 +50,18 @@ If EOF, return value is undefined and LastRead() will return 0 and not 1. \membersection{wxInputStream::Eof}\label{wxinputstreameof} -\constfunc{wxInputStream}{Eof}{\void} +\constfunc{bool}{Eof}{\void} -Returns true if the end of stream has been reached. +Returns true after an attempt has been made to read past the end of the +stream. \wxheading{Note} -This cannot be really implemented for all streams and CanRead() is more -reliable than Eof(). +In wxWidgets 2.6.x and below some streams returned Eof() when the last +byte had been read rather than when an attempt had been made to read +past the last byte. If you want to avoid depending on one behaviour or +the other then call \helpref{LastRead()}{wxinputstreamlastread} to +check the number of bytes actually read. \membersection{wxInputStream::LastRead}\label{wxinputstreamlastread} @@ -58,7 +69,7 @@ reliable than Eof(). Returns the last number of bytes read. -\membersection{wxInputStream::Peek} +\membersection{wxInputStream::Peek}\label{wxinputstreampeek} \func{char}{Peek}{\void} @@ -70,7 +81,7 @@ Blocks until something appears in the stream if necessary, if nothing ever does (i.e. EOF) LastRead() will return 0 (and the return value is undefined), otherwise LastRead() returns 1. -\membersection{wxInputStream::Read} +\membersection{wxInputStream::Read}\label{wxinputstreamread} \func{wxInputStream\&}{Read}{\param{void *}{buffer}, \param{size\_t}{ size}} @@ -111,7 +122,7 @@ Changes the stream current position. The new stream position or wxInvalidOffset on error. -\membersection{wxInputStream::TellI} +\membersection{wxInputStream::TellI}\label{wxinputstreamtelli} \constfunc{off\_t}{TellI}{\void}