summaryrefslogtreecommitdiffstats
path: root/arts/kde/kartsdispatcher.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 /arts/kde/kartsdispatcher.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 'arts/kde/kartsdispatcher.h')
-rw-r--r--arts/kde/kartsdispatcher.h87
1 files changed, 87 insertions, 0 deletions
diff --git a/arts/kde/kartsdispatcher.h b/arts/kde/kartsdispatcher.h
new file mode 100644
index 000000000..db2792a97
--- /dev/null
+++ b/arts/kde/kartsdispatcher.h
@@ -0,0 +1,87 @@
+ /*
+
+ Copyright (C) 2001 Nikolas Zimmermann <wildfox@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 KARTSDISPATCHER_H
+#define KARTSDISPATCHER_H
+
+#include <qobject.h>
+
+#include <kdelibs_export.h>
+
+namespace Arts
+{
+ class QIOManager;
+ class Dispatcher;
+}
+
+/**
+ * KArtsDispatcher ensures that an instance of Arts::Dispatcher using an
+ * Arts::QIOManager exists. When the last KArtsDispatcher is deleted, the
+ * Arts::Dispatcher is released as well.
+ *
+ * Using KArtsDispatcher is especially useful in setups where another plugin
+ * might also already use an Arts::Dispatcher, for instance in konqueror.
+ *
+ * \code
+ * {
+ * // old code
+ * Arts::QIOManager qiomanager;
+ * Arts::Dispatcher dispatcher(&qiomanager);
+ *
+ * Arts::SoundServer server = Arts::Reference("global:Arts_SoundServer");
+ * server.play("/usr/share/sounds/pop.wav");
+ * }
+ * \endcode
+ *
+ * \code
+ * {
+ * // new code
+ * KArtsDispatcher dispatcher;
+ *
+ * Arts::SoundServer server = Arts::Reference("global:Arts_SoundServer");
+ * server.play("/usr/share/sounds/pop.wav");
+ * }
+ * \endcode
+ */
+class KDE_EXPORT KArtsDispatcher : public QObject
+{
+Q_OBJECT
+public:
+ /**
+ * Constructor.
+ *
+ * @param parent the parent Qt object
+ * @param name the Qt object name of this object
+ */
+ KArtsDispatcher(QObject *parent = 0, const char *name = 0);
+
+ /**
+ * Destructor
+ */
+ ~KArtsDispatcher();
+
+private:
+ static int m_refCount;
+ static Arts::Dispatcher *artsDispatcher;
+ static Arts::QIOManager *artsQIOManager;
+};
+
+#endif