summaryrefslogtreecommitdiffstats
path: root/arts/kde/kartsfloatwatch.h
diff options
context:
space:
mode:
Diffstat (limited to 'arts/kde/kartsfloatwatch.h')
-rw-r--r--arts/kde/kartsfloatwatch.h82
1 files changed, 82 insertions, 0 deletions
diff --git a/arts/kde/kartsfloatwatch.h b/arts/kde/kartsfloatwatch.h
new file mode 100644
index 000000000..6c23327ea
--- /dev/null
+++ b/arts/kde/kartsfloatwatch.h
@@ -0,0 +1,82 @@
+ /*
+
+ Copyright (C) 2001 Stefan Westerfeld
+ stefan@space.twc.de
+
+ 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.
+
+ */
+
+#include "common.h"
+#include <qobject.h>
+
+class KArtsFloatWatchPrivate;
+namespace Arts { class KFloatWatchProxy_impl; }
+
+/**
+ * KArtsFloatWatch offers an easy way to watch aRts streams via Qt signals.
+ * For instance, if you have an object of the following type:
+ *
+ * \code
+ * interface StereoVolumeControl : StereoEffect {
+ * attribute float scaleFactor;
+ * readonly attribute float currentVolumeLeft;
+ * readonly attribute float currentVolumeRight;
+ * };
+ * \endcode
+ *
+ * and you want to get notified when scaleFactor changes, you could do it
+ * like this:
+ *
+ * \code
+ * StereoVolumeControl stereoVolumeControl = ...;
+ * KArtsFloatWatch *w = new KArtsFloatWatch(stereoVolumeControl, "scaleFactor_changed", this);
+ * connect(w, SIGNAL(valueChanged(float)), this, SLOT(setValue(float)));
+ * \endcode
+ */
+class KArtsFloatWatch : public QObject {
+ Q_OBJECT
+private:
+ KArtsFloatWatchPrivate *d;
+ friend class Arts::KFloatWatchProxy_impl;
+
+ /**
+ * called by the proxy (internal)
+ */
+ void change(float newValue);
+
+public:
+ /**
+ * Constructor.
+ *
+ * @param object the aRts object that should be watched
+ * @param stream the aRts stream that should be watched
+ * @param parent the parent Qt object
+ * @param name the Qt object name of this object
+ */
+ KArtsFloatWatch(Arts::Object object, const char *stream, QObject *parent = 0, const char *name = 0);
+
+ /**
+ * Destructor
+ */
+ ~KArtsFloatWatch();
+
+signals:
+ /**
+ * this signal will be emitted with values of the aRts stream
+ */
+ void valueChanged(float newValue);
+};