summaryrefslogtreecommitdiffstats
path: root/kded/kdedmodule.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 /kded/kdedmodule.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 'kded/kdedmodule.h')
-rw-r--r--kded/kdedmodule.h148
1 files changed, 148 insertions, 0 deletions
diff --git a/kded/kdedmodule.h b/kded/kdedmodule.h
new file mode 100644
index 000000000..3e8c7b12c
--- /dev/null
+++ b/kded/kdedmodule.h
@@ -0,0 +1,148 @@
+/*
+ This file is part of the KDE libraries
+
+ Copyright (c) 2001 Waldo Bastian <bastian@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 __KDEDMODULE_H__
+#define __KDEDMODULE_H__
+
+#include <qobject.h>
+#include <dcopobject.h>
+#include <ksharedptr.h>
+
+class KDEDModulePrivate;
+class Kded;
+
+/**
+ * The base class for KDED modules.
+ *
+ * In KDE 2 and KDE 3, KDED modules are realized as shared
+ * libraries that are loaded on-demand into kded at runtime.
+ *
+ * To write a config module, you have to create a library
+ * that contains at least one factory function like this:
+ *
+ * \code
+ * extern "C" {
+ * KDE_EXPORT KDEDModule *create_xyz(QCString *name)
+ * {
+ * return new XYZ(name);
+ * }
+ * }
+ * \endcode
+ *
+ * See kdelibs/kded/HOWTO for more detailed documentation.
+ *
+ * @author Waldo Bastian <bastian@kde.org>
+ */
+
+class KDE_EXPORT KDEDModule : public QObject, public DCOPObject
+{
+ Q_OBJECT
+// For inclusion in KDE4 (since it's BIC) long-needed fix for allowing
+// DCOP-based kdedmodules -- Gav <gav@kde.org>.
+// K_DCOP
+ friend class Kded;
+public:
+
+ /**
+ * Create a DCOPObject named @p name
+ */
+ KDEDModule(const QCString &name);
+
+ virtual ~KDEDModule();
+
+ /**
+ * Specifies the idle timeout in seconds. The default is 0.
+ *
+ * This will call the idle slot @p secs seconds after the last
+ * reference was removed.
+ */
+ void setIdleTimeout(int secs);
+
+ /**
+ * Reset the idle timeout counter.
+ *
+ * (re)starts the timeout counter if no objects are being referenced.
+ */
+ void resetIdle();
+
+ /**
+ * Insert @p obj indexed with @p app and @p key. The
+ * object will be automatically deleted when the application
+ * @p app unregisters with DCOP.
+ *
+ * Any previous object inserted with the same values for @p app
+ * and @p key will be removed.
+ */
+ void insert(const QCString &app, const QCString &key, KShared *obj);
+
+ /**
+ * Lookup object indexed with @p app and @p key
+ */
+ KShared *find(const QCString &app, const QCString &key);
+
+ /**
+ * remove object indexed with @p app and @p key.
+ * The object will be deleted when it is no more referenced.
+ */
+ void remove(const QCString &app, const QCString &key);
+
+ /**
+ * remove all objects indexed with @p app.
+ * The objects will be deleted when they are no more referenced.
+ */
+ void removeAll(const QCString &app);
+
+ /**
+ * Returns whether a certain mainwindow has registered itself with KDED
+ */
+ bool isWindowRegistered(long windowId);
+
+public slots:
+ /**
+ * Called whenever the last referenced object gets dereferenced.
+ *
+ * See also setIdleTimeout()
+ *
+ * You may delete the module from this slot.
+ */
+ virtual void idle() { };
+
+signals:
+ /**
+ * Emitted when the module is being deleted.
+ */
+ void moduleDeleted(KDEDModule *);
+
+ /**
+ * Emitted when a mainwindow registers itself.
+ */
+ void windowRegistered(long windowId);
+
+ /**
+ * Emitted when a mainwindow unregisters itself.
+ */
+ void windowUnregistered(long windowId);
+
+private:
+ KDEDModulePrivate *d;
+};
+
+#endif