1
/*  This file is part of the KDE project
2
    Copyright (C) 2006-2008 Matthias Kretz <kretz@kde.org>
3
4
    This library is free software; you can redistribute it and/or
5
    modify it under the terms of the GNU Lesser General Public
6
    License as published by the Free Software Foundation; either
7
    version 2.1 of the License, or (at your option) version 3, or any
8
    later version accepted by the membership of KDE e.V. (or its
9
    successor approved by the membership of KDE e.V.), Nokia Corporation 
10
    (or its successors, if any) and the KDE Free Qt Foundation, which shall
11
    act as a proxy defined in Section 6 of version 3 of the license.
12
13
    This library is distributed in the hope that it will be useful,
14
    but WITHOUT ANY WARRANTY; without even the implied warranty of
15
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16
    Lesser General Public License for more details.
17
18
    You should have received a copy of the GNU Lesser General Public 
19
    License along with this library.  If not, see <http://www.gnu.org/licenses/>.
20
21
*/
22
23
#ifndef PHONON_EFFECTINTERFACE_H
24
#define PHONON_EFFECTINTERFACE_H
25
26
#include "phononnamespace.h"
27
#include <QtCore/QVariant>
28
29
QT_BEGIN_HEADER
30
QT_BEGIN_NAMESPACE
31
32
#ifndef QT_NO_PHONON_EFFECT
33
34
namespace Phonon
35
{
36
    class EffectParameter;
37
    /** \class EffectInterface effectinterface.h Phonon/EffectInterface
38
     * \short Interface for Effect objects
39
     *
40
     * \author Matthias Kretz <kretz@kde.org>
41
     */
42
    class EffectInterface
43
    {
44
        public:
45
            virtual ~EffectInterface() {}
46
            /**
47
             * Returns the EffectParameter objects to describe the parameters of this effect.
48
             */
49
            virtual QList<EffectParameter> parameters() const = 0;
50
            /**
51
             * Returns the value for the selected parameter.
52
             */
53
            virtual QVariant parameterValue(const EffectParameter &) const = 0;
54
            /**
55
             * Sets the value for the selected parameter.
56
             */
57
            virtual void setParameterValue(const EffectParameter &, const QVariant &newValue) = 0;
58
    };
59
} //namespace Phonon
60
61
Q_DECLARE_INTERFACE(Phonon::EffectInterface, "EffectInterface0.phonon.kde.org")
62
63
#endif //QT_NO_PHONON_EFFECT
64
65
QT_END_NAMESPACE
66
QT_END_HEADER
67
68
#endif // PHONON_EFFECTINTERFACE_H