textdocument.h 2.57 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
2
**
hjk's avatar
hjk committed
3
4
** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
5
**
hjk's avatar
hjk committed
6
** This file is part of Qt Creator.
7
**
hjk's avatar
hjk committed
8
9
10
11
12
13
14
** 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.
15
16
**
** GNU Lesser General Public License Usage
hjk's avatar
hjk committed
17
18
19
20
21
22
23
24
25
** 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
26
27
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
28
****************************************************************************/
29

30
31
#ifndef CORE_TEXTDOCUMENT_H
#define CORE_TEXTDOCUMENT_H
32

33
#include "idocument.h"
34
35
36
37
38
39

#include <utils/textfileformat.h>

namespace Core {

namespace Internal {
40
class TextDocumentPrivate;
41
42
}

43
class CORE_EXPORT TextDocument : public IDocument
44
45
46
47
48
{
    Q_OBJECT
public:
    typedef Utils::TextFileFormat::ReadResult ReadResult;

49
50
    explicit TextDocument(QObject *parent = 0);
    virtual ~TextDocument();
51
52
53
54

    Utils::TextFileFormat format() const;
    const QTextCodec *codec() const;
    void setCodec(const QTextCodec *);
55
    void switchUtf8Bom();
56
    virtual bool supportsUtf8Bom() { return true; }
57
58
59
60
61
62
63
64
65
66
67

    ReadResult read(const QString &fileName, QStringList *plainTextList, QString *errorString);
    ReadResult read(const QString &fileName, QString *plainText, QString *errorString);

    bool hasDecodingError() const;
    QByteArray decodingErrorSample() const;

    bool write(const QString &fileName, const QString &data, QString *errorMessage) const;
    bool write(const QString &fileName, const Utils::TextFileFormat &format, const QString &data, QString *errorMessage) const;

private:
68
    Internal::TextDocumentPrivate *d;
69
70
71
72
};

} // namespace Core

73
#endif // CORE_TEXTDOCUMENT_H