BaseTextDocument Class | Extending Qt Creator Manual
Description: The BaseTextDocument class is a very general base class for documents that work with text.

- Extending Qt Creator Manual
- QtCreator
- BaseTextDocument
- Extending Qt Creator Manual 15.0.0

# BaseTextDocument Class

class Core::BaseTextDocument

The BaseTextDocument class is a very general base class for documents that work with text. More...

Header: | `#include <coreplugin/textdocument.h>`
Inherits: | Core::IDocument

- List of all members, including inherited members

## Public Functions

Utils::TextFileFormat | format() const
Core::BaseTextDocument::ReadResult | read(const Utils::FilePath &filePath, QString *plainText, QString *errorString)
Core::BaseTextDocument::ReadResult | read(const Utils::FilePath &filePath, QStringList *plainTextList, QString *errorString)
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

## Detailed Description

This class contains helper methods for saving and reading text files with encoding and line ending settings.

See also Utils::TextFileFormat.

## Member Function Documentation

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

Returns the format obtained from the last call to read().

### Core::BaseTextDocument::ReadResult BaseTextDocument::read(const Utils::FilePath &filePath, QString *plainText, QString *errorString)

Autodetects file format and reads the text file specified by filePath into plainText.

If an error occurs while writing the file, errorString is set to the error details.

Returns whether the operation was successful.

### Core::BaseTextDocument::ReadResult BaseTextDocument::read(const Utils::FilePath &filePath, QStringList *plainTextList, QString *errorString)

Autodetects file format and reads the text file specified by filePath into a list of strings specified by plainTextList.

If an error occurs while writing the file, errorString is set to the error details.

Returns whether the operation was successful.

### bool BaseTextDocument::write(const Utils::FilePath &filePath, const QString &data, QString *errorMessage) const

Writes out the contents (data) of the text file filePath. Uses the format obtained from the last read() of the file.

If an error occurs while writing the file, errorMessage is set to the error details.

Returns whether the operation was successful.

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

Writes out the contents (data) of the text file filePath. Uses the custom format format.

If an error occurs while writing the file, errorMessage is set to the error details.

Returns whether the operation was successful.