kis_brush_factory.h 1.52 KB
Newer Older
1
/*
2
 *  Copyright (c) 2008 Boudewijn Rempt <boud@valdyas.org>
3 4 5 6 7 8 9 10 11 12 13 14 15
 *
 *  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
16
 *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17
 */
18 19
#ifndef KIS_BRUSH_FACTORY
#define KIS_BRUSH_FACTORY
20

21
#include "kis_brush.h"
Boudewijn Rempt's avatar
Boudewijn Rempt committed
22

23 24
class QDomElement;

25
/**
26 27 28
 * A brush factory can create a new brush instance based
 * on a properties object that contains a serialized representation
 * of the object.
29
 */
30
class BRUSH_EXPORT KisBrushFactory
Boudewijn Rempt's avatar
Boudewijn Rempt committed
31
{
Boudewijn Rempt's avatar
Boudewijn Rempt committed
32

33 34
public:

35 36
    KisBrushFactory() {}
    virtual ~KisBrushFactory() {}
37

38 39

    virtual QString id() const = 0;
40

Boudewijn Rempt's avatar
Boudewijn Rempt committed
41 42 43
    virtual QString name() const {
        return QString();
    }
Jarosław Staniek's avatar
Jarosław Staniek committed
44

45
    /**
Boudewijn Rempt's avatar
Boudewijn Rempt committed
46
     * Create a new brush from the given data or return an existing KisBrush
47 48 49
     * object. If this call leads to the creation of a resource, it should be
     * added to the resource provider, too.
     */
50
    virtual KisBrushSP createBrush(const QDomElement& element) = 0;
51 52

};
53

54
#endif