templatescollection.h

Go to the documentation of this file.

/*
    Copyright 2006-2019 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 TITLEBLOCK_SLASH_TEMPLATES_COLLECTION_H
#define TITLEBLOCK_SLASH_TEMPLATES_COLLECTION_H
#define TITLEBLOCKS_FILE_EXTENSION ".titleblock"
#include <QtCore>
#include <QtXml>
#include "templatelocation.h"
#include "qet.h"
class TitleBlockTemplate;
class QETProject;

class TitleBlockTemplatesCollection : public QObject {
    Q_OBJECT
    
    // Constructors, destructor
    public:
    TitleBlockTemplatesCollection(QObject *parent);
    ~TitleBlockTemplatesCollection() override;
    private:
    TitleBlockTemplatesCollection(const TitleBlockTemplatesCollection &);
    
    // methods
    public:
    virtual QStringList templates() = 0;
    virtual TitleBlockTemplate *getTemplate(const QString &) = 0;
    virtual QDomElement getTemplateXmlDescription(const QString &) = 0;
    virtual bool setTemplateXmlDescription(const QString &, const QDomElement &) = 0;
    virtual void removeTemplate(const QString &) = 0;
    virtual TitleBlockTemplateLocation location(const QString & = QString()) = 0;
    virtual bool hasFilePath() = 0;
    virtual QString filePath() = 0;
    virtual bool isReadOnly(const QString & = QString()) const = 0;
    virtual QString title() const;
    virtual void setTitle(const QString &);
    virtual QString protocol() const;
    virtual void setProtocol(const QString &);
    virtual QET::QetCollection collection () const;
    virtual void setCollection (QET::QetCollection);
    virtual QETProject *parentProject();
    virtual QList<TitleBlockTemplateLocation> templatesLocations();
    
    signals:
    void changed(TitleBlockTemplatesCollection *, const QString & = QString());
    void aboutToRemove(TitleBlockTemplatesCollection *, const QString &);
    
    // attributes
    protected:
    QString title_;
    QString protocol_;
    QET::QetCollection m_collection;
    QHash<QString, TitleBlockTemplate *> titleblock_templates_;
};

class TitleBlockTemplatesProjectCollection : public TitleBlockTemplatesCollection {
    Q_OBJECT
    
    // Constructors, destructor
    public:
    TitleBlockTemplatesProjectCollection(QETProject *, QObject *parent = nullptr);
    ~TitleBlockTemplatesProjectCollection() override;
    private:
    TitleBlockTemplatesProjectCollection(const TitleBlockTemplatesProjectCollection &);
    
    // methods
    public:
    QString title() const override;
    QString protocol() const override;
    QETProject *parentProject() override;
    QStringList templates() override;
    TitleBlockTemplate *getTemplate(const QString &) override;
    QDomElement getTemplateXmlDescription(const QString &) override;
    bool setTemplateXmlDescription(const QString &, const QDomElement &) override;
    void removeTemplate(const QString &) override;
    TitleBlockTemplateLocation location(const QString & = QString()) override;
    bool hasFilePath() override;
    QString filePath() override;
    bool isReadOnly(const QString & = QString()) const override;
    virtual void fromXml(const QDomElement &);
    virtual void deleteUnusedTitleBlocKTemplates();
    
    // attributes
    private:
    QETProject *project_;
    QDomDocument xml_document_;
    QHash<QString, QDomElement> titleblock_templates_xml_;
};

class TitleBlockTemplatesFilesCollection : public TitleBlockTemplatesCollection {
    Q_OBJECT
    
    // Constructors, destructor
    public:
    TitleBlockTemplatesFilesCollection(const QString &, QObject * = nullptr);
    ~TitleBlockTemplatesFilesCollection() override;
    private:
    TitleBlockTemplatesFilesCollection(const TitleBlockTemplatesFilesCollection &);
    
    // methods
    public:
    QString path(const QString & = QString()) const;
    QStringList templates() override;
    TitleBlockTemplate *getTemplate(const QString &) override;
    QDomElement getTemplateXmlDescription(const QString &) override;
    bool setTemplateXmlDescription(const QString &, const QDomElement &) override;
    void removeTemplate(const QString &) override;
    TitleBlockTemplateLocation location(const QString & = QString()) override;
    bool hasFilePath() override;
    QString filePath() override;
    bool isReadOnly(const QString & = QString()) const override;
    
    static QString toTemplateName(const QString &);
    static QString toFileName(const QString &);
    
    private slots:
    void fileSystemChanged(const QString &str);
    
    // attributes
    private:
    QFileSystemWatcher watcher_;
    QDir dir_;
};
#endif