Project.h

Go to the documentation of this file.

/*
    This file is part of Rocs.
    Copyright 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 PROJECT_H
#define PROJECT_H

#include "RocsCoreExport.h"
#include "CoreTypes.h"

#include <QList>
#include <QString>
#include <QScopedPointer>

class KUrl;
class ProjectPrivate;
class Document;

namespace KTextEditor
{
class Document;
}

class ROCSLIB_EXPORT Project
{

public:
    explicit Project();

    explicit Project(const KUrl &projectFile);

    explicit Project(const KUrl &projectArchive, const KUrl &projectDirectory);

    virtual ~Project();

    QString projectDirectory() const;

    KUrl projectFile() const;

    void setProjectFile(const KUrl &fileUrl);

    void setName(const QString &name);

    QString name() const;

    bool isTemporary();

    void setModified(bool modified=true);

    bool isModified() const;

    QList<KUrl> codeFiles() const;

    QList<KTextEditor::Document*> codeFilesNew() const;

    void addCodeFileNew(KTextEditor::Document *document);

    int addCodeFile(const KUrl &file);

    void saveCodeFileNew(KTextEditor::Document *document, const KUrl &file);

    void removeCodeFileNew(KTextEditor::Document *document);

    void removeCodeFile(int fileID);

    QList<KUrl> graphFiles() const;

    void addGraphFileNew(Document *document);

    int addGraphFile(const KUrl &file);

    void saveGraphFileNew(Document *document, const QString &file);

    void saveGraphFileAs(Document *document, const QString &file);

    void removeGraphFileNew(Document *document);

    void removeGraphFile(int fileID);

    void setJournalFile(const KUrl &file);

    KUrl journalFile() const;

    bool writeProjectFile(const QString& fileUrl = QString());

    bool exportProject(const KUrl &exportUrl);

private:
    bool writeNewProjectFile();
    const QScopedPointer<ProjectPrivate> d;
};

#endif // PROJECT_H