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

% -----------------------------------------------------------------------------
% wxFilterInputStream
% -----------------------------------------------------------------------------
\section{\class{wxFilterInputStream}}\label{wxfilterinputstream}

\wxheading{Derived from}

\helpref{wxInputStream}{wxinputstream}\\
\helpref{wxStreamBase}{wxstreambase}

\wxheading{Note}

The use of this class is exactly the same as of wxInputStream. Only a constructor
differs and it is documented below.

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

\func{}{wxFilterInputStream}{\param{wxInputStream\&}{ stream}}

Initializes a "filter" stream. A filter stream has the capability of a normal
stream but it can be placed on the top of another stream. So, for example, it
can uncompress, uncrypt the datas which are read from another stream and pass it
to the requester.
Commit	Line	Data
e2a6f233 JS	1	% -----------------------------------------------------------------------------
	2	% wxFilterInputStream
	3	% -----------------------------------------------------------------------------
	4	\section{\class{wxFilterInputStream}}\label{wxfilterinputstream}
	5
	6	\wxheading{Derived from}
	7
631f1bfe JS	8	\helpref{wxInputStream}{wxinputstream}\\
631f1bfe JS	9	\helpref{wxStreamBase}{wxstreambase}
e2a6f233 JS	10
	11	\wxheading{Note}
	12
	13	The use of this class is exactly the same as of wxInputStream. Only a constructor
	14	differs and it is documented below.
	15
	16	% -----------
	17	% ctor & dtor
	18	% -----------
	19	\membersection{wxFilterInputStream::wxFilterInputStream}
	20
	21	\func{}{wxFilterInputStream}{\param{wxInputStream\&}{ stream}}
	22
da3aea64 GL	23	Initializes a "filter" stream. A filter stream has the capability of a normal
	24	stream but it can be placed on the top of another stream. So, for example, it
	25	can uncompress, uncrypt the datas which are read from another stream and pass it
	26	to the requester.