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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
|
/*
* Copyright (c) 2011-2012 Boudewijn Rempt <boud@valdyas.org>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser 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 KOELEMENTREFERENCE_H
#define KOELEMENTREFERENCE_H
#include <QSharedDataPointer>
#include <QSharedData>
#include <QUuid>
#include "KoXmlReaderForward.h"
#include "koodf_export.h"
class KoXmlWriter;
class KoElementReferenceData : public QSharedData
{
public:
KoElementReferenceData()
{
xmlid = QUuid::createUuid().toString();
xmlid.remove('{');
xmlid.remove('}');
}
KoElementReferenceData(const KoElementReferenceData &other)
: QSharedData(other)
, xmlid(other.xmlid)
{
}
~KoElementReferenceData() {}
QString xmlid;
};
/**
* KoElementReference is used to store unique identifiers for elements in an odf document.
* Element references are saved as xml:id and optionally for compatibility also as draw:id
* and text:id.
*
* You can use element references wherever you would have used a QString to refer to the id
* of an object.
*
* Element references are implicitly shared, so you can and should pass them along by value.
*/
class KOODF_EXPORT KoElementReference
{
public:
enum GenerationOption {
UUID = 0,
Counter = 1
};
enum SaveOption {
XmlId = 0x0,
DrawId = 0x1,
TextId = 0x2
};
Q_DECLARE_FLAGS(SaveOptions, SaveOption)
KoElementReference();
explicit KoElementReference(const QString &prefix);
KoElementReference(const QString &prefix, int counter);
KoElementReference(const KoElementReference &other);
KoElementReference &operator=(const KoElementReference &rhs);
bool operator==(const KoElementReference &other) const;
bool operator!=(const KoElementReference &other) const;
/**
* @return true if the xmlid is valid, i.e., not null
*/
bool isValid() const;
/**
* @brief loadOdf creates a new KoElementReference from the given element. If the element
* does not have an xml:id, draw:id or text:id attribute, and invalid element reference
* is returned.
* @param element the element that may contain xml:id, text:id or draw:id. xml:id has
* priority.
* @return a new element reference
*/
KoElementReference loadOdf(const KoXmlElement &element);
/**
* @brief saveOdf saves this element reference into the currently open element in the xml writer.
* @param writer the writer we save to
* @param saveOption determines which attributes we save. We always save the xml:id.
*/
void saveOdf(KoXmlWriter *writer, SaveOption saveOption = XmlId) const;
/**
* @brief toString creates a QString from the element reference
* @return a string that represents the element. Can be used in maps etc.
*/
QString toString() const;
/**
* Invalidate the reference
*/
void invalidate();
private:
QSharedDataPointer<KoElementReferenceData> d;
};
Q_DECLARE_OPERATORS_FOR_FLAGS(KoElementReference::SaveOptions)
#endif // KOELEMENTREFERENCE_H
|
