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

% -----------------------------------------------------------------------------
% wxCountingOutputStream
% -----------------------------------------------------------------------------
\section{\class{wxCountingOutputStream}}\label{wxcountingoutputstream}

wxCountingOutputStream is a specialized output stream which does not write any data anywhere,
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>

\latexignore{\rtfignore{\wxheading{Members}}}

% -----------
% ctor & dtor
% -----------
\membersection{wxCountingOutputStream::wxCountingOutputStream}\label{wxcountingoutputstreamctor}

\func{}{wxCountingOutputStream}{\void}

Creates a wxCountingOutputStream object.

\membersection{wxCountingOutputStream::\destruct{wxCountingOutputStream}}\label{wxcountingoutputstreamdtor}

\func{}{\destruct{wxCountingOutputStream}}{\void}

Destructor.

\membersection{wxCountingOutputStream::GetSize}\label{wxcountingoutputstreamgetsize}

\constfunc{size\_t}{GetSize}{\void}

Returns the current size of the stream.
Commit	Line	Data
fa482912 JS	1	% -----------------------------------------------------------------------------
	2	% wxCountingOutputStream
	3	% -----------------------------------------------------------------------------
	4	\section{\class{wxCountingOutputStream}}\label{wxcountingoutputstream}
	5
5cafd4be	6	wxCountingOutputStream is a specialized output stream which does not write any data anywhere,
fa482912 JS	7	instead it counts how many bytes would get written if this were a normal stream. This
	8	can sometimes be useful or required if some data gets serialized to a stream or compressed
	9	by using stream compression and thus the final size of the stream cannot be known other
	10	than pretending to write the stream. One case where the resulting size would have to be
	11	known is if the data has to be written to a piece of memory and the memory has to be
	12	allocated before writing to it (which is probably always the case when writing to a
	13	memory stream).
	14
	15	\wxheading{Derived from}
	16
	17	\helpref{wxOutputStream}{wxoutputstream}
	18	\helpref{wxStreamBase}{wxstreambase}
	19
	20	\wxheading{Include files}
	21
	22	<wx/stream.h>
	23
	24	\latexignore{\rtfignore{\wxheading{Members}}}
	25
	26	% -----------
	27	% ctor & dtor
	28	% -----------
f510b7b2	29	\membersection{wxCountingOutputStream::wxCountingOutputStream}\label{wxcountingoutputstreamctor}
fa482912 JS	30
	31	\func{}{wxCountingOutputStream}{\void}
	32
	33	Creates a wxCountingOutputStream object.
	34
f510b7b2	35	\membersection{wxCountingOutputStream::\destruct{wxCountingOutputStream}}\label{wxcountingoutputstreamdtor}
fa482912 JS	36
	37	\func{}{\destruct{wxCountingOutputStream}}{\void}
	38
	39	Destructor.
	40
f510b7b2	41	\membersection{wxCountingOutputStream::GetSize}\label{wxcountingoutputstreamgetsize}
fa482912 JS	42
	43	\constfunc{size\_t}{GetSize}{\void}
	44
	45	Returns the current size of the stream.
	46