Core::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 19.0.0

# Core::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)
Utils::Result<> | write(const Utils::FilePath &filePath, const QString &data) const
Utils::Result<> | write(const Utils::FilePath &filePath, const Utils::TextFileFormat &format, const QString &data) 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)

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

Returns whether the operation was successful.

### Utils::Result<> BaseTextDocument::write(const Utils::FilePath &filePath, const QString &data) const

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

Returns whether the operation was successful.

### Utils::Result<> BaseTextDocument::write(const Utils::FilePath &filePath, const Utils::TextFileFormat &format, const QString &data) const

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

Returns whether the operation was successful.