Added event table macros to wxGrid that take window identifiers

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

diff --git a/docs/latex/wx/inputstr.tex b/docs/latex/wx/inputstr.tex
index a46d41fa391a078626ea418090f2cb280b6f93c3..eb2c5f2249668d69d304ed0e8514b8ebd10f1e2b 100644 (file)
--- a/docs/latex/wx/inputstr.tex
+++ b/docs/latex/wx/inputstr.tex
@@ -34,7 +34,12 @@ Destructor.
 
 \func{char}{GetC}{\void}
 
 
 \func{char}{GetC}{\void}
 

-Returns the first character in the input queue and removes it.
+Returns the first character in the input queue and removes it, 
+blocking until it appears if necessary.
+
+\wxheading{Note}
+
+If EOF, return value is undefined and LastRead() will return 0 and not 1.

 
 \membersection{wxInputStream::Eof}\label{wxinputstreameof}
 
 
 \membersection{wxInputStream::Eof}\label{wxinputstreameof}
 


@@ -42,6 +47,14 @@ Returns the first character in the input queue and removes it.
 
 Returns true if the end of stream has been reached.
 
 
 Returns true if the end of stream has been reached.
 

+\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.
+

 \membersection{wxInputStream::LastRead}\label{wxinputstreamlastread}
 
 \constfunc{size\_t}{LastRead}{\void}
 \membersection{wxInputStream::LastRead}\label{wxinputstreamlastread}
 
 \constfunc{size\_t}{LastRead}{\void}


@@ -54,6 +67,12 @@ Returns the last number of bytes read.
 
 Returns the first character in the input queue without removing it.
 
 
 Returns the first character in the input queue without removing it.
 

+\wxheading{Note}
+
+Blocks until something appears in the stream if necessary, if nothing
+ever does (i.e. EOF) LastRead() will return 0 (and the return value is
+undefined), otherwise LastRead() returns 1.
+

 \membersection{wxInputStream::Read}
 
 \func{wxInputStream\&}{Read}{\param{void *}{buffer}, \param{size\_t}{ size}}
 \membersection{wxInputStream::Read}
 
 \func{wxInputStream\&}{Read}{\param{void *}{buffer}, \param{size\_t}{ size}}


@@ -79,12 +98,22 @@ The data is read until an error is raised by one of the two streams.
 This function returns a reference on the current object, so the user can test
 any states of the stream right away.
 
 This function returns a reference on the current object, so the user can test
 any states of the stream right away.
 

-\membersection{wxInputStream::SeekI}
+\membersection{wxInputStream::SeekI}\label{wxinputstreamseeki}

 
 \func{off\_t}{SeekI}{\param{off\_t}{ pos}, \param{wxSeekMode}{ mode = wxFromStart}}
 
 Changes the stream current position.
 
 
 \func{off\_t}{SeekI}{\param{off\_t}{ pos}, \param{wxSeekMode}{ mode = wxFromStart}}
 
 Changes the stream current position.
 

+\wxheading{Parameters}
+
+\docparam{pos}{Offset to seek to.}
+
+\docparam{mode}{One of {\bf wxFromStart}, {\bf wxFromEnd}, {\bf wxFromCurrent}.}
+
+\wxheading{Return value}
+
+The new stream position or wxInvalidOffset on error.
+

 \membersection{wxInputStream::TellI}
 
 \constfunc{off\_t}{TellI}{\void}
 \membersection{wxInputStream::TellI}
 
 \constfunc{off\_t}{TellI}{\void}