Класс QPageLayout

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

• Список всех членов, включая унаследованные

Типы публичного интерфейса

Функции публичного интерфейса

Связанные нечлены

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

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

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

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

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

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

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

См. также QPageSize.

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

перечисление QPageLayout::Mode

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

перечисление QPageLayout::Orientation

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

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

enum QPageLayout::Unit

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

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

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(), и отступы необходимо управлять вручную.

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(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 этому экземпляру.