TextFileFormat 类

class Utils::TextFileFormat

TextFileFormat 类描述文本文件的格式并提供自动检测。更多...

头文件	#include <TextFileFormat>

所有成员的列表，包括继承的成员

公共函数

bool	decode(const QByteArray &data, QString *target) const
bool	decode(const QByteArray &data, QStringList *target) const
bool	writeFile(const Utils::FilePath &filePath, QString plainText, QString *errorString) const

静态公共成员

QByteArray	decodingErrorSample(const QByteArray &data)
Utils::TextFileFormat	detect(const QByteArray &data)
Utils::TextFileFormat::ReadResult	readFile(const Utils::FilePath &filePath, const QTextCodec *defaultCodec, QStringList *plainTextList, Utils::TextFileFormat *format, QString *errorString, QByteArray *decodingErrorSample = nullptr)
Utils::TextFileFormat::ReadResult	readFile(const Utils::FilePath &filePath, const QTextCodec *defaultCodec, QString *plainText, Utils::TextFileFormat *format, QString *errorString, QByteArray *decodingErrorSample = nullptr)

详细描述

该格式包括

由 QTextCodec 指针表示的编码
存在 UTF8 字节顺序标记 (BOM)
换行符存储约定

该类还提供了便利函数来读取文本文件，并将它们作为字符串或字符串列表返回，以及写入文件。

成员函数文档

bool TextFileFormat::decode(const QByteArray &data, QString **target*) const

将 data 解码为普通字符串，target。

bool TextFileFormat::decode(const QByteArray &data, QStringList **target*) const

将 data 解码为字符串列表，target。

用于加载大型文件的进度条

`[静态]` QByteArray TextFileFormat::decodingErrorSample(const QByteArray &data)

返回一个由 data 指定的文本段，适合用作编码错误的显示。

`[静态]` Utils::TextFileFormat TextFileFormat::detect(const QByteArray &data)

检测文本数据的格式。

`[静态]` Utils::TextFileFormat::ReadResult TextFileFormat::readFile(const Utils::FilePath &filePath, const QTextCodec **defaultCodec*, QStringList **plainTextList*, Utils::TextFileFormat **format*, QString **errorString*, QByteArray **decodingErrorSample* = nullptr)

从一个文本文件 filePath 中读取到字符串列表 plainTextList，使用 defaultCodec 和文本文件格式 format。

返回解码是否没有错误。如果发生错误，则返回错误消息 errorString 和样本错误 decodingErrorSample。

`[静态]` Utils::TextFileFormat::ReadResult TextFileFormat::readFile(const Utils::FilePath &filePath, const QTextCodec **defaultCodec*, QString **plainText*, Utils::TextFileFormat **format*, QString **errorString*, QByteArray **decodingErrorSample* = nullptr)

从一个文本文件 filePath 中读取到一个字符串 plainText，使用 defaultCodec 和文本文件格式 format。

返回解码是否没有错误。

bool TextFileFormat::writeFile(const Utils::FilePath &filePath, QString plainText, QString **errorString*) const

将文本写入一个字符串 filePath 中。

返回解码是否没有错误。如果发生错误，则返回错误消息 errorString。

TextFileFormat 类

公共函数

静态公共成员

详细描述

成员函数文档

bool TextFileFormat::decode(const QByteArray &data, QString *target) const

bool TextFileFormat::decode(const QByteArray &data, QStringList *target) const

[静态] QByteArray TextFileFormat::decodingErrorSample(const QByteArray &data)

[静态] Utils::TextFileFormat TextFileFormat::detect(const QByteArray &data)

[静态] Utils::TextFileFormat::ReadResult TextFileFormat::readFile(const Utils::FilePath &filePath, const QTextCodec *defaultCodec, QStringList *plainTextList, Utils::TextFileFormat *format, QString *errorString, QByteArray *decodingErrorSample = nullptr)

[静态] Utils::TextFileFormat::ReadResult TextFileFormat::readFile(const Utils::FilePath &filePath, const QTextCodec *defaultCodec, QString *plainText, Utils::TextFileFormat *format, QString *errorString, QByteArray *decodingErrorSample = nullptr)