no changes, just come cleanup and more comments

[wxWidgets.git] / docs / latex / wx / strmbfrd.tex

diff --git a/docs/latex/wx/strmbfrd.tex b/docs/latex/wx/strmbfrd.tex
index f6822b29cc34fd710a9d0ddc1eaccf04023e63b2..3cf7705b93ef5c749735bdc00be92515d4182834 100644 (file)
--- a/docs/latex/wx/strmbfrd.tex
+++ b/docs/latex/wx/strmbfrd.tex
@@ -11,15 +11,22 @@ from (such as a file stream or a memory stream).
 
 \wxheading{Derived from}
 
-\helpref{wxFilterInputStream}{wxfilterinputstream}
+\helpref{wxFilterInputStream}{wxfilterinputstream}\\
+\helpref{wxInputStream}{wxinputstream}\\
+\helpref{wxStreamBase}{wxstreambase}
 
 \wxheading{Include files}
 
 <wx/stream.h>
 
+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}
+
 \wxheading{See also}
 
-\helpref{wxStreamBuffer}{wxstreambuffer}, \helpref{wxInputStream}{wxinputstream}
+\helpref{wxStreamBuffer}{wxstreambuffer}, \helpref{wxInputStream}{wxinputstream},
+\helpref{wxBufferedOutputStream}{wxbufferedoutputstream}
 
 % -----------------------------------------------------------------------------
 % wxBufferedOutputStream
@@ -28,20 +35,59 @@ from (such as a file stream or a memory stream).
 
 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}
 
-\helpref{wxFilterOutputStream}{wxfilteroutputstream}
+\helpref{wxFilterOutputStream}{wxfilteroutputstream}\\
+\helpref{wxOutputStream}{wxoutputstream}\\
+\helpref{wxStreamBase}{wxstreambase}
 
 \wxheading{Include files}
 
 <wx/stream.h>
 
+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}
+
 \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.
+
+