GraphFilePluginInterface.h

Go to the documentation of this file.

/*
    This file is part of Rocs.
    Copyright 2010-2011  Tomaz Canabrava <tomaz.canabrava@gmail.com>
    Copyright 2010       Wagner Reck <wagner.reck@gmail.com>
    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 GRAPHFILEPLUGININTERFACE_H
#define GRAPHFILEPLUGININTERFACE_H

#include <QObject>
#include <RocsCoreExport.h>

class KAboutData;
class KUrl;
class Document;
class GraphFilePluginInterfacePrivate;

class ROCSLIB_EXPORT GraphFilePluginInterface: public QObject
{
    Q_OBJECT

public:
    enum Error {
        None,
        Unknown,
        FileIsReadOnly,
        CouldNotOpenFile,
        NoGraphFound,
        EncodingProblem,
        CouldNotRecognizeFileFormat,
        NotSupportedOperation
    };

    enum PluginType {
        ImportOnly,
        ExportOnly,
        ImportAndExport
    };

    GraphFilePluginInterface(const KAboutData* aboutData, QObject* parent);
    virtual ~GraphFilePluginInterface();

    virtual PluginType pluginCapability() const;

    bool hasError() const;

    Error error() const;

    QString errorString() const;

    const KAboutData* aboutData() const;

    virtual const QStringList extensions() const = 0;

    virtual void writeFile(Document &graph) = 0;

    virtual void readFile() = 0;

    void setFile(const KUrl& file);

    virtual bool isGraphDocument() const;

    virtual Document* graphDocument() const;


protected:
    const KUrl& file() const;

    void setGraphDocument(Document* document);

    void setError(Error error, QString message=QString());

private:
    GraphFilePluginInterfacePrivate * const d;
};

#endif // FILEPLUGININTERFACE_H