docs/latex/wx/strmzlib.tex

   1 % -----------------------------------------------------------------------------
   2 % wxZlibInputStream
   3 % -----------------------------------------------------------------------------
   4 \section{\class{wxZlibInputStream}}\label{wxzlibinputstream}
   5
   6 This filter stream decompresses a stream that is in zlib or gzip format.
   7 Note that reading the gzip format requires zlib version 1.2.1 or greater,
   8 (the builtin version does support gzip format).
   9
  10 The stream is not seekable, \helpref{SeekI()}{wxinputstreamseeki} returns
  11  {\it wxInvalidOffset}. Also \helpref{GetSize()}{wxstreambasegetsize} is
  12 not supported, it always returns $0$.
  13
  14 \wxheading{Derived from}
  15
  16 \helpref{wxFilterInputStream}{wxfilterinputstream}\\
  17 \helpref{wxInputStream}{wxinputstream}\\
  18 \helpref{wxStreamBase}{wxstreambase}
  19
  20 \wxheading{Include files}
  21
  22 <wx/zstream.h>
  23
  24 \wxheading{Library}
  25
  26 \helpref{wxBase}{librarieslist}
  27
  28 \wxheading{See also}
  29
  30 \helpref{wxInputStream}{wxinputstream},
  31  \helpref{wxZlibOutputStream}{wxzliboutputstream}.
  32
  33 \latexignore{\rtfignore{\wxheading{Members}}}
  34
  35 \membersection{wxZlibInputStream::wxZlibInputStream}\label{wxzlibinputstreamwxzlibinputstream}
  36
  37 \func{}{wxZlibInputStream}{\param{wxInputStream\&}{ stream}, \param{int}{ flags = wxZLIB\_AUTO}}
  38
  39 \func{}{wxZlibInputStream}{\param{wxInputStream*}{ stream}, \param{int}{ flags = wxZLIB\_AUTO}}
  40
  41 If the parent stream is passed as a pointer then the new filter stream
  42 takes ownership of it. If it is passed by reference then it does not.
  43
  44 The {\it flags} wxZLIB\_ZLIB and wxZLIB\_GZIP specify whether the input data
  45 is in zlib or gzip format. If wxZLIB\_AUTO is used, then zlib will
  46 autodetect the stream type, this is the default.
  47
  48 If {\it flags} is wxZLIB\_NO\_HEADER, then the data is assumed to be a raw
  49 deflate stream without either zlib or gzip headers. This is a lower level
  50 mode, which is not usually used directly. It can be used to read a raw
  51 deflate stream embedded in a higher level protocol.
  52
  53 %if WXWIN_COMPATIBILITY_2_4
  54 This version is not by default compatible with the output produced by
  55 the version of {\it wxZlibOutputStream} in wxWidgets 2.4.x. However,
  56 there is a compatibility mode, which is switched on by passing
  57 wxZLIB\_24COMPATIBLE for flags. Note that in when operating in compatibility
  58 mode error checking is very much reduced.
  59 %endif
  60
  61 The following symbols can be use for the flags:
  62
  63 \begin{verbatim}
  64 // Flags
  65 enum {
  66 #if WXWIN_COMPATIBILITY_2_4
  67     wxZLIB_24COMPATIBLE = 4, // read v2.4.x data without error
  68 #endif
  69     wxZLIB_NO_HEADER = 0,    // raw deflate stream, no header or checksum
  70     wxZLIB_ZLIB = 1,         // zlib header and checksum
  71     wxZLIB_GZIP = 2,         // gzip header and checksum, requires zlib 1.2.1+
  72     wxZLIB_AUTO = 3          // autodetect header zlib or gzip
  73 };
  74 \end{verbatim}
  75
  76 \membersection{wxZlibInputStream::CanHandleGZip}\label{wxzlibinputstreamcanhandlegzip}
  77
  78 \func{static bool}{CanHandleGZip}{\void}
  79
  80 Returns true if zlib library in use can handle gzip compressed data.
  81
  82 % -----------------------------------------------------------------------------
  83 % wxZlibOutputStream
  84 % -----------------------------------------------------------------------------
  85 \section{\class{wxZlibOutputStream}}\label{wxzliboutputstream}
  86
  87 This stream compresses all data written to it. The compressed output can be
  88 in zlib or gzip format.
  89 Note that writing the gzip format requires zlib version 1.2.1 or greater
  90 (the builtin version does support gzip format).
  91
  92 The stream is not seekable, \helpref{SeekO()}{wxoutputstreamseeko} returns
  93  {\it wxInvalidOffset}.
  94
  95 \wxheading{Derived from}
  96
  97 \helpref{wxFilterOutputStream}{wxfilteroutputstream}\\
  98 \helpref{wxOutputStream}{wxoutputstream}\\
  99 \helpref{wxStreamBase}{wxstreambase}
 100
 101 \wxheading{Include files}
 102
 103 <wx/zstream.h>
 104
 105 \wxheading{Library}
 106
 107 \helpref{wxBase}{librarieslist}
 108
 109 \wxheading{See also}
 110
 111 \helpref{wxOutputStream}{wxoutputstream},
 112  \helpref{wxZlibInputStream}{wxzlibinputstream}
 113
 114
 115 \latexignore{\rtfignore{\wxheading{Members}}}
 116
 117 \membersection{wxZlibOutputStream::wxZlibOutputStream}\label{wxzliboutputstreamwxzliboutputstream}
 118
 119 \func{}{wxZlibOutputStream}{\param{wxOutputStream\&}{ stream}, \param{int}{ level = -1}, \param{int}{ flags = wxZLIB\_ZLIB}}
 120
 121 \func{}{wxZlibOutputStream}{\param{wxOutputStream*}{ stream}, \param{int}{ level = -1}, \param{int}{ flags = wxZLIB\_ZLIB}}
 122
 123 Creates a new write-only compressed stream. {\it level} means level of
 124 compression. It is number between 0 and 9 (including these values) where
 125 0 means no compression and 9 best but slowest compression. -1 is default
 126 value (currently equivalent to 6).
 127
 128 If the parent stream is passed as a pointer then the new filter stream
 129 takes ownership of it. If it is passed by reference then it does not.
 130
 131 The {\it flags} wxZLIB\_ZLIB and wxZLIB\_GZIP specify whether the output data
 132 will be in zlib or gzip format. wxZLIB\_ZLIB is the default.
 133
 134 If {\it flags} is wxZLIB\_NO\_HEADER, then a raw deflate stream is output
 135 without either zlib or gzip headers. This is a lower level
 136 mode, which is not usually used directly. It can be used to embed a raw
 137 deflate stream in a higher level protocol.
 138
 139 The following symbols can be use for the compression level and flags:
 140
 141 \begin{verbatim}
 142 // Compression level
 143 enum {
 144     wxZ_DEFAULT_COMPRESSION = -1,
 145     wxZ_NO_COMPRESSION = 0,
 146     wxZ_BEST_SPEED = 1,
 147     wxZ_BEST_COMPRESSION = 9
 148 };
 149
 150 // Flags
 151 enum {
 152     wxZLIB_NO_HEADER = 0,   // raw deflate stream, no header or checksum
 153     wxZLIB_ZLIB = 1,        // zlib header and checksum
 154     wxZLIB_GZIP = 2         // gzip header and checksum, requires zlib 1.2.1+
 155 };
 156 \end{verbatim}
 157
 158 \membersection{wxZlibOutputStream::CanHandleGZip}\label{wxoutputstreamcanhandlegzip}
 159
 160 \func{static bool}{CanHandleGZip}{\void}
 161
 162 Returns true if zlib library in use can handle gzip compressed data.
 163