X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/9a75ba66de8f9dd3ebac0f41ec2e27be6d95aa73..0bd2681966523df88ad5cf8e505b532843e58d74:/docs/latex/wx/stream.tex diff --git a/docs/latex/wx/stream.tex b/docs/latex/wx/stream.tex index a0bd5a64d1..90cd8c8840 100644 --- a/docs/latex/wx/stream.tex +++ b/docs/latex/wx/stream.tex @@ -8,6 +8,10 @@ None +\wxheading{Library} + +\helpref{wxBase}{librarieslist} + \wxheading{See also} \helpref{wxStreamBase}{wxstreambase} @@ -95,8 +99,8 @@ It returns the size of the data read. If the returned size is different of the s \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} @@ -184,6 +188,17 @@ the beginning of the stream. Otherwise, it returns wxInvalidOffset. 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}} @@ -296,6 +311,12 @@ Flushes the IO buffer. Fill the IO buffer. +\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}