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.
See @ref overview_archive_noseek 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
wxArchiveInputStream::GetNextEntry() returns, with the following exceptions:
@li GetSize(): guaranteed to be available after the entry has been read to Eof(),
or CloseEntry() has been called;
@li IsReadOnly(): guaranteed to be available after the end of the archive has
been reached, i.e. after GetNextEntry() returns NULL and Eof() is true.
<h2></h2><div><span class='lib'>Library:</span> <span class='lib_text'>\ref page_libs_wxbase</span></div>
@see @ref overview_archive, @ref overview_archive_generic,
wxArchiveInputStream, wxArchiveOutputStream, wxArchiveNotifier
|
wxArchiveEntry * | Clone () const |
| Returns a copy of this entry object. More...
|
|
virtual wxDateTime | GetDateTime () const =0 |
| Gets the entry's timestamp. More...
|
|
virtual void | SetDateTime (const wxDateTime &dt)=0 |
| Sets the entry's timestamp. More...
|
|
virtual wxString | GetName (wxPathFormat format=wxPATH_NATIVE) const =0 |
| Returns the entry's name, by default in the native format. More...
|
|
virtual void | SetName (const wxString &name, wxPathFormat format=wxPATH_NATIVE)=0 |
| Sets the entry's name. More...
|
|
virtual wxFileOffset | GetSize () const =0 |
| Returns the size of the entry's data in bytes. More...
|
|
virtual void | SetSize (wxFileOffset size)=0 |
| Sets the size of the entry's data in bytes. More...
|
|
virtual wxPathFormat | GetInternalFormat () const =0 |
| Returns the path format used internally within the archive to store filenames. More...
|
|
virtual wxString | GetInternalName () const =0 |
| Returns the entry's filename in the internal format used within the archive. More...
|
|
virtual wxFileOffset | GetOffset () const =0 |
| Returns a numeric value unique to the entry within the archive. More...
|
|
virtual bool | IsDir () const =0 |
| Returns true if this is a directory entry. More...
|
|
virtual void | SetIsDir (bool isDir=true)=0 |
| Marks this entry as a directory if isDir is true. More...
|
|
virtual bool | IsReadOnly () const =0 |
| Returns true if the entry is a read-only file. More...
|
|
virtual void | SetIsReadOnly (bool isReadOnly=true)=0 |
| Sets this entry as a read-only file. More...
|
|
void | SetNotifier (wxArchiveNotifier ¬ifier) |
| Sets the notifier (see wxArchiveNotifier) for this entry. More...
|
|
virtual void | UnsetNotifier () |
| Unsets the notifier eventually attached to this entry. More...
|
|
| wxObject () |
| Default ctor; initializes to NULL the internal reference data. More...
|
|
| wxObject (const wxObject &other) |
| Copy ctor. More...
|
|
virtual | ~wxObject () |
| Destructor. More...
|
|
virtual wxClassInfo * | GetClassInfo () const |
| This virtual function is redefined for every class that requires run-time type information, when using the wxDECLARE_CLASS macro (or similar). More...
|
|
wxObjectRefData * | GetRefData () const |
| Returns the wxObject::m_refData pointer, i.e. the data referenced by this object. More...
|
|
bool | IsKindOf (const wxClassInfo *info) const |
| Determines whether this class is a subclass of (or the same class as) the given class. More...
|
|
bool | IsSameAs (const wxObject &obj) const |
| Returns true if this object has the same data pointer as obj. More...
|
|
void | Ref (const wxObject &clone) |
| Makes this object refer to the data in clone. More...
|
|
void | SetRefData (wxObjectRefData *data) |
| Sets the wxObject::m_refData pointer. More...
|
|
void | UnRef () |
| Decrements the reference count in the associated data, and if it is zero, deletes the data. More...
|
|
void | UnShare () |
| This is the same of AllocExclusive() but this method is public. More...
|
|
void | operator delete (void *buf) |
| The delete operator is defined for debugging versions of the library only, when the identifier __WXDEBUG__ is defined. More...
|
|
void * | operator new (size_t size, const wxString &filename=NULL, int lineNum=0) |
| The new operator is defined for debugging versions of the library only, when the identifier __WXDEBUG__ is defined. More...
|
|