qelectrotech-source-mirror/sources/fileelementscollection.h

/*
	Copyright 2006-2013 The QElectroTech Team
	This file is part of QElectroTech.
	
	QElectroTech is free software: you can redistribute it and/or modify
	it under the terms of the GNU General Public License as published by
	the Free Software Foundation, either version 2 of the License, or
	(at your option) any later version.
	
	QElectroTech is distributed in the hope that it will be useful,
	but WITHOUT ANY WARRANTY; without even the implied warranty of
	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
	GNU General Public License for more details.
	
	You should have received a copy of the GNU General Public License
	along with QElectroTech.  If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef FILE_ELEMENTS_COLLECTION_H
#define FILE_ELEMENTS_COLLECTION_H
#include <QtCore>
#include "elementscollection.h"
class FileElementsCategory;
/**
	This class represents an elements collection stored on filesystem, like the
	collection provided along with QET or users custom collection.
*/
class FileElementsCollection : public ElementsCollection {
	Q_OBJECT
	
	// constructors, destructor
	public:
	FileElementsCollection(const QString &, ElementsCollectionItem *parent = 0);
	virtual ~FileElementsCollection();
	
	private:
	FileElementsCollection(const FileElementsCollection &);
	
	// methods
	public:
	virtual void reload();
	virtual ElementsCategory *rootCategory();
	
	virtual bool hasFilePath();
	virtual QString filePath();
	virtual void setFilePath(const QString &);
	virtual bool exists();
	virtual bool isReadable();
	virtual bool isWritable();
	virtual bool write();
	virtual bool isCacheable() const;
	
	private:
	void deleteContent();
	
	// attributes
	private:
	QString coll_path;
	FileElementsCategory *root;
	QMutex reload_mutex_;       ///< Mutex used to avoid loading a collection twice at the same time
};
#endif