ZipFolder.ZipFolder Class Reference


Detailed Description

This class is used to extract a zip file into a temporary folder so that the application may then read it.

The temporary folder should be deleted by calling ZipFolder.cleanup() once the file is closed.

#include <class_zip_folder_1_1_zip_folder.h>

List of all members.

Public Member Functions

  __init__ ()
  cleanup ()
  isZipFile ()
  isZipExt ()
  Does the filename have '.zip' as it's extension?
  isA3sExt ()
  Does the filename have '.a3s' as it's extension?
  convertToZipExt ()
  Change the filename extension to be '.zip'.
  convertToA3sExt ()
  Change the filename extension to be '.a3s'.
  unzipArchive ()
  extractThumbnail ()
  Extract a zip file's thumbnail bmp file into a temporary file saved in the specified directory.
  zipArchive ()
  Given a path to the .a3s file put it and the files in its companion folder into a zip archive.
  getUnzipTemporaryDirectory ()
  Return the full path to the unzip temporary directory.
  removeUnzipTemporaryDirectory ()

Member Function Documentation

ZipFolder.ZipFolder.__init__ ( )
ZipFolder.ZipFolder.cleanup ( )
ZipFolder.ZipFolder.isZipFile ( )
ZipFolder.ZipFolder.isZipExt ( )

Does the filename have '.zip' as it's extension?

ZipFolder.ZipFolder.isA3sExt ( )

Does the filename have '.a3s' as it's extension?

ZipFolder.ZipFolder.convertToZipExt ( )

Change the filename extension to be '.zip'.

ZipFolder.ZipFolder.convertToA3sExt ( )

Change the filename extension to be '.a3s'.

ZipFolder.ZipFolder.unzipArchive ( )
ZipFolder.ZipFolder.extractThumbnail ( )

Extract a zip file's thumbnail bmp file into a temporary file saved in the specified directory.

ZipFolder.ZipFolder.zipArchive ( )

Given a path to the .a3s file put it and the files in its companion folder into a zip archive.

ZipFolder.ZipFolder.getUnzipTemporaryDirectory ( )

Return the full path to the unzip temporary directory.

This directory will be created if the createIt argument is True. When loading or importing zip archives, use this directory for holding the extracted version.

May return None if the directory could not be created.

ZipFolder.ZipFolder.removeUnzipTemporaryDirectory ( )

ZipFolder.ZipFolder ZipFolder.ZipFolder ZipFolder.ZipFolder ZipFolder.ZipFolder ZipFolder.ZipFolder ZipFolder.ZipFolder ZipFolder.ZipFolder ZipFolder.ZipFolder ZipFolder.ZipFolder ZipFolder.ZipFolder
ZipFolder.ZipFolder ZipFolder.ZipFolder ZipFolder.ZipFolder ZipFolder.ZipFolder ZipFolder.ZipFolder ZipFolder.ZipFolder ZipFolder.ZipFolder ZipFolder.ZipFolder ZipFolder.ZipFolder ZipFolder.ZipFolder