docs/latex/wx/fltinstr.tex

   1 % -----------------------------------------------------------------------------
   2 % wxFilterInputStream
   3 % -----------------------------------------------------------------------------
   4 \section{\class{wxFilterInputStream}}\label{wxfilterinputstream}
   5
   6 A filter stream has the capability of a normal stream but it can be placed on top
   7 of another stream. So, for example, it can uncompress or decrypt the data which are read
   8 from another stream and pass it to the requester.
   9
  10 \wxheading{Derived from}
  11
  12 \helpref{wxInputStream}{wxinputstream}\\
  13 \helpref{wxStreamBase}{wxstreambase}
  14
  15 \wxheading{Include files}
  16
  17 <wx/stream.h>
  18
  19 \wxheading{Note}
  20
  21 The interface of this class is the same as that of wxInputStream. Only a constructor
  22 differs and it is documented below.
  23
  24 \wxheading{See also}
  25
  26 \helpref{wxFilterClassFactory}{wxfilterclassfactory}\\
  27 \helpref{wxFilterOutputStream}{wxfilteroutputstream}
  28
  29 \latexignore{\rtfignore{\wxheading{Members}}}
  30
  31 % -----------
  32 % ctor & dtor
  33 % -----------
  34 \membersection{wxFilterInputStream::wxFilterInputStream}\label{wxfilterinputstreamctor}
  35
  36 \func{}{wxFilterInputStream}{\param{wxInputStream\&}{ stream}}
  37
  38 \func{}{wxFilterInputStream}{\param{wxInputStream*}{ stream}}
  39
  40 Initializes a "filter" stream.
  41
  42 If the parent stream is passed as a pointer then the new filter stream
  43 takes ownership of it. If it is passed by reference then it does not.
  44