BaseTextDocument Class | Extending Qt Creator Manual

Extending Qt Creator Manual | BaseTextDocument

Extending Qt Creator Manual 4.6.0

# BaseTextDocument Class

(Core::BaseTextDocument)

Inherits: | Core::IDocument

- List of all members, including inherited members

## Public Types

typedef | ReadResult

## Public Functions

| BaseTextDocument(QObject *parent = 0)
| ~BaseTextDocument() override
const QTextCodec * | codec() const
QByteArray | decodingErrorSample() const
Utils::TextFileFormat | format() const
bool | hasDecodingError() const
ReadResult | read(const QString &fileName, QStringList *plainTextList, QString *errorString)
ReadResult | read(const QString &fileName, QString *plainText, QString *errorString)
void | setCodec(const QTextCodec *)
void | setSupportsUtf8Bom(bool value)
bool | supportsUtf8Bom() const
void | switchUtf8Bom()
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

- 33 public functions inherited from Core::IDocument

### Additional Inherited Members

- 6 signals inherited from Core::IDocument

## Member Type Documentation

### typedef BaseTextDocument::ReadResult

## Member Function Documentation

### BaseTextDocument::BaseTextDocument(QObject *parent = 0)

Default constructs an instance of BaseTextDocument.

### BaseTextDocument::~BaseTextDocument()

Destroys the instance of BaseTextDocument.

### const QTextCodec *BaseTextDocument::codec() const

See also setCodec().

### QByteArray BaseTextDocument::decodingErrorSample() const

### Utils::TextFileFormat BaseTextDocument::format() const

### bool BaseTextDocument::hasDecodingError() const

### ReadResult BaseTextDocument::read(const QString &fileName, QStringList *plainTextList, QString *errorString)

### ReadResult BaseTextDocument::read(const QString &fileName, QString *plainText, QString *errorString)

### void BaseTextDocument::setCodec(const QTextCodec *)

See also codec().

### void BaseTextDocument::setSupportsUtf8Bom(bool value)

See also supportsUtf8Bom().

### bool BaseTextDocument::supportsUtf8Bom() const

See also setSupportsUtf8Bom().

### void BaseTextDocument::switchUtf8Bom()

### bool BaseTextDocument::write(const QString &fileName, const QString &data, QString *errorMessage) const

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