summaryrefslogtreecommitdiffstats
path: root/kate/interfaces/pluginconfiginterface.h
diff options
context:
space:
mode:
Diffstat (limited to 'kate/interfaces/pluginconfiginterface.h')
-rw-r--r--kate/interfaces/pluginconfiginterface.h63
1 files changed, 63 insertions, 0 deletions
diff --git a/kate/interfaces/pluginconfiginterface.h b/kate/interfaces/pluginconfiginterface.h
new file mode 100644
index 000000000..f626b1cde
--- /dev/null
+++ b/kate/interfaces/pluginconfiginterface.h
@@ -0,0 +1,63 @@
+/* This file is part of the KDE project
+ 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 __kate_pluginconfiginterface_h__
+#define __kate_pluginconfiginterface_h__
+
+#include <kdemacros.h>
+
+namespace Kate
+{
+
+/*
+* This is an interface for the KTextEditor::Document/Plugin/ViewPlugin classes !!!
+*/
+class KDE_EXPORT PluginConfigInterface
+{
+ friend class PrivatePluginConfigInterface;
+
+ public:
+ PluginConfigInterface();
+ virtual ~PluginConfigInterface();
+
+ unsigned int pluginConfigInterfaceNumber () const;
+
+ //
+ // slots !!!
+ //
+ public:
+ /**
+ Read/Write the config to the standard place where this editor
+ part saves it config, say: read/save default values for that
+ editor part
+ */
+ virtual void readConfig () = 0;
+ virtual void writeConfig () = 0;
+
+ private:
+ class PrivatePluginConfigInterface *d;
+ static unsigned int globalPluginConfigInterfaceNumber;
+ unsigned int myPluginConfigInterfaceNumber;
+};
+
+class Plugin;
+KDE_EXPORT PluginConfigInterface *pluginConfigInterface (Plugin *plugin);
+
+}
+
+#endif