Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

final w*h interface header reviews

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@55911 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-09-27 10:59:01 +00:00
parent 75bc3a0d80
commit e7d0a28b01
3 changed files with 134 additions and 90 deletions
Download Patch File Download Diff File Expand all files Collapse all files

67
interface/wx/zstream.h
View File

@@ -6,16 +6,35 @@
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/// Compression level
enum wxZlibCompressionLevels {
wxZ_DEFAULT_COMPRESSION = -1,
wxZ_NO_COMPRESSION = 0,
wxZ_BEST_SPEED = 1,
wxZ_BEST_COMPRESSION = 9
};
/// Flags
enum wxZLibFlags {
wxZLIB_NO_HEADER = 0, //!< raw deflate stream, no header or checksum
wxZLIB_ZLIB = 1, //!< zlib header and checksum
wxZLIB_GZIP = 2, //!< gzip header and checksum, requires zlib 1.2.1+
wxZLIB_AUTO = 3 //!< autodetect header zlib or gzip
};
/**
@class wxZlibOutputStream
This stream compresses all data written to it. The compressed output can be
in zlib or gzip format.
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 gzip format).
The stream is not seekable, wxOutputStream::SeekO returns
@e wxInvalidOffset.
The stream is not seekable, wxOutputStream::SeekO() returns
::wxInvalidOffset.
@library{wxbase}
@category{streams}
@@ -27,19 +46,25 @@ class wxZlibOutputStream : public wxFilterOutputStream
public:
//@{
/**
Creates a new write-only compressed stream. @a 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).
Creates a new write-only compressed stream.
@a 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 @a flags wxZLIB_ZLIB and wxZLIB_GZIP specify whether the output data
will be in zlib or gzip format. wxZLIB_ZLIB is the default.
If @a flags is wxZLIB_NO_HEADER, then a raw deflate stream is output
without either zlib or gzip headers. This is a lower level
mode, which is not usually used directly. It can be used to embed a raw
deflate stream in a higher level protocol.
The following symbols can be use for the compression level and flags:
without either zlib or gzip headers. This is a lower level mode, which
is not usually used directly. It can be used to embed a raw deflate
stream in a higher level protocol.
The values of the ::wxZlibCompressionLevels and ::wxZLibFlags
enumerations can be used.
*/
wxZlibOutputStream(wxOutputStream& stream, int level = -1,
int flags = wxZLIB_ZLIB);
@@ -62,9 +87,8 @@ public:
Note that reading the gzip format requires zlib version 1.2.1 or greater,
(the builtin version does support gzip format).
The stream is not seekable, wxInputStream::SeekI returns
@e wxInvalidOffset. Also wxStreamBase::GetSize is
not supported, it always returns 0.
The stream is not seekable, wxInputStream::SeekI returns ::wxInvalidOffset.
Also wxStreamBase::GetSize() is not supported, it always returns 0.
@library{wxbase}
@category{streams}
@@ -78,23 +102,20 @@ public:
/**
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 @a 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.
If @a flags is wxZLIB_NO_HEADER, then the data is assumed to be a raw
deflate stream without either zlib or gzip headers. This is a lower level
mode, which is not usually used directly. It can be used to read a raw
deflate stream embedded in a higher level protocol.
This version is not by default compatible with the output produced by
the version of @e wxZlibOutputStream in wxWidgets 2.4.x. However,
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.
The following symbols can be use for the flags:
The values of the ::wxZLibFlags enumeration can be used.
*/
wxZlibInputStream(wxInputStream& stream, int flags = wxZLIB_AUTO);
wxZlibInputStream(wxInputStream* stream,
int flags = wxZLIB_AUTO);
wxZlibInputStream(wxInputStream* stream, int flags = wxZLIB_AUTO);
//@}
/**