KReportPluginInterface.h

/* This file is part of the KDE project
   Copyright (C) 2010 by Adam Pigg ([email protected])
   Copyright (C) 2015 Jarosław Staniek <[email protected]>
 
   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2.1 of the License, or (at your option) any later version.
 
   This library 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
   Library General Public License for more details.
 
   You should have received a copy of the GNU Library General Public License
   along with this library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
   Boston, MA 02110-1301, USA.
*/
 
#ifndef KREPORTPLUGININTERFACE_H
#define KREPORTPLUGININTERFACE_H
 
#include "config-kreport.h"
#include "kreport_export.h"
#include "KReportElement.h"
 
#include <KPluginFactory>
 
class QGraphicsScene;
class QDomNode;
class QDomElement;
class KReportPluginMetaData;
class KReportDesignReadingStatus;
class KReportDesigner;
class KReportItemBase;
 
//! deprecated, use K_PLUGIN_CLASS_WITH_JSON instead!
#define KREPORT_PLUGIN_FACTORY(class_name, name) \
    K_PLUGIN_FACTORY_WITH_JSON(class_name ## Factory, name, registerPlugin<class_name>();)
 
/*!
 * @brief An interface for plugins delivering KReport elements.
 */
class KREPORT_EXPORT KReportPluginInterface : public QObject
{
    Q_OBJECT
public:
    explicit KReportPluginInterface(QObject *parent = nullptr,
                                     const QVariantList &args = QVariantList());
 
    ~KReportPluginInterface() override;
 
    virtual QObject* createDesignerInstance(KReportDesigner *designer, QGraphicsScene * scene,
                                            const QPointF &pos) = 0;
 
    //! @todo 4.0: Use QDomElement
    virtual QObject* createDesignerInstance(const QDomNode &element, KReportDesigner *designer,
                                            QGraphicsScene *scene) = 0;
 
    //! @todo 4.0: Use QDomElement
    virtual QObject* createRendererInstance(const QDomNode &element) = 0;
 
    virtual KReportElement createElement();
 
    virtual bool loadElement(KReportElement *el, const QDomElement &dom, KReportDesignReadingStatus *status);
 
#ifdef KREPORT_SCRIPTING
    virtual QObject* createScriptInstance(KReportItemBase* item) = 0;
#endif
 
    //! @return information about the plugin
    const KReportPluginMetaData* metaData() const;
 
private:
    friend class KReportPluginEntry;
    void setMetaData(KReportPluginMetaData* metaData);
 
    Q_DISABLE_COPY(KReportPluginInterface)
    class Private;
    Private * const d;
};
 
#endif // KREPORTPLUGININTERFACE_H