More asserts and stuff

[wxWidgets.git] / docs / latex / wx / inputstr.tex

diff --git a/docs/latex/wx/inputstr.tex b/docs/latex/wx/inputstr.tex
index ec8d55353f0d727ec26cca0cec9ebaf601837e69..d0888a8c450779e952cca915bc656d8a6d1b0332 100644 (file)
--- a/docs/latex/wx/inputstr.tex
+++ b/docs/latex/wx/inputstr.tex
@@ -11,10 +11,6 @@
 
 <wx/stream.h>
 
-\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,12 +32,6 @@ 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}
 
 \constfunc{size\_t}{LastRead}{\void}
@@ -74,7 +59,7 @@ The buffer absolutely needs to have at least the specified size.
 This function returns a reference on the current object, so the user can test
 any states of the stream right away.
 
-\func{wxInputStream\&}{Read}{\param{wxOutputStream\&}{ stream_out}}
+\func{wxInputStream\&}{Read}{\param{wxOutputStream\&}{ stream\_out}}
 
 Reads data from the input queue and stores it in the specified output stream.
 The data is read until an error is raised by one of the two streams.
@@ -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.
+