.\" This is a wxWidgets manpage page generated from the XML docs
.TH wxArchiveEntry 3wx 2005-02-15 "wxWidgets" "wxWidgets class documentation"
.SH NAME
wxArchiveEntry \- 
.SH DESCRIPTION

  


   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.
  
  


   
    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
     
    

   
  
 
.SH "PARENTS"

  wxObject
 
.SH "INCLUDE FILES"
wx/archive.h
.SH MEMBERS

  
.SS wxArchiveEntry* Clone ()

     


      Returns a copy of this entry object.
     
    
   
  
.SS wxDateTime GetDateTime ()

.SS void SetDateTime (const wxDateTime& dt)

     


      The entry's timestamp.
     
    
   
  
.SS wxPathFormat GetInternalFormat ()

     


      Returns the path format used internally within the archive to store
      filenames.
     
    
   
  
.SS wxString GetInternalName ()

     


      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.
     
    
   
  
.SS wxString GetName (wxPathFormat format = wxPATH_NATIVE)

.SS void SetName (const wxString& namewxPathFormat 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().
     
    
   
  
.SS off_t GetOffset ()

     


      Returns a numeric value unique to the entry within the archive.
     
    
   
  
.SS off_t GetSize ()

.SS void SetSize (off_t size)

     


      The size of the entry's data in bytes.
     
    
   
  
.SS bool IsDir ()

.SS 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.
     
    
   
  
.SS bool IsReadOnly ()

.SS void SetIsReadOnly (bool isReadOnly = true)

     


      True if the entry is a read-only file.
     
    
   
  
.SS void SetNotifier (wxArchiveNotifier& notifier)

.SS 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).
     
    
 
.SH "SEE ALSO"

  wxObject
 
  Archive formats such as zip
  
   
  Generic archive programming
  
   
  wxArchiveInputStream
  
   
  wxArchiveOutputStream
  
   
  wxArchiveNotifier
 
.SH "AUTHORS"
Documentation content by Julian Smart, Robert Roebling, Vadim Zeitlin, Robin Dunn, et al

Conversion to manpage format by Arnout Engelen (http://bzzt.net), bugreports welcome.