X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/22d6efa851642c6a69174278fc50f712f41e2271..e31f4da5f0e888e3bae947061be02a427c570372:/docs/latex/wx/strmbfrd.tex diff --git a/docs/latex/wx/strmbfrd.tex b/docs/latex/wx/strmbfrd.tex index fdbc3fa938..3364df7543 100644 --- a/docs/latex/wx/strmbfrd.tex +++ b/docs/latex/wx/strmbfrd.tex @@ -3,6 +3,12 @@ % ----------------------------------------------------------------------------- \section{\class{wxBufferedInputStream}}\label{wxbufferedinputstream} +This stream acts as a cache. It caches the bytes read from the specified +input stream (See \helpref{wxFilterInputStream}{wxfilterinputstream}). +It uses wxStreamBuffer and sets the default in-buffer size to 1024 bytes. +This class may not be used without some other stream to read the data +from (such as a file stream or a memory stream). + \wxheading{Derived from} \helpref{wxFilterInputStream}{wxfilterinputstream} @@ -13,19 +19,22 @@ \wxheading{See also} -\helpref{wxStreamBuffer}{wxstreamBuffer}, \helpref{wxInputStream}{wxinputstream} - -\wxheading{Short description} - -This stream acts as a cache. It caches the bytes read from the specified -input stream (See \helpref{wxFilterInputStream}{wxfilterinputstream}). -It uses wxStreamBuffer and sets the default in-buffer size to 1024 bytes. +\helpref{wxStreamBuffer}{wxstreambuffer}, \helpref{wxInputStream}{wxinputstream}, +\helpref{wxBufferedOutputStream}{wxbufferedoutputstream} % ----------------------------------------------------------------------------- % wxBufferedOutputStream % ----------------------------------------------------------------------------- \section{\class{wxBufferedOutputStream}}\label{wxbufferedoutputstream} +This stream acts as a cache. It caches the bytes to be written to the specified +output stream (See \helpref{wxFilterOutputStream}{wxfilteroutputstream}). The +data is only written when the cache is full, when the buffered stream is +destroyed or when calling SeekO(). + +This class may not be used without some other stream to write the data +to (such as a file stream or a memory stream). + \wxheading{Derived from} \helpref{wxFilterOutputStream}{wxfilteroutputstream} @@ -36,12 +45,37 @@ It uses wxStreamBuffer and sets the default in-buffer size to 1024 bytes. \wxheading{See also} -\helpref{wxStreamBuffer}{wxstreamBuffer}, \helpref{wxOutputStream}{wxoutputstream} +\helpref{wxStreamBuffer}{wxstreambuffer}, \helpref{wxOutputStream}{wxoutputstream} + +% ---------- +% Members +% ---------- +\latexignore{\rtfignore{\wxheading{Members}}} + +\membersection{wxBufferedOutputStream::wxBufferedOutputStream}\label{wxbufferedoutputstreamctor} + +\func{}{wxBufferedOutputStream}{\param{const wxOutputStream\&}{ parent}} + +Creates a buffered stream using a buffer of a default size of 1024 bytes for cashing +the stream {\it parent}. + +\membersection{wxBufferedOutputStream::\destruct{wxBufferedOutputStream}}\label{wxbufferedoutputstreamdtor} + +\func{}{\destruct{wxBufferedOutputStream}}{\void} + +Destructor. Calls Sync() and destroys the internal buffer. + +\membersection{wxBufferedOutputStream::SeekO}\label{wxbufferedoutputstreamseeko} + +\func{off\_t}{SeekO}{\param{off\_t}{ pos}, \param{wxSeekMode}{ mode}} + +Calls Sync() and changes the stream position. + +\membersection{wxBufferedOutputStream::Sync}\label{wxbufferedoutputstreamsync} + +\func{void}{Sync}{\void} + +Flushes the buffer and calls Sync() on the parent stream. -\wxheading{Short description} -This stream acts as a cache. It caches the bytes to be written to the specified -output stream (See \helpref{wxFilterOutputStream}{wxfilteroutputstream}). The -datas are only written when the cache is full or when the buffered stream is -destroyed.