Класс 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 (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 (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

Возвращает прямоугольник, который можно рисовать, в округленных PostScript-точках (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().