]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/outptstr.tex
added wxMemoryFSHandler docs
[wxWidgets.git] / docs / latex / wx / outptstr.tex
index eae660ae4241fa08f217f4605769d960b789ad47..90873de8f919b8b1930df914501bca5787d4447d 100644 (file)
@@ -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}
 
 <wx/stream.h>
 
 
 <wx/stream.h>
 
-\wxheading{See also}
-
-\helpref{wxStreamBuffer}{wxstreambuffer}
-
 % -----------
 % ctor & dtor
 % -----------
 % -----------
 % ctor & dtor
 % -----------
 
 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.
 
-% -----------
-% IO function
-% -----------
+\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}}
@@ -45,47 +41,75 @@ Destructor.
 Puts the specified character in the output queue and increments the
 stream position.
 
 Puts the specified character in the output queue and increments the
 stream position.
 
+\membersection{wxOutputStream::SeekO}
+
+\func{off\_t}{SeekO}{\param{off\_t}{ pos}, \param{wxSeekMode}{ mode}}
+
+Changes the stream current position.
+
+\membersection{wxOutputStream::TellO}
+
+\constfunc{off\_t}{TellO}{\void}
+
+Returns the current stream position.
+
 \membersection{wxOutputStream::Write}
 
 \membersection{wxOutputStream::Write}
 
-\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.
 
-\func{wxOutputStream\&}{Write}{\param{wxInputStream\&}{ stream_in}}
+\func{wxOutputStream\&}{Write}{\param{wxInputStream\&}{ stream\_in}}
 
 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.
 
 
 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.
 
-% ------------------
-% Position functions
-% ------------------
-\membersection{wxOutputStream::SeekO}
+% -----------------------------------------------------------------------------
+% wxCountingOutputStream
+% -----------------------------------------------------------------------------
+\section{\class{wxCountingOutputStream}}\label{wxcountingoutputstream}
 
 
-\func{off_t}{SeekO}{\param{off_t}{ pos}, \param{wxSeekMode}{ mode}}
+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).
 
 
-Changes the stream current position.
+\wxheading{Derived from}
 
 
-\membersection{wxOutputStream::TellO}
+\helpref{wxOutputStream}{wxoutputstream}
+\helpref{wxStreamBase}{wxstreambase}
 
 
-\constfunc{off_t}{TellO}{\void}
+\wxheading{Include files}
 
 
-Returns the current stream position.
+<wx/stream.h>
 
 
-% ---------------
-% State functions
-% ---------------
-\membersection{wxOutputStream::OutputStreamBuffer}
+% -----------
+% ctor & dtor
+% -----------
+\membersection{wxCountingOutputStream::wxCountingOutputStream}
 
 
-\func{wxStreamBuffer *}{OutputStreamBuffer}{\void}
+\func{}{wxCountingOutputStream}{\void}
 
 
-Returns the stream buffer associated with the output stream.
+Creates a wxCountingOutputStream object.
 
 
-\membersection{wxOutputStream::LastWrite}
+\membersection{wxCountingOutputStream::\destruct{wxCountingOutputStream}}
+
+\func{}{\destruct{wxCountingOutputStream}}{\void}
+
+Destructor.
+
+\membersection{wxCountingOutputStream::GetSize}
+
+\constfunc{size\_t}{GetSize}{\void}
 
 
-\constfunc{size_t}{LastWrite}{\void}
+Returns the current size of the stream.