Files
qt-creator/src/plugins/coreplugin/textdocument.h
David Schulz 665c090039 Core: filepathify IDocument
Change-Id: I364a80d070c5f90433309c281c4906ee101a1a1a
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2021-05-19 09:45:22 +00:00

70 lines
2.5 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 "idocument.h"
#include <utils/textfileformat.h>
namespace Core {
namespace Internal { class TextDocumentPrivate; }
class CORE_EXPORT BaseTextDocument : public IDocument
{
Q_OBJECT
public:
using ReadResult = Utils::TextFileFormat::ReadResult;
explicit BaseTextDocument(QObject *parent = nullptr);
~BaseTextDocument() override;
Utils::TextFileFormat format() const;
const QTextCodec *codec() const;
void setCodec(const QTextCodec *);
void switchUtf8Bom();
bool supportsUtf8Bom() const;
Utils::TextFileFormat::LineTerminationMode lineTerminationMode() const;
ReadResult read(const Utils::FilePath &filePath, QStringList *plainTextList, QString *errorString);
ReadResult read(const Utils::FilePath &filePath, QString *plainText, QString *errorString);
bool hasDecodingError() const;
QByteArray decodingErrorSample() const;
bool write(const Utils::FilePath &filePath, const QString &data, QString *errorMessage) const;
bool write(const Utils::FilePath &filePath, const Utils::TextFileFormat &format, const QString &data, QString *errorMessage) const;
void setSupportsUtf8Bom(bool value);
void setLineTerminationMode(Utils::TextFileFormat::LineTerminationMode mode);
private:
Internal::TextDocumentPrivate *d;
};
} // namespace Core