Doc updates.

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

% -----------------------------------------------------------------------------
% wxFilterOutputStream
% -----------------------------------------------------------------------------
\section{\class{wxFilterOutputStream}}\label{wxfilteroutputstream}

\wxheading{Derived from}

\helpref{wxOutputStream}{wxoutputstream}\\
\helpref{wxStreamBase}{wxstreambase}

\wxheading{Include files}

<wx/stream.h>

\wxheading{Note}

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

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

\func{}{wxFilterOutputStream}{\param{wxOutputStream\&}{ 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 compress, crypt the datas which are passed to it and write them to another
stream.