X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/2edb0bdef6238c8c246b6978bc14828b7033d931..b3a029f0bbf8262cfe30914790802f88608ea618:/docs/latex/wx/stream.tex

diff --git a/docs/latex/wx/stream.tex b/docs/latex/wx/stream.tex
index d573446a86..420a2c04db 100644
--- a/docs/latex/wx/stream.tex
+++ b/docs/latex/wx/stream.tex
@@ -8,19 +8,18 @@ None
 
 <wx/stream.h>
 
+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}
+
 \wxheading{See also}
 
 \helpref{wxStreamBase}{wxstreambase}
 
-% ---------------------------------------------------------------------------
-% Members
-% ---------------------------------------------------------------------------
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-% -----------
-% ctor & dtor
-% -----------
-\membersection{wxStreamBuffer::wxStreamBuffer}\label{wxstreambufconst}
+
+\membersection{wxStreamBuffer::wxStreamBuffer}\label{wxstreambufferctor}
 
 \func{}{wxStreamBuffer}{\param{wxStreamBase\&}{ stream}, \param{BufMode}{ mode}}
 
@@ -52,7 +51,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}}
 
@@ -68,52 +67,79 @@ program.
 
 \helpref{wxStreamBuffer:SetBufferIO}{wxstreambuffersetbufferio}
 
-\membersection{wxStreamBuffer::\destruct{wxStreamBuffer}}
+
+\membersection{wxStreamBuffer::\destruct{wxStreamBuffer}}\label{wxstreambufferdtor}
 
 \func{}{wxStreamBuffer}{\destruct{wxStreamBuffer}}
 
 Destructor. It finalizes all IO calls and frees all internal buffers if
 necessary.
 
-% -----------
-% Filtered IO
-% -----------
-\membersection{wxStreamBuffer::Read}\label{wxstreambufferread}
 
-\func{size\_t}{Read}{\param{void *}{buffer}, \param{size\_t }{size}}
+\membersection{wxStreamBuffer::FillBuffer}\label{wxstreambufferfillbuffer}
 
-Reads a block of the specified {\it size} and stores the data in {\it buffer}.
-This function tries to read from the buffer first and if more data has been
-requested, reads more data from the associated stream and updates the buffer
-accordingly until all requested data is read.
+\func{bool}{FillBuffer}{\void}
 
-\wxheading{Return value}
+Fill the IO buffer.
 
-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{LastError}{wxstreambaselasterror}.
 
-\func{size\_t}{Read}{\param{wxStreamBuffer *}{buffer}}
+\membersection{wxStreamBuffer::Fixed}\label{wxstreambufferfixed}
 
-Reads a {\it buffer}. The function returns when {\it buffer} is full or when there isn't
-data anymore in the current buffer.
+\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.
 
 \wxheading{See also}
 
-\helpref{wxStreamBuffer::Write}{wxstreambufferwrite}
+\helpref{wxStreamBuffer::SetBufferIO}{wxstreambuffersetbufferio}
 
-\membersection{wxStreamBuffer::Write}\label{wxstreambufferwrite}
 
-\func{size\_t}{Write}{\param{const void *}{buffer}, \param{size\_t }{size}}
+\membersection{wxStreamBuffer::Flushable}\label{wxstreambufferflushable}
 
-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{void}{Flushable}{\param{bool}{ flushable}}
 
-\func{size\_t}{Write}{\param{wxStreamBuffer *}{buffer}}
+Toggles the flushable flag. If {\it flushable} is disabled, no data are sent
+to the parent stream.
+
+
+\membersection{wxStreamBuffer::FlushBuffer}\label{wxstreambufferflushbuffer}
+
+\func{bool}{FlushBuffer}{\void}
+
+Flushes the IO buffer.
+
+
+\membersection{wxStreamBuffer::GetBufferEnd}\label{wxstreambuffergetbufferend}
+
+\constfunc{void *}{GetBufferEnd}{\void}
+
+Returns a pointer on the end of the stream buffer.
+
+
+\membersection{wxStreamBuffer::GetBufferPos}\label{wxstreambuffergetbufferpos}
+
+\constfunc{void *}{GetBufferPos}{\void}
+
+Returns a pointer on the current position of the stream buffer.
+
+
+\membersection{wxStreamBuffer::GetBufferSize}\label{wxstreambuffergetbuffersize}
+
+\constfunc{size\_t}{GetBufferSize}{\void}
+
+Returns the size of the buffer.
 
-See \helpref{Read}{wxstreambufferread}.
 
-\membersection{wxStreamBuffer::GetChar}
+\membersection{wxStreamBuffer::GetBufferStart}\label{wxstreambuffergetbufferstart}
+
+\constfunc{void *}{GetBufferStart}{\void}
+
+Returns a pointer on the start of the stream buffer.
+
+
+\membersection{wxStreamBuffer::GetChar}\label{wxstreambuffergetchar}
 
 \func{char}{GetChar}{\void}
 
@@ -127,7 +153,29 @@ You aren't directly notified if an error occurred during the IO call.
 
 \helpref{wxStreamBuffer::Read}{wxstreambufferread}
 
-\membersection{wxStreamBuffer::PutChar}
+
+\membersection{wxStreamBuffer::GetDataLeft}\label{wxstreambuffergetdataleft}
+
+\func{size\_t}{GetDataLeft}{\void}
+
+Returns the amount of available data in the buffer.
+
+
+\membersection{wxStreamBuffer::GetIntPosition}\label{wxstreambuffergetintposition}
+
+\constfunc{off\_t}{GetIntPosition}{\void}
+
+Returns the current position (counted in bytes) in the stream buffer.
+
+
+\membersection{wxStreamBuffer::GetLastAccess}\label{wxstreambuffergetlastaccess}
+
+\constfunc{size\_t}{GetLastAccess}{\void}
+
+Returns the amount of bytes read during the last IO call to the parent stream.
+
+
+\membersection{wxStreamBuffer::PutChar}\label{wxstreambufferputchar}
 
 \func{void}{PutChar}{\param{char }{c}}
 
@@ -141,19 +189,38 @@ You aren't directly notified if an error occurred during the IO call.
 
 \helpref{wxStreamBuffer::Read}{wxstreambufferwrite}
 
-\membersection{wxStreamBuffer::Tell}
 
-\constfunc{off\_t}{Tell}{\void}
+\membersection{wxStreamBuffer::Read}\label{wxstreambufferread}
 
-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 stream.
+\func{size\_t}{Read}{\param{void *}{buffer}, \param{size\_t }{size}}
+
+Reads a block of the specified {\it size} and stores the data in {\it buffer}.
+This function tries to read from the buffer first and if more data has been
+requested, reads more data from the associated stream and updates the buffer
+accordingly until all requested data is read.
 
 \wxheading{Return value}
 
-Returns the current position in the stream if possible, wxInvalidOffset in the
-other case.
+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}}
+
+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}
+
+\helpref{wxStreamBuffer::Write}{wxstreambufferwrite}
+
+
+\membersection{wxStreamBuffer::ResetBuffer}\label{wxstreambufferresetbuffer}
+
+\func{void}{ResetBuffer}{\void}
+
+Resets to the initial state variables concerning the buffer.
+
 
 \membersection{wxStreamBuffer::Seek}\label{wxstreambufferseek}
 
@@ -175,14 +242,6 @@ Changes the current position.
 Upon successful completion, it returns the new offset as measured in bytes from
 the beginning of the stream. Otherwise, it returns wxInvalidOffset.
 
-% --------------
-% Buffer control
-% --------------
-\membersection{wxStreamBuffer::ResetBuffer}
-
-\func{void}{ResetBuffer}{\void}
-
-Resets to the initial state variables concerning the buffer.
 
 \membersection{wxStreamBuffer::SetBufferIO}\label{wxstreambuffersetbufferio}
 
@@ -191,7 +250,7 @@ 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}
 
@@ -202,7 +261,7 @@ it when it is full.
 
 \wxheading{See also}
 
-\helpref{wxStreamBuffer constructor}{wxstreambufconst}\\
+\helpref{wxStreamBuffer constructor}{wxstreambufferctor}\\
 \helpref{wxStreamBuffer::Fixed}{wxstreambufferfixed}\\
 \helpref{wxStreamBuffer::Flushable}{wxstreambufferflushable}
 
@@ -224,90 +283,59 @@ The created IO buffer is growable by the object.
 \helpref{wxStreamBuffer::Fixed}{wxstreambufferfixed}\\
 \helpref{wxStreamBuffer::Flushable}{wxstreambufferflushable}
 
-\membersection{wxStreamBuffer::GetBufferStart}
-
-\constfunc{char *}{GetBufferStart}{\void}
-
-Returns a pointer on the start of the stream buffer.
-
-\membersection{wxStreamBuffer::GetBufferEnd}
-
-\constfunc{char *}{GetBufferEnd}{\void}
-
-Returns a pointer on the end of the stream buffer.
-
-\membersection{wxStreamBuffer::GetBufferPos}
 
-\constfunc{char *}{GetBufferPos}{\void}
+\membersection{wxStreamBuffer::SetIntPosition}\label{wxstreambuffersetintposition}
 
-Returns a pointer on the current position of the stream buffer.
-
-\membersection{wxStreamBuffer::GetIntPosition}
-
-\constfunc{off\_t}{GetIntPosition}{\void}
-
-Returns the current position (counted in bytes) in the stream buffer.
-
-\membersection{wxStreamBuffer::SetIntPosition}
-
-\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.
-
-\membersection{wxStreamBuffer::GetLastAccess}
-
-\constfunc{size\_t}{GetLastAccess}{\void}
+specifying an invalid position can induce unexpected results.
 
-Returns the amount of bytes read during the last IO call to the parent stream.
 
-\membersection{wxStreamBuffer::Fixed}\label{wxstreambufferfixed}
+\membersection{wxStreamBuffer::Stream}\label{wxstreambufferstream}
 
-\func{void}{Fixed}{\param{bool}{ fixed}}
+\func{wxStreamBase*}{Stream}{\void}
 
-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.
+Returns the parent stream of the stream buffer.
 
-\wxheading{See also}
 
-\helpref{wxStreamBuffer::SetBufferIO}{wxstreambuffersetbufferio}
+\membersection{wxStreamBuffer::Tell}\label{wxstreambuffertell}
 
-\membersection{wxStreamBuffer::Flushable}\label{wxstreambufferflushable}
+\constfunc{off\_t}{Tell}{\void}
 
-\func{void}{Flushable}{\param{bool}{ flushable}}
+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 stream.
 
-Toggles the flushable flag. If {\it flushable} is disabled, no data are sent
-to the parent stream.
+\wxheading{Return value}
 
-\membersection{wxStreamBuffer::FlushBuffer}
+Returns the current position in the stream if possible, wxInvalidOffset in the
+other case.
 
-\func{bool}{FlushBuffer}{\void}
 
-Flushes the IO buffer.
+\membersection{wxStreamBuffer::Truncate}\label{wxstreambuffertruncate}
 
-\membersection{wxStreamBuffer::FillBuffer}
+\func{void}{Truncate}{\void}
 
-\func{bool}{FillBuffer}{\void}
+Truncates the buffer to the current position.
 
-Fill the IO buffer.
+Note: Truncate() cannot be used to enlarge the buffer. This is
+usually not needed since the buffer expands automatically.
 
-\membersection{wxStreamBuffer::GetDataLeft}
 
-\func{size\_t}{GetDataLeft}{\void}
+\membersection{wxStreamBuffer::Write}\label{wxstreambufferwrite}
 
-Returns the amount of available data in the buffer.
+\func{size\_t}{Write}{\param{const void *}{buffer}, \param{size\_t }{size}}
 
-% --------------
-% Administration
-% --------------
-\membersection{wxStreamBuffer::Stream}
+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{wxStreamBase*}{Stream}{\void}
+\func{size\_t}{Write}{\param{wxStreamBuffer *}{buffer}}
 
-Returns the parent stream of the stream buffer.
+See \helpref{Read}{wxstreambufferread}.