diff options
Diffstat (limited to 'interfaces/tdetexteditor/plugin.h')
-rw-r--r-- | interfaces/tdetexteditor/plugin.h | 88 |
1 files changed, 88 insertions, 0 deletions
diff --git a/interfaces/tdetexteditor/plugin.h b/interfaces/tdetexteditor/plugin.h new file mode 100644 index 000000000..68416bf78 --- /dev/null +++ b/interfaces/tdetexteditor/plugin.h @@ -0,0 +1,88 @@ +/* This file is part of the KDE libraries + Copyright (C) 2001 Christoph Cullmann <cullmann@kde.org> + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Library General Public + License version 2 as published by the Free Software Foundation. + + 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 __tdetexteditor_plugin_h__ +#define __tdetexteditor_plugin_h__ + +#include <tqobject.h> + +#include <tdelibs_export.h> + +namespace KTextEditor +{ + +class Document; +class View; + +/** + * Basic KTextEditor plugin class. + * This plugin will be bound to a Document. + */ +class KTEXTEDITOR_EXPORT Plugin : public TQObject +{ + friend class PrivatePlugin; + + Q_OBJECT + + public: + Plugin ( Document *document = 0, const char *name = 0 ); + virtual ~Plugin (); + + unsigned int pluginNumber () const; + + Document *document () const; + + private: + class PrivatePlugin *d; + static unsigned int globalPluginNumber; + unsigned int myPluginNumber; +}; + +KTEXTEDITOR_EXPORT Plugin *createPlugin ( const char* libname, Document *document = 0, const char *name = 0 ); + +/** + * View plugin class. + * This plugin will be bound to a View + */ +class KTEXTEDITOR_EXPORT PluginViewInterface +{ + friend class PrivatePluginViewInterface; + + public: + PluginViewInterface (); + virtual ~PluginViewInterface (); + + unsigned int pluginViewInterfaceNumber () const; + + /* + * will be called from the part to bound the plugin to a view + */ + virtual void addView (View *) = 0; + virtual void removeView (View *) = 0; + + private: + class PrivatePluginViewInterface *d; + static unsigned int globalPluginViewInterfaceNumber; + unsigned int myPluginViewInterfaceNumber; +}; + +KTEXTEDITOR_EXPORT PluginViewInterface *pluginViewInterface (Plugin *plugin); + +} + +#endif |