X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/2bf8e4ebcc9d52bcee96e69e7013279a4f2efa37..235fb242f665ea0bf3e1bff3d5344f4d621ab75e:/docs/latex/wx/stream.tex

diff --git a/docs/latex/wx/stream.tex b/docs/latex/wx/stream.tex
index d1543a6772..9262f10486 100644
--- a/docs/latex/wx/stream.tex
+++ b/docs/latex/wx/stream.tex
@@ -20,15 +20,14 @@ None
 % -----------
 % ctor & dtor
 % -----------
-\membersection{wxStreamBuffer::wxStreamBuffer}\label{wxstreambufconst}
+\membersection{wxStreamBuffer::wxStreamBuffer}\label{wxstreambufferctor}
 
 \func{}{wxStreamBuffer}{\param{wxStreamBase\&}{ stream}, \param{BufMode}{ mode}}
 
-Constructor, creates a new stream buffer using \it{stream} as a parent stream
-and \it{mode} as the IO mode. \it{mode} can be: wxStreamBuffer::read,
+Constructor, creates a new stream buffer using {\it stream} as a parent stream
+and {\it mode} as the IO mode. {\it mode} can be: wxStreamBuffer::read,
 wxStreamBuffer::write, wxStreamBuffer::read\_write.
 
-
 One stream can have many stream buffers but only one is used internally to
 pass IO call (e.g. wxInputStream::Read() -> wxStreamBuffer::Read()), but you
 can call directly wxStreamBuffer::Read without any problems. Note that
@@ -44,7 +43,7 @@ the stream buffers:
 \func{}{wxStreamBuffer}{\param{BufMode}{ mode}}
 
 Constructor, creates a new empty stream buffer which won't flush any data
-to a stream. \it{mode} specifies the type of the buffer (read, write, read\_write).
+to a stream. {\it mode} specifies the type of the buffer (read, write, read\_write).
 This stream buffer has the advantage to be stream independent and to
 work only on memory buffers but it is still compatible with the rest of the
 wxStream classes. You can write, read to this special stream and it will
@@ -53,7 +52,7 @@ functionality of a ``normal'' stream.
 
 \wxheading{Warning}
 
-The "read\_write" mode may not work: it isn't completely finished.
+The "read\_write" mode doesn't currently work for standalone stream buffers.
 
 \func{}{wxStreamBuffer}{\param{const wxStreamBuffer\&}{buffer}}
 
@@ -69,7 +68,7 @@ program.
 
 \helpref{wxStreamBuffer:SetBufferIO}{wxstreambuffersetbufferio}
 
-\membersection{wxStreamBuffer::\destruct{wxStreamBuffer}}
+\membersection{wxStreamBuffer::\destruct{wxStreamBuffer}}\label{wxstreambufferdtor}
 
 \func{}{wxStreamBuffer}{\destruct{wxStreamBuffer}}
 
@@ -90,14 +89,14 @@ accordingly until all requested data is read.
 
 \wxheading{Return value}
 
-It returns the size of the data read. If thereturned size is different of the specified 
-{\it size}, an error has occured and should be tested using 
-\helpref{LastError}{wxstreambaselasterror}.
+It returns the size of the data read. If the returned size is different of the specified 
+{\it size}, an error has occurred and should be tested using 
+\helpref{GetLastError}{wxstreambasegetlasterror}.
 
 \func{size\_t}{Read}{\param{wxStreamBuffer *}{buffer}}
 
-Reads a \it{buffer}. The function returns when \it{buffer} is full or when there isn't
-data anymore in the current buffer.
+Copies data to {\it buffer}. The function returns when {\it buffer} is full or when there isn't
+any more data in the current buffer.
 
 \wxheading{See also}
 
@@ -107,14 +106,14 @@ data anymore in the current buffer.
 
 \func{size\_t}{Write}{\param{const void *}{buffer}, \param{size\_t }{size}}
 
-Writes a block of the specified \it{size} using datas of \it{buffer}. The datas
+Writes a block of the specified {\it size} using data of {\it buffer}. The data
 are cached in a buffer before being sent in one block to the stream.
 
 \func{size\_t}{Write}{\param{wxStreamBuffer *}{buffer}}
 
 See \helpref{Read}{wxstreambufferread}.
 
-\membersection{wxStreamBuffer::GetChar}
+\membersection{wxStreamBuffer::GetChar}\label{wxstreambuffergetchar}
 
 \func{char}{GetChar}{\void}
 
@@ -122,13 +121,13 @@ Gets a single char from the stream buffer. It acts like the Read call.
 
 \wxheading{Problem}
 
-You aren't directly notified if an error occured during the IO call.
+You aren't directly notified if an error occurred during the IO call.
 
 \wxheading{See also}
 
 \helpref{wxStreamBuffer::Read}{wxstreambufferread}
 
-\membersection{wxStreamBuffer::PutChar}
+\membersection{wxStreamBuffer::PutChar}\label{wxstreambufferputchar}
 
 \func{void}{PutChar}{\param{char }{c}}
 
@@ -136,19 +135,19 @@ Puts a single char to the stream buffer.
 
 \wxheading{Problem}
 
-You aren't directly notified if an error occured during the IO call.
+You aren't directly notified if an error occurred during the IO call.
 
 \wxheading{See also}
 
 \helpref{wxStreamBuffer::Read}{wxstreambufferwrite}
 
-\membersection{wxStreamBuffer::Tell}
+\membersection{wxStreamBuffer::Tell}\label{wxstreambuffertell}
 
 \constfunc{off\_t}{Tell}{\void}
 
 Gets the current position in the stream. This position is calculated from
-the \it{real} position in the stream and from the internal buffer position: so
-it gives you the position in the \it{real} stream counted from the start of
+the {\it real} position in the stream and from the internal buffer position: so
+it gives you the position in the {\it real} stream counted from the start of
 the stream.
 
 \wxheading{Return value}
@@ -162,7 +161,7 @@ other case.
 
 Changes the current position.
 
-\it{mode} may be one of the following:
+{\it mode} may be one of the following:
 
 \twocolwidtha{5cm}
 \begin{twocollist}\itemsep=0pt
@@ -179,12 +178,23 @@ the beginning of the stream. Otherwise, it returns wxInvalidOffset.
 % --------------
 % Buffer control
 % --------------
-\membersection{wxStreamBuffer::ResetBuffer}
+\membersection{wxStreamBuffer::ResetBuffer}\label{wxstreambufferresetbuffer}
 
 \func{void}{ResetBuffer}{\void}
 
 Resets to the initial state variables concerning the buffer.
 
+
+\membersection{wxStreamBuffer::Truncate}\label{wxstreambuffertruncate}
+
+\func{void}{Truncate}{\void}
+
+Truncates the buffer to the current position.
+
+Note: Truncate() cannot be used to enlarge the buffer. This is
+usually not needed since the buffer expands automatically.
+
+
 \membersection{wxStreamBuffer::SetBufferIO}\label{wxstreambuffersetbufferio}
 
 \func{void}{SetBufferIO}{\param{char*}{ buffer\_start}, \param{char*}{ buffer\_end}}
@@ -192,18 +202,18 @@ Resets to the initial state variables concerning the buffer.
 Specifies which pointers to use for stream buffering. You need to pass a pointer on the
 start of the buffer end and another on the end. The object will use this buffer
 to cache stream data. It may be used also as a source/destination buffer when
-you create an empty stream buffer (See \helpref{wxStreamBuffer::wxStreamBuffer}{wxstreambufconst}).
+you create an empty stream buffer (See \helpref{wxStreamBuffer::wxStreamBuffer}{wxstreambufferctor}).
 
 \wxheading{Remarks}
 
-When you use this function, you'll have to destroy the IO buffers yourself
+When you use this function, you will have to destroy the IO buffers yourself
 after the stream buffer is destroyed or don't use it anymore.
-In the case you use it with an empty buffer, the stream buffer will not grow
+In the case you use it with an empty buffer, the stream buffer will not resize
 it when it is full.
 
 \wxheading{See also}
 
-\helpref{wxStreamBuffer constructor}{wxstreambufconst}\\
+\helpref{wxStreamBuffer constructor}{wxstreambufferctor}\\
 \helpref{wxStreamBuffer::Fixed}{wxstreambufferfixed}\\
 \helpref{wxStreamBuffer::Flushable}{wxstreambufferflushable}
 
@@ -225,42 +235,42 @@ The created IO buffer is growable by the object.
 \helpref{wxStreamBuffer::Fixed}{wxstreambufferfixed}\\
 \helpref{wxStreamBuffer::Flushable}{wxstreambufferflushable}
 
-\membersection{wxStreamBuffer::GetBufferStart}
+\membersection{wxStreamBuffer::GetBufferStart}\label{wxstreambuffergetbufferstart}
 
-\constfunc{char *}{GetBufferStart}{\void}
+\constfunc{void *}{GetBufferStart}{\void}
 
 Returns a pointer on the start of the stream buffer.
 
-\membersection{wxStreamBuffer::GetBufferEnd}
+\membersection{wxStreamBuffer::GetBufferEnd}\label{wxstreambuffergetbufferend}
 
-\constfunc{char *}{GetBufferEnd}{\void}
+\constfunc{void *}{GetBufferEnd}{\void}
 
 Returns a pointer on the end of the stream buffer.
 
-\membersection{wxStreamBuffer::GetBufferPos}
+\membersection{wxStreamBuffer::GetBufferPos}\label{wxstreambuffergetbufferpos}
 
-\constfunc{char *}{GetBufferPos}{\void}
+\constfunc{void *}{GetBufferPos}{\void}
 
 Returns a pointer on the current position of the stream buffer.
 
-\membersection{wxStreamBuffer::GetIntPosition}
+\membersection{wxStreamBuffer::GetIntPosition}\label{wxstreambuffergetintposition}
 
 \constfunc{off\_t}{GetIntPosition}{\void}
 
 Returns the current position (counted in bytes) in the stream buffer.
 
-\membersection{wxStreamBuffer::SetIntPosition}
+\membersection{wxStreamBuffer::SetIntPosition}\label{wxstreambuffersetintposition}
 
-\func{void}{SetIntPosition}{\void}
+\func{void}{SetIntPosition}{\param{size\_t}{ pos}}
 
 Sets the current position (in bytes) in the stream buffer.
 
 \wxheading{Warning}
 
 Since it is a very low-level function, there is no check on the position:
-specify an invalid position can induce unexpected results.
+specifying an invalid position can induce unexpected results.
 
-\membersection{wxStreamBuffer::GetLastAccess}
+\membersection{wxStreamBuffer::GetLastAccess}\label{wxstreambuffergetlastaccess}
 
 \constfunc{size\_t}{GetLastAccess}{\void}
 
@@ -271,8 +281,8 @@ Returns the amount of bytes read during the last IO call to the parent stream.
 \func{void}{Fixed}{\param{bool}{ fixed}}
 
 Toggles the fixed flag. Usually this flag is toggled at the same time as 
-\it{flushable}. This flag allows (when it has the FALSE value) or forbids
-(when it has the TRUE value) the stream buffer to resize dynamically the IO buffer.
+{\it flushable}. This flag allows (when it has the false value) or forbids
+(when it has the true value) the stream buffer to resize dynamically the IO buffer.
 
 \wxheading{See also}
 
@@ -282,31 +292,37 @@ Toggles the fixed flag. Usually this flag is toggled at the same time as
 
 \func{void}{Flushable}{\param{bool}{ flushable}}
 
-Toggles the flushable flag. If \it{flushable} is disabled, no datas are sent
+Toggles the flushable flag. If {\it flushable} is disabled, no data are sent
 to the parent stream.
 
-\membersection{wxStreamBuffer::FlushBuffer}
+\membersection{wxStreamBuffer::FlushBuffer}\label{wxstreambufferflushbuffer}
 
 \func{bool}{FlushBuffer}{\void}
 
 Flushes the IO buffer.
 
-\membersection{wxStreamBuffer::FillBuffer}
+\membersection{wxStreamBuffer::FillBuffer}\label{wxstreambufferfillbuffer}
 
 \func{bool}{FillBuffer}{\void}
 
 Fill the IO buffer.
 
-\membersection{wxStreamBuffer::GetDataLeft}
+\membersection{wxStreamBuffer::GetBufferSize}\label{wxstreambuffergetbuffersize}
+
+\constfunc{size\_t}{GetBufferSize}{\void}
+
+Returns the size of the buffer.
+
+\membersection{wxStreamBuffer::GetDataLeft}\label{wxstreambuffergetdataleft}
 
 \func{size\_t}{GetDataLeft}{\void}
 
-Returns the amount of available datas in the buffer.
+Returns the amount of available data in the buffer.
 
 % --------------
 % Administration
 % --------------
-\membersection{wxStreamBuffer::Stream}
+\membersection{wxStreamBuffer::Stream}\label{wxstreambufferstream}
 
 \func{wxStreamBase*}{Stream}{\void}
 
