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{Library}
  20
  21 \helpref{wxBase}{librarieslist}
  22
  23 \wxheading{Note}
  24
  25 The interface of this class is the same as that of wxInputStream. Only a constructor
  26 differs and it is documented below.
  27
  28 \wxheading{See also}
  29
  30 \helpref{wxFilterClassFactory}{wxfilterclassfactory}\\
  31 \helpref{wxFilterOutputStream}{wxfilteroutputstream}
  32
  33 \latexignore{\rtfignore{\wxheading{Members}}}
  34
  35 % -----------
  36 % ctor & dtor
  37 % -----------
  38 \membersection{wxFilterInputStream::wxFilterInputStream}\label{wxfilterinputstreamctor}
  39
  40 \func{}{wxFilterInputStream}{\param{wxInputStream\&}{ stream}}
  41
  42 \func{}{wxFilterInputStream}{\param{wxInputStream*}{ stream}}
  43
  44 Initializes a "filter" stream.
  45
  46 If the parent stream is passed as a pointer then the new filter stream
  47 takes ownership of it. If it is passed by reference then it does not.
  48