TextFileFormat Class
class Utils::TextFileFormatThe TextFileFormat class describes the format of a text file and provides autodetection. More...
Header: | #include <TextFileFormat> |
Public Functions
bool | decode(const QByteArray &data, QString *target) const |
bool | decode(const QByteArray &data, QStringList *target) const |
bool | writeFile(const FilePath &filePath, QString plainText, QString *errorString) const |
Static Public Members
QByteArray | decodingErrorSample(const QByteArray &data) |
TextFileFormat | detect(const QByteArray &data) |
ReadResult | readFile(const FilePath &filePath, const QTextCodec *defaultCodec, QStringList *plainTextList, TextFileFormat *format, QString *errorString, QByteArray *decodingErrorSample = nullptr) |
ReadResult | readFile(const FilePath &filePath, const QTextCodec *defaultCodec, QString *plainText, TextFileFormat *format, QString *errorString, QByteArray *decodingErrorSample = nullptr) |
Detailed Description
\inmodule
QtCreator
The format comprises
- Encoding represented by a pointer to a QTextCodec
- Presence of an UTF8 Byte Order Marker (BOM)
- Line feed storage convention
The class also provides convenience functions to read text files and return them as strings or string lists and to write out files.
Member Function Documentation
bool TextFileFormat::decode(const QByteArray &data, QString *target) const
Returns data decoded to a plain string, target.
bool TextFileFormat::decode(const QByteArray &data, QStringList *target) const
Returns data decoded to a list of strings, target.
Intended for use with progress bars loading large files.
[static]
QByteArray TextFileFormat::decodingErrorSample(const QByteArray &data)
Returns a piece of text specified by data suitable as display for an encoding error.
[static]
TextFileFormat TextFileFormat::detect(const QByteArray &data)
Detects the format of text data.
[static]
ReadResult TextFileFormat::readFile(const FilePath &filePath, const QTextCodec *defaultCodec, QStringList *plainTextList, TextFileFormat *format, QString *errorString, QByteArray *decodingErrorSample = nullptr)
Reads a text file from filePath into a list of strings, plainTextList using defaultCodec and text file format format.
Returns whether decoding was possible without errors. If errors occur, returns an error message, errorString and a sample error, decodingErrorSample.
[static]
ReadResult TextFileFormat::readFile(const FilePath &filePath, const QTextCodec *defaultCodec, QString *plainText, TextFileFormat *format, QString *errorString, QByteArray *decodingErrorSample = nullptr)
Reads a text file from filePath into a string, plainText using defaultCodec and text file format format.
Returns whether decoding was possible without errors.
bool TextFileFormat::writeFile(const FilePath &filePath, QString plainText, QString *errorString) const
Writes out a text file to filePath into a string, plainText.
Returns whether decoding was possible without errors. If errors occur, returns an error message, errorString.