summaryrefslogtreecommitdiffabout
path: root/kabc/formatfactory.h
Side-by-side diff
Diffstat (limited to 'kabc/formatfactory.h') (more/less context) (ignore whitespace changes)
-rw-r--r--kabc/formatfactory.h104
1 files changed, 104 insertions, 0 deletions
diff --git a/kabc/formatfactory.h b/kabc/formatfactory.h
new file mode 100644
index 0000000..9612374
--- a/dev/null
+++ b/kabc/formatfactory.h
@@ -0,0 +1,104 @@
+/*
+ This file is part of libkabc.
+ Copyright (c) 2002 Tobias Koenig <tokoe@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., 59 Temple Place - Suite 330,
+ Boston, MA 02111-1307, USA.
+*/
+
+#ifndef KABC_FORMATFACTORY_H
+#define KABC_FORMATFACTORY_H
+
+#include <qdict.h>
+#include <qstring.h>
+
+#include <kconfig.h>
+#ifndef DESKTOP_VERSION
+#include <klibloader.h>
+#endif
+
+#include "formatplugin.h"
+
+namespace KABC {
+
+struct FormatInfo
+{
+ QString library;
+ QString nameLabel;
+ QString descriptionLabel;
+};
+
+/**
+ * Class for loading format plugins.
+ *
+ * Example:
+ *
+ * <pre>
+ * KABC::FormatFactory *factory = KABC::FormatFactory::self();
+ *
+ * QStringList list = factory->formats();
+ * QStringList::Iterator it;
+ * for ( it = list.begin(); it != list.end(); ++it ) {
+ * KABC::FormatPlugin *format = factory->format( (*it) );
+ * // do something with format
+ * }
+ * </pre>
+ */
+class FormatFactory
+{
+ public:
+
+ /**
+ Destructor.
+ */
+ ~FormatFactory();
+
+ /**
+ * Returns the global format factory.
+ */
+ static FormatFactory *self();
+
+ /**
+ * Returns a pointer to a format object or a null pointer
+ * if format type doesn't exist.
+ *
+ * @param type The type of the format, returned by @ref formats()
+ */
+ FormatPlugin *format( const QString &type );
+
+ /**
+ * Returns a list of all available format types.
+ */
+ QStringList formats();
+
+ /**
+ * Returns the info structure for a special type.
+ */
+ FormatInfo *info( const QString &type );
+
+ protected:
+ FormatFactory();
+
+ private:
+#ifndef DESKTOP_VERSION
+ KLibrary *openLibrary( const QString& libName );
+#endif
+ static FormatFactory *mSelf;
+
+ QDict<FormatInfo> mFormatList;
+};
+
+}
+#endif