Update documentation for new library name.

[wxWidgets.git] / interface / wx / zstream.h

diff --git a/interface/wx/zstream.h b/interface/wx/zstream.h
index db994b47b6b80343f615a1b182819da5ac906c29..4f12c6f46e76e54e26ece569b0857295c6210c16 100644 (file)
--- a/interface/wx/zstream.h
+++ b/interface/wx/zstream.h
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxZlibOutputStream
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 
@@ -37,7 +37,7 @@ enum wxZLibFlags {
     ::wxInvalidOffset.
 
     @library{wxbase}
-    @category{streams}
+    @category{archive,streams}
 
     @see wxOutputStream, wxZlibInputStream
 */
@@ -76,6 +76,19 @@ public:
         Returns @true if zlib library in use can handle gzip compressed data.
     */
     static bool CanHandleGZip();
+
+    //@{
+    /**
+        Sets the dictionary to the specified chunk of data. This can improve
+        compression rate but note that the dictionary has to be the same when
+        you deflate the data as when you inflate the data, otherwise you
+        will inflate corrupted data.
+
+        Returns @true if the dictionary was successfully set.
+    */
+    bool SetDictionary(const char *data, const size_t datalen);
+    bool SetDictionary(const wxMemoryBuffer &buf);
+    //@}
 };
 
 
@@ -91,7 +104,7 @@ public:
     Also wxStreamBase::GetSize() is not supported, it always returns 0.
 
     @library{wxbase}
-    @category{streams}
+    @category{archive,streams}
 
     @see wxInputStream, wxZlibOutputStream.
 */
@@ -122,5 +135,18 @@ public:
         Returns @true if zlib library in use can handle gzip compressed data.
     */
     static bool CanHandleGZip();
+
+    //@{
+    /**
+        Sets the dictionary to the specified chunk of data. This can improve
+        compression rate but note that the dictionary has to be the same when
+        you deflate the data as when you inflate the data, otherwise you
+        will inflate corrupted data.
+
+        Returns @true if the dictionary was successfully set.
+    */
+    bool SetDictionary(const char *data, const size_t datalen);
+    bool SetDictionary(const wxMemoryBuffer &buf);
+    //@}
 };