wxTINY_CAPTION_XXX are obsolete

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

diff --git a/docs/latex/wx/inputstr.tex b/docs/latex/wx/inputstr.tex
index d0888a8c450779e952cca915bc656d8a6d1b0332..a46d41fa391a078626ea418090f2cb280b6f93c3 100644 (file)
--- a/docs/latex/wx/inputstr.tex
+++ b/docs/latex/wx/inputstr.tex
@@ -3,6 +3,8 @@
 % -----------------------------------------------------------------------------
 \section{\class{wxInputStream}}\label{wxinputstream}
 
 % -----------------------------------------------------------------------------
 \section{\class{wxInputStream}}\label{wxinputstream}
 

+wxInputStream is an abstract base class which may not be used directly.
+

 \wxheading{Derived from}
 
 \helpref{wxStreamBase}{wxstreambase}
 \wxheading{Derived from}
 
 \helpref{wxStreamBase}{wxstreambase}


@@ -11,6 +13,8 @@
 
 <wx/stream.h>
 
 
 <wx/stream.h>
 

+\latexignore{\rtfignore{\wxheading{Members}}}
+

 % -----------
 % ctor & dtor
 % -----------
 % -----------
 % ctor & dtor
 % -----------


@@ -32,7 +36,13 @@ Destructor.
 
 Returns the first character in the input queue and removes it.
 
 
 Returns the first character in the input queue and removes it.
 

-\membersection{wxInputStream::LastRead}
+\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}
 
 
 \constfunc{size\_t}{LastRead}{\void}
 


@@ -48,7 +58,7 @@ Returns the first character in the input queue without removing it.
 
 \func{wxInputStream\&}{Read}{\param{void *}{buffer}, \param{size\_t}{ size}}
 
 
 \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}
 
 
 \wxheading{Warning}
 


@@ -81,16 +91,21 @@ Changes the stream current position.
 
 Returns the current stream 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}}
 
 
 \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.
 
 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.
 \wxheading{Return value}
 
 Returns the amount of bytes saved in the Write-Back buffer.