ToolsPluginInterface.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-2012  Wagner Reck <wagner.reck@gmail.com>
    Copyright 2013       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 TOOLSPLUGININTERFACE_H
#define TOOLSPLUGININTERFACE_H

#include "VisualEditorExport.h"
#include "CoreTypes.h"

#include <KPluginInfo>
#include <KXMLGUIClient>

#include <QtCore/QObject>

class Document;
class ToolsPluginInterfacePrivate;

class VISUALEDITOR_EXPORT ToolsPluginInterface
:   public QObject, public KXMLGUIClient
{
    Q_OBJECT

public:
    ToolsPluginInterface(const KComponentData &instance, QObject *parent);
    virtual ~ToolsPluginInterface();

    KPluginInfo pluginInfo();

    QString displayName();

    QString pluginId() const;

    QStringList supportedDataStructures();

    virtual void run(Document *document = 0) const = 0;

private:
    ToolsPluginInterfacePrivate * const d;
};

#endif