removed small as otherwise the code was apparently unreadable in HTML docs

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

diff --git a/docs/latex/wx/inputstr.tex b/docs/latex/wx/inputstr.tex
index 0b940c020f6cdd2ac322f5ea5b69c5e1ae27e6ee..e8308866243adbf07782db1e142ccf0563339b06 100644 (file)
--- a/docs/latex/wx/inputstr.tex
+++ b/docs/latex/wx/inputstr.tex
@@ -3,6 +3,8 @@
 % -----------------------------------------------------------------------------
 \section{\class{wxInputStream}}\label{wxinputstream}
 
+wxInputStream is an abstract base class which may not be used directly.
+
 \wxheading{Derived from}
 
 \helpref{wxStreamBase}{wxstreambase}
@@ -11,9 +13,7 @@
 
 <wx/stream.h>
 
-\wxheading{See also}
-
-\helpref{wxStreamBuffer}{wxstreambuffer}
+\latexignore{\rtfignore{\wxheading{Members}}}
 
 % -----------
 % ctor & dtor
@@ -24,11 +24,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 +36,13 @@ Destructor.
 
 Returns the first character in the input queue and removes it.
 
-\membersection{wxInputStream::InputStreamBuffer}
+\membersection{wxInputStream::Eof}\label{wxinputstreameof}
 
-\func{wxStreamBuffer*}{InputStreamBuffer}{\void}
+\constfunc{wxInputStream}{Eof}{\void}
 
-Returns the stream buffer associated with the input stream.
+Returns TRUE if the end of stream has been reached.
 
-\membersection{wxInputStream::LastRead}
+\membersection{wxInputStream::LastRead}\label{wxinputstreamlastread}
 
 \constfunc{size\_t}{LastRead}{\void}
 
@@ -63,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}
 
@@ -96,3 +91,27 @@ Changes the stream current position.
 
 Returns the current stream position.
 
+\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
+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.
+
+Be very careful about this call in connection with calling SeekI() on the same
+stream. Any call to SeekI() will invalidate any previous call to this method
+(otherwise you could SeekI() to one position, "unread" a few bytes there, SeekI()
+to another position and data would be either lost or corrupted).
+
+\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.
+