1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
|
/***************************************************************************
* Copyright (C) 2007-2021 by Ilya Kotov *
* forkotov02@ya.ru *
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
* This program 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 General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program; if not, write to the *
* Free Software Foundation, Inc., *
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. *
***************************************************************************/
#ifndef EFFECTFACTORY_H
#define EFFECTFACTORY_H
#include <QObject>
#include "qmmp_export.h"
class QObject;
class QWidget;
class Effect;
/*! @brief Structure to store effect plugin properties.
* @author Ilya Kotov <forkotov02@ya.ru>
*/
struct EffectProperties
{
/*!
* This enum describes effect preferd position.
*/
enum Priority
{
EFFECT_PRIORITY_LOW = 0, /*!< Low priority */
EFFECT_PRIORITY_DEFAULT, /*!< Default priority */
EFFECT_PRIORITY_HIGH /*!< High priority */
};
QString name; /*!< Effect plugin full name */
QString shortName; /*!< Effect plugin short name for internal usage */
bool hasAbout = false; /*!< Should be \b true if plugin has about dialog, and \b false otherwise */
bool hasSettings = false; /*!< Should be \b true if plugin has settings dialog,and \b false otherwise */
int priority = EFFECT_PRIORITY_DEFAULT; /*!< Effect priority. Effecs with higher priority will be applied first */
};
/*! @brief Effect plugin interface (effect factory).
* @author Ilya Kotov <forkotov02@ya.ru>
*/
class EffectFactory
{
public:
/*!
* Returns effect plugin properties.
*/
virtual const EffectProperties properties() const = 0;
/*!
* Creates effect provided by plugin.
*/
virtual Effect *create() = 0;
/*!
* Shows settings dialog.
* @param parent Parent widget.
*/
virtual void showSettings(QWidget *parent) = 0;
/*!
* Shows about dialog.
* @param parent Parent widget.
*/
virtual void showAbout(QWidget *parent) = 0;
/*!
* Returns translation file path without locale code and extension
*/
virtual QString translation() const = 0;
};
Q_DECLARE_INTERFACE(EffectFactory, "EffectFactory/1.0")
#endif
|
