Класс 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, Orientation orientation, const QMarginsF &margins, Unit units = Point, const QMarginsF &minMargins = QMarginsF( 0, 0, 0, 0 )) | |
| QPageLayout(const QPageLayout &other) | |
| ~QPageLayout() | |
| QRectF | fullRect() const |
| QRectF | fullRect(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(Unit units) const |
| QMargins | marginsPixels(int resolution) const |
| QMargins | marginsPoints() const |
| QMarginsF | maximumMargins() const |
| QMarginsF | minimumMargins() const |
| Mode | mode() const |
| Orientation | orientation() const |
| QPageSize | pageSize() const |
| QRectF | paintRect() const |
| QRectF | paintRect(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(Mode mode) |
| void | setOrientation(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(Unit units) |
| void | swap(QPageLayout &other) |
| 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, Orientation orientation, const QMarginsF &margins, 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(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(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().
Mode QPageLayout::mode() const
Возвращает режим макета страницы.
См. также setMode().
Orientation QPageLayout::orientation() const
Возвращает ориентацию страницы макета страницы.
См. также setOrientation().
QPageSize QPageLayout::pageSize() const
Возвращает размер страницы макета страницы.
Обратите внимание, что QPageSize всегда определяется в портретной ориентации. Чтобы получить размер, который учитывает установленную ориентацию, необходимо использовать fullRect().
См. также setPageSize().
QRectF QPageLayout::paintRect() const
Возвращает прямоугольник страницы в текущих единицах макета.
Прямоугольник, на который можно рисовать, учитывает размер, ориентацию и отступы страницы.
Если установлен режим FullPageMode, то возвращается fullRect(), и отступы необходимо управлять вручную.
QRectF QPageLayout::paintRect(Unit units) const
Возвращает прямоугольник страницы в требуемых units.
Прямоугольник, на который можно рисовать, учитывает размер, ориентацию и отступы страницы.
Если установлен режим FullPageMode, то возвращается fullRect(), и отступы необходимо управлять вручную.
QRect QPageLayout::paintRectPixels(int resolution) const
Возвращает прямоугольник, на который можно рисовать, в округленных пикселях устройства для заданного resolution.
Прямоугольник, на который можно рисовать, учитывает размер, ориентацию и отступы страницы.
Если установлен режим FullPageMode, то возвращается fullRect(), и отступы необходимо управлять вручную.
QRect QPageLayout::paintRectPoints() const
Возвращает прямоугольник, на который можно рисовать, в округленных пунктах PostScript (1/72 дюйма).
Прямоугольник, на который можно рисовать, учитывает размер, ориентацию и отступы страницы.
Если установлен режим FullPageMode, то возвращается fullRect(), и отступы необходимо управлять вручную.
END_OF_DOCUMENT_MARKERbool 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(Mode mode)
Устанавливает режим макета страницы до mode.
См. также mode().
void QPageLayout::setOrientation(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(Unit units)
Устанавливает используемые units для определения макета страницы.
См. также units().
void QPageLayout::swap(QPageLayout &other)
Меняет местами текущий макет страницы с other. Эта функция очень быстрая и никогда не терпит неудачу.
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/archives/qt-5.6/qpagelayout.html