CEF C++ API Docs - Revision 1123: CefZipArchive

Overview

Project

Class

Tree

Index

CEF C++ API Docs - Revision 1123

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

(default)
Class CefZipArchive

CefBase
   |
   +--CefZipArchive

in cef_zip_archive.h

class CefZipArchive
extends CefBase

Thread-safe class for accessing zip archive file contents. This class should not be used with large archive files because all data will be resident in memory at the same time. This implementation supports a restricted set of zip archive features: (1) Password-protected files are not supported. (2) All file names are stored and compared in lower case. (3) File ordering from the original zip archive is not maintained. This means that files from the same folder may not be located together in the file content map.

Inner Classes, Typedefs, and Enums
`class`	`CefZipArchive::File` Class representing a file in the archive.
`typedef`	`CefZipArchive::FileMap`

Constructor Summary
`CefZipArchive()` Create a new object.
`virtual ~CefZipArchive()`

Method Summary
`void`	`Clear()` Clears the contents of this object.
`CefRefPtr< CefZipArchive::File >`	`GetFile( const CefString& fileName )` Returns the specified file.
`size_t`	`GetFileCount()` Returns the number of files in the archive.
`size_t`	`GetFiles( CefZipArchive::FileMap& map )` Returns the map of all files.
`bool`	`HasFile( const CefString& fileName )` Returns true if the specified file exists and has contents.
`size_t`	`Load( CefRefPtr< CefStreamReader > stream, bool overwriteExisting )` Load the contents of the specified zip archive stream into this object.
`bool`	`RemoveFile( const CefString& fileName )` Removes the specified file.

Methods inherited from class CefBase

AddRef, Release, GetRefCt

Constructor Detail

CefZipArchive

public CefZipArchive();

Create a new object.

~CefZipArchive

public virtual ~CefZipArchive();

Method Detail

Clear

public void Clear();

Clears the contents of this object.

GetFile

public CefRefPtr< CefZipArchive::File > GetFile( const CefString& fileName );

Returns the specified file.

GetFileCount

public size_t GetFileCount();

Returns the number of files in the archive.

GetFiles

public size_t GetFiles( CefZipArchive::FileMap& map );

Returns the map of all files.

HasFile

public bool HasFile( const CefString& fileName );

Returns true if the specified file exists and has contents.

Load

public size_t Load( CefRefPtr< CefStreamReader > stream, bool overwriteExisting );

Load the contents of the specified zip archive stream into this object. If |overwriteExisting| is true then any files in this object that also exist in the specified archive will be replaced with the new files. Returns the number of files successfully loaded.

RemoveFile

public bool RemoveFile( const CefString& fileName );

Removes the specified file.