d8/db4/qetproject_8h_source.html

/*

        Copyright 2006-2020 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 QET_PROJECT_H

#define QET_PROJECT_H


#include "nameslist.h"

#include "elementslocation.h"

#include "borderproperties.h"

#include "conductorproperties.h"

#include "titleblockproperties.h"

#include "templatescollection.h"

#include "properties/xrefproperties.h"

#include "projectdatabase.h"

#include "reportproperties.h"


#include <KAutoSaveFile>


class Diagram;

class ElementsLocation;

class QETResult;

class TitleBlockTemplate;

class MoveTitleBlockTemplatesHandler;

class NumerotationContext;

class QUndoStack;

class XmlElementCollection;

class QTimer;

class KAutoSaveFile;


class QETProject : public QObject

{

                Q_OBJECT

        public :

                //This enum lists possible states for a particular project.

                enum ProjectState {

                        Ok                    = 0,

                        FileOpenFailed        = 1,

                        XmlParsingFailed      = 2,

                        ProjectParsingRunning = 3,

                        ProjectParsingFailed  = 4,

                        FileOpenDiscard       = 5

                };


                Q_PROPERTY(bool autoConductor READ autoConductor WRITE setAutoConductor)


                // constructors, destructor

        public:

                QETProject (QObject *parent = nullptr);

                QETProject (const QString &path, QObject * = nullptr);

                QETProject (KAutoSaveFile *backup, QObject *parent=nullptr);

                ~QETProject() override;


        private:

                QETProject(const QETProject &);


                // methods

        public:

                projectDataBase *dataBase();

                QUuid uuid() const;

                ProjectState state() const;

                QList<Diagram *> diagrams() const;

                int folioIndex(const Diagram *) const;

                XmlElementCollection *embeddedElementCollection()const;

                TitleBlockTemplatesProjectCollection *embeddedTitleBlockTemplatesCollection();

                QString filePath();

                void setFilePath(const QString &);

                QString currentDir() const;

                QString pathNameTitle() const;

                QString title() const;

                qreal declaredQElectroTechVersion();

                void setTitle(const QString &);


                BorderProperties defaultBorderProperties() const;

                void             setDefaultBorderProperties(const BorderProperties &);


                TitleBlockProperties defaultTitleBlockProperties() const;

                void                 setDefaultTitleBlockProperties(const TitleBlockProperties &);


                ConductorProperties defaultConductorProperties() const;

                void                setDefaultConductorProperties(const ConductorProperties &);


                QString defaultReportProperties() const;

                void    setDefaultReportProperties (const QString &properties);


                XRefProperties                                  defaultXRefProperties (const QString &type) const {return m_default_xref_properties[type];}

                QHash <QString, XRefProperties> defaultXRefProperties() const                                     {return m_default_xref_properties;}

                void setDefaultXRefProperties(const QString& type, const XRefProperties &properties);

                void setDefaultXRefProperties(QHash <QString, XRefProperties> hash);


                QHash <QString, NumerotationContext> conductorAutoNum() const;

                QHash <QString, NumerotationContext> elementAutoNum() const;

                QHash <QString, NumerotationContext> folioAutoNum() const;

                void addConductorAutoNum (const QString& key, const NumerotationContext& context);

                void addElementAutoNum (const QString& key, const NumerotationContext& context);

                void addFolioAutoNum     (const QString& key, const NumerotationContext& context);

                void removeConductorAutoNum (const QString& key);

                void removeElementAutoNum (const QString& key);

                void removeFolioAutoNum (const QString& key);

                NumerotationContext conductorAutoNum(const QString &key) const;

                NumerotationContext folioAutoNum(const QString &key)     const;

                NumerotationContext elementAutoNum(const QString &key);


                QString conductorAutoNumFormula(const QString& key) const; //returns Formula

                QString conductorCurrentAutoNum() const;

                void setCurrentConductorAutoNum(QString autoNum);


                QString elementAutoNumFormula(const QString& key) const;

                QString elementAutoNumCurrentFormula() const;

                QString elementCurrentAutoNum() const;

                void setCurrrentElementAutonum(QString autoNum);


                        //Element

                void freezeExistentElementLabel(bool freeze, int from, int to);

                void freezeNewElementLabel(bool freeze, int from, int to);

                bool isFreezeNewElements();

                void setFreezeNewElements(bool);


                        //Conductor

                void freezeExistentConductorLabel(bool freeze, int from, int to);

                void freezeNewConductorLabel(bool freeze, int from, int to);

                bool isFreezeNewConductors();

                void setFreezeNewConductors(bool);


                bool autoConductor () const;

                bool autoElement () const;

                bool autoFolio () const;

                void setAutoConductor (bool ac);

                void setAutoElement (bool ae);

                void autoFolioNumberingNewFolios ();

                void autoFolioNumberingSelectedFolios(int, int, const QString&);


                QDomDocument toXml();

                bool close();

                QETResult write();

                bool isReadOnly() const;

                void setReadOnly(bool);

                bool isEmpty() const;

                ElementsLocation importElement(ElementsLocation &location);

                QString integrateTitleBlockTemplate(const TitleBlockTemplateLocation &, MoveTitleBlockTemplatesHandler *handler);

                bool usesElement(const ElementsLocation &) const;

                QList <ElementsLocation> unusedElements() const;

                bool usesTitleBlockTemplate(const TitleBlockTemplateLocation &);

                bool projectWasModified();

                bool projectOptionsWereModified();

                DiagramContext projectProperties();

                void setProjectProperties(const DiagramContext &);

                QUndoStack* undoStack() {return m_undo_stack;}


        public slots:

                Diagram *addNewDiagram(int pos = -1);

                void removeDiagram(Diagram *);

                void diagramOrderChanged(int, int);

                void setModified(bool);


        signals:

                void projectFilePathChanged(QETProject *, const QString &);

                void projectTitleChanged(QETProject *, const QString &);

                void projectInformationsChanged(QETProject *);

                void diagramAdded(QETProject *, Diagram *);

                void diagramRemoved(QETProject *, Diagram *);

                void projectModified(QETProject *, bool);

                void projectDiagramsOrderChanged(QETProject *, int, int);

                void diagramUsedTemplate(TitleBlockTemplatesCollection *, const QString &);

                void readOnlyChanged(QETProject *, bool);

                void reportPropertiesChanged(const QString &old_str, const QString &new_str);

                void XRefPropertiesChanged ();

                void addAutoNumDiagram();

                void elementAutoNumAdded(QString name);

                void elementAutoNumRemoved(QString name);

                void conductorAutoNumAdded();

                void conductorAutoNumRemoved();

                void folioAutoNumAdded();

                void folioAutoNumRemoved();

                void folioAutoNumChanged(QString);

                void defaultTitleBlockPropertiesChanged();

                void conductorAutoNumChanged();


        private slots:

                void updateDiagramsFolioData();

                void updateDiagramsTitleBlockTemplate(TitleBlockTemplatesCollection *, const QString &);

                void removeDiagramsTitleBlockTemplate(TitleBlockTemplatesCollection *, const QString &);

                void usedTitleBlockTemplateChanged(const QString &);

                void undoStackChanged (bool a) {if (!a) setModified(true);}


        private:

                void readProjectXml(QDomDocument &xml_project);

                void readDiagramsXml(QDomDocument &xml_project);

                void readElementsCollectionXml(QDomDocument &xml_project);

                void readProjectPropertiesXml(QDomDocument &xml_project);

                void readDefaultPropertiesXml(QDomDocument &xml_project);


                void writeProjectPropertiesXml(QDomElement &);

                void writeDefaultPropertiesXml(QDomElement &);

                void addDiagram(Diagram *diagram, int pos = -1);

                NamesList namesListForIntegrationCategory();

                void writeBackup();

                void init();

                ProjectState openFile(QFile *file);


        // attributes

        private:

                QString m_file_path;

                ProjectState m_state;

                QList<Diagram *> m_diagrams_list;

                QString project_title_;

                qreal m_project_qet_version = -1;

                bool m_modified = false;

                bool m_read_only = false;

                QString read_only_file_path_;

                BorderProperties default_border_properties_ = BorderProperties::defaultProperties();

                ConductorProperties default_conductor_properties_ = ConductorProperties::defaultProperties();

                TitleBlockProperties default_titleblock_properties_;

                QString m_default_report_properties = ReportProperties::defaultProperties();

                QHash <QString, XRefProperties> m_default_xref_properties = XRefProperties::defaultProperties();

                TitleBlockTemplatesProjectCollection m_titleblocks_collection;

                DiagramContext m_project_properties;

                QUndoStack *m_undo_stack;

                QHash <QString, NumerotationContext> m_conductor_autonum;//Title and NumContext hash

                QString m_current_conductor_autonum;

                QHash <QString, NumerotationContext> m_folio_autonum;

                QHash <QString, NumerotationContext> m_element_autonum; //Title and NumContext hash

                QString m_current_element_autonum;

                bool m_auto_conductor = true;

                XmlElementCollection *m_elements_collection = nullptr;

                bool m_freeze_new_elements = false;

                bool m_freeze_new_conductors = false;

                QTimer m_save_backup_timer,

                           m_autosave_timer;

                KAutoSaveFile m_backup_file;

                QUuid m_uuid = QUuid::createUuid();

                projectDataBase m_data_base;

};


Q_DECLARE_METATYPE(QETProject *)

#endif