undefine _DEFINE_LIST before redefining it; also rename it to have WX prefix

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

diff --git a/docs/latex/wx/stream.tex b/docs/latex/wx/stream.tex
index d573446a8648d9883f9b80d27cfec0470a58b48c..90cd8c8840dcf98c3ee991ca0928156894bdae43 100644 (file)
--- a/docs/latex/wx/stream.tex
+++ b/docs/latex/wx/stream.tex
@@ -8,6 +8,10 @@ None
 
 <wx/stream.h>
 
 
 <wx/stream.h>
 

+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}
+

 \wxheading{See also}
 
 \helpref{wxStreamBase}{wxstreambase}
 \wxheading{See also}
 
 \helpref{wxStreamBase}{wxstreambase}


@@ -20,7 +24,7 @@ None
 % -----------
 % ctor & dtor
 % -----------
 % -----------
 % ctor & dtor
 % -----------

-\membersection{wxStreamBuffer::wxStreamBuffer}\label{wxstreambufconst}
+\membersection{wxStreamBuffer::wxStreamBuffer}\label{wxstreambufferctor}

 
 \func{}{wxStreamBuffer}{\param{wxStreamBase\&}{ stream}, \param{BufMode}{ mode}}
 
 
 \func{}{wxStreamBuffer}{\param{wxStreamBase\&}{ stream}, \param{BufMode}{ mode}}
 


@@ -52,7 +56,7 @@ functionality of a ``normal'' stream.
 
 \wxheading{Warning}
 
 
 \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}}
 
 
 \func{}{wxStreamBuffer}{\param{const wxStreamBuffer\&}{buffer}}
 


@@ -68,7 +72,7 @@ program.
 
 \helpref{wxStreamBuffer:SetBufferIO}{wxstreambuffersetbufferio}
 
 
 \helpref{wxStreamBuffer:SetBufferIO}{wxstreambuffersetbufferio}
 

-\membersection{wxStreamBuffer::\destruct{wxStreamBuffer}}
+\membersection{wxStreamBuffer::\destruct{wxStreamBuffer}}\label{wxstreambufferdtor}

 
 \func{}{wxStreamBuffer}{\destruct{wxStreamBuffer}}
 
 
 \func{}{wxStreamBuffer}{\destruct{wxStreamBuffer}}
 


@@ -91,12 +95,12 @@ accordingly until all requested data is read.
 
 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 
 
 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}.
+\helpref{GetLastError}{wxstreambasegetlasterror}.

 
 \func{size\_t}{Read}{\param{wxStreamBuffer *}{buffer}}
 
 
 \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}
 
 
 \wxheading{See also}
 


@@ -113,7 +117,7 @@ are cached in a buffer before being sent in one block to the stream.
 
 See \helpref{Read}{wxstreambufferread}.
 
 
 See \helpref{Read}{wxstreambufferread}.
 

-\membersection{wxStreamBuffer::GetChar}
+\membersection{wxStreamBuffer::GetChar}\label{wxstreambuffergetchar}

 
 \func{char}{GetChar}{\void}
 
 
 \func{char}{GetChar}{\void}
 


@@ -127,7 +131,7 @@ You aren't directly notified if an error occurred during the IO call.
 
 \helpref{wxStreamBuffer::Read}{wxstreambufferread}
 
 
 \helpref{wxStreamBuffer::Read}{wxstreambufferread}
 

-\membersection{wxStreamBuffer::PutChar}
+\membersection{wxStreamBuffer::PutChar}\label{wxstreambufferputchar}

 
 \func{void}{PutChar}{\param{char }{c}}
 
 
 \func{void}{PutChar}{\param{char }{c}}
 


@@ -141,7 +145,7 @@ You aren't directly notified if an error occurred during the IO call.
 
 \helpref{wxStreamBuffer::Read}{wxstreambufferwrite}
 
 
 \helpref{wxStreamBuffer::Read}{wxstreambufferwrite}
 

-\membersection{wxStreamBuffer::Tell}
+\membersection{wxStreamBuffer::Tell}\label{wxstreambuffertell}

 
 \constfunc{off\_t}{Tell}{\void}
 
 
 \constfunc{off\_t}{Tell}{\void}
 


@@ -178,12 +182,23 @@ the beginning of the stream. Otherwise, it returns wxInvalidOffset.
 % --------------
 % Buffer control
 % --------------
 % --------------
 % Buffer control
 % --------------

-\membersection{wxStreamBuffer::ResetBuffer}
+\membersection{wxStreamBuffer::ResetBuffer}\label{wxstreambufferresetbuffer}

 
 \func{void}{ResetBuffer}{\void}
 
 Resets to the initial state variables concerning the buffer.
 
 
 \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}}
 \membersection{wxStreamBuffer::SetBufferIO}\label{wxstreambuffersetbufferio}
 
 \func{void}{SetBufferIO}{\param{char*}{ buffer\_start}, \param{char*}{ buffer\_end}}


@@ -191,7 +206,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
 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}
 
 
 \wxheading{Remarks}
 


@@ -202,7 +217,7 @@ it when it is full.
 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

-\helpref{wxStreamBuffer constructor}{wxstreambufconst}\\
+\helpref{wxStreamBuffer constructor}{wxstreambufferctor}\\

 \helpref{wxStreamBuffer::Fixed}{wxstreambufferfixed}\\
 \helpref{wxStreamBuffer::Flushable}{wxstreambufferflushable}
 
 \helpref{wxStreamBuffer::Fixed}{wxstreambufferfixed}\\
 \helpref{wxStreamBuffer::Flushable}{wxstreambufferflushable}
 


@@ -224,42 +239,42 @@ The created IO buffer is growable by the object.
 \helpref{wxStreamBuffer::Fixed}{wxstreambufferfixed}\\
 \helpref{wxStreamBuffer::Flushable}{wxstreambufferflushable}
 
 \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.
 
 
 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.
 
 
 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.
 
 
 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.
 
 
 \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:
 
 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}
 
 
 \constfunc{size\_t}{GetLastAccess}{\void}
 


@@ -270,8 +285,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 
 \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}
 
 
 \wxheading{See also}
 


@@ -284,19 +299,25 @@ Toggles the fixed flag. Usually this flag is toggled at the same time as
 Toggles the flushable flag. If {\it flushable} is disabled, no data are sent
 to the parent stream.
 
 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.
 
 
 \func{bool}{FlushBuffer}{\void}
 
 Flushes the IO buffer.
 

-\membersection{wxStreamBuffer::FillBuffer}
+\membersection{wxStreamBuffer::FillBuffer}\label{wxstreambufferfillbuffer}

 
 \func{bool}{FillBuffer}{\void}
 
 Fill the IO buffer.
 
 
 \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}
 
 
 \func{size\_t}{GetDataLeft}{\void}
 


@@ -305,7 +326,7 @@ Returns the amount of available data in the buffer.
 % --------------
 % Administration
 % --------------
 % --------------
 % Administration
 % --------------

-\membersection{wxStreamBuffer::Stream}
+\membersection{wxStreamBuffer::Stream}\label{wxstreambufferstream}

 
 \func{wxStreamBase*}{Stream}{\void}
 
 
 \func{wxStreamBase*}{Stream}{\void}