Класс QTextDocumentWriter

Класс QTextDocumentWriter предоставляет независимый от формата интерфейс для записи QTextDocument в файлы или другие устройства. Подробнее...

• Список всех членов, включая унаследованные

Открытые функции

Статические открытые члены

Подробное описание

Для записи документа создайте объект QTextDocumentWriter, указав имя файла или объект устройства, а также формат документа для записи. Вы можете создать объект writer и задать формат позже с помощью setFormat().

Вызовите write() для записи документа в устройство. Если документ успешно записан, эта функция возвращает true. В противном случае, при возникновении ошибки при записи документа она вернет false.

Для получения списка поддерживаемых форматов вызовите supportedDocumentFormats().

Поскольку возможности поддерживаемых форматов вывода значительно различаются, writer просто выводит соответствующий подмножество объектов для каждого формата. Это обычно включает отформатированный текст и изображения, содержащиеся в документе.

Документация функций-членов

QTextDocumentWriter::QTextDocumentWriter(const QString &fileName, const QByteArray &format = QByteArray())

Создаёт объект QTextDocumentWriter, который будет записывать в файл с именем fileName, используя формат документа, указанный параметром format. Если format не указан, QTextDocumentWriter определит формат документа, проанализировав расширение fileName.

QTextDocumentWriter::QTextDocumentWriter(QIODevice *device, const QByteArray &format)

Создаёт объект QTextDocumentWriter для записи в заданное устройство device в формате документа format.

QTextDocumentWriter::QTextDocumentWriter()

Создаёт пустой объект QTextDocumentWriter. Перед записью вы должны вызвать setFormat() для установки формата документа, а затем setDevice() или setFileName().

QTextDocumentWriter::~QTextDocumentWriter()

Уничтожает объект QTextDocumentWriter.

QIODevice *QTextDocumentWriter::device() const

Возвращает текущее назначенное устройство или nullptr, если устройство не было назначено.

См. также setDevice().

QString QTextDocumentWriter::fileName() const

Если текущее назначенное устройство является QFile, или если была вызвана функция setFileName(), эта функция возвращает имя файла, в который будет записываться. Во всех остальных случаях возвращает пустую строку.

См. также setFileName() и setDevice().

QByteArray QTextDocumentWriter::format() const

Возвращает формат, используемый для записи документов.

См. также setFormat().

void QTextDocumentWriter::setDevice(QIODevice *device)

Устанавливает устройство writer в указанное device. Если устройство уже задано, старое устройство удаляется, но в остальном остается неизменным.

Если устройство ещё не открыто, QTextDocumentWriter попытается открыть устройство в режиме только записи, вызвав open().

Примечание: Это не сработает для некоторых устройств, таких как QProcess, QTcpSocket и QUdpSocket, где требуется некоторая конфигурация перед открытием устройства.

См. также device() и setFileName().

void QTextDocumentWriter::setFileName(const QString &fileName)

Устанавливает имя файла для записи в fileName. Внутренне, QTextDocumentWriter создаст QFile и откроет его в режиме только записи и будет использовать этот файл при записи документа.

См. также fileName() и setDevice().

void QTextDocumentWriter::setFormat(const QByteArray &format)

Устанавливает формат для записи документов в format. format — строка текста, нечувствительная к регистру. Например:

        QTextDocumentWriter writer;
        writer.setFormat("odf"); // same as writer.setFormat("ODF");

Вы можете вызвать supportedDocumentFormats() для получения полного списка форматов, поддерживаемых QTextDocumentWriter.

См. также format().

[static] QList<QByteArray> QTextDocumentWriter::supportedDocumentFormats()

Возвращает список форматов документов, поддерживаемых QTextDocumentWriter.

По умолчанию Qt может записывать следующие форматы:

См. также setFormat().

bool QTextDocumentWriter::write(const QTextDocument *document)

Записывает указанный document в назначенное устройство или файл и возвращает true при успехе; в противном случае возвращает false.

bool QTextDocumentWriter::write(const QTextDocumentFragment &fragment)

Записывает фрагмент документа, указанный параметром fragment, в назначенное устройство или файл и возвращает true при успехе; в противном случае возвращает false.