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

% -----------------------------------------------------------------------------
% 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{Include files}

<wx/stream.h>

% -----------
% ctor & dtor
% -----------
\membersection{wxOutputStream::wxOutputStream}

\func{}{wxOutputStream}{\void}

Creates a dummy wxOutputStream object.

\membersection{wxOutputStream::\destruct{wxOutputStream}}

\func{}{\destruct{wxOutputStream}}{\void}

Destructor.

\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}}

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}

\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.

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}}

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.

% -----------------------------------------------------------------------------
% 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}{wxstreambase}
\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.
Commit	Line	Data
e2a6f233 JS	1	% -----------------------------------------------------------------------------
	2	% wxOutputStream
	3	% -----------------------------------------------------------------------------
	4	\section{\class{wxOutputStream}}\label{wxoutputstream}
	5
d984207c RR	6	wxOutputStream is an abstract base class which may not be used directly.
d984207c RR	7
e2a6f233 JS	8	\wxheading{Derived from}
	9
	10	\helpref{wxStreamBase}{wxstreambase}
	11
954b8ae6 JS	12	\wxheading{Include files}
	13
	14	<wx/stream.h>
	15
e2a6f233 JS	16	% -----------
	17	% ctor & dtor
	18	% -----------
	19	\membersection{wxOutputStream::wxOutputStream}
	20
	21	\func{}{wxOutputStream}{\void}
	22
	23	Creates a dummy wxOutputStream object.
	24
e2a6f233 JS	25	\membersection{wxOutputStream::\destruct{wxOutputStream}}
	26
	27	\func{}{\destruct{wxOutputStream}}{\void}
	28
	29	Destructor.
	30
40b480c3	31	\membersection{wxOutputStream::LastWrite}
e2a6f233	32
294e9a7a	33	\constfunc{size\_t}{LastWrite}{\void}
e2a6f233	34
d984207c RR	35	Returns the number of bytes written during the last Write().
d984207c RR	36
40b480c3	37	\membersection{wxOutputStream::PutC}
e2a6f233	38
40b480c3	39	\func{void}{PutC}{\param{char}{ c}}
e2a6f233	40
40b480c3 JS	41	Puts the specified character in the output queue and increments the
40b480c3 JS	42	stream position.
e2a6f233	43
e2a6f233 JS	44	\membersection{wxOutputStream::SeekO}
e2a6f233 JS	45
294e9a7a	46	\func{off\_t}{SeekO}{\param{off\_t}{ pos}, \param{wxSeekMode}{ mode}}
e2a6f233 JS	47
	48	Changes the stream current position.
	49
	50	\membersection{wxOutputStream::TellO}
	51
294e9a7a	52	\constfunc{off\_t}{TellO}{\void}
e2a6f233 JS	53
	54	Returns the current stream position.
	55
40b480c3	56	\membersection{wxOutputStream::Write}
e2a6f233	57
294e9a7a	58	\func{wxOutputStream\&}{Write}{\param{const void *}{buffer}, \param{size\_t}{ size}}
e2a6f233	59
605d715d VS	60	Writes the specified amount of bytes using the data of {\it buffer}.
605d715d VS	61	{\it WARNING!} The buffer absolutely needs to have at least the specified size.
e2a6f233	62
40b480c3 JS	63	This function returns a reference on the current object, so the user can test
40b480c3 JS	64	any states of the stream right away.
e2a6f233	65
294e9a7a	66	\func{wxOutputStream\&}{Write}{\param{wxInputStream\&}{ stream\_in}}
40b480c3 JS	67
	68	Reads data from the specified input stream and stores them
	69	in the current stream. The data is read until an error is raised
	70	by one of the two streams.
e2a6f233	71
d984207c RR	72	% -----------------------------------------------------------------------------
	73	% wxCountingOutputStream
	74	% -----------------------------------------------------------------------------
cf3da716	75	\section{\class{wxCountingOutputStream}}\label{wxcountingoutputstream}
d984207c RR	76
	77	wxCountingOutputStream is specialized output stream which does not write any data anyway,
	78	instead it counts how many bytes would get written if this were a normal stream. This
	79	can sometimes be useful or required if some data gets serialized to a stream or compressed
	80	by using stream compression and thus the final size of the stream cannot be known other
	81	than pretending to write the stream. One case where the resulting size would have to be
	82	known is if the data has to be written to a piece of memory and the memory has to be
	83	allocated before writing to it (which is probably always the case when writing to a
	84	memory stream).
	85
	86	\wxheading{Derived from}
	87
	88	\helpref{wxOutputStream}{wxstreambase}
	89	\helpref{wxStreamBase}{wxstreambase}
	90
	91	\wxheading{Include files}
	92
	93	<wx/stream.h>
	94
	95	% -----------
	96	% ctor & dtor
	97	% -----------
	98	\membersection{wxCountingOutputStream::wxCountingOutputStream}
	99
	100	\func{}{wxCountingOutputStream}{\void}
	101
	102	Creates a wxCountingOutputStream object.
	103
	104	\membersection{wxCountingOutputStream::\destruct{wxCountingOutputStream}}
	105
	106	\func{}{\destruct{wxCountingOutputStream}}{\void}
	107
	108	Destructor.
	109
	110	\membersection{wxCountingOutputStream::GetSize}
	111
	112	\constfunc{size\_t}{GetSize}{\void}
	113
	114	Returns the current size of the stream.