X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/d9dd875f001176760fd133f19aae8b93a0565b70..3cc305b2b4a0674c56c84d7088cfd70676b850f0:/docs/latex/wx/inputstr.tex?ds=sidebyside diff --git a/docs/latex/wx/inputstr.tex b/docs/latex/wx/inputstr.tex index e830886624..8fa169ef5d 100644 --- a/docs/latex/wx/inputstr.tex +++ b/docs/latex/wx/inputstr.tex @@ -13,34 +13,59 @@ wxInputStream is an abstract base class which may not be used directly. +\wxheading{Library} + +\helpref{wxBase}{librarieslist} + \latexignore{\rtfignore{\wxheading{Members}}} % ----------- % 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} -Returns the first character in the input queue and removes it. +Returns the first character in the input queue and removes it, +blocking until it appears if necessary. + +\wxheading{Note} + +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 after an attempt has been made to read past the end of the +stream. + +\wxheading{Note} -Returns TRUE if the end of stream has been reached. +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} @@ -48,13 +73,19 @@ Returns TRUE if the end of stream has been reached. Returns the last number of bytes read. -\membersection{wxInputStream::Peek} +\membersection{wxInputStream::Peek}\label{wxinputstreampeek} \func{char}{Peek}{\void} Returns the first character in the input queue without removing it. -\membersection{wxInputStream::Read} +\wxheading{Note} + +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}\label{wxinputstreamread} \func{wxInputStream\&}{Read}{\param{void *}{buffer}, \param{size\_t}{ size}} @@ -79,13 +110,23 @@ The data is read until an error is raised by one of the two streams. This function returns a reference on the current object, so the user can test any states of the stream right away. -\membersection{wxInputStream::SeekI} +\membersection{wxInputStream::SeekI}\label{wxinputstreamseeki} \func{off\_t}{SeekI}{\param{off\_t}{ pos}, \param{wxSeekMode}{ mode = wxFromStart}} Changes the stream current position. -\membersection{wxInputStream::TellI} +\wxheading{Parameters} + +\docparam{pos}{Offset to seek to.} + +\docparam{mode}{One of {\bf wxFromStart}, {\bf wxFromEnd}, {\bf wxFromCurrent}.} + +\wxheading{Return value} + +The new stream position or wxInvalidOffset on error. + +\membersection{wxInputStream::TellI}\label{wxinputstreamtelli} \constfunc{off\_t}{TellI}{\void} @@ -96,7 +137,7 @@ Returns the current stream position. \func{size\_t}{Ungetch}{\param{const char*}{ buffer}, \param{size\_t}{ size}} This function is only useful in {\it read} mode. It is the manager of the "Write-Back" -buffer. This buffer acts like a temporary buffer where datas which has to be +buffer. This buffer acts like a temporary buffer where data which has to be read during the next read IO call are put. This is useful when you get a big block of data which you didn't want to read: you can replace them at the top of the input queue by this way.