documented VFS handlers

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

diff --git a/docs/latex/wx/outptstr.tex b/docs/latex/wx/outptstr.tex
index 74378c89b6d4efc0873fad594f3e972f699fbcfa..90873de8f919b8b1930df914501bca5787d4447d 100644 (file)
--- a/docs/latex/wx/outptstr.tex
+++ b/docs/latex/wx/outptstr.tex
@@ -3,6 +3,8 @@
 % -----------------------------------------------------------------------------
 \section{\class{wxOutputStream}}\label{wxoutputstream}
 
 % -----------------------------------------------------------------------------
 \section{\class{wxOutputStream}}\label{wxoutputstream}
 

+wxOutputStream is an abstract base class which may not be used directly.
+

 \wxheading{Derived from}
 
 \helpref{wxStreamBase}{wxstreambase}
 \wxheading{Derived from}
 
 \helpref{wxStreamBase}{wxstreambase}


@@ -11,10 +13,6 @@
 
 <wx/stream.h>
 
 
 <wx/stream.h>
 

-\wxheading{See also}
-
-\helpref{wxStreamBuffer}{wxstreambuffer}
-

 % -----------
 % ctor & dtor
 % -----------
 % -----------
 % ctor & dtor
 % -----------


@@ -24,27 +22,18 @@
 
 Creates a dummy wxOutputStream object.
 
 
 Creates a dummy wxOutputStream object.
 

-\func{}{wxOutputStream}{\param{wxStreamBuffer*}{ sbuf}}
-
-Creates an input stream using the specified stream buffer \it{sbuf}. This
-stream buffer can point to another stream.
-

 \membersection{wxOutputStream::\destruct{wxOutputStream}}
 
 \func{}{\destruct{wxOutputStream}}{\void}
 
 Destructor.
 
 \membersection{wxOutputStream::\destruct{wxOutputStream}}
 
 \func{}{\destruct{wxOutputStream}}{\void}
 
 Destructor.
 

-\membersection{wxOutputStream::OutputStreamBuffer}
-
-\func{wxStreamBuffer *}{OutputStreamBuffer}{\void}
-
-Returns the stream buffer associated with the output stream.
-

 \membersection{wxOutputStream::LastWrite}
 
 \constfunc{size\_t}{LastWrite}{\void}
 
 \membersection{wxOutputStream::LastWrite}
 
 \constfunc{size\_t}{LastWrite}{\void}
 

+Returns the number of bytes written during the last Write().
+

 \membersection{wxOutputStream::PutC}
 
 \func{void}{PutC}{\param{char}{ c}}
 \membersection{wxOutputStream::PutC}
 
 \func{void}{PutC}{\param{char}{ c}}


@@ -68,8 +57,8 @@ Returns the current stream position.
 
 \func{wxOutputStream\&}{Write}{\param{const void *}{buffer}, \param{size\_t}{ size}}
 
 
 \func{wxOutputStream\&}{Write}{\param{const void *}{buffer}, \param{size\_t}{ size}}
 

-Writes the specified amount of bytes using the data of \it{buffer}. 
-\it{WARNING!} The buffer absolutely needs to have at least the specified size.
+Writes the specified amount of bytes using the data of {\it buffer}. 
+{\it WARNING!} The buffer absolutely needs to have at least the specified size.

 
 This function returns a reference on the current object, so the user can test
 any states of the stream right away.
 
 This function returns a reference on the current object, so the user can test
 any states of the stream right away.


@@ -80,3 +69,47 @@ Reads data from the specified input stream and stores them
 in the current stream. The data is read until an error is raised
 by one of the two streams.
 
 in the current stream. The data is read until an error is raised
 by one of the two streams.
 

+% -----------------------------------------------------------------------------
+% wxCountingOutputStream
+% -----------------------------------------------------------------------------
+\section{\class{wxCountingOutputStream}}\label{wxcountingoutputstream}
+
+wxCountingOutputStream is specialized output stream which does not write any data anyway,
+instead it counts how many bytes would get written if this were a normal stream. This
+can sometimes be useful or required if some data gets serialized to a stream or compressed
+by using stream compression and thus the final size of the stream cannot be known other
+than pretending to write the stream. One case where the resulting size would have to be
+known is if the data has to be written to a piece of memory and the memory has to be
+allocated before writing to it (which is probably always the case when writing to a 
+memory stream).
+
+\wxheading{Derived from}
+
+\helpref{wxOutputStream}{wxoutputstream}
+\helpref{wxStreamBase}{wxstreambase}
+
+\wxheading{Include files}
+
+<wx/stream.h>
+
+% -----------
+% ctor & dtor
+% -----------
+\membersection{wxCountingOutputStream::wxCountingOutputStream}
+
+\func{}{wxCountingOutputStream}{\void}
+
+Creates a wxCountingOutputStream object.
+
+\membersection{wxCountingOutputStream::\destruct{wxCountingOutputStream}}
+
+\func{}{\destruct{wxCountingOutputStream}}{\void}
+
+Destructor.
+
+\membersection{wxCountingOutputStream::GetSize}
+
+\constfunc{size\_t}{GetSize}{\void}
+
+Returns the current size of the stream.
+