.TH "fileentry.h" 3 "Tue May 9 2017" "Zipios++" \" -*- nroff -*-
.ad l
.nh
.SH NAME
fileentry.h \- Header file that defines FileEntry\&.  

.SH SYNOPSIS
.br
.PP
\fC#include 'zipios++/zipios\-config\&.h'\fP
.br
\fC#include <string>\fP
.br
\fC#include <vector>\fP
.br
\fC#include 'zipios++/meta\-iostreams\&.h'\fP
.br
\fC#include 'zipios++/simplesmartptr\&.h'\fP
.br
\fC#include 'zipios++/zipios_defs\&.h'\fP
.br

.SS "Classes"

.in +1c
.ti -1c
.RI "class \fBzipios::FileEntry\fP"
.br
.RI "A \fBFileEntry\fP represents an entry in a \fBFileCollection\fP\&. "
.ti -1c
.RI "class \fBzipios::FileEntry::MatchName\fP"
.br
.RI "Function object to be used with the STL find_if algorithm to find a \fBFileEntry\fP in a container, which name (as obtained with \fBFileEntry::getName()\fP) is identical to the name specified in the \fBMatchName\fP constructor\&. "
.ti -1c
.RI "class \fBzipios::FileEntry::MatchFileName\fP"
.br
.RI "Function object to be used with the STL find_if algorithm to find a \fBFileEntry\fP in a container, which name (as obtained with \fBFileEntry::getFileName()\fP) is identical to the name specified in the \fBMatchName\fP constructor\&. "
.in -1c
.SS "Typedefs"

.in +1c
.ti -1c
.RI "typedef SimpleSmartPointer< FileEntry > \fBzipios::EntryPointer\fP"
.br
.RI "EntryPointer is a \fBSimpleSmartPointer\fP for \fBFileEntry\fP's\&. "
.ti -1c
.RI "typedef SimpleSmartPointer< const FileEntry > \fBzipios::ConstEntryPointer\fP"
.br
.RI "ConstEntryPointer is a \fBSimpleSmartPointer\fP for const \fBFileEntry\fP's\&. "
.ti -1c
.RI "typedef vector< EntryPointer > \fBzipios::Entries\fP"
.br
.RI "Entries is a vector of EntryPointer's\&. "
.ti -1c
.RI "typedef vector< EntryPointer > \fBzipios::ConstEntries\fP"
.br
.RI "ConstEntries is a vector of ConstEntryPointer's\&. "
.in -1c
.SS "Enumerations"

.in +1c
.ti -1c
.RI "enum \fBzipios::StorageMethod\fP { \fBSTORED\fP = 0, \fBSHRUNK\fP, \fBREDUCED1\fP, \fBREDUCED2\fP, \fBREDUCED3\fP, \fBREDUCED4\fP, \fBIMPLODED\fP, \fBRESERVED\fP, \fBDEFLATED\fP }
.RI "The types used with FileEntry::setMethod and FileEntry::getMethod\&. ""
.br
.in -1c
.SS "Functions"

.in +1c
.ti -1c
.RI "ostream & \fBzipios::operator<<\fP (ostream &os, const FileEntry &entry)"
.br
.ti -1c
.RI "ostream & \fBzipios::operator<<\fP (ostream &os, const ConstEntryPointer &entry)"
.br
.in -1c
.SH "Detailed Description"
.PP 
Header file that defines FileEntry\&. 


.PP
Definition in file \fBfileentry\&.h\fP\&.
.SH "Typedef Documentation"
.PP 
.SS "typedef vector< EntryPointer > \fBzipios::ConstEntries\fP"

.PP
ConstEntries is a vector of ConstEntryPointer's\&. 
.PP
Definition at line 43 of file fileentry\&.h\&.
.SS "typedef SimpleSmartPointer< const FileEntry > \fBzipios::ConstEntryPointer\fP"

.PP
ConstEntryPointer is a SimpleSmartPointer for const FileEntry's\&. 
.PP
Definition at line 37 of file fileentry\&.h\&.
.SS "typedef vector< EntryPointer > \fBzipios::Entries\fP"

.PP
Entries is a vector of EntryPointer's\&. 
.PP
Definition at line 40 of file fileentry\&.h\&.
.SS "typedef SimpleSmartPointer< FileEntry > \fBzipios::EntryPointer\fP"

.PP
EntryPointer is a SimpleSmartPointer for FileEntry's\&. 
.PP
Definition at line 33 of file fileentry\&.h\&.
.SH "Enumeration Type Documentation"
.PP 
.SS "enum \fBzipios::StorageMethod\fP"

.PP
The types used with FileEntry::setMethod and FileEntry::getMethod\&. The current entries are the types supported by the zip format\&. The numbering also matches the numbering used in the zip file format, ie STORED is indicated by a 0 in the method field in a zip file and so on\&. 
.PP
Definition at line 25 of file fileentry\&.h\&.
.SH "Author"
.PP 
Generated automatically by Doxygen for Zipios++ from the source code\&.