Class allowing to manage the zip/unzip actions on project file. More...

#include <qgsarchive.h>

Inheritance diagram for QgsProjectArchive:

Public Member Functions
QString	auxiliaryStorageFile () const
	Returns the current .qgd auxiliary storage file or an empty string if there's none.

bool	clearProjectFile ()
	Remove the current .qgs project file from the temporary directory.

QString	projectFile () const
	Returns the current .qgs project file or an empty string if there's none.

bool	unzip (const QString &zipFilename) override
	Clear the current content of this archive and unzip.

Public Member Functions inherited from QgsArchive
	QgsArchive ()
	Constructor.

	QgsArchive (const QgsArchive &other)
	Copy constructor.

virtual	~QgsArchive ()=default
	Destructor.

void	addFile (const QString &filename)
	Add a new file to this archive.

void	clear ()
	Clear the current content of this archive and create a new temporary directory.

QString	dir () const
	Returns the current temporary directory.

bool	exists () const
	Returns `true` if the archive exists on the filesystem, `false` otherwise.

QStringList	files () const
	Returns the list of files within this archive.

QgsArchive &	operator= (const QgsArchive &other)

bool	removeFile (const QString &filename)
	Remove a file from this archive and from the filesystem.

bool	zip (const QString &zipFilename)
	Zip the content of this archive.

Detailed Description

Class allowing to manage the zip/unzip actions on project file.

Definition at line 119 of file qgsarchive.h.

Member Function Documentation

QString QgsProjectArchive::auxiliaryStorageFile ( ) const

Returns the current .qgd auxiliary storage file or an empty string if there's none.

Definition at line 166 of file qgsarchive.cpp.

bool QgsProjectArchive::clearProjectFile ( )

Remove the current .qgs project file from the temporary directory.

Definition at line 161 of file qgsarchive.cpp.

QString QgsProjectArchive::projectFile ( ) const

Returns the current .qgs project file or an empty string if there's none.

Definition at line 140 of file qgsarchive.cpp.

bool QgsProjectArchive::unzip ( const QString & zipFilename )

overridevirtual

Clear the current content of this archive and unzip.

If a project file is found in the content, then this archive may be considered as a valid one. Files are unzipped in the temporary directory.

Parameters

zipFilename The zip file to unzip

Reimplemented from QgsArchive.

Definition at line 153 of file qgsarchive.cpp.

The documentation for this class was generated from the following files: