Класс QPageLayout

Описывает размер, ориентацию и поля страницы. Подробнее...

Этот класс был введен в Qt 5.3.

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

Открытые типы

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

Связанные внешние функции

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

Класс QPageLayout определяет макет страницы в документе с постраничной разбивкой, при этом размер страницы, ориентация и поля могут быть установлены, а полные прямоугольники страницы и области печати, определяемые этими атрибутами, могут быть запрошены в различных единицах измерения.

Размер страницы определяется классом QPageSize, у которого можно запрашивать атрибуты размера страницы. Обратите внимание, что сам QPageSize всегда определяется в книжной ориентации.

Минимальные поля могут быть определены для макета, но обычно по умолчанию равны 0. При использовании совместно с поддержкой печати Qt минимальные поля будут отражать минимальную область печати, определяемую принтером.

В режиме StandardMode по умолчанию всегда учитываются текущие поля и минимальные поля. Прямоугольник печати — это полный прямоугольник страницы за вычетом текущих полей, а текущие поля могут быть установлены только в значения между минимальными и максимальными полями, разрешенными полным размером страницы.

В режиме FullPageMode текущие поля и минимальные поля не учитываются. Прямоугольник печати — это полный прямоугольник страницы, а текущие поля могут быть установлены в любые значения, независимо от минимальных полей и размера страницы.

См. также QPageSize.

Описание типа члена

enum QPageLayout::Mode

Определяет режим макета страницы

enum QPageLayout::Orientation

Этот перечисляемый тип определяет ориентацию страницы

Обратите внимание, что некоторые стандартные размеры страниц определены с шириной, большей, чем высота, поэтому ориентация определяется относительно стандартного размера страницы, а не с использованием относительных размеров страницы.

enum QPageLayout::Unit

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

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

QPageLayout::QPageLayout(const QPageLayout &other)

Конструктор копирования, копирует other в этот объект.

QPageLayout::QPageLayout(const QPageSize &pageSize, QPageLayout::Orientation orientation, const QMarginsF &margins, QPageLayout::Unit units = Point, const QMarginsF &minMargins = QMarginsF(0, 0, 0, 0))

Создает QPageLayout с заданным pageSize, orientation и margins в заданных units.

Допускается опциональное определение минимальных разрешенных отступов minMargins, например, минимальных отступов, которые может печатать физическое устройство печати.

Созданный QPageLayout будет в режиме StandardMode.

Указанные margins будут ограничены минимальными и максимальными отступами, разрешенными размером страницы.

QPageLayout::QPageLayout()

Создаёт невалидный QPageLayout.

QPageLayout &QPageLayout::operator=(const QPageLayout &other)

Оператор присваивания, присваивает other этому объекту.

QPageLayout &QPageLayout::operator=(QPageLayout &&other)

Перемещающее присваивание, присваивает other этому экземпляру QPageLayout, передавая владение управляемым указателем этому экземпляру.

QPageLayout::~QPageLayout()

Уничтожает макет страницы.

QRectF QPageLayout::fullRect() const

Возвращает полную область страницы в текущих единицах измерения макета.

Область страницы учитывает размер и ориентацию страницы, но не отступы страницы.

См. также paintRect() и units().

QRectF QPageLayout::fullRect(QPageLayout::Unit units) const

Возвращает полную область страницы в требуемых units.

Область страницы учитывает размер и ориентацию страницы, но не отступы страницы.

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

QRect QPageLayout::fullRectPixels(int resolution) const

Возвращает полную область страницы в пикселях устройства для заданного resolution.

Область страницы учитывает размер и ориентацию страницы, но не отступы страницы.

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

QRect QPageLayout::fullRectPoints() const

Возвращает полную область страницы в Postscript Points (1/72 дюйма).

Область страницы учитывает размер и ориентацию страницы, но не отступы страницы.

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

bool QPageLayout::isEquivalentTo(const QPageLayout &other) const

Возвращает true, если макет этой страницы эквивалентен макету страницы other, т.е. если страница имеет тот же размер, отступы и ориентацию.

bool QPageLayout::isValid() const

Возвращает true, если макет страницы валиден.

QMarginsF QPageLayout::margins() const

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

См. также setMargins() и units().

QMarginsF QPageLayout::margins(QPageLayout::Unit units) const

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

См. также setMargins() и margins().

QMargins QPageLayout::marginsPixels(int resolution) const

Возвращает отступы макета страницы в пикселях устройства для заданного resolution.

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

QMargins QPageLayout::marginsPoints() const

Возвращает отступы макета страницы в Postscript Points (1/72 дюйма).

См. также setMargins() и margins().

QMarginsF QPageLayout::maximumMargins() const

Возвращает максимальные отступы, которые будут применены, если макет страницы находится в режиме StandardMode.

Максимальные разрешённые отступы вычисляются как полный размер страницы минус минимальные установленные отступы. Например, если ширина страницы составляет 100 пунктов, а минимальный правый отступ составляет 10 пунктов, то максимальный левый отступ будет 90 пунктов.

См. также setMinimumMargins() и minimumMargins().

QMarginsF QPageLayout::minimumMargins() const

Возвращает минимальные отступы макета страницы.

См. также setMinimumMargins() и maximumMargins().

QPageLayout::Mode QPageLayout::mode() const

Возвращает режим макета страницы.

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

QPageLayout::Orientation QPageLayout::orientation() const

Возвращает ориентацию страницы макета страницы.

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

QPageSize QPageLayout::pageSize() const

Возвращает размер страницы макета страницы.

Обратите внимание, что QPageSize всегда определён в портретном режиме. Чтобы получить размер, учитывающий установленную ориентацию, необходимо использовать fullRect().

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

QRectF QPageLayout::paintRect() const

Возвращает область страницы в текущих единицах измерения макета.

Рисуемая область учитывает размер страницы, ориентацию и отступы.

Если установлен режим FullPageMode, то возвращается fullRect(), и отступы необходимо управлять вручную.

QRectF QPageLayout::paintRect(QPageLayout::Unit units) const

Возвращает область страницы в необходимых units.

Рисуемая область учитывает размер страницы, ориентацию и отступы.

Если установлен режим FullPageMode, то возвращается fullRect(), и отступы необходимо управлять вручную.

QRect QPageLayout::paintRectPixels(int resolution) const

Возвращает рисуемую область в округленных пикселях устройства для заданного resolution.

Прямоугольник, который можно заполнить, учитывает размер страницы, ориентацию и поля.

Если установлен режим FullPageMode, то возвращается fullRect(), и поля необходимо управлять вручную.

QRect QPageLayout::paintRectPoints() const

Возвращает прямоугольник, который можно заполнить, в округленных постскриптовых пунктах (1/72 дюйма).

Прямоугольник, который можно заполнить, учитывает размер страницы, ориентацию и поля.

Если установлен режим FullPageMode, то возвращается fullRect(), и поля необходимо управлять вручную.

bool QPageLayout::setBottomMargin(qreal bottomMargin)

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

Используемые единицы определены для макета. Для использования других единиц сначала вызовите setUnits().

Если используется режим по умолчанию StandardMode, то новое поле должно находиться между минимальным установленным полем и максимальным полем, разрешенным размером страницы; в противном случае поле не будет установлено.

Если используется режим FullPageMode, то значения полей будут приняты.

См. также setMargins() и margins().

bool QPageLayout::setLeftMargin(qreal leftMargin)

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

Используемые единицы определены для макета. Для использования других единиц сначала вызовите setUnits().

Если используется режим по умолчанию StandardMode, то новое поле должно находиться между минимальным установленным полем и максимальным полем, разрешенным размером страницы; в противном случае поле не будет установлено.

Если используется режим FullPageMode, то значения полей будут приняты.

См. также setMargins() и margins().

bool QPageLayout::setMargins(const QMarginsF &margins)

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

Используемые единицы определены для макета. Для использования других единиц сначала вызовите setUnits().

Если используется режим по умолчанию StandardMode, то все новые поля должны находиться между минимальными установленным полем и максимальным полем, разрешенным размером страницы; в противном случае поля не будут установлены.

Если используется режим FullPageMode, то значения полей будут приняты.

См. также margins() и units().

void QPageLayout::setMinimumMargins(const QMarginsF &minMargins)

Устанавливает минимальные поля страницы макета страницы на minMargins.

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

Если установлен режим StandardMode, то существующие поля будут ограничены новым minMargins и максимальным полем, разрешенным размером страницы. Если установлен режим FullPageMode, то существующие поля останутся неизменными.

См. также minimumMargins() и setMargins().

void QPageLayout::setMode(QPageLayout::Mode mode)

Устанавливает режим макета страницы в mode.

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

void QPageLayout::setOrientation(QPageLayout::Orientation orientation)

Устанавливает ориентацию страницы макета страницы на orientation.

Изменение ориентации не влияет на текущие поля или минимальные поля.

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

void QPageLayout::setPageSize(const QPageSize &pageSize, const QMarginsF &minMargins = QMarginsF(0, 0, 0, 0))

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

Можно дополнительно определить минимальные разрешенные поля minMargins, например, минимальные поля, которые может распечатать физическое устройство печати, иначе минимальные поля будут по умолчанию равны 0.

Если установлен режим StandardMode, то существующие поля будут ограничены новыми минимальными полями и максимальными полями, разрешенными размером страницы. Если установлен режим FullPageMode, то существующие поля останутся неизменными.

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

bool QPageLayout::setRightMargin(qreal rightMargin)

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

Используемые единицы определены для макета. Для использования других единиц сначала вызовите setUnits().

Если используется режим по умолчанию StandardMode, то новое поле должно находиться между минимальным установленным полем и максимальным полем, разрешенным размером страницы; в противном случае поле не будет установлено.

Если используется режим FullPageMode, то значения полей будут приняты.

См. также setMargins() и margins().

bool QPageLayout::setTopMargin(qreal topMargin)

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

Используемые единицы определены для макета. Для использования других единиц сначала вызовите setUnits().

Если используется режим по умолчанию StandardMode, то новое поле должно находиться между минимальным установленным полем и максимальным полем, разрешенным размером страницы; в противном случае поле не будет установлено.

Если используется режим FullPageMode, то значения полей будут приняты.

См. также setMargins() и margins().

void QPageLayout::setUnits(QPageLayout::Unit units)

Устанавливает используемые units для определения макета страницы.

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

void QPageLayout::swap(QPageLayout &other)

Меняет местами этот макет страницы с other. Эта функция очень быстрая и никогда не терпит неудачу.

QPageLayout::Unit QPageLayout::units() const

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

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