phonon/phonon/effectinterface.h

0001 /*  This file is part of the KDE project
0002     Copyright (C) 2006-2008 Matthias Kretz <kretz@kde.org>
0003
0004     This library is free software; you can redistribute it and/or
0005     modify it under the terms of the GNU Lesser General Public
0006     License as published by the Free Software Foundation; either
0007     version 2.1 of the License, or (at your option) version 3, or any
0008     later version accepted by the membership of KDE e.V. (or its
0009     successor approved by the membership of KDE e.V.), Nokia Corporation
0010     (or its successors, if any) and the KDE Free Qt Foundation, which shall
0011     act as a proxy defined in Section 6 of version 3 of the license.
0012
0013     This library is distributed in the hope that it will be useful,
0014     but WITHOUT ANY WARRANTY; without even the implied warranty of
0015     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
0016     Lesser General Public License for more details.
0017
0018     You should have received a copy of the GNU Lesser General Public
0019     License along with this library.  If not, see <http://www.gnu.org/licenses/>.
0020
0021 */
0022
0023 #ifndef PHONON_EFFECTINTERFACE_H
0024 #define PHONON_EFFECTINTERFACE_H
0025
0026 #include "phononnamespace.h"
0027 #include <QVariant>
0028
0029
0030 #ifndef QT_NO_PHONON_EFFECT
0031
0032 namespace Phonon
0033 {
0034     class EffectParameter;
0035     /** \class EffectInterface effectinterface.h phonon/EffectInterface
0036      * \short Interface for Effect objects
0037      *
0038      * \author Matthias Kretz <kretz@kde.org>
0039      */
0040     class EffectInterface
0041     {
0042         public:
0043             virtual ~EffectInterface() {}
0044             /**
0045              * Returns the EffectParameter objects to describe the parameters of this effect.
0046              */
0047             virtual QList<EffectParameter> parameters() const = 0;
0048             /**
0049              * Returns the value for the selected parameter.
0050              */
0051             virtual QVariant parameterValue(const EffectParameter &) const = 0;
0052             /**
0053              * Sets the value for the selected parameter.
0054              */
0055             virtual void setParameterValue(const EffectParameter &, const QVariant &newValue) = 0;
0056     };
0057 } //namespace Phonon
0058
0059 Q_DECLARE_INTERFACE(Phonon::EffectInterface, "EffectInterface0.phonon.kde.org")
0060
0061 #endif //QT_NO_PHONON_EFFECT
0062
0063
0064 #endif // PHONON_EFFECTINTERFACE_H