ICSharpCode::SharpZipLib::Zip::FastZip Class Reference

FastZip provides facilities for creating and extracting zip files. Only relative paths are supported. More...

List of all members.

Public Types

enum  Overwrite { Prompt, Never, Always }
 Defines the desired handling when overwriting files. More...

Public Member Functions

 FastZip ()
 Initialize a default instance of FastZip.
 FastZip (FastZipEvents events)
 Initialise a new instance of FastZip.
delegate bool ConfirmOverwriteDelegate (string fileName)
 Delegate called when confirming overwriting of files.
void CreateZip (string zipFileName, string sourceDirectory, bool recurse, string fileFilter, string directoryFilter)
 Create a zip file.
void CreateZip (string zipFileName, string sourceDirectory, bool recurse, string fileFilter)
 Create a zip file/archive.
void ExtractZip (string zipFileName, string targetDirectory, string fileFilter)
 Extract the contents of a zip file.
void ExtractZip (string zipFileName, string targetDirectory, Overwrite overwrite, ConfirmOverwriteDelegate confirmDelegate, string fileFilter, string directoryFilter)
 Exatract the contents of a zip file.

Properties

bool CreateEmptyDirectories
 Get/set a value indicating wether empty directories should be created.
ZipNameTransform NameTransform
 Get or set the ZipNameTransform active when creating Zip files..
byte[] buffer
ZipOutputStream outputStream
ZipInputStream inputStream
string password = null
string targetDirectory
string sourceDirectory
NameFilter fileFilter
NameFilter directoryFilter
Overwrite overwrite
ConfirmOverwriteDelegate confirmDelegate
bool restoreDateTime = false
bool createEmptyDirectories = false
FastZipEvents events
ZipNameTransform nameTransform

Private Member Functions

void ProcessDirectory (object sender, DirectoryEventArgs e)
void ProcessFile (object sender, ScanEventArgs e)
void AddFileContents (string name)
void ExtractFileEntry (ZipEntry entry, string targetName)
bool NameIsValid (string name)
void ExtractEntry (ZipEntry entry)


Detailed Description

FastZip provides facilities for creating and extracting zip files. Only relative paths are supported.

Definition at line 125 of file FastZip.cs.


Member Enumeration Documentation

enum ICSharpCode::SharpZipLib::Zip::FastZip::Overwrite
 

Defines the desired handling when overwriting files.

Enumerator:
Prompt  Prompt the user to confirm overwriting.
Never  Never overwrite files.
Always  Always overwrite files.

Definition at line 147 of file FastZip.cs.


Constructor & Destructor Documentation

ICSharpCode::SharpZipLib::Zip::FastZip::FastZip  )  [inline]
 

Initialize a default instance of FastZip.

Definition at line 130 of file FastZip.cs.

ICSharpCode::SharpZipLib::Zip::FastZip::FastZip FastZipEvents  events  )  [inline]
 

Initialise a new instance of FastZip.

Parameters:
events 

Definition at line 139 of file FastZip.cs.


Member Function Documentation

void ICSharpCode::SharpZipLib::Zip::FastZip::AddFileContents string  name  )  [inline, private]
 

Definition at line 294 of file FastZip.cs.

delegate bool ICSharpCode::SharpZipLib::Zip::FastZip::ConfirmOverwriteDelegate string  fileName  ) 
 

Delegate called when confirming overwriting of files.

void ICSharpCode::SharpZipLib::Zip::FastZip::CreateZip string  zipFileName,
string  sourceDirectory,
bool  recurse,
string  fileFilter
[inline]
 

Create a zip file/archive.

Parameters:
zipFileName The name of the zip file to create.
sourceDirectory The directory to obtain files and directories from.
recurse True to recurse directories, false for no recursion.
fileFilter The file filter to apply.

Definition at line 210 of file FastZip.cs.

void ICSharpCode::SharpZipLib::Zip::FastZip::CreateZip string  zipFileName,
string  sourceDirectory,
bool  recurse,
string  fileFilter,
string  directoryFilter
[inline]
 

Create a zip file.

Parameters:
zipFileName The name of the zip file to create.
sourceDirectory The directory to source files from.
recurse True to recurse directories, false for no recursion.
fileFilter The file filter to apply.
directoryFilter The directory filter to apply.

Definition at line 184 of file FastZip.cs.

References ICSharpCode::SharpZipLib::Core::FileSystemScanner::ProcessDirectory, ICSharpCode::SharpZipLib::Core::ProcessDirectoryDelegate(), ICSharpCode::SharpZipLib::Core::FileSystemScanner::ProcessFile, ICSharpCode::SharpZipLib::Core::ProcessFileDelegate(), and ICSharpCode::SharpZipLib::Core::FileSystemScanner::Scan().

void ICSharpCode::SharpZipLib::Zip::FastZip::ExtractEntry ZipEntry  entry  )  [inline, private]
 

Definition at line 357 of file FastZip.cs.

References ICSharpCode::SharpZipLib::Zip::ZipEntry::Name.

void ICSharpCode::SharpZipLib::Zip::FastZip::ExtractFileEntry ZipEntry  entry,
string  targetName
[inline, private]
 

Definition at line 313 of file FastZip.cs.

void ICSharpCode::SharpZipLib::Zip::FastZip::ExtractZip string  zipFileName,
string  targetDirectory,
Overwrite  overwrite,
ConfirmOverwriteDelegate  confirmDelegate,
string  fileFilter,
string  directoryFilter
[inline]
 

Exatract the contents of a zip file.

Parameters:
zipFileName The zip file to extract from.
targetDirectory The directory to save extracted information in.
overwrite The style of Overwriteoverwriting to apply.
confirmDelegate A delegate to invoke when confirming overwriting.
fileFilter A filter to apply to files.
directoryFilter A filter to apply to directories.

Definition at line 235 of file FastZip.cs.

References ICSharpCode::SharpZipLib::Zip::ZipEntry::Name.

void ICSharpCode::SharpZipLib::Zip::FastZip::ExtractZip string  zipFileName,
string  targetDirectory,
string  fileFilter
[inline]
 

Extract the contents of a zip file.

Parameters:
zipFileName The zip file to extract from.
targetDirectory The directory to save extracted information in.
fileFilter A filter to apply to files.

Definition at line 221 of file FastZip.cs.

bool ICSharpCode::SharpZipLib::Zip::FastZip::NameIsValid string  name  )  [inline, private]
 

Definition at line 352 of file FastZip.cs.

void ICSharpCode::SharpZipLib::Zip::FastZip::ProcessDirectory object  sender,
DirectoryEventArgs  e
[inline, private]
 

Definition at line 268 of file FastZip.cs.

References ICSharpCode::SharpZipLib::Core::DirectoryEventArgs::HasMatchingFiles, and ICSharpCode::SharpZipLib::Core::ScanEventArgs::Name.

void ICSharpCode::SharpZipLib::Zip::FastZip::ProcessFile object  sender,
ScanEventArgs  e
[inline, private]
 

Definition at line 283 of file FastZip.cs.

References ICSharpCode::SharpZipLib::Core::ScanEventArgs::Name.


Property Documentation

byte [] ICSharpCode::SharpZipLib::Zip::FastZip::buffer [private]
 

Definition at line 414 of file FastZip.cs.

ConfirmOverwriteDelegate ICSharpCode::SharpZipLib::Zip::FastZip::confirmDelegate [private]
 

Definition at line 423 of file FastZip.cs.

bool ICSharpCode::SharpZipLib::Zip::FastZip::createEmptyDirectories = false [private]
 

Definition at line 425 of file FastZip.cs.

bool ICSharpCode::SharpZipLib::Zip::FastZip::CreateEmptyDirectories [get, set]
 

Get/set a value indicating wether empty directories should be created.

Definition at line 166 of file FastZip.cs.

NameFilter ICSharpCode::SharpZipLib::Zip::FastZip::directoryFilter [private]
 

Definition at line 421 of file FastZip.cs.

FastZipEvents ICSharpCode::SharpZipLib::Zip::FastZip::events [private]
 

Definition at line 426 of file FastZip.cs.

NameFilter ICSharpCode::SharpZipLib::Zip::FastZip::fileFilter [private]
 

Definition at line 420 of file FastZip.cs.

ZipInputStream ICSharpCode::SharpZipLib::Zip::FastZip::inputStream [private]
 

Definition at line 416 of file FastZip.cs.

ZipNameTransform ICSharpCode::SharpZipLib::Zip::FastZip::nameTransform [private]
 

Definition at line 427 of file FastZip.cs.

ZipNameTransform ICSharpCode::SharpZipLib::Zip::FastZip::NameTransform [get, set]
 

Get or set the ZipNameTransform active when creating Zip files..

Definition at line 401 of file FastZip.cs.

ZipOutputStream ICSharpCode::SharpZipLib::Zip::FastZip::outputStream [private]
 

Definition at line 415 of file FastZip.cs.

Overwrite ICSharpCode::SharpZipLib::Zip::FastZip::overwrite [private]
 

Definition at line 422 of file FastZip.cs.

string ICSharpCode::SharpZipLib::Zip::FastZip::password = null [private]
 

Definition at line 417 of file FastZip.cs.

bool ICSharpCode::SharpZipLib::Zip::FastZip::restoreDateTime = false [private]
 

Definition at line 424 of file FastZip.cs.

string ICSharpCode::SharpZipLib::Zip::FastZip::sourceDirectory [private]
 

Definition at line 419 of file FastZip.cs.

string ICSharpCode::SharpZipLib::Zip::FastZip::targetDirectory [private]
 

Definition at line 418 of file FastZip.cs.


The documentation for this class was generated from the following file:
Generated on Fri Jun 23 21:50:06 2006 for OblivionModTranslator by  doxygen 1.4.6-NO