Класс QTextDocumentWriter

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

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

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

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

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

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

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

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

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

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

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

QTextDocumentWriter::QTextDocumentWriter()

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

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

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

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

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

QTextDocumentWriter::~QTextDocumentWriter()

Удаляет объект QTextDocumentWriter.

QTextCodec *QTextDocumentWriter::codec() const

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

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

QIODevice *QTextDocumentWriter::device() const

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

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

QString QTextDocumentWriter::fileName() const

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

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

QByteArray QTextDocumentWriter::format() const

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

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

void QTextDocumentWriter::setCodec(QTextCodec *codec)

Устанавливает кодек для этого потока в codec. Кодек используется для кодирования любых данных, которые записываются. По умолчанию QTextDocumentWriter использует UTF-8.

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

void QTextDocumentWriter::setDevice(QIODevice *device)

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

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

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

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

void QTextDocumentWriter::setFileName(const QString &fileName)

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

См. также 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.