summaryrefslogtreecommitdiffstats
path: root/kparts/factory.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
commitce4a32fe52ef09d8f5ff1dd22c001110902b60a2 (patch)
tree5ac38a06f3dde268dc7927dc155896926aaf7012 /kparts/factory.h
downloadtdelibs-ce4a32fe52ef09d8f5ff1dd22c001110902b60a2.tar.gz
tdelibs-ce4a32fe52ef09d8f5ff1dd22c001110902b60a2.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/kdelibs@1054174 283d02a7-25f6-0310-bc7c-ecb5cbfe19da
Diffstat (limited to 'kparts/factory.h')
-rw-r--r--kparts/factory.h142
1 files changed, 142 insertions, 0 deletions
diff --git a/kparts/factory.h b/kparts/factory.h
new file mode 100644
index 000000000..808ad8851
--- /dev/null
+++ b/kparts/factory.h
@@ -0,0 +1,142 @@
+/* This file is part of the KDE project
+ Copyright (C) 1999 Simon Hausmann <hausmann@kde.org>
+ (C) 1999 David Faure <faure@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 __kparts_factory_h__
+#define __kparts_factory_h__
+
+#include <klibloader.h>
+
+class QWidget;
+
+namespace KParts
+{
+
+class Part;
+
+/**
+ * A generic factory object to create a Part.
+ *
+ * Factory is an abstract class. Reimplement the
+ * createPartObject() method to give it functionality.
+ *
+ * @see KLibFactory.
+ */
+class KPARTS_EXPORT Factory : public KLibFactory
+{
+ Q_OBJECT
+public:
+ Factory( QObject *parent = 0, const char *name = 0 );
+ virtual ~Factory();
+
+ /**
+ * Creates a part.
+ *
+ * The QStringList can be used to pass additional arguments to the part.
+ * If the part needs additional arguments, it should take them as
+ * name="value" pairs. This is the way additional arguments will get passed
+ * to the part from eg. khtml. You can for example embed the part into HTML
+ * by using the following code:
+ * \code
+ * <object type="my_mimetype" data="url_to_my_data">
+ * <param name="name1" value="value1">
+ * <param name="name2" value="value2">
+ * </object>
+ * \endcode
+ * This could result in a call to
+ * \code
+ * createPart( parentWidget, name, parentObject, parentName, "KParts::Part",
+ * QStringList("name1="value1"", "name2="value2") );
+ * \endcode
+ *
+ * @returns the newly created part.
+ *
+ * createPart() automatically emits a signal KLibFactory::objectCreated to tell
+ * the library about its newly created object. This is very
+ * important for reference counting, and allows unloading the
+ * library automatically once all its objects have been destroyed.
+ */
+ Part *createPart( QWidget *parentWidget = 0, const char *widgetName = 0, QObject *parent = 0, const char *name = 0, const char *classname = "KParts::Part", const QStringList &args = QStringList() );
+
+ /**
+ * If you have a part contained in a shared library you might want to query
+ * for meta-information like the about-data, or the KInstance in general.
+ * If the part is exported using KParts::GenericFactory then this method will
+ * return the instance that belongs to the part without the need to instantiate
+ * the part component.
+ */
+ const KInstance *partInstance();
+
+ /**
+ * A convenience method for partInstance() that takes care of retrieving
+ * the factory for a given library name and calling partInstance() on it.
+ *
+ * @param libraryName name of the library to query the instance from
+ */
+ static const KInstance *partInstanceFromLibrary( const QCString &libraryName );
+
+protected:
+
+ /**
+ * Reimplement this method in your implementation to create the Part.
+ *
+ * The QStringList can be used to pass additional arguments to the part.
+ * If the part needs additional arguments, it should take them as
+ * name="value" pairs. This is the way additional arguments will get passed
+ * to the part from eg. khtml. You can for example emebed the part into HTML
+ * by using the following code:
+ * \code
+ * <object type="my_mimetype" data="url_to_my_data">
+ * <param name="name1" value="value1">
+ * <param name="name2" value="value2">
+ * </object>
+ * \endcode
+ * This could result in a call to
+ * \code
+ * createPart( parentWidget, name, parentObject, parentName, "Kparts::Part",
+ * QStringList("name1="value1"", "name2="value2") );
+ * \endcode
+ *
+ * @returns the newly created part.
+ */
+ virtual Part *createPartObject( QWidget *parentWidget = 0, const char *widgetName = 0, QObject *parent = 0, const char *name = 0, const char *classname = "KParts::Part", const QStringList &args = QStringList() ) = 0;
+
+ /**
+ * Reimplemented from KLibFactory. Calls createPart()
+ */
+ virtual QObject *createObject( QObject *parent = 0, const char *name = 0, const char *classname = "QObject", const QStringList &args = QStringList() );
+
+ /** This 'enum' along with the structure below is NOT part of the public API.
+ * It's going to disappear in KDE 4.0 and is likely to change inbetween.
+ *
+ * @internal
+ */
+ enum { VIRTUAL_QUERY_INSTANCE_PARAMS = 0x10 };
+ struct QueryInstanceParams
+ {
+ const KInstance *instance;
+ };
+};
+
+}
+
+/*
+ * vim: et sw=4
+ */
+
+#endif