fix warning

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

diff --git a/docs/latex/wx/inputstr.tex b/docs/latex/wx/inputstr.tex
index d0888a8c450779e952cca915bc656d8a6d1b0332..eb2c5f2249668d69d304ed0e8514b8ebd10f1e2b 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
 % -----------


@@ -30,9 +34,28 @@ 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}
+
+\constfunc{wxInputStream}{Eof}{\void}
+
+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}
+\membersection{wxInputStream::LastRead}\label{wxinputstreamlastread}

 
 \constfunc{size\_t}{LastRead}{\void}
 
 
 \constfunc{size\_t}{LastRead}{\void}
 


@@ -44,11 +67,17 @@ 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}}
 

-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}
 


@@ -69,28 +98,43 @@ 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}
 
 Returns the current stream position.
 
 \membersection{wxInputStream::TellI}
 
 \constfunc{off\_t}{TellI}{\void}
 
 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.