<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}}
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
\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}}
\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 thereturned size is different of the specified
-{\it size}, an error has occured 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 datas of {\it buffer}. The datas
-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.
-See \helpref{Read}{wxstreambufferread}.
-\membersection{wxStreamBuffer::GetChar}
+\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.
+
+
+\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}
\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::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}}
\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}
-\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}
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}
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 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}
\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}
+\membersection{wxStreamBuffer::SetIntPosition}\label{wxstreambuffersetintposition}
-\constfunc{char *}{GetBufferEnd}{\void}
-
-Returns a pointer on the end of the stream buffer.
-
-\membersection{wxStreamBuffer::GetBufferPos}
-
-\constfunc{char *}{GetBufferPos}{\void}
-
-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}
+specifying an invalid position can induce unexpected results.
-\constfunc{size\_t}{GetLastAccess}{\void}
-Returns the amount of bytes read during the last IO call to the parent stream.
+\membersection{wxStreamBuffer::Stream}\label{wxstreambufferstream}
-\membersection{wxStreamBuffer::Fixed}\label{wxstreambufferfixed}
-
-\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 datas 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 datas 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}.
projects / wxWidgets.git / blobdiff