X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/8d483c9b752524c3808a1ca7e52713898f2094f9..3dac8f8a995ca4faea65932f2657acca0c33ce37:/interface/archive.h diff --git a/interface/archive.h b/interface/archive.h index 991208d4f7..cb2069dc60 100644 --- a/interface/archive.h +++ b/interface/archive.h @@ -10,7 +10,7 @@ @class wxArchiveInputStream @wxheader{archive.h} - An abstract base class which serves as a common interface to + This is an abstract base class which serves as a common interface to archive input streams such as wxZipInputStream. wxArchiveInputStream::GetNextEntry returns an wxArchiveEntry object containing @@ -34,7 +34,7 @@ public: Closes the current entry. On a non-seekable stream reads to the end of the current entry first. */ - virtual bool CloseEntry(); + virtual bool CloseEntry() = 0; /** Closes the current entry if one is open, then reads the meta-data for @@ -50,7 +50,7 @@ public: @a entry must be from the same archive file that this wxArchiveInputStream is reading, and it must be reading it from a seekable stream. */ - virtual bool OpenEntry(wxArchiveEntry& entry); + virtual bool OpenEntry(wxArchiveEntry& entry) = 0; }; @@ -59,7 +59,7 @@ public: @class wxArchiveOutputStream @wxheader{archive.h} - An abstract base class which serves as a common interface to + This is an abstract base class which serves as a common interface to archive output streams such as wxZipOutputStream. wxArchiveOutputStream::PutNextEntry is used to create a new entry in the @@ -92,7 +92,7 @@ public: It is called implicitly whenever another new entry is created with CopyEntry() or PutNextEntry(), or when the archive is closed. */ - virtual bool CloseEntry(); + virtual bool CloseEntry() = 0; /** Some archive formats have additional meta-data that applies to the archive @@ -111,11 +111,11 @@ public: in which case the two streams set up a link and transfer the data when it becomes available. */ - virtual bool CopyArchiveMetaData(wxArchiveInputStream& stream); + virtual bool CopyArchiveMetaData(wxArchiveInputStream& stream) = 0; /** Takes ownership of @a entry and uses it to create a new entry in the - archive. @a entry is then opened in the input stream @e stream + archive. @a entry is then opened in the input stream @a stream and its contents copied to this stream. For archive types which compress entry data, CopyEntry() is likely to be @@ -124,10 +124,10 @@ public: @a entry must be from the same archive file that @a stream is accessing. For non-seekable streams, @a entry must also be the last - thing read from @e stream. + thing read from @a stream. */ virtual bool CopyEntry(wxArchiveEntry* entry, - wxArchiveInputStream& stream); + wxArchiveInputStream& stream) = 0; /** Create a new directory entry (see wxArchiveEntry::IsDir) with the given @@ -137,13 +137,13 @@ public: a name with a trailing path separator. */ virtual bool PutNextDirEntry(const wxString& name, - const wxDateTime& dt = wxDateTime::Now()); + const wxDateTime& dt = wxDateTime::Now()) = 0; /** Takes ownership of entry and uses it to create a new entry in the archive. The entry's data can then be written by writing to this wxArchiveOutputStream. */ - virtual bool PutNextEntry(wxArchiveEntry* entry); + virtual bool PutNextEntry(wxArchiveEntry* entry) = 0; /** Create a new entry with the given name, timestamp and size. The entry's @@ -151,7 +151,7 @@ public: */ virtual bool PutNextEntry(const wxString& name, const wxDateTime& dt = wxDateTime::Now(), - wxFileOffset size = wxInvalidOffset); + wxFileOffset size = wxInvalidOffset) = 0; }; @@ -160,14 +160,15 @@ public: @class wxArchiveEntry @wxheader{archive.h} - An abstract base class which serves as a common interface to + This is an abstract base class which serves as a common interface to archive entry classes such as wxZipEntry. These hold the meta-data (filename, timestamp, etc.), for entries in archive files such as zips and tars. - About non-seekable streams: this information applies only when reading - archives from non-seekable streams. When the stream is seekable GetNextEntry() - returns a fully populated wxArchiveEntry. + @section wxarchiveentry_nonseekable About non-seekable streams + + This information applies only when reading archives from non-seekable streams. + When the stream is seekable GetNextEntry() returns a fully populated wxArchiveEntry. See @ref overview_archive_noseek for more information. For generic programming, when the worst case must be assumed, you can rely on @@ -196,12 +197,12 @@ public: /** Gets the entry's timestamp. */ - virtual wxDateTime GetDateTime() const; + virtual wxDateTime GetDateTime() const = 0; /** Sets the entry's timestamp. */ - virtual void SetDateTime(const wxDateTime& dt); + virtual void SetDateTime(const wxDateTime& dt) = 0; /** Returns the entry's name, by default in the native format. @@ -210,7 +211,7 @@ public: If this is a directory entry, (i.e. if IsDir() is @true) then the returned string is the name with a trailing path separator. */ - virtual wxString GetName(wxPathFormat format = wxPATH_NATIVE) const; + virtual wxString GetName(wxPathFormat format = wxPATH_NATIVE) const = 0; /** Sets the entry's name. @@ -219,23 +220,23 @@ public: @see GetName() */ virtual void SetName(const wxString& name, - wxPathFormat format = wxPATH_NATIVE); + wxPathFormat format = wxPATH_NATIVE) = 0; /** Returns the size of the entry's data in bytes. */ - virtual wxFileOffset GetSize() const; + virtual wxFileOffset GetSize() const = 0; /** Sets the size of the entry's data in bytes. */ - virtual void SetSize(wxFileOffset size); + virtual void SetSize(wxFileOffset size) = 0; /** Returns the path format used internally within the archive to store filenames. */ - virtual wxPathFormat GetInternalFormat() const; + virtual wxPathFormat GetInternalFormat() const = 0; /** Returns the entry's filename in the internal format used within the @@ -247,12 +248,12 @@ public: @see @ref overview_archive_byname */ - virtual wxString GetInternalName() const; + virtual wxString GetInternalName() const = 0; /** Returns a numeric value unique to the entry within the archive. */ - virtual wxFileOffset GetOffset() const; + virtual wxFileOffset GetOffset() const = 0; /** Returns @true if this is a directory entry. @@ -266,22 +267,22 @@ public: unarchivers typically create whatever directories are necessary as they restore files, even if the archive contains no explicit directory entries. */ - virtual bool IsDir() const; + virtual bool IsDir() const = 0; /** Marks this entry as a directory if @a isDir is @true. See IsDir() for more info. */ - virtual void SetIsDir(bool isDir = true); + virtual void SetIsDir(bool isDir = true) = 0; /** Returns @true if the entry is a read-only file. */ - virtual bool IsReadOnly() const; + virtual bool IsReadOnly() const = 0; /** Sets this entry as a read-only file. */ - virtual void SetIsReadOnly(bool isReadOnly = true); + virtual void SetIsReadOnly(bool isReadOnly = true) = 0; /** Sets the notifier (see wxArchiveNotifier) for this entry. @@ -616,7 +617,7 @@ public: /** Construct the iterator that returns all the entries in the archive input - stream @e arc. + stream @a arc. */ wxArchiveIterator(Arc& arc);