use wx_static_cast() inside wxDynamicCast to catch impossible casts at compile-time...

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

diff --git a/docs/latex/wx/inputstr.tex b/docs/latex/wx/inputstr.tex
index fec1deea18a4960d742b6666be657c5337436167..05f45a1884434f9f6b47000bf30e35a87f0a28d0 100644 (file)
--- a/docs/latex/wx/inputstr.tex
+++ b/docs/latex/wx/inputstr.tex
@@ -3,13 +3,17 @@
 % -----------------------------------------------------------------------------
 \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}
 

-\wxheading{See also}
+\wxheading{Include files}
+
+<wx/stream.h>

 
 

-\helpref{wxStreamBuffer}{wxstreambuffer}
+\latexignore{\rtfignore{\wxheading{Members}}}

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


@@ -20,75 +24,120 @@
 
 Creates a dummy input stream.
 
 
 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}
 
 Destructor.
 
 \membersection{wxInputStream::\destruct{wxInputStream}}
 
 \func{}{\destruct{wxInputStream}}{\void}
 
 Destructor.
 

-% -----------
-% IO function
-% -----------
+\membersection{wxInputStream::GetC}
+
+\func{char}{GetC}{\void}
+
+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}
+
+This cannot be really implemented for all streams and CanRead() is more 
+reliable than Eof().
+
+\membersection{wxInputStream::LastRead}\label{wxinputstreamlastread}
+
+\constfunc{size\_t}{LastRead}{\void}
+
+Returns the last number of bytes read.
+

 \membersection{wxInputStream::Peek}
 
 \func{char}{Peek}{\void}
 
 Returns the first character in the input queue without removing it.
 
 \membersection{wxInputStream::Peek}
 
 \func{char}{Peek}{\void}
 
 Returns the first character in the input queue without removing it.
 

-\membersection{wxInputStream::GetC}
-
-\func{char}{GetC}{\void}
+\wxheading{Note}

 
 

-Returns the first character in the input queue and removes it.
+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}
 
 
 \membersection{wxInputStream::Read}
 

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

 
 

-\it{WARNING!} The buffer absolutely needs to have at least the specified size.
+\wxheading{Warning}
+
+The buffer absolutely needs to have at least the specified size.
+
+\wxheading{Return value}

 
 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.
 

-\func{wxInputStream\&}{Read}{\param{wxOutputStream\&}{ stream_out}}
+\func{wxInputStream\&}{Read}{\param{wxOutputStream\&}{ stream\_out}}

 
 Reads data from the input queue and stores it in the specified output stream.
 The data is read until an error is raised by one of the two streams.
 
 
 Reads data from the input queue and stores it in the specified output stream.
 The data is read until an error is raised by one of the two streams.
 

-% ------------------
-% Position functions
-% ------------------
-\membersection{wxInputStream::SeekI}
+\wxheading{Return value}
+
+This function returns a reference on the current object, so the user can test
+any states of the stream right away.

 
 

-\func{off_t}{SeekI}{\param{off_t}{ pos}, \param{wxSeekMode}{ mode = wxFromStart}}
+\membersection{wxInputStream::SeekI}\label{wxinputstreamseeki}
+
+\func{off\_t}{SeekI}{\param{off\_t}{ pos}, \param{wxSeekMode}{ mode = wxFromStart}}

 
 Changes the stream current position.
 
 
 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}
 
 \membersection{wxInputStream::TellI}
 

-\constfunc{off_t}{TellI}{\void}
+\constfunc{off\_t}{TellI}{\void}

 
 Returns the current stream position.
 
 
 Returns the current stream position.
 

-% ---------------
-% State functions
-% ---------------
-\membersection{wxInputStream::InputStreamBuffer}
+\membersection{wxInputStream::Ungetch}\label{wxinputstreamungetch}

 
 

-\func{wxStreamBuffer*}{InputStreamBuffer}{\void}
+\func{size\_t}{Ungetch}{\param{const char*}{ buffer}, \param{size\_t}{ size}}

 
 

-Returns the stream buffer associated with the input stream.
+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.

 
 

-\membersection{wxInputStream::LastRead}
+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).

 
 

-\constfunc{size_t}{LastRead}{\void}
+\wxheading{Return value}

 
 

-Returns the last number of bytes read.
+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.