Spec-Zone.ru › Qt

Класс QPageLayout

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

Заголовок: #include <QPageLayout>
CMake: find_package(Qt6 COMPONENTS Gui REQUIRED) target_link_libraries(mytarget PRIVATE Qt6::Gui)
qmake: QT += gui
Начиная с: Qt 5.3
  • Список всех членов, включая унаследованные члены

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

enum Mode { StandardMode, FullPageMode }
enum Orientation { Portrait, Landscape }
enum Unit { Millimeter, Point, Inch, Pica, Didot, Cicero }

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

QPageLayout(const QPageLayout &other)
QPageLayout(const QPageSize &pageSize, QPageLayout::Orientation orientation, const QMarginsF &margins, QPageLayout::Unit units = Point, const QMarginsF &minMargins = QMarginsF(0, 0, 0, 0))
QPageLayout()
QPageLayout & operator=(const QPageLayout &other)
QPageLayout & operator=(QPageLayout &&other)
~QPageLayout()
QRectF fullRect() const
QRectF fullRect(QPageLayout::Unit units) const
QRect fullRectPixels(int resolution) const
QRect fullRectPoints() const
bool isEquivalentTo(const QPageLayout &other) const
bool isValid() const
QMarginsF margins() const
QMarginsF margins(QPageLayout::Unit units) const
QMargins marginsPixels(int resolution) const
QMargins marginsPoints() const
QMarginsF maximumMargins() const
QMarginsF minimumMargins() const
QPageLayout::Mode mode() const
QPageLayout::Orientation orientation() const
QPageSize pageSize() const
QRectF paintRect() const
QRectF paintRect(QPageLayout::Unit units) const
QRect paintRectPixels(int resolution) const
QRect paintRectPoints() const
bool setBottomMargin(qreal bottomMargin)
bool setLeftMargin(qreal leftMargin)
bool setMargins(const QMarginsF &margins)
void setMinimumMargins(const QMarginsF &minMargins)
void setMode(QPageLayout::Mode mode)
void setOrientation(QPageLayout::Orientation orientation)
void setPageSize(const QPageSize &pageSize, const QMarginsF &minMargins = QMarginsF(0, 0, 0, 0))
bool setRightMargin(qreal rightMargin)
bool setTopMargin(qreal topMargin)
void setUnits(QPageLayout::Unit units)
void swap(QPageLayout &other)
QPageLayout::Unit units() const

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

bool operator!=(const QPageLayout &lhs, const QPageLayout &rhs)
bool operator==(const QPageLayout &lhs, const QPageLayout &rhs)

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

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

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

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

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

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

См. также QPageSize.

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

enum QPageLayout::Mode

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

Константа Значение Описание
QPageLayout::StandardMode 0 Прямоугольник печати включает поля, поля должны находиться между минимальными и максимальными.
QPageLayout::FullPageMode 1 Прямоугольник печати исключает поля, поля могут иметь любое значение и должны управляться вручную.

enum QPageLayout::Orientation

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

Константа Значение Описание
QPageLayout::Portrait 0 Размер страницы используется в её стандартной ориентации
QPageLayout::Landscape 1 Размер страницы повернут на 90 градусов

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

Перечисление QPageLayout::Unit

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

Константа Значение Описание
QPageLayout::Millimeter 0
QPageLayout::Point 1 1/72 дюйма
QPageLayout::Inch 2
QPageLayout::Pica 3 1/72 фута, 1/6 дюйма, 12 пунктов
QPageLayout::Didot 4 1/72 французского дюйма, 0,375 мм
QPageLayout::Cicero 5 1/6 французского дюйма, 12 дидо, 4,5 мм

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

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().

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

bool operator!=(const QPageLayout &lhs, const QPageLayout &rhs)

Возвращает true если макет страницы lhs не равен макету страницы rhs, то есть если отличаются какие-либо атрибуты.

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

См. также QPageLayout::isEquivalentTo().

bool operator==(const QPageLayout &lhs, const QPageLayout &rhs)

Возвращает true если макет страницы lhs равен макету страницы rhs, то есть если все атрибуты точно равны.

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

См. также QPageLayout::isEquivalentTo().

© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-6.2/qpagelayout.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API