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-2009 Thomas Zander <zander@kde.org>
* Copyright (C) 2008 Thorsten Zachmann <zachmann@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 __KOVARIABLE_H__
#define __KOVARIABLE_H__
// Calligra libs
#include "KoInlineObject.h"
#include "kritatext_export.h"
class KoProperties;
class QWidget;
class KoVariableManager;
class KoVariablePrivate;
/**
* Base class for in-text variables.
*
* A variable is a field inserted into the text and the content is set to a specific value that
* is used as text. This class is pretty boring in that it has just a setValue() to alter the
* text shown; we depend on plugin writers to create more exciting ways to update variables.
*/
class KRITATEXT_EXPORT KoVariable : public KoInlineObject
{
Q_OBJECT
public:
/**
* Constructor.
*/
explicit KoVariable(bool propertyChangeListener = false);
virtual ~KoVariable();
/**
* The new value this variable will show.
* Will be used at the next repaint.
* @param value the new value this variable shows.
*/
void setValue(const QString &value);
/// @return the current value of this variable.
QString value() const;
/**
* Shortly after instantiating this variable the factory should set the
* properties using this method.
* Note that the loading mechanism will fill this properties object with the
* attributes from the ODF file (if applicable), so it would be useful to synchronize
* the property names based on that.
*/
virtual void setProperties(const KoProperties *props) {
Q_UNUSED(props);
}
/**
* If this variable has user-editable options it should provide a widget that is capable
* of manipulating these options so the text-tool can use it to show that to the user.
* Note that all manipulations should have a direct effect on the variable itself.
*/
virtual QWidget *createOptionsWidget() {
return 0;
}
protected:
/**
* This hook is called whenever the variable gets a new position.
* If this is a type of variable that needs to change its value based on that
* you should implement this method and act on it.
*/
virtual void variableMoved(const QTextDocument *document, int posInDocument);
friend class KoVariableManager;
/**
* return the last known position in the document. Note that if the variable has not yet been layouted,
* it does not know the position.
*/
int positionInDocument() const;
/// reimplemented
void resize(const QTextDocument *document, QTextInlineObject &object,
int posInDocument, const QTextCharFormat &format, QPaintDevice *pd);
private:
void updatePosition(const QTextDocument *document,
int posInDocument, const QTextCharFormat &format);
void paint(QPainter &painter, QPaintDevice *pd, const QTextDocument *document,
const QRectF &rect, const QTextInlineObject &object, int posInDocument, const QTextCharFormat &format);
private Q_SLOTS:
void documentDestroyed();
private:
Q_DECLARE_PRIVATE(KoVariable)
};
#endif
|
