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
|
/* This file is part of the KDE project
* Copyright (C) 2006 Thomas Zander <zander@kde.org>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library 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 Library 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 _KO_SHAPE_CONFIG_FACTORY_
#define _KO_SHAPE_CONFIG_FACTORY_
#include "flake_export.h"
#include <QString>
class KoShape;
class KoShapeConfigWidgetBase;
/**
* A factory that creates config panels (widgets) for just a created shape.
* The KoCreateShapesTool is able to show a number of configuration panels after
* it created a shape via user interaction. Each shape configuration panel type
* has its own factory, which will inherit from this class.
* @see KoShapeFactoryBase::panelFactories()
* @see KoShapeConfigWidgetBase
*/
class FLAKE_EXPORT KoShapeConfigFactoryBase
{
public:
/// default constructor
KoShapeConfigFactoryBase();
virtual ~KoShapeConfigFactoryBase();
/**
* create a new config widget, intialized with the param shape
* @param shape the shape that will be configured in the config widget.
* @see KoShapeConfigWidgetBase::open()
*/
virtual KoShapeConfigWidgetBase *createConfigWidget(KoShape *shape) = 0;
/// return the (translated) name of this configuration
virtual QString name() const = 0;
/**
* Return a sorting ordering to specify where in the list of config widgets this
* one will be shown.
* Higher sorting numbers will be shown first. The default is 1.
*/
virtual int sortingOrder() const {
return 1;
}
/**
* Return true if the createConfigWidget() should be called at all for a shape of
* the specified type.
* @param id an ID like the KoShapeFactoryBase::shapeId()
*/
virtual bool showForShapeId(const QString &id) const {
Q_UNUSED(id); return true;
}
/// \internal a compare for sorting.
static bool compare(KoShapeConfigFactoryBase *f1, KoShapeConfigFactoryBase *f2) {
return f1->sortingOrder() - f2->sortingOrder() > 0;
}
};
#endif
|
