X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/294e9a7aa00c23de9aad973b3998071b81159aee..5f445b310b239ea4d26996d4384899c66aa833c5:/docs/latex/wx/inputstr.tex?ds=sidebyside diff --git a/docs/latex/wx/inputstr.tex b/docs/latex/wx/inputstr.tex index 0b940c020f..9edd5d824a 100644 --- a/docs/latex/wx/inputstr.tex +++ b/docs/latex/wx/inputstr.tex @@ -11,10 +11,6 @@ -\wxheading{See also} - -\helpref{wxStreamBuffer}{wxstreambuffer} - % ----------- % ctor & dtor % ----------- @@ -24,11 +20,6 @@ Creates a dummy input stream. -\func{}{wxInputStream}{\param{wxStreamBuffer *}{sbuf}} - -Creates an input stream using the specified stream buffer \it{sbuf}. This -stream buffer can point to another stream. - \membersection{wxInputStream::\destruct{wxInputStream}} \func{}{\destruct{wxInputStream}}{\void} @@ -41,13 +32,7 @@ Destructor. Returns the first character in the input queue and removes it. -\membersection{wxInputStream::InputStreamBuffer} - -\func{wxStreamBuffer*}{InputStreamBuffer}{\void} - -Returns the stream buffer associated with the input stream. - -\membersection{wxInputStream::LastRead} +\membersection{wxInputStream::LastRead}\label{wxinputstreamlastread} \constfunc{size\_t}{LastRead}{\void} @@ -96,3 +81,22 @@ Changes the stream current position. Returns the current stream position. +\membersection{wxInputStream::Ungetch}\label{wxinputstream_ungetch} + +\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 +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. + +\wxheading{Return value} + +Returns the amount of bytes saved in the Write-Back buffer. + +\func{bool}{Ungetch}{\param{char }{c}} + +This function acts like the previous one except that it takes only one +character: it is sometimes shorter to use than the generic function. +