Some doc changes

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

diff --git a/docs/latex/wx/inputstr.tex b/docs/latex/wx/inputstr.tex
index 795b834dd3833c05b0e1addca83c511363e075b8..9edd5d824a911d2b514d629efc55f8aedd913b9a 100644 (file)
--- a/docs/latex/wx/inputstr.tex
+++ b/docs/latex/wx/inputstr.tex
@@ -7,9 +7,9 @@
 
 \helpref{wxStreamBase}{wxstreambase}
 
 
 \helpref{wxStreamBase}{wxstreambase}
 

-\wxheading{See also}
+\wxheading{Include files}

 
 

-\helpref{wxStreamBuffer}{wxstreambuffer}
+<wx/stream.h>

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


@@ -20,35 +20,33 @@
 
 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::Peek}
-
-\func{char}{Peek}{\void}
-
-Returns the first character in the input queue without removing it.
-

 \membersection{wxInputStream::GetC}
 
 \func{char}{GetC}{\void}
 
 Returns the first character in the input queue and removes it.
 
 \membersection{wxInputStream::GetC}
 
 \func{char}{GetC}{\void}
 
 Returns the first character in the input queue and removes it.
 

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


@@ -61,7 +59,7 @@ The buffer absolutely needs to have at least the specified size.
 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.


@@ -71,33 +69,34 @@ 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.
 

-% ------------------
-% Position functions
-% ------------------

 \membersection{wxInputStream::SeekI}
 
 \membersection{wxInputStream::SeekI}
 

-\func{off_t}{SeekI}{\param{off_t}{ pos}, \param{wxSeekMode}{ mode = wxFromStart}}
+\func{off\_t}{SeekI}{\param{off\_t}{ pos}, \param{wxSeekMode}{ mode = wxFromStart}}

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

 
 

-\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 datas 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}
+\wxheading{Return value}

 
 

-\constfunc{size_t}{LastRead}{\void}
+Returns the amount of bytes saved in the Write-Back buffer.

 
 

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