BaseTextDocument Class
(Core::BaseTextDocument)The BaseTextDocument class is a very general base class for documents that work with text. More...
Header: | #include <BaseTextDocument> |
Inherits: | Core::IDocument |
Public Functions
Utils::TextFileFormat | format() const |
Core::BaseTextDocument::ReadResult | read(const QString &fileName, QStringList *plainTextList, QString *errorString) |
Core::BaseTextDocument::ReadResult | read(const QString &fileName, QString *plainText, QString *errorString) |
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 |
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 QString &fileName, QStringList *plainTextList, QString *errorString)
Autodetects file format and reads the text file specified by fileName 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.
Core::BaseTextDocument::ReadResult BaseTextDocument::read(const QString &fileName, QString *plainText, QString *errorString)
Autodetects file format and reads the text file specified by fileName into plainText.
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 QString &fileName, const QString &data, QString *errorMessage) const
Writes out the contents (data) of the text file fileName. 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 QString &fileName, const Utils::TextFileFormat &format, const QString &data, QString *errorMessage) const
Writes out the contents (data) of the text file fileName. 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.