forked from qt-creator/qt-creator
42e072f159
Similar to the InfoBar. The only thing that an editor implementation needs to do is to set a settings group and the possible info bars in the document constructor. And later call document->minimizableInfoBars()->setInfoVisible(id, visible) to manage the state. Change-Id: I23afb3639b70b1bfccd424579da018280a7fe2cb Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
158 lines
4.3 KiB
C++
158 lines
4.3 KiB
C++
/****************************************************************************
|
|
**
|
|
** Copyright (C) 2016 The Qt Company Ltd.
|
|
** Contact: https://www.qt.io/licensing/
|
|
**
|
|
** 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 The Qt Company. For licensing terms
|
|
** and conditions see https://www.qt.io/terms-conditions. For further
|
|
** information use the contact form at https://www.qt.io/contact-us.
|
|
**
|
|
** GNU General Public License Usage
|
|
** Alternatively, this file may be used under the terms of the GNU
|
|
** General Public License version 3 as published by the Free Software
|
|
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
|
|
** included in the packaging of this file. Please review the following
|
|
** information to ensure the GNU General Public License requirements will
|
|
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
|
|
**
|
|
****************************************************************************/
|
|
|
|
#pragma once
|
|
|
|
#include "core_global.h"
|
|
|
|
#include <utils/fileutils.h>
|
|
#include <utils/id.h>
|
|
|
|
#include <QObject>
|
|
|
|
namespace Utils {
|
|
class FilePath;
|
|
class InfoBar;
|
|
class MinimizableInfoBars;
|
|
} // namespace Utils
|
|
|
|
namespace Core {
|
|
|
|
namespace Internal {
|
|
class IDocumentPrivate;
|
|
}
|
|
|
|
class CORE_EXPORT IDocument : public QObject
|
|
{
|
|
Q_OBJECT
|
|
|
|
public:
|
|
enum class OpenResult {
|
|
Success,
|
|
ReadError,
|
|
CannotHandle
|
|
};
|
|
|
|
// 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
|
|
};
|
|
|
|
IDocument(QObject *parent = nullptr);
|
|
~IDocument() override;
|
|
|
|
void setId(Utils::Id id);
|
|
Utils::Id id() const;
|
|
|
|
virtual OpenResult open(QString *errorString, const Utils::FilePath &filePath, const Utils::FilePath &realFilePath);
|
|
|
|
virtual bool save(QString *errorString, const Utils::FilePath &filePath = Utils::FilePath(), bool autoSave = false);
|
|
|
|
virtual QByteArray contents() const;
|
|
virtual bool setContents(const QByteArray &contents);
|
|
|
|
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;
|
|
|
|
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 bool reload(QString *errorString, ReloadFlag flag, ChangeType type);
|
|
|
|
void checkPermissions();
|
|
|
|
bool autoSave(QString *errorString, 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 filePathChanged(const Utils::FilePath &oldName, const Utils::FilePath &newName);
|
|
|
|
private:
|
|
Internal::IDocumentPrivate *d;
|
|
};
|
|
|
|
} // namespace Core
|