basetextdocument.h 3.79 KB
Newer Older
1
/**************************************************************************
con's avatar
con committed
2 3 4
**
** This file is part of Qt Creator
**
con's avatar
con committed
5
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
con's avatar
con committed
6
**
7
** Contact: Nokia Corporation (qt-info@nokia.com)
con's avatar
con committed
8
**
con's avatar
con committed
9
** No Commercial Usage
10
**
con's avatar
con committed
11 12 13 14
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the Technology Preview License Agreement accompanying
** this package.
15
**
16
** GNU Lesser General Public License Usage
17
**
18 19 20 21 22 23
** 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.
24
**
con's avatar
con committed
25 26 27 28 29 30
** 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.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
con's avatar
con committed
31
**
32
**************************************************************************/
hjk's avatar
hjk committed
33

con's avatar
con committed
34 35 36 37 38
#ifndef BASETEXTDOCUMENT_H
#define BASETEXTDOCUMENT_H

#include "texteditor_global.h"

39 40
#include <coreplugin/ifile.h>

con's avatar
con committed
41 42 43 44 45 46
QT_BEGIN_NAMESPACE
class QTextCursor;
class QTextDocument;
QT_END_NAMESPACE

namespace TextEditor {
47 48 49
namespace Internal {
class DocumentMarker;
}
con's avatar
con committed
50

51 52 53
class ITextMarkable;
class StorageSettings;
class TabSettings;
54
class ExtraEncodingSettings;
55
class SyntaxHighlighter;
56
class BaseTextDocumentPrivate;
con's avatar
con committed
57

hjk's avatar
hjk committed
58
class TEXTEDITOR_EXPORT BaseTextDocument : public Core::IFile
con's avatar
con committed
59 60 61 62 63
{
    Q_OBJECT

public:
    BaseTextDocument();
64
    virtual ~BaseTextDocument();
con's avatar
con committed
65

66 67
    void setStorageSettings(const StorageSettings &storageSettings);
    void setTabSettings(const TabSettings &tabSettings);
68
    void setExtraEncodingSettings(const ExtraEncodingSettings &extraEncodingSettings);
con's avatar
con committed
69

70 71
    const StorageSettings &storageSettings() const;
    const TabSettings &tabSettings() const;
72
    const ExtraEncodingSettings &extraEncodingSettings() const;
73 74

    ITextMarkable *documentMarker() const;
con's avatar
con committed
75 76 77

    //IFile
    virtual bool save(const QString &fileName = QString());
78
    virtual QString fileName() const;
con's avatar
con committed
79 80
    virtual bool isReadOnly() const;
    virtual bool isModified() const;
81
    virtual bool isSaveAsAllowed() const;
82
    virtual void checkPermissions();
83 84
    ReloadBehavior reloadBehavior(ChangeTrigger state, ChangeType type) const;
    void reload(ReloadFlag flag, ChangeType type);
con's avatar
con committed
85 86
    virtual QString mimeType() const;
    void setMimeType(const QString &mt);
dt's avatar
dt committed
87
    virtual void rename(const QString &newName);
con's avatar
con committed
88

89 90
    virtual QString defaultPath() const;
    virtual QString suggestedFileName() const;
con's avatar
con committed
91

92 93
    void setDefaultPath(const QString &defaultPath);
    void setSuggestedFileName(const QString &suggestedFileName);
con's avatar
con committed
94 95 96 97

    virtual bool open(const QString &fileName = QString());
    virtual void reload();

98
    QTextDocument *document() const;
99
    void setSyntaxHighlighter(SyntaxHighlighter *highlighter);
100
    SyntaxHighlighter *syntaxHighlighter() const;
con's avatar
con committed
101 102


103 104 105 106
    bool hasDecodingError() const;
    QTextCodec *codec() const;
    void setCodec(QTextCodec *c);
    QByteArray decodingErrorSample() const;
con's avatar
con committed
107 108 109

    void reload(QTextCodec *codec);

110
    void cleanWhitespace(const QTextCursor &cursor);
111

con's avatar
con committed
112 113 114 115
signals:
    void titleChanged(QString title);

private:
116
    void cleanWhitespace(QTextCursor& cursor, bool cleanIndentation, bool inEntireDocument);
con's avatar
con committed
117
    void ensureFinalNewLine(QTextCursor& cursor);
118
    void documentClosing();
119 120

    BaseTextDocumentPrivate *d;
con's avatar
con committed
121 122 123 124
};

} // namespace TextEditor

hjk's avatar
hjk committed
125
#endif // BASETEXTDOCUMENT_H