Класс QPdfWriter

Класс QPdfWriter — это класс для генерации PDF-файлов, которые могут использоваться как устройство для рисования. Подробнее...

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

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

Переопределённые открытые функции

Переопределённые защищённые функции

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

QPdfWriter генерирует PDF на основе последовательности команд рисования, используя QPainter. Метод newPage() может использоваться для создания нескольких страниц.

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

QPdfWriter::QPdfWriter(QIODevice *device)

Создаёт создатель PDF-файла, который будет записывать PDF в device.

QPdfWriter::QPdfWriter(const QString &filename)

Создаёт создатель PDF-файла, который будет записывать PDF в filename.

[virtual] QPdfWriter::~QPdfWriter()

Уничтожает создатель PDF-файла.

void QPdfWriter::addFileAttachment(const QString &fileName, const QByteArray &data, const QString &mimeType = QString())

Добавляет вложение fileName в PDF с (необязательным) mimeType. data содержит исходные данные файла для встраивания в PDF-файл.

Эта функция была добавлена в Qt 5.15.

QString QPdfWriter::creator() const

Возвращает создателя документа.

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

QByteArray QPdfWriter::documentXmpMetadata() const

Получает метаданные документа, как они были предоставлены вызовом setDocumentXmpMetadata. Он не вернёт стандартные метаданные.

Эта функция была добавлена в Qt 5.15.

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

[override virtual] bool QPdfWriter::newPage()

Реализация: QPagedPaintDevice::newPage().

QPageLayout QPdfWriter::pageLayout() const

Возвращает текущую компоновку страницы. Используйте этот метод для доступа к текущему QPageSize, QPageLayout::Orientation, QMarginsF, fullRect() и paintRect().

Обратите внимание, что вы не можете использовать методы установки для возвращённого объекта; вы должны либо вызвать отдельные методы QPdfWriter, либо использовать setPageLayout().

Эта функция была добавлена в Qt 5.3.

См. также setPageLayout(), setPageSize(), setPageOrientation() и setPageMargins().

[override virtual protected] QPaintEngine *QPdfWriter::paintEngine() const

Реализация: QPaintDevice::paintEngine() const.

QPagedPaintDevice::PdfVersion QPdfWriter::pdfVersion() const

Возвращает версию PDF для данного создателя. По умолчанию PdfVersion_1_4.

Эта функция была добавлена в Qt 5.10.

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

int QPdfWriter::resolution() const

Возвращает разрешение PDF в точках на дюйм (DPI).

Эта функция была добавлена в Qt 5.3.

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

void QPdfWriter::setCreator(const QString &creator)

Устанавливает создателя документа на creator.

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

void QPdfWriter::setDocumentXmpMetadata(const QByteArray &xmpMetadata)

Устанавливает метаданные документа. Эти метаданные не зависят от методов setTitle / setCreator, поэтому пользователю необходимо поддерживать их согласованность. xmpMetadata содержит метаданные в формате XML для встраивания в PDF-файл.

Эта функция была добавлена в Qt 5.15.

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

bool QPdfWriter::setPageLayout(const QPageLayout &newPageLayout)

Устанавливает макет страницы PDF на newPageLayout.

Вы должны вызвать эту функцию перед вызовом QPainter::begin() или непосредственно перед вызовом newPage(), чтобы применить новый макет страницы к новой странице. Не следует вызывать какие-либо методы рисования между вызовом setPageLayout() и newPage(), так как могут быть использованы неправильные метрики рисования.

Возвращает true, если макет страницы был успешно установлен на newPageLayout.

Функция была добавлена в Qt 5.3.

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

bool QPdfWriter::setPageMargins(const QMarginsF &margins)

Устанавливает поля страницы PDF margins в текущих единицах макета страницы.

Вы должны вызвать эту функцию перед вызовом QPainter::begin() или непосредственно перед вызовом newPage(), чтобы применить новые поля к новой странице. Не следует вызывать какие-либо методы рисования между вызовом setPageMargins() и newPage(), так как могут быть использованы неправильные метрики рисования.

Для получения текущих полей страницы используйте pageLayout().pageMargins().

Возвращает true, если поля страницы были успешно установлены на margins.

Функция была добавлена в Qt 5.3.

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

bool QPdfWriter::setPageMargins(const QMarginsF &margins, QPageLayout::Unit units)

Устанавливает поля страницы PDF margins, заданные в указанных units.

Вы должны вызвать эту функцию перед вызовом QPainter::begin() или непосредственно перед вызовом newPage(), чтобы применить новые поля к новой странице. Не следует вызывать какие-либо методы рисования между вызовом setPageMargins() и newPage(), так как могут быть использованы неправильные метрики рисования.

Для получения текущих полей страницы используйте pageLayout().pageMargins().

Возвращает true, если поля страницы были успешно установлены на margins.

Функция была добавлена в Qt 5.3.

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

bool QPdfWriter::setPageOrientation(QPageLayout::Orientation orientation)

Устанавливает ориентацию страницы PDF.

Ориентация страницы используется для определения ориентации размера страницы при получении прямоугольника страницы.

Вы должны вызвать эту функцию перед вызовом QPainter::begin() или непосредственно перед вызовом newPage(), чтобы применить новую ориентацию к новой странице. Не следует вызывать какие-либо методы рисования между вызовом setPageOrientation() и newPage(), так как могут быть использованы неправильные метрики рисования.

Для получения текущей ориентации QPageLayout::Orientation используйте pageLayout().pageOrientation().

Возвращает true, если ориентация страницы была успешно установлена на orientation.

Функция была добавлена в Qt 5.3.

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

bool QPdfWriter::setPageSize(const QPageSize &pageSize)

Устанавливает размер страницы PDF на pageSize.

Для получения текущего размера QPageSize используйте pageLayout().pageSize().

Вы должны вызвать эту функцию перед вызовом QPainter::begin() или непосредственно перед вызовом newPage(), чтобы применить новый размер страницы к новой странице. Не следует вызывать какие-либо методы рисования между вызовом setPageSize() и newPage(), так как могут быть использованы неправильные метрики рисования.

Возвращает true, если размер страницы был успешно установлен на pageSize.

Функция была добавлена в Qt 5.3.

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

void QPdfWriter::setPdfVersion(QPagedPaintDevice::PdfVersion version)

Устанавливает версию PDF для этого записывающего устройства на version.

Если version имеет то же значение, что и текущее значение, то никаких изменений не будет.

Функция была добавлена в Qt 5.10.

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

void QPdfWriter::setResolution(int resolution)

Устанавливает разрешение PDF в DPI.

Это значение влияет на систему координат, возвращаемую, например, QPainter::viewport().

Функция была добавлена в Qt 5.3.

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

void QPdfWriter::setTitle(const QString &title)

Устанавливает заголовок создаваемого документа на title.

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

QString QPdfWriter::title() const

Возвращает заголовок документа.

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