Класс QPageLayout
Описывает размер, ориентацию и поля страницы. Подробнее...
| Заголовок: | #include <QPageLayout> |
| qmake: | QT += gui |
| С момента: | Qt 5.3 |
Типы публичного доступа
| перечисление | Mode { Стандартный режим, Режим всей страницы } |
| перечисление | Orientation { Портрет, Альбом } |
| перечисление | Unit { Миллиметр, Точка, Дюйм, Пика, Дидо, Цицеро } |
Функции публичного доступа
| 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 |
Связанные функции
| bool | operator!=(const QPageLayout &lhs, const QPageLayout &rhs) |
| bool | operator==(const QPageLayout &lhs, const QPageLayout &rhs) |
Подробное описание
Описывает размер, ориентацию и поля страницы.
Класс QPageLayout определяет макет страницы в документе с возможностью установки размера, ориентации и полей страницы, а также запроса прямоугольников полной страницы и области рисования в различных единицах.
Размер страницы определяется классом QPageSize, который можно запросить для получения атрибутов размера страницы. Обратите внимание, что сам QPageSize всегда определен в ориентации Портрет.
Минимальные поля могут быть определены для макета, но обычно по умолчанию равны 0. При использовании поддержки печати Qt минимальные поля отражают минимальную печатаемую область, определенную принтером.
В стандартном режиме (Стандартный режим) текущие поля и минимальные поля всегда учитываются. Область рисования — это прямоугольник полной страницы минус текущие поля, и текущие поля могут быть установлены только в значениях между минимальными полями и максимальными полями, разрешенными размером полной страницы.
В режиме всей страницы (Режим всей страницы) текущие поля и минимальные поля не учитываются. Область рисования — это прямоугольник полной страницы, и текущие поля могут быть установлены в любые значения независимо от минимальных полей и размера страницы.
См. также QPageSize.
Документация по типу члена
перечисление QPageLayout::Mode
Определяет режим макета страницы
| Постоянная | Значение | Описание |
|---|---|---|
QPageLayout::StandardMode |
0 |
Прямоугольник рисования включает поля, поля должны находиться между минимальными и максимальными значениями. |
QPageLayout::FullPageMode |
1 |
Прямоугольник рисования исключает поля, поля могут иметь любое значение и должны управляться вручную. |
перечисление 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(), и отступы необходимо управлять вручную.
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(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/archives/qt-5.11/qpagelayout.html