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
|
/****************************************************************************
**
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of Qt Creator.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia. For licensing terms and
** conditions see http://qt.digia.com/licensing. For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights. These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/
#ifndef IDOCUMENT_H
#define IDOCUMENT_H
#include "core_global.h"
#include <QObject>
namespace Core {
class MimeType;
class InfoBar;
class CORE_EXPORT IDocument : public QObject
{
Q_OBJECT
public:
// This enum must match the indexes of the reloadBehavior widget
// in generalsettings.ui
enum ReloadSetting {
AlwaysAsk = 0,
ReloadUnmodified = 1,
IgnoreAll = 2
};
enum Utf8BomSetting {
AlwaysAdd = 0,
OnlyKeep = 1,
AlwaysDelete = 2
};
enum ChangeTrigger {
TriggerInternal,
TriggerExternal
};
enum ChangeType {
TypeContents,
TypePermissions,
TypeRemoved
};
enum ReloadBehavior {
BehaviorAsk,
BehaviorSilent
};
enum ReloadFlag {
FlagReload,
FlagIgnore
};
IDocument(QObject *parent = 0);
virtual ~IDocument();
virtual bool save(QString *errorString, const QString &fileName = QString(), bool autoSave = false) = 0;
virtual bool setContents(const QByteArray &contents);
QString filePath() const { return m_filePath; }
virtual void setFilePath(const QString &filePath);
QString displayName() const;
void setDisplayName(const QString &name);
virtual bool isFileReadOnly() const;
bool isTemporary() const;
void setTemporary(bool temporary);
virtual QString defaultPath() const = 0;
virtual QString suggestedFileName() const = 0;
virtual QString mimeType() const = 0;
virtual bool shouldAutoSave() const;
virtual bool isModified() const = 0;
virtual bool isSaveAsAllowed() const = 0;
virtual ReloadBehavior reloadBehavior(ChangeTrigger state, ChangeType type) const;
virtual bool reload(QString *errorString, ReloadFlag flag, ChangeType type) = 0;
virtual void checkPermissions();
bool autoSave(QString *errorString, const QString &filePath);
void setRestoredFrom(const QString &name);
void removeAutoSaveFile();
bool hasWriteWarning() const { return m_hasWriteWarning; }
void setWriteWarning(bool has) { m_hasWriteWarning = has; }
InfoBar *infoBar();
signals:
void changed();
void aboutToReload();
void reloadFinished(bool success);
void filePathChanged(const QString &oldName, const QString &newName);
private:
QString m_filePath;
QString m_displayName;
bool m_temporary;
QString m_autoSaveName;
InfoBar *m_infoBar;
bool m_hasWriteWarning;
bool m_restored;
};
} // namespace Core
#endif // IDOCUMENT_H
|
