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
|
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
#pragma once
#include "core_global.h"
#include <utils/filepath.h>
#include <utils/id.h>
#include <QObject>
namespace Utils {
class InfoBar;
class MinimizableInfoBars;
} // namespace Utils
namespace Core {
namespace Internal {
class IDocumentPrivate;
}
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 ChangeTrigger {
TriggerInternal,
TriggerExternal
};
enum ChangeType {
TypeContents,
TypeRemoved
};
enum ReloadBehavior {
BehaviorAsk,
BehaviorSilent
};
enum ReloadFlag {
FlagReload,
FlagIgnore
};
enum class SaveOption { AutoSave, DisableFormatOnSave, None };
IDocument(QObject *parent = nullptr);
~IDocument() override;
void setId(Utils::Id id);
Utils::Id id() const;
virtual Utils::Result<> open(const Utils::FilePath &filePath, const Utils::FilePath &realFilePath);
Utils::Result<> save(const Utils::FilePath &filePath = {}, SaveOption option = SaveOption::None);
virtual QByteArray contents() const;
virtual Utils::Result<> setContents(const QByteArray &contents);
virtual void formatContents();
const Utils::FilePath &filePath() const;
virtual void setFilePath(const Utils::FilePath &filePath);
QString displayName() const;
void setPreferredDisplayName(const QString &name);
QString preferredDisplayName() const;
QString plainDisplayName() const;
void setUniqueDisplayName(const QString &name);
QString uniqueDisplayName() const;
QString toolTip() const;
bool isFileReadOnly() const;
bool isTemporary() const;
void setTemporary(bool temporary);
virtual Utils::FilePath fallbackSaveAsPath() const;
virtual QString fallbackSaveAsFileName() const;
QString mimeType() const;
void setMimeType(const QString &mimeType);
virtual bool shouldAutoSave() const;
virtual bool isModified() const;
virtual bool isSaveAsAllowed() const;
bool isSuspendAllowed() const;
void setSuspendAllowed(bool value);
virtual ReloadBehavior reloadBehavior(ChangeTrigger state, ChangeType type) const;
virtual Utils::Result<> reload(ReloadFlag flag, ChangeType type);
void checkPermissions();
Utils::Result<> autoSave(const Utils::FilePath &filePath);
void setRestoredFrom(const Utils::FilePath &path);
void removeAutoSaveFile();
bool hasWriteWarning() const;
void setWriteWarning(bool has);
Utils::InfoBar *infoBar();
Utils::MinimizableInfoBars *minimizableInfoBars();
signals:
// For meta data changes: file name, modified state, ...
void changed();
// For changes in the contents of the document
void contentsChanged();
void mimeTypeChanged();
void aboutToReload();
void reloadFinished(bool success);
void aboutToSave(const Utils::FilePath &filePath, SaveOption option);
void saved(const Utils::FilePath &filePath, SaveOption option);
void filePathChanged(const Utils::FilePath &oldName, const Utils::FilePath &newName);
protected:
virtual Utils::Result<> saveImpl(
const Utils::FilePath &filePath = {}, SaveOption option = SaveOption::None);
private:
Internal::IDocumentPrivate *d;
};
} // namespace Core
|
