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
|
/* This file is part of the KDE project
* Copyright (c) 2009 Jan Hambrecht <jaham@gmx.net>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser 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 Lesser 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 KOFILTEREFFECTFACTORY_H
#define KOFILTEREFFECTFACTORY_H
#include "flake_export.h"
class KoFilterEffect;
class KoFilterEffectConfigWidgetBase;
/// API docs go here
class FLAKE_EXPORT KoFilterEffectFactoryBase
{
public:
/**
* Create the new factory
* @param id a string that will be used internally for referencing the filter effect
* @param name the user visible name of the filter effect this factory creates
*/
KoFilterEffectFactoryBase(const QString &id, const QString &name);
virtual ~KoFilterEffectFactoryBase();
/**
* Returns the id for the filter this factory creates.
* @return the id for the filter this factory creates
*/
QString id() const;
/**
* Returns the user visible (and translated) name to be seen by the user.
* @return the user visible (and translated) name to be seen by the user
*/
QString name() const;
/**
* This method should be implemented by factories to create a filter effect.
* @return a new filter effect
*/
virtual KoFilterEffect *createFilterEffect() const = 0;
/**
* This method should be implemented by factories to create a filter effect config widget.
* @return the filter effect options widget
*/
virtual KoFilterEffectConfigWidgetBase *createConfigWidget() const = 0;
private:
class Private;
Private * const d;
};
#endif // KOFILTEREFFECTFACTORY_H
|
