summaryrefslogtreecommitdiffstats
path: root/libkdepim/pluginloaderbase.h
diff options
context:
space:
mode:
authortoma <toma@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>2009-11-25 17:56:58 +0000
committertoma <toma@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>2009-11-25 17:56:58 +0000
commit460c52653ab0dcca6f19a4f492ed2c5e4e963ab0 (patch)
tree67208f7c145782a7e90b123b982ca78d88cc2c87 /libkdepim/pluginloaderbase.h
downloadtdepim-460c52653ab0dcca6f19a4f492ed2c5e4e963ab0.tar.gz
tdepim-460c52653ab0dcca6f19a4f492ed2c5e4e963ab0.zip
Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features.
BUG:215923 git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/kdepim@1054174 283d02a7-25f6-0310-bc7c-ecb5cbfe19da
Diffstat (limited to 'libkdepim/pluginloaderbase.h')
-rw-r--r--libkdepim/pluginloaderbase.h86
1 files changed, 86 insertions, 0 deletions
diff --git a/libkdepim/pluginloaderbase.h b/libkdepim/pluginloaderbase.h
new file mode 100644
index 000000000..fd63cf690
--- /dev/null
+++ b/libkdepim/pluginloaderbase.h
@@ -0,0 +1,86 @@
+/* -*- c++ -*-
+ This file is part of libkdepim.
+
+ Copyright (c) 2002,2004 Marc Mutz <mutz@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 as published by the Free Software Foundation; either
+ version 2 of the License, or (at your option) any later version.
+
+ 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 __LIBKDEPIM_PLUGINLOADERBASE_H__
+#define __LIBKDEPIM_PLUGINLOADERBASE_H__
+
+#include <qstring.h>
+#include <qmap.h>
+
+#include <kdepimmacros.h>
+
+class KLibrary;
+class QStringList;
+
+namespace KPIM {
+
+ class KDE_EXPORT PluginMetaData {
+ public:
+ PluginMetaData() {}
+ PluginMetaData( const QString & lib, const QString & name,
+ const QString & comment )
+ : library( lib ), nameLabel( name ),
+ descriptionLabel( comment ), loaded( false ) {}
+ QString library;
+ QString nameLabel;
+ QString descriptionLabel;
+ mutable bool loaded;
+ };
+
+ class KDE_EXPORT PluginLoaderBase {
+ protected:
+ PluginLoaderBase();
+ virtual ~PluginLoaderBase();
+
+ public:
+ /** Returns a list of all available plugin objects (of kind @p T) */
+ QStringList types() const;
+
+ /** Returns the @ref PluginMetaData structure for a given type */
+ const PluginMetaData * infoForName( const QString & type ) const;
+
+ /** Overload this method in subclasses to call @ref doScan with
+ the right @p path argument */
+ virtual void scan() = 0;
+
+ protected:
+ /** Rescans the plugin directory to find any newly installed
+ plugins. Extend this method in subclasses to add any
+ builtins. Subclasses must call this explicitely. It's not
+ called for them in the constructor.
+ **/
+ void doScan( const char * path );
+
+ /** Returns a pointer to symbol @p main_func in the library that
+ implements the plugin of type @p type */
+ void * mainFunc( const QString & type, const char * main_func ) const;
+
+ private:
+ const KLibrary * openLibrary( const QString & libName ) const;
+ QMap< QString, PluginMetaData > mPluginMap;
+
+ class Private;
+ Private * d;
+ };
+
+} // namespace KMime
+
+#endif // __LIBKDEPIM_PLUGINLOADERBASE_H__