elementslocation.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 ELEMENTS_LOCATION_H
#define ELEMENTS_LOCATION_H

#include "nameslist.h"
#include "diagramcontext.h"
#include <QString>
#include <QIcon>

class QETProject;
class XmlElementCollection;

class ElementsLocation
{
    public:
        ElementsLocation();
        ElementsLocation(const QString &path, QETProject *project = nullptr);
        ElementsLocation(const ElementsLocation &);
        ElementsLocation(const QMimeData *data);
        virtual ~ElementsLocation();
        ElementsLocation &operator=(const ElementsLocation &);
        bool operator==(const ElementsLocation &) const;
        bool operator!=(const ElementsLocation &) const;
    
    public:
        QString baseName() const;
        int projectId() const;

        QString collectionPath(bool protocol = true) const;
        QString projectCollectionPath() const;
        QString fileSystemPath() const;
        QString path() const;
        void setPath(const QString &path);
        bool addToPath(const QString &);

        ElementsLocation parent() const;
        QETProject *project() const;
        void setProject(QETProject *);
        bool isNull() const;
        QString toString() const;

        bool isElement() const;
        bool isDirectory() const;
        bool isFileSystem() const;
        bool isCommonCollection() const;
        bool isCustomCollection() const;
        bool isProject() const;
        bool exist() const;
        bool isWritable() const;

        XmlElementCollection *projectCollection() const;
        NamesList nameList();

        QDomElement xml() const;
        bool setXml(const QDomDocument &xml_document) const;
        QUuid uuid() const;
        QIcon icon() const;
        QString name() const;
        QString fileName() const;
        DiagramContext elementInformations() const;
    
    private:
        QString m_collection_path;
        QString m_file_system_path;
        QETProject *m_project = nullptr;
    
    public:
        static int MetaTypeId; 
};

QDebug operator<<(QDebug debug, const ElementsLocation &location);

Q_DECLARE_METATYPE(ElementsLocation)
uint qHash(const ElementsLocation &);
#endif