iplugin.h

Go to the documentation of this file.

/* This file is part of the KDE project
   Copyright 1999-2001 Bernd Gehrmann <[email protected]>
   Copyright 2004,2007 Alexander Dymo <[email protected]>
   Copyright 2006 Adam Treat <[email protected]>
   Copyright 2007 Andreas Pakulat <[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 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 KDEVPLATFORM_IPLUGIN_H
#define KDEVPLATFORM_IPLUGIN_H
 
#include <QObject>
 
#include <KXMLGUIClient>
 
#include "interfacesexport.h"
 
namespace Sublime {
class MainWindow;
}
 
namespace KDevelop
{
 
class ICore;
class ConfigPage;
class Context;
class ContextMenuExtension;
struct ProjectConfigOptions;
class IPluginPrivate;
 
class KDEVPLATFORMINTERFACES_EXPORT IPlugin: public QObject, public KXMLGUIClient
{
    Q_OBJECT
 
public:
    IPlugin(const QString &componentName, QObject *parent);
 
    ~IPlugin() override;
 
    virtual void unload();
 
    ICore *core() const;
 
    template<class Extension>
    inline Extension* extension()
    {
        return qobject_cast<Extension*>(this);
    }
 
    virtual ContextMenuExtension contextMenuExtension(KDevelop::Context* context, QWidget* parent);
 
    virtual KXMLGUIClient* createGUIForMainWindow( Sublime::MainWindow* window );
 
    virtual void createActionsForMainWindow( Sublime::MainWindow* window, QString& xmlFile, KActionCollection& actions );
 
    bool hasError() const;
    
    QString errorDescription() const;
 
    void setErrorDescription(QString const& description);
 
    virtual ConfigPage* configPage(int number, QWidget *parent);
 
    virtual int configPages() const;
 
    virtual int perProjectConfigPages() const;
 
    virtual ConfigPage* perProjectConfigPage(int number, const KDevelop::ProjectConfigOptions& options, QWidget* parent);
 
protected:
    virtual void initializeGuiState();
 
private:
    const QScopedPointer<class IPluginPrivate> d_ptr;
    Q_DECLARE_PRIVATE(IPlugin)
    friend class IPluginPrivate;
};
 
}
 
#endif