/////////////////////////////////////////////////////////////////////////////
// Name: zipstrm.h
-// Purpose: documentation for wxZipNotifier class
+// Purpose: interface of wxZipNotifier
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
@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
};
+
/**
@class wxZipEntry
@wxheader{zipstrm.h}
@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
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();
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();
//@{
/**
- 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
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);
};
+
/**
@class wxZipInputStream
@wxheader{zipstrm.h}
@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
{
};
+
/**
@class wxZipClassFactory
@wxheader{zipstrm.h}
@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
{
};
+
/**
@class wxZipOutputStream
@wxheader{zipstrm.h}
@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
{
*/
void SetComment(const wxString& comment);
};
+