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
|
/* This file is part of the KDE project
* Copyright (C) 2006-2007 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 KOINLINEOBJECTREGISTRY_H
#define KOINLINEOBJECTREGISTRY_H
#include <KoGenericRegistry.h>
#include <KoInlineObjectFactoryBase.h>
#include <KoXmlReaderForward.h>
#include "kotext_export.h"
#include <QList>
class KoCanvasBase;
class QAction;
class KoShapeLoadingContext;
/**
* This singleton class keeps a register of all available InlineObject factories.
* @see KoInlineObjectFactoryBase
* @see KoInlineTextObjectManager
* @see KoInlineObject
* @see KoVariable
*/
class KOTEXT_EXPORT KoInlineObjectRegistry : public KoGenericRegistry<KoInlineObjectFactoryBase*>
{
public:
KoInlineObjectRegistry();
~KoInlineObjectRegistry() override;
/**
* Return an instance of the KoInlineObjectRegistry
* Creates an instance if that has never happened before and returns the singleton instance.
*/
static KoInlineObjectRegistry *instance();
/**
* Create a list of actions that can be used to plug into a menu, for example.
* This method will find all the InlineObjectFactories that are installed in the system and
* find out which object they provide. If a factory provides a variable, then all its
* templates will be added to the response.
* Each of these actions, when executed, will insert the relevant variable in the current text-position.
* The actions assume that the text tool is selected, if that's not the case then they will silently fail.
* @param host the canvas for which these actions are created. Note that the actions will get these
* actions as a parent (for memory management purposes) as well.
* @see KoInlineTextObjectManager::createInsertVariableActions()
*/
QList<QAction*> createInsertVariableActions(KoCanvasBase *host) const;
/**
* Use the element to find out which variable plugin can load it, and returns the loaded
* variable. The element expected is one of 'text:subject', 'text:date' / etc.
*
* @returns the variable or 0 if no variable could be created
*/
KoInlineObject *createFromOdf(const KoXmlElement &element, KoShapeLoadingContext &context) const;
private:
KoInlineObjectRegistry(const KoInlineObjectRegistry&);
KoInlineObjectRegistry operator=(const KoInlineObjectRegistry&);
class Private;
Private * const d;
};
#endif
|
