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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
|
/* This file is part of the KDE project
Copyright (C) 1998, 1999 Torben Weis <weis@kde.org>
Copyright (C) 2000-2005 David Faure <faure@kde.org>
Copyright (C) 2007 Thorsten Zachmann <zachmann@kde.org>
Copyright (C) 2009 Boudewijn Rempt <boud@valdyas.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 KODOCUMENTBASE_H
#define KODOCUMENTBASE_H
class KoStore;
class KoOdfReadStore;
class KoOdfWriteStore;
class KoEmbeddedDocumentSaver;
class KoXmlElement;
class KoOdfLoadingContext;
class QUrl;
class QByteArray;
class QString;
#include "koodf_export.h"
/**
* Base class for documents that can load and save ODF. Most of the
* implementation is still in KoDocument, though that should probably
* change.
*/
class KOODF_EXPORT KoDocumentBase
{
public:
// context passed on saving to saveOdf
struct SavingContext {
SavingContext(KoOdfWriteStore &odfStore, KoEmbeddedDocumentSaver &embeddedSaver)
: odfStore(odfStore)
, embeddedSaver(embeddedSaver) {}
KoOdfWriteStore &odfStore;
KoEmbeddedDocumentSaver &embeddedSaver;
};
/**
* create a new KoDocumentBase
*/
KoDocumentBase();
/**
* delete this document
*/
virtual ~KoDocumentBase();
/**
* Set when you want an external embedded document to be stored internally
*/
void setStoreInternal(bool i);
/**
* @return true when external embedded documents are stored internally
*/
bool storeInternal() const;
/**
* Return true if url() is a real filename, false if url() is
* an internal url in the store, like "tar:/..."
*/
virtual bool isStoredExtern() const = 0;
/**
* @return the current URL
*/
virtual QUrl url() const = 0;
virtual void setUrl(const QUrl &url) = 0;
/**
* Returns the OASIS OpenDocument mimetype of the document, if supported
* This comes from the X-KDE-NativeOasisMimeType key in the .desktop file
*/
virtual QByteArray nativeOasisMimeType() const = 0;
/**
* @brief Saves a document to a store.
*/
virtual bool saveToStore(KoStore *store, const QString &path) = 0;
/**
* Reimplement this method to load the odf document. Take care to
* make sure styles are loaded before body text is loaded by the
* text shape.
*/
virtual bool loadOdf(KoOdfReadStore &odfStore) = 0;
/**
* Reimplement this method to save the contents of your %Calligra document,
* using the ODF format.
*/
virtual bool saveOdf(SavingContext &documentContext) = 0;
/**
* Checks whether the document is currently in the process of autosaving
*/
virtual bool isAutosaving() const = 0;
/**
* Returns true if this document or any of its internal child documents are modified.
*/
virtual bool isModified() const = 0;
/**
* @return true if the document is empty.
*/
virtual bool isEmpty() const = 0;
/**
* Returns the actual mimetype of the document
*/
virtual QByteArray mimeType() const = 0;
/**
* @brief Sets the mime type for the document.
*
* When choosing "save as" this is also the mime type
* selected by default.
*/
virtual void setMimeType(const QByteArray & mimeType) = 0;
virtual QString localFilePath() const = 0;
/**
* Return the set of SupportedSpecialFormats that the application wants to
* offer in the "Save" file dialog.
*/
virtual int supportedSpecialFormats() const = 0;
/// Enum values used by specialOutputFlag - note that it's a bitfield for supportedSpecialFormats
enum { /*SaveAsCalligra1dot1 = 1,*/ // old and removed
SaveAsDirectoryStore = 2,
SaveAsFlatXML = 4,
SaveEncrypted = 8
// bitfield! next value is 16
};
virtual int specialOutputFlag() const = 0;
/**
* @brief Set the format in which the document should be saved.
*
* This is called on loading, and in "save as", so you shouldn't
* have to call it.
*
* @param mimeType the mime type (format) to use.
* @param specialOutputFlag is for "save as older version" etc.
*/
virtual void setOutputMimeType(const QByteArray & mimeType, int specialOutputFlag = 0) = 0;
virtual QByteArray outputMimeType() const = 0;
/**
* Sets the document URL to empty URL
* KParts doesn't allow this, but %Calligra apps have e.g. templates
* After using loadNativeFormat on a template, one wants
* to set the url to QUrl()
*/
virtual void resetURL() = 0;
/// Re-implement to load odf document from @p store
virtual bool loadOasisFromStore(KoStore *store) = 0;
private:
class Private;
Private *const d;
};
#endif
|
