Use const

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

diff --git a/docs/latex/wx/inputstr.tex b/docs/latex/wx/inputstr.tex
index 54897253f88a392eb377c8d5b4e9a78218a3c0a0..8fa169ef5d609b7e54661fd96d7a4e91a0744b4c 100644 (file)
--- a/docs/latex/wx/inputstr.tex
+++ b/docs/latex/wx/inputstr.tex
@@ -13,6 +13,10 @@ wxInputStream is an abstract base class which may not be used directly.
 
 <wx/stream.h>
 
 
 <wx/stream.h>
 

+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}
+

 \latexignore{\rtfignore{\wxheading{Members}}}
 
 % -----------
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 % -----------


@@ -30,6 +34,13 @@ Creates a dummy input stream.
 
 Destructor.
 
 
 Destructor.
 

+\membersection{wxInputStream::CanRead}\label{wxinputstreamcanread}
+
+\constfunc{bool}{CanRead}{\void}
+
+Returns true if some data is available in the stream right now, so that
+calling \helpref{Read()}{wxinputstreamread} wouldn't block.
+

 \membersection{wxInputStream::GetC}\label{wxinputstreamgetc}
 
 \func{char}{GetC}{\void}
 \membersection{wxInputStream::GetC}\label{wxinputstreamgetc}
 
 \func{char}{GetC}{\void}


@@ -43,17 +54,18 @@ If EOF, return value is undefined and LastRead() will return 0 and not 1.
 
 \membersection{wxInputStream::Eof}\label{wxinputstreameof}
 
 
 \membersection{wxInputStream::Eof}\label{wxinputstreameof}
 

-\constfunc{wxInputStream}{Eof}{\void}
+\constfunc{bool}{Eof}{\void}

 
 

-Returns true if the end of stream has been reached.
+Returns true after an attempt has been made to read past the end of the
+stream.

 
 \wxheading{Note}
 
 
 \wxheading{Note}
 

-For some streams Eof() will not return true until an
-attempt has been made to read past the end of the stream.
-\helpref{LastRead()}{wxinputstreamlastread}
-should be called after each read to check that
-a non-zero number of bytes have been read.
+In wxWidgets 2.6.x and below some streams returned Eof() when the last
+byte had been read rather than when an attempt had been made to read
+past the last byte. If you want to avoid depending on one behaviour or
+the other then call \helpref{LastRead()}{wxinputstreamlastread} to
+check the number of bytes actually read.

 
 \membersection{wxInputStream::LastRead}\label{wxinputstreamlastread}
 
 
 \membersection{wxInputStream::LastRead}\label{wxinputstreamlastread}