X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/36edded90cf3d4d11dc55362b332733b79e8f54d..852b6c3ce7baa055da25f5254f6ee2eee0cd79b7:/docs/latex/wx/strmbfrd.tex?ds=sidebyside diff --git a/docs/latex/wx/strmbfrd.tex b/docs/latex/wx/strmbfrd.tex index 464c435f19..3364df7543 100644 --- a/docs/latex/wx/strmbfrd.tex +++ b/docs/latex/wx/strmbfrd.tex @@ -6,6 +6,8 @@ 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} @@ -17,7 +19,8 @@ It uses wxStreamBuffer and sets the default in-buffer size to 1024 bytes. \wxheading{See also} -\helpref{wxStreamBuffer}{wxstreamBuffer}, \helpref{wxInputStream}{wxinputstream} +\helpref{wxStreamBuffer}{wxstreambuffer}, \helpref{wxInputStream}{wxinputstream}, +\helpref{wxBufferedOutputStream}{wxbufferedoutputstream} % ----------------------------------------------------------------------------- % wxBufferedOutputStream @@ -26,8 +29,11 @@ It uses wxStreamBuffer and sets the default in-buffer size to 1024 bytes. 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. +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} @@ -39,5 +45,37 @@ destroyed. \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. + +