Класс QPageLayout
Описывает размер, ориентацию и поля страницы. Подробнее...
| Заголовок: | #include <QPageLayout> |
| qmake: | QT += gui |
| С момента версии: | Qt 5.3 |
Открытые типы
| enum | Mode { StandardMode, FullPageMode } |
| enum | Orientation { Portrait, Landscape } |
| enum | Unit { Millimeter, Point, Inch, Pica, Didot, Cicero } |
Открытые функции
| QPageLayout() | |
| QPageLayout(const QPageSize &pageSize, QPageLayout::Orientation orientation, const QMarginsF &margins, QPageLayout::Unit units = Point, const QMarginsF &minMargins = QMarginsF(0, 0, 0, 0)) | |
| QPageLayout(const 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 |
| QPageLayout & | operator=(QPageLayout &&other) |
| QPageLayout & | operator=(const QPageLayout &other) |
Связанные внешние функции
| 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 градусов |
Обратите внимание, что некоторые стандартные размеры страниц определяются шириной, большей, чем высота, поэтому ориентация определяется относительно стандартного размера страницы, а не относительных размеров страницы.
enum 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()
Создаёт недопустимый QPageLayout.
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(const QPageLayout &other)
Конструктор копирования, копирует other в этот объект.
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().
QPageLayout &QPageLayout::operator=(QPageLayout &&other)
Оператор перемещаемого присваивания, присваивает other этому экземпляру QPageLayout, передавая владение управляемым указателем этому экземпляру.
QPageLayout &QPageLayout::operator=(const QPageLayout &other)
Оператор присваивания, присваивает other этому экземпляру.
Связанные нечлены
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-5.12/qpagelayout.html