kate

pluginconfiginterfaceextension.h

00001 /* This file is part of the KDE project
00002    Copyright (C) 2001 Christoph Cullmann <cullmann@kde.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 version 2 as published by the Free Software Foundation.
00007 
00008    This library is distributed in the hope that it will be useful,
00009    but WITHOUT ANY WARRANTY; without even the implied warranty of
00010    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00011    Library General Public License for more details.
00012 
00013    You should have received a copy of the GNU Library General Public License
00014    along with this library; see the file COPYING.LIB.  If not, write to
00015    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
00016    Boston, MA 02110-1301, USA.
00017 */
00018 
00019 #ifndef __kate_pluginconfiginterfaceextension_h__
00020 #define __kate_pluginconfiginterfaceextension_h__
00021 
00022 #include <qwidget.h>
00023 #include <qpixmap.h>
00024 #include <kicontheme.h>
00025 
00026 namespace Kate
00027 {
00028 
00029 class KDE_EXPORT PluginConfigPage : public QWidget
00030 {
00031   Q_OBJECT
00032 
00033   public:
00034     PluginConfigPage ( QWidget *parent=0, const char *name=0 );
00035     virtual ~PluginConfigPage ();
00036 
00037   //
00038   // slots !!!
00039   //
00040   public:
00044     virtual void apply () = 0;
00045     
00049     virtual void reset () = 0;
00050     
00054     virtual void defaults () = 0;
00055 
00056   signals:
00057     void changed();
00058 };
00059 
00060 /*
00061 *  This is an interface for the KTextEditor::Document/Plugin/ViewPlugin classes !!!
00062 */
00063 class KDE_EXPORT PluginConfigInterfaceExtension
00064 {
00065   friend class PrivatePluginConfigInterfaceExtension;
00066 
00067   public:
00068     PluginConfigInterfaceExtension();
00069     virtual ~PluginConfigInterfaceExtension();
00070 
00071     unsigned int pluginConfigInterfaceExtensionNumber () const;
00072 
00073   //
00074   // slots !!!
00075   //
00076   public:    
00080     virtual uint configPages () const = 0;
00081     
00087     virtual PluginConfigPage *configPage (uint number = 0, QWidget *parent = 0, const char *name=0 ) = 0;
00088   
00089     virtual QString configPageName (uint number = 0) const = 0;
00090     virtual QString configPageFullName (uint number = 0) const = 0;
00091     virtual QPixmap configPagePixmap (uint number = 0, int size = KIcon::SizeSmall) const = 0;    
00092     
00093   private:
00094     class PrivatePluginConfigInterfaceExtension *d;
00095     static unsigned int globalPluginConfigInterfaceExtensionNumber;
00096     unsigned int myPluginConfigInterfaceExtensionNumber;
00097 };
00098 
00099 class Plugin;
00100 KDE_EXPORT PluginConfigInterfaceExtension *pluginConfigInterfaceExtension (Plugin *plugin);
00101 
00102 }
00103 
00104 #endif
kate

pluginconfiginterfaceextension.h

kate

API Reference
