Document.h

Go to the documentation of this file.

/*
    This file is part of Rocs.
    Copyright 2008-2011  Tomaz Canabrava <tomaz.canabrava@gmail.com>
    Copyright 2008       Ugo Sangiori <ugorox@gmail.com>
    Copyright 2010-2011  Wagner Reck <wagner.reck@gmail.com>
    Copyright 2011-2012  Andreas Cord-Landwehr <cola@uni-paderborn.de>

    This program 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.

    This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef DOCUMENT_H
#define DOCUMENT_H

#include "RocsCoreExport.h"
#include "CoreTypes.h"
#include <QList>
#include <QObject>
#include <QSize>
#include <QRectF>
#include <QMap>

class DocumentPrivate;
class KUrl;
class DataStructureBackendInterface;
class DataStructure;
class QtScriptBackend;
class QSvgRenderer;
class QPointF;

class ROCSLIB_EXPORT Document : public QObject
{
    Q_OBJECT

public:
    explicit Document(const QString &name, QObject *parent = 0);
    ~Document();

    bool isModified() const;

    void setName(const QString &name);
    QString name() const;

    void save();

    void saveAs(const QString &fileUrl);

    QString fileUrl() const;

    void setFileUrl(const KUrl &fileUrl);

    static bool isValidIdentifier(const QString &identifier);

    QtScriptBackend * engineBackend() const;
    QList<DataStructurePtr>& dataStructures() const;

    void remove(DataStructurePtr dataStructure);

    void clear();

    QRectF sceneRect() const;

    virtual void cleanUpBeforeConvert();

    DataStructureBackendInterface * backend() const;

    void setBackend(const QString &pluginIdentifier);

    void changeBackend();

    int registerDataType(const QString &name, int identifier = 0);

    int registerPointerType(const QString &name, int identifier = 0);

    bool removeDataType(int dataType);

    bool removePointerType(int pointerType);

    PointerTypePtr pointerType(int pointerType) const;
    DataTypePtr dataType(int dataType) const;

    int groupType();

    QList<int> dataTypeList() const;

    QList<int> pointerTypeList() const;

    QString iconPackage() const;

public Q_SLOTS:
    void setModified(const bool mod = true);

    void updateSceneRect(const QPointF &position);

    DataStructurePtr addDataStructure(const QString &name = QString());

    DataStructurePtr addDataStructure(DataStructurePtr dataStructure);

    DataStructurePtr activeDataStructure() const;

    void setActiveDataStructure(int index);
    void setActiveDataStructure(DataStructurePtr g);

    void updateGraphics(DataTypePtr dataType);
    void updateGraphics(PointerTypePtr pointerType);

Q_SIGNALS:
    void dataStructureCreated(DataStructurePtr g);
    void dataStructureListChanged();
    void dataTypeCreated(int identifier);
    void pointerTypeCreated(int identifier);
    void dataTypeRemoved(int identifier);
    void pointerTypeRemoved(int identifier);
    void nameChanged(QString name);
    void activeDataStructureChanged(DataStructurePtr g);
    void sceneRectChanged(const QRectF &);

private:
    // d-pointer
    const QScopedPointer<DocumentPrivate> d;
    Document(const Document&);
    Document& operator=(const Document&);
};

#endif