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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
|
/* 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 KOINLINEOBJECTFACTORY_H
#define KOINLINEOBJECTFACTORY_H
#include <QString>
#include <QVector>
#include "kotext_export.h"
class KoInlineObject;
class InlineObjectFactoryPrivate;
class KoProperties;
/// A template used in the KoInlineObjectFactoryBase
struct KOTEXT_EXPORT KoInlineObjectTemplate {
QString id; ///< The id of the inlineObject
QString name; ///< The name to be shown for this template
/**
* The properties which, when passed to the KoInlineObjectFactoryBase::createInlineObject() method
* result in the object this template represents.
*/
const KoProperties *properties;
};
Q_DECLARE_TYPEINFO(KoInlineObjectTemplate, Q_MOVABLE_TYPE);
/**
* A factory for inline text objects. There should be one for each plugin type to
* allow the creation of the inlineObject from that plugin.
* The factory additionally has information to allow showing a menu entry for user
* access to the object-type.
* @see KoInlineObjectRegistry
*/
class KOTEXT_EXPORT KoInlineObjectFactoryBase
{
public:
/// The type of inlineObject this factory creates.
enum ObjectType {
TextVariable, ///< The factory creates KoVariable inheriting objects.
Other = 0x100 ///< The factory creates objects that should not be shown in any menu
};
/**
* Create the new factory
* @param id a string that will be used internally for referencing the variable-type.
* @param type the factory type.
*/
KoInlineObjectFactoryBase(const QString &id, ObjectType type);
virtual ~KoInlineObjectFactoryBase();
/**
* Create a new instance of an inline object.
*/
virtual KoInlineObject *createInlineObject(const KoProperties *properties = 0) const = 0;
/**
* return the id for the variable this factory creates.
* @return the id for the variable this factory creates.
*/
QString id() const;
/**
* Returns the type of object this factory creates.
* The main purpose is to group plugins per type in, for example, a menu.
*/
ObjectType type() const;
/**
* Return all the templates this factory knows about.
* Each template shows a different way to create an object this factory is specialized in.
*/
QVector<KoInlineObjectTemplate> templates() const;
QStringList odfElementNames() const;
QString odfNameSpace() const;
void setOdfElementNames(const QString &nameSpace, const QStringList &names);
protected:
/**
* Add a template with the properties of a specific type of object this factory can generate
* using the createInlineObject() method.
* @param params The new template this factory knows to produce
*/
void addTemplate(const KoInlineObjectTemplate ¶ms);
private:
InlineObjectFactoryPrivate * const d;
};
#endif
|
