X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/4c68a10264347cc04b1a6634000595f160792231..81c882b613b5d99ddb1e5ab69fcd7ebccc287025:/docs/latex/wx/strmzlib.tex diff --git a/docs/latex/wx/strmzlib.tex b/docs/latex/wx/strmzlib.tex index 46945e16ad..eda8d2f207 100644 --- a/docs/latex/wx/strmzlib.tex +++ b/docs/latex/wx/strmzlib.tex @@ -5,7 +5,7 @@ This filter stream decompresses a stream that is in zlib or gzip format. Note that reading the gzip format requires zlib version 1.2.1 or greater, -(the builtin version does support gzips). +(the builtin version does support gzip format). The stream is not seekable, \helpref{SeekI()}{wxinputstreamseeki} returns {\it wxInvalidOffset}. Also \helpref{GetSize()}{wxstreambasegetsize} is @@ -26,10 +26,15 @@ not supported, it always returns $0$. \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxZlibInputStream::wxZlibInputStream} +\membersection{wxZlibInputStream::wxZlibInputStream}\label{wxzlibinputstreamwxzlibinputstream} \func{}{wxZlibInputStream}{\param{wxInputStream\&}{ stream}, \param{int}{ flags = wxZLIB\_AUTO}} +\func{}{wxZlibInputStream}{\param{wxInputStream*}{ stream}, \param{int}{ flags = wxZLIB\_AUTO}} + +If the parent stream is passed as a pointer then the new filter stream +takes ownership of it. If it is passed by reference then it does not. + The {\it flags} wxZLIB\_ZLIB and wxZLIB\_GZIP specify whether the input data is in zlib or gzip format. If wxZLIB\_AUTO is used, then zlib will autodetect the stream type, this is the default. @@ -42,8 +47,8 @@ deflate stream embedded in a higher level protocol. %if WXWIN_COMPATIBILITY_2_4 This version is not by default compatible with the output produced by the version of {\it wxZlibOutputStream} in wxWidgets 2.4.x. However, -there is a compatibilty mode, which is switched on by passing -wxZLIB\_24COMPATIBLE for flags. Note that in when operating in compatibilty +there is a compatibility mode, which is switched on by passing +wxZLIB\_24COMPATIBLE for flags. Note that in when operating in compatibility mode error checking is very much reduced. %endif @@ -76,7 +81,7 @@ Returns true if zlib library in use can handle gzip compressed data. This stream compresses all data written to it. The compressed output can be in zlib or gzip format. Note that writing the gzip format requires zlib version 1.2.1 or greater -(the builtin version does support gzips). +(the builtin version does support gzip format). The stream is not seekable, \helpref{SeekO()}{wxoutputstreamseeko} returns {\it wxInvalidOffset}. @@ -97,15 +102,20 @@ The stream is not seekable, \helpref{SeekO()}{wxoutputstreamseeko} returns \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxZlibOutputStream::wxZlibOutputStream} +\membersection{wxZlibOutputStream::wxZlibOutputStream}\label{wxzliboutputstreamwxzliboutputstream} \func{}{wxZlibOutputStream}{\param{wxOutputStream\&}{ stream}, \param{int}{ level = -1}, \param{int}{ flags = wxZLIB\_ZLIB}} +\func{}{wxZlibOutputStream}{\param{wxOutputStream*}{ stream}, \param{int}{ level = -1}, \param{int}{ flags = wxZLIB\_ZLIB}} + Creates a new write-only compressed stream. {\it level} means level of compression. It is number between 0 and 9 (including these values) where 0 means no compression and 9 best but slowest compression. -1 is default value (currently equivalent to 6). +If the parent stream is passed as a pointer then the new filter stream +takes ownership of it. If it is passed by reference then it does not. + The {\it flags} wxZLIB\_ZLIB and wxZLIB\_GZIP specify whether the output data will be in zlib or gzip format. wxZLIB\_ZLIB is the default.