git.saurik.com Git - wxWidgets.git/blame_incremental

... / ...

Commit	Line	Data
	1	% -----------------------------------------------------------------------------
	2	% wxBufferedInputStream
	3	% -----------------------------------------------------------------------------
	4	\section{\class{wxBufferedInputStream}}\label{wxbufferedinputstream}
	5
	6	This stream acts as a cache. It caches the bytes read from the specified
	7	input stream (See \helpref{wxFilterInputStream}{wxfilterinputstream}).
	8	It uses wxStreamBuffer and sets the default in-buffer size to 1024 bytes.
	9	This class may not be used without some other stream to read the data
	10	from (such as a file stream or a memory stream).
	11
	12	\wxheading{Derived from}
	13
	14	\helpref{wxFilterInputStream}{wxfilterinputstream}\\
	15	\helpref{wxInputStream}{wxinputstream}\\
	16	\helpref{wxStreamBase}{wxstreambase}
	17
	18	\wxheading{Include files}
	19
	20	<wx/stream.h>
	21
	22	\wxheading{Library}
	23
	24	\helpref{wxBase}{librarieslist}
	25
	26	\wxheading{See also}
	27
	28	\helpref{wxStreamBuffer}{wxstreambuffer}, \helpref{wxInputStream}{wxinputstream},
	29	\helpref{wxBufferedOutputStream}{wxbufferedoutputstream}
	30
	31	% -----------------------------------------------------------------------------
	32	% wxBufferedOutputStream
	33	% -----------------------------------------------------------------------------
	34	\section{\class{wxBufferedOutputStream}}\label{wxbufferedoutputstream}
	35
	36	This stream acts as a cache. It caches the bytes to be written to the specified
	37	output stream (See \helpref{wxFilterOutputStream}{wxfilteroutputstream}). The
	38	data is only written when the cache is full, when the buffered stream is
	39	destroyed or when calling SeekO().
	40
	41	This class may not be used without some other stream to write the data
	42	to (such as a file stream or a memory stream).
	43
	44	\wxheading{Derived from}
	45
	46	\helpref{wxFilterOutputStream}{wxfilteroutputstream}\\
	47	\helpref{wxOutputStream}{wxoutputstream}\\
	48	\helpref{wxStreamBase}{wxstreambase}
	49
	50	\wxheading{Include files}
	51
	52	<wx/stream.h>
	53
	54	\wxheading{Library}
	55
	56	\helpref{wxBase}{librarieslist}
	57
	58	\wxheading{See also}
	59
	60	\helpref{wxStreamBuffer}{wxstreambuffer}, \helpref{wxOutputStream}{wxoutputstream}
	61
	62	% ----------
	63	% Members
	64	% ----------
	65	\latexignore{\rtfignore{\wxheading{Members}}}
	66
	67	\membersection{wxBufferedOutputStream::wxBufferedOutputStream}\label{wxbufferedoutputstreamctor}
	68
	69	\func{}{wxBufferedOutputStream}{\param{const wxOutputStream\&}{ parent}}
	70
	71	Creates a buffered stream using a buffer of a default size of 1024 bytes for cashing
	72	the stream {\it parent}.
	73
	74	\membersection{wxBufferedOutputStream::\destruct{wxBufferedOutputStream}}\label{wxbufferedoutputstreamdtor}
	75
	76	\func{}{\destruct{wxBufferedOutputStream}}{\void}
	77
	78	Destructor. Calls Sync() and destroys the internal buffer.
	79
	80	\membersection{wxBufferedOutputStream::SeekO}\label{wxbufferedoutputstreamseeko}
	81
	82	\func{off\_t}{SeekO}{\param{off\_t}{ pos}, \param{wxSeekMode}{ mode}}
	83
	84	Calls Sync() and changes the stream position.
	85
	86	\membersection{wxBufferedOutputStream::Sync}\label{wxbufferedoutputstreamsync}
	87
	88	\func{void}{Sync}{\void}
	89
	90	Flushes the buffer and calls Sync() on the parent stream.
	91
	92
	93