summaryrefslogtreecommitdiffstats
path: root/sigencore/plugins/CanvasPlugin.h
blob: 2ca4c18ca4d80ba1468a31dda741d6c02f338ff5 (plain)
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
/*
 * Copyright 2009 Ben Boeckel <MathStuf@gmail.com>
 * 
 * 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 3 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, see <http://www.gnu.org/licenses/>.
 */

#ifndef SIGENCOREINTERFACES_CANVASPLUGIN
#define SIGENCOREINTERFACES_CANVASPLUGIN

// Plugin includes
#include "Global.h"

// KDE includes
#include <KPluginFactory>

// Qt includes
#include <QtCore/QStringList>
#include <QtCore/QVariantList>
#include <QtGui/QIcon>

// Forward declarations
namespace Sigscript
{
class Config;
class GameWrapper;
}

namespace Sigencore
{
class Canvas;

namespace Interfaces
{
class SIGENCOREPLUGINS_EXPORT CanvasPlugin : public QObject
{
    Q_OBJECT
    
    public:
        CanvasPlugin(QObject* parent, const QVariantList& args);
        virtual ~CanvasPlugin();
        
        Canvas* getCanvas(const QString& name, Sigscript::GameWrapper* game, Sigscript::Config* parent);
        
        virtual QStringList canvases() const = 0;
        virtual QString description(const QString& name) const = 0;
        virtual QIcon icon(const QString& name) = 0;
    protected:
        virtual Canvas* createCanvas(const QString& name, Sigscript::GameWrapper* game, Sigscript::Config* parent) = 0;
    protected slots:
        virtual void cleanupCanvas(Sigencore::Canvas* arena) = 0;
    private:
        class Private;
        Private* const d;
};
}
}

#define SIGEN_CANVAS_PLUGIN(type, name) \
    K_PLUGIN_FACTORY(CanvasFactory, registerPlugin<type>();) \
    K_EXPORT_PLUGIN(CanvasFactory(name))
#define SIGEN_CANVAS_PLUGIN_VERSION(type, name, version) \
    SIGEN_CANVAS_PLUGIN(type, name) \
    K_EXPORT_PLUGIN_VERSION(version)

#endif