X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/d984207cc37ad70649b2392314fb9e42719506c3..56b88f1276ea4049a21f6174842b56ca9f280a3f:/docs/latex/wx/inputstr.tex diff --git a/docs/latex/wx/inputstr.tex b/docs/latex/wx/inputstr.tex index ac2f97a3f7..daf42acc31 100644 --- a/docs/latex/wx/inputstr.tex +++ b/docs/latex/wx/inputstr.tex @@ -13,6 +13,8 @@ wxInputStream is an abstract base class which may not be used directly. +\latexignore{\rtfignore{\wxheading{Members}}} + % ----------- % ctor & dtor % ----------- @@ -34,6 +36,12 @@ Destructor. Returns the first character in the input queue and removes it. +\membersection{wxInputStream::Eof}\label{wxinputstreameof} + +\constfunc{wxInputStream}{Eof}{\void} + +Returns true if the end of stream has been reached. + \membersection{wxInputStream::LastRead}\label{wxinputstreamlastread} \constfunc{size\_t}{LastRead}{\void} @@ -50,7 +58,7 @@ Returns the first character in the input queue without removing it. \func{wxInputStream\&}{Read}{\param{void *}{buffer}, \param{size\_t}{ size}} -Reads the specified amount of bytes and stores the data in \it{buffer}. +Reads the specified amount of bytes and stores the data in {\it buffer}. \wxheading{Warning} @@ -71,7 +79,7 @@ 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}} @@ -83,12 +91,12 @@ Changes the stream current position. Returns the current stream position. -\membersection{wxInputStream::Ungetch}\label{wxinputstream_ungetch} +\membersection{wxInputStream::Ungetch}\label{wxinputstreamungetch} \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 +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 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.