wxarchiveentry

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.

derived from

wxobject

include files

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 'archives on non-seekable streams' for more information.

for generic programming, when the worst case must be assumed, you can rely on all the fields of wxarchiveentry being fully populated when getnextentry() returns, with the the following exceptions:

getsize()	guaranteed to be available after the entry has been read to eof(), or closeentry() has been called
isreadonly()	guaranteed to be available after the end of the archive has been reached, i.e. after getnextentry() returns null and eof() is true

members

wxarchiveentry::clone
wxarchiveentry::get/setdatetime
wxarchiveentry::getinternalformat
wxarchiveentry::getinternalname
wxarchiveentry::get/setname
wxarchiveentry::getoffset
wxarchiveentry::get/setsize
wxarchiveentry::isdir/setisdir
wxarchiveentry::isreadonly/setisreadonly
wxarchiveentry::set/unsetnotifier

wxarchiveentry::clone

wxarchiveentry* clone() const

returns a copy of this entry object.

wxarchiveentry::get/setdatetime

wxdatetime getdatetime() const

void setdatetime(const wxdatetime& dt)

the entry's timestamp.

wxarchiveentry::getinternalformat

wxpathformat getinternalformat() const

returns the path format used internally within the archive to store filenames.

wxarchiveentry::getinternalname

wxstring getinternalname() const

returns the entry's filename in the internal format used within the archive. the name can include directory components, i.e. it can be a full path.

the names of directory entries are returned without any trailing path separator. this gives a canonical name that can be used in comparisons.

see also

looking up an archive entry by name

wxarchiveentry::get/setname

wxstring getname(wxpathformat format = wxpath_native) const

void setname(const wxstring& name, wxpathformat format = wxpath_native)

the entry's name, by default in the native format. the name can include directory components, i.e. it can be a full path.

if this is a directory entry, (i.e. if isdir() is true) then getname() returns the name with a trailing path separator.

similarly, setting a name with a trailing path separator sets isdir().

wxarchiveentry::getoffset

off_t getoffset() const

returns a numeric value unique to the entry within the archive.

wxarchiveentry::get/setsize

off_t getsize() const

void setsize(off_t size)

the size of the entry's data in bytes.

wxarchiveentry::isdir/setisdir

bool isdir() const

void setisdir(bool isdir = true)

true if this is a directory entry.

directory entries are entries with no data, which are used to store the meta-data of directories. they also make it possible for completely empty directories to be stored.

the names of entries within an archive can be complete paths, and unarchivers typically create whatever directories are necessary as they restore files, even if the archive contains no explicit directory entries.

wxarchiveentry::isreadonly/setisreadonly

bool isreadonly() const

void setisreadonly(bool isreadonly = true)

true if the entry is a read-only file.

wxarchiveentry::set/unsetnotifier

void setnotifier(wxarchivenotifier& notifier)

void unsetnotifier()

sets the notifier for this entry. whenever the wxarchiveinputstream updates this entry, it will then invoke the associated notifier's onentryupdated method.

setting a notifier is not usually necessary. it is used to handle certain cases when modifying an archive in a pipeline (i.e. between non-seekable streams).