Add wxPopupWindow

[wxWidgets.git] / interface / zipstrm.h

diff --git a/interface/zipstrm.h b/interface/zipstrm.h
index e2ea0877a4632a8bceeb76d1aebe4fd1670798dc..ba285cd4abe979d5f81bad847374d565099a2366 100644 (file)
--- a/interface/zipstrm.h
+++ b/interface/zipstrm.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        zipstrm.h
-// Purpose:     documentation for wxZipNotifier class
+// Purpose:     interface of wxZipNotifier
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -25,8 +25,7 @@
     @library{wxbase}
     @category{FIXME}
 
-    @seealso
-    @ref overview_wxarcnoseek "Archives on non-seekable streams", wxZipEntry,
+    @see @ref overview_wxarcnoseek "Archives on non-seekable streams", wxZipEntry,
     wxZipInputStream, wxZipOutputStream
 */
 class wxZipNotifier
@@ -40,6 +39,7 @@ public:
 };
 
 
+
 /**
     @class wxZipEntry
     @wxheader{zipstrm.h}
@@ -49,8 +49,7 @@ public:
     @library{wxbase}
     @category{FIXME}
 
-    @seealso
-    @ref overview_wxarc "Archive formats such as zip", wxZipInputStream,
+    @see @ref overview_wxarc "Archive formats such as zip", wxZipInputStream,
     wxZipOutputStream, wxZipNotifier
 */
 class wxZipEntry : public wxArchiveEntry
@@ -67,14 +66,14 @@ public:
     /**
         Make a copy of this entry.
     */
-    wxZipEntry* Clone();
+    wxZipEntry* Clone() const;
 
     //@{
     /**
         A short comment for this entry.
     */
     wxString GetComment();
-    void SetComment(const wxString& comment);
+    const void SetComment(const wxString& comment);
     //@}
 
     //@{
@@ -89,13 +88,13 @@ public:
         high 16 bits are unix mode bits.
         The following other accessors access these bits:
         @ref wxArchiveEntry::isreadonly IsReadOnly/SetIsReadOnly
-        
+
         @ref wxArchiveEntry::isdir IsDir/SetIsDir
-        
+
         @ref mode() Get/SetMode
     */
     wxUint32 GetExternalAttributes();
-    void SetExternalAttributes(wxUint32 attr);
+    const void SetExternalAttributes(wxUint32 attr);
     //@}
 
     //@{
@@ -105,8 +104,8 @@ public:
         data. See Pkware's document 'appnote.txt' for information on its format.
     */
     const char* GetExtra();
-    size_t GetExtraLen();
-    void SetExtra(const char* extra, size_t len);
+    const size_t GetExtraLen();
+    const void SetExtra(const char* extra, size_t len);
     //@}
 
     //@{
@@ -116,8 +115,8 @@ public:
         data. See Pkware's document 'appnote.txt' for information on its format.
     */
     const char* GetLocalExtra();
-    size_t GetLocalExtraLen();
-    void SetLocalExtra(const char* extra, size_t len);
+    const size_t GetLocalExtraLen();
+    const void SetLocalExtra(const char* extra, size_t len);
     //@}
 
     //@{
@@ -129,7 +128,7 @@ public:
         choose the method when writing the entry.
     */
     int GetMethod();
-    void SetMethod(int method);
+    const void SetMethod(int method);
     //@}
 
     //@{
@@ -145,7 +144,7 @@ public:
         permissions when creating zips, call SetSystemMadeBy(wxZIP_SYSTEM_UNIX).
     */
     int GetMode();
-    void SetMode(int mode);
+    const void SetMode(int mode);
     //@}
 
     //@{
@@ -155,23 +154,23 @@ public:
         able to store unix permissions using @ref mode() SetMode.
     */
     int GetSystemMadeBy();
-    void SetSystemMadeBy(int system);
+    const void SetSystemMadeBy(int system);
     //@}
 
     /**
         The compressed size of this entry in bytes.
     */
-    off_t GetCompressedSize();
+    off_t GetCompressedSize() const;
 
     /**
         CRC32 for this entry's data.
     */
-    wxUint32 GetCrc();
+    wxUint32 GetCrc() const;
 
     /**
         Returns a combination of the bits flags in the enumeration @c wxZipFlags.
     */
-    int GetFlags();
+    int GetFlags() const;
 
     //@{
     /**
@@ -179,32 +178,32 @@ public:
         within the archive. If the third parameter is provided, the bool pointed
         to is set to indicate whether the name looks like a directory name
         (i.e. has a trailing path separator).
-        
+
         @see @ref overview_wxarcbyname "Looking up an archive entry by name"
     */
     wxString GetInternalName();
-    wxString GetInternalName(const wxString& name,
-                             wxPathFormat format = wxPATH_NATIVE,
-                             bool* pIsDir = NULL);
+    const wxString  GetInternalName(const wxString& name,
+                                    wxPathFormat format = wxPATH_NATIVE,
+                                    bool* pIsDir = NULL);
     //@}
 
     /**
         Returns @true if @ref systemmadeby() GetSystemMadeBy
         is a flavour of unix.
     */
-    bool IsMadeByUnix();
+    bool IsMadeByUnix() const;
 
     //@{
     /**
         Indicates that this entry's data is text in an 8-bit encoding.
     */
     bool IsText();
-    void SetIsText(bool isText = true);
+    const void SetIsText(bool isText = true);
     //@}
 
     //@{
     /**
-        Sets the notifier for this entry.
+        Sets the notifier() for this entry.
         Whenever the wxZipInputStream updates
         this entry, it will then invoke the associated
         notifier's wxZipNotifier::OnEntryUpdated
@@ -212,7 +211,7 @@ public:
         Setting a notifier is not usually necessary. It is used to handle
         certain cases when modifying an zip in a pipeline (i.e. between
         non-seekable streams).
-        
+
         @see @ref overview_wxarcnoseek "Archives on non-seekable streams", wxZipNotifier
     */
     void SetNotifier(wxZipNotifier& notifier);
@@ -226,6 +225,7 @@ public:
 };
 
 
+
 /**
     @class wxZipInputStream
     @wxheader{zipstrm.h}
@@ -245,8 +245,8 @@ public:
     @library{wxbase}
     @category{streams}
 
-    @seealso
-    @ref overview_wxarc "Archive formats such as zip", wxZipEntry, wxZipOutputStream
+    @see @ref overview_wxarc "Archive formats such as zip", wxZipEntry,
+    wxZipOutputStream
 */
 class wxZipInputStream : public wxArchiveInputStream
 {
@@ -305,6 +305,7 @@ public:
 };
 
 
+
 /**
     @class wxZipClassFactory
     @wxheader{zipstrm.h}
@@ -315,9 +316,8 @@ public:
     @library{wxbase}
     @category{FIXME}
 
-    @seealso
-    @ref overview_wxarc "Archive formats such as zip", @ref overview_wxarcgeneric
-    "Generic archive programming", wxZipEntry, wxZipInputStream, wxZipOutputStream
+    @see @ref overview_wxarc "Archive formats such as zip", @ref
+    overview_wxarcgeneric "Generic archive programming", wxZipEntry, wxZipInputStream, wxZipOutputStream
 */
 class wxZipClassFactory : public wxArchiveClassFactory
 {
@@ -326,6 +326,7 @@ public:
 };
 
 
+
 /**
     @class wxZipOutputStream
     @wxheader{zipstrm.h}
@@ -340,8 +341,8 @@ public:
     @library{wxbase}
     @category{streams}
 
-    @seealso
-    @ref overview_wxarc "Archive formats such as zip", wxZipEntry, wxZipInputStream
+    @see @ref overview_wxarc "Archive formats such as zip", wxZipEntry,
+    wxZipInputStream
 */
 class wxZipOutputStream : public wxArchiveOutputStream
 {
@@ -409,7 +410,7 @@ public:
         which currently is equivalent to 6.
     */
     int GetLevel();
-    void SetLevel(int level);
+    const void SetLevel(int level);
     //@}
 
     /**
@@ -438,3 +439,4 @@ public:
     */
     void SetComment(const wxString& comment);
 };
+