Rename IFile->IDocument and FileManager->DocumentManager

And adapt the other API respectively.

Change-Id: I1e04e555409be09242db6890f9e013396f83aeed
Reviewed-by: Bill King <bill.king@nokia.com>
Reviewed-by: Eike Ziller <eike.ziller@nokia.com>

1 files changed, 129 insertions, 0 deletions

diff --git a/src/plugins/coreplugin/idocument.h b/src/plugins/coreplugin/idocument.h
new file mode 100644
index 0000000000..8a2716d398
--- /dev/null
+++ b/src/plugins/coreplugin/idocument.h
@@ -0,0 +1,129 @@
+/**************************************************************************
+**
+** This file is part of Qt Creator
+**
+** Copyright (c) 2012 Nokia Corporation and/or its subsidiary(-ies).
+**
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+**
+** GNU Lesser General Public License Usage
+**
+** 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, Nokia gives you certain additional
+** rights. These rights are described in the Nokia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** Other Usage
+**
+** Alternatively, this file may be used in accordance with the terms and
+** conditions contained in a signed written agreement between you and Nokia.
+**
+** If you have questions regarding the use of this file, please contact
+** Nokia at qt-info@nokia.com.
+**
+**************************************************************************/
+
+#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 QString fileName() const = 0;
+    virtual bool isFileReadOnly() const;
+
+    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 rename(const QString &newName) = 0;
+
+    virtual void checkPermissions();
+
+    bool autoSave(QString *errorString, const QString &fileName);
+    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 reloaded();
+
+private:
+    QString m_autoSaveName;
+    InfoBar *m_infoBar;
+    bool m_hasWriteWarning;
+    bool m_restored;
+};
+
+} // namespace Core
+
+#endif // IDOCUMENT_H