KDevelop API Documentation

kdevplugin.h

Go to the documentation of this file.
00001 /* This file is part of the KDE project
00002    Copyright (C) 1999-2001 Bernd Gehrmann <bernd@kdevelop.org>
00003 
00004    This library is free software; you can redistribute it and/or
00005    modify it under the terms of the GNU Library General Public
00006    License as published by the Free Software Foundation; either
00007    version 2 of the License, or (at your option) any later version.
00008 
00009    This library is distributed in the hope that it will be useful,
00010    but WITHOUT ANY WARRANTY; without even the implied warranty of
00011    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00012    Library General Public License for more details.
00013 
00014    You should have received a copy of the GNU Library General Public License
00015    along with this library; see the file COPYING.LIB.  If not, write to
00016    the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
00017    Boston, MA 02111-1307, USA.
00018 */
00019 
00020 #ifndef _KDEVPLUGIN_H_
00021 #define _KDEVPLUGIN_H_
00022 
00023 #include <qobject.h>
00024 #include <qvaluelist.h>
00025 #include <kxmlguiclient.h>
00026 
00027 class KDevApi;
00028 class KDevCore;
00029 class KDevProject;
00030 class KDevVersionControl;
00031 class KDevLanguageSupport;
00032 class KDevEditorManager;
00033 class KDevMakeFrontend;
00034 class KDevAppFrontend;
00035 class KDevPartController;
00036 class KDevMainWindow;
00037 class KDevDebugger;
00038 class KDevDiffFrontend;
00039 class KDevCreateFile;
00040 class KDevSourceFormatter;
00041 class KDevCodeRepository;
00042 class CodeModel;
00043 
00044 class DCOPClient;
00045 class KAboutData;
00046 class QDomElement;
00047 
00048 namespace KParts
00049 {
00050     class Part;
00051 }
00052 
00053 // increase this if you want old plugins to stop working
00054 #define KDEVELOP_PLUGIN_VERSION 1
00055 
00060 class KDevPlugin : public QObject, public KXMLGUIClient
00061 {
00062     Q_OBJECT
00063 
00064 public:
00068     KDevPlugin( const QString& pluginName, const QString& icon, QObject *parent, const char *name=0 );
00069 
00073     ~KDevPlugin();
00074 
00078     QString pluginName() const;
00079 
00083     QString icon() const;
00084 
00088     virtual QString shortDescription() const;
00089 
00093     virtual QString description() const;
00094 
00099     virtual bool createDCOPInterface( const QString& /*serviceType*/ ) { return 0L; }
00100 
00111     virtual QStringList configModules() const { return QStringList(); };
00112 
00117     virtual KAboutData* aboutData() { return 0L; };
00118 
00123     virtual KParts::Part* part() { return 0; }
00124 
00134     DCOPClient *dcopClient() const;
00135 
00139     virtual QWidget* widget() { return 0L; }
00140 
00144     KDevMainWindow *mainWindow();
00148     bool mainWindowValid();
00149 
00153     KDevCore *core() const;
00157     KDevProject *project() const;
00161     KDevLanguageSupport *languageSupport() const;
00165     KDevMakeFrontend *makeFrontend() const;
00169     KDevDiffFrontend *diffFrontend() const;
00173     KDevAppFrontend *appFrontend() const;
00177     CodeModel *codeModel() const;
00178 
00183     QDomDocument *projectDom() const;
00184 
00188     KDevPartController *partController() const;
00189 
00193     KDevDebugger *debugger() const;
00194 
00198     KDevCreateFile *createFileSupport() const;
00199 
00203     KDevSourceFormatter *sourceFormatter() const;
00204 
00217     virtual void restorePartialProjectSession(const QDomElement* el);
00218 
00222     virtual void savePartialProjectSession(QDomElement* el);
00223 
00227     KDevVersionControl *versionControl() const;   // used by the FileTree
00228 
00232     KDevCodeRepository* codeRepository() const;
00233 
00234 signals:
00239     void aboutToShowPart();
00240 
00241 protected:
00245     virtual void showPart();
00246 
00247 private:
00248     KDevApi *m_api;
00249     class Private;
00250     Private *d;
00251 };
00252 
00253 #endif
KDE Logo
This file is part of the documentation for KDevelop Version 3.1.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Wed Mar 23 00:03:52 2005 by doxygen 1.3.9.1 written by Dimitri van Heesch, © 1997-2003