kate

plugin.h

00001 /* This file is part of the KDE project
00002    Copyright (C) 2001 Christoph Cullmann <cullmann@kde.org>
00003    Copyright (C) 2002 Joseph Wenninger <jowenn@kde.org>
00004 
00005    This library is free software; you can redistribute it and/or
00006    modify it under the terms of the GNU Library General Public
00007    License version 2 as published by the Free Software Foundation.
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., 51 Franklin Street, Fifth Floor,
00017    Boston, MA 02110-1301, USA.
00018 */
00019 
00020 #ifndef _KATE_PLUGIN_INCLUDE_
00021 #define _KATE_PLUGIN_INCLUDE_
00022 
00023 #include <qwidget.h>
00024 #include <qpixmap.h>
00025 #include <kicontheme.h>
00026 
00027 #include <kurl.h>
00028 
00029 namespace Kate
00030 {
00031 
00032 class Application;
00033 class MainWindow;
00034 
00035 class KDE_EXPORT Plugin : public QObject
00036 {
00037   friend class PrivatePlugin;
00038 
00039   Q_OBJECT
00040 
00041   public:
00042     Plugin (Application *application = 0, const char *name = 0 );
00043     virtual ~Plugin ();
00044 
00045     unsigned int pluginNumber () const;
00046 
00047     Application *application() const;
00048 
00049   private:
00050     class PrivatePlugin *d;
00051     static unsigned int globalPluginNumber;
00052     unsigned int myPluginNumber;
00053 };
00054 
00055 KDE_EXPORT Plugin *createPlugin ( const char* libname, Application *application = 0, const char *name = 0,const QStringList &args = QStringList() );
00056 
00057 /*
00058  * view plugin class
00059  * this plugin will be bound to a ktexteditor::view
00060  */
00061 class KDE_EXPORT PluginViewInterface
00062 {
00063   friend class PrivatePluginViewInterface;
00064 
00065   public:
00066     PluginViewInterface ();
00067     virtual ~PluginViewInterface ();
00068 
00069     unsigned int pluginViewInterfaceNumber () const;
00070 
00071     /*
00072      * will be called from the part to bound the plugin to a view
00073      */
00074     virtual void addView (MainWindow *) = 0;
00075     virtual void removeView (MainWindow *) = 0;
00076 
00077   private:
00078     class PrivatePluginViewInterface *d;
00079     static unsigned int globalPluginViewInterfaceNumber;
00080     unsigned int myPluginViewInterfaceNumber;
00081 };
00082 
00083 KDE_EXPORT PluginViewInterface *pluginViewInterface (Plugin *plugin);
00084 
00085 }
00086 
00087 #endif
kate

plugin.h

kate

API Reference
