QPageLayout Class
Describe el tamaño, la orientación y los márgenes de una página. Más...
| Encabezado: | #include <QPageLayout> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS Gui) target_link_libraries(mytarget PRIVATE Qt6::Gui) |
| qmake: | QT += gui |
Tipos públicos
| enum | Mode { StandardMode, FullPageMode } |
| enum | Orientation { Portrait, Landscape } |
(since 6.8) enum class | OutOfBoundsPolicy { Reject, Clamp } |
| enum | Unit { Millimeter, Point, Inch, Pica, Didot, Cicero } |
Funciones públicas
| 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, QPageLayout::OutOfBoundsPolicy outOfBoundsPolicy = OutOfBoundsPolicy::Reject) |
| bool | setLeftMargin(qreal leftMargin, QPageLayout::OutOfBoundsPolicy outOfBoundsPolicy = OutOfBoundsPolicy::Reject) |
| bool | setMargins(const QMarginsF &margins, QPageLayout::OutOfBoundsPolicy outOfBoundsPolicy = OutOfBoundsPolicy::Reject) |
| 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, QPageLayout::OutOfBoundsPolicy outOfBoundsPolicy = OutOfBoundsPolicy::Reject) |
| bool | setTopMargin(qreal topMargin, QPageLayout::OutOfBoundsPolicy outOfBoundsPolicy = OutOfBoundsPolicy::Reject) |
| void | setUnits(QPageLayout::Unit units) |
| void | swap(QPageLayout &other) |
| QPageLayout::Unit | units() const |
| QPageLayout & | operator=(QPageLayout &&other) |
| QPageLayout & | operator=(const QPageLayout &other) |
Elementos no miembros relacionados
| bool | operator!=(const QPageLayout &lhs, const QPageLayout &rhs) |
| bool | operator==(const QPageLayout &lhs, const QPageLayout &rhs) |
Descripción detallada
La clase QPageLayout define el diseño de una página en un documento paginado, permitiendo establecer el tamaño, la orientación y los márgenes de la página, así como consultar los rectángulos de la página completa y de la página pintable definidos por dichos atributos en diversas unidades.
El tamaño de la página viene definido por la clase ` QPageSize `, a la que se puede consultar para obtener los atributos de tamaño de página. Ten en cuenta que el ` QPageSize ` en sí mismo siempre se define con orientación vertical.
Se pueden definir los márgenes mínimos para el diseño, aunque normalmente el valor por defecto es 0. Cuando se utiliza junto con Qt Print Support, los márgenes mínimos reflejarán el área mínima imprimible definida por la impresora.
En el ` StandardMode ` predeterminado, siempre se tienen en cuenta los márgenes actuales y los márgenes mínimos. El rectángulo pintable es el rectángulo de la página completa menos los márgenes actuales, y los márgenes actuales solo pueden establecerse en valores comprendidos entre los márgenes mínimos y los márgenes máximos permitidos por el tamaño de la página completa.
En FullPageMode no se tienen en cuenta ni los márgenes actuales ni los márgenes mínimos. El rectángulo pintable es el rectángulo de la página completa, y los márgenes actuales pueden establecerse en cualquier valor, independientemente de los márgenes mínimos y del tamaño de la página.
Véase también QPageSize.
Documentación sobre los tipos de miembros
enum QPageLayout::Mode
Define el modo de diseño de página
| Constante | Valor | Descripción |
|---|---|---|
QPageLayout::StandardMode | 0 | «Paint Rect» incluye los márgenes; estos deben estar comprendidos entre el valor mínimo y el máximo. |
QPageLayout::FullPageMode | 1 | «Paint Rect» excluye los márgenes; estos pueden tener cualquier valor y deben gestionarse manualmente. |
En «StandardMode», al establecer los márgenes, utilice « Clamp » para limitar automáticamente los márgenes de modo que se sitúen entre los valores mínimo y máximo permitidos.
Véase también ` OutOfBoundsPolicy`.
enum QPageLayout::Orientation
Este tipo de enumeración define la orientación de la página
| Constante | Valor | Descripción |
|---|---|---|
QPageLayout::Portrait | 0 | El tamaño de la página se utiliza en su orientación predeterminada |
QPageLayout::Landscape | 1 | El tamaño de la página se gira 90 grados |
Tenga en cuenta que algunos tamaños de página estándar se definen con un ancho mayor que su altura, por lo que la orientación se define en relación con el tamaño de página estándar y no utilizando las dimensiones relativas de la página.
[since 6.8] enum class QPageLayout::OutOfBoundsPolicy
Define la política para los márgenes que se salen de los límites
| Constante | Valor | Descripción |
|---|---|---|
QPageLayout::OutOfBoundsPolicy::Reject | 0 | Los márgenes deben estar comprendidos entre los valores mínimo y máximo; de lo contrario, se rechazarán. |
QPageLayout::OutOfBoundsPolicy::Clamp | 1 | Los márgenes se limitan entre los valores mínimo y máximo para garantizar su validez. Nota: Esta política no tiene efecto en « FullPageMode », donde se aceptan todos los márgenes. |
Esta enumeración se introdujo en Qt 6.8.
enum QPageLayout::Unit
Este tipo de enumeración se utiliza para especificar la unidad de medida para la maquetación de la página y los márgenes.
| Constante | Valor | Descripción |
|---|---|---|
QPageLayout::Millimeter | 0 | |
QPageLayout::Point | 1 | 1/72 de pulgada |
QPageLayout::Inch | 2 | |
QPageLayout::Pica | 3 | 1/72 de pie, 1/6 de pulgada, 12 puntos |
QPageLayout::Didot | 4 | 1/72 de pulgada francesa, 0,375 mm |
QPageLayout::Cicero | 5 | 1/6 de pulgada francesa, 12 Didot, 4,5 mm |
Documentación de funciones de miembro
QPageLayout::QPageLayout()
Crea un QPageLayout no válido.
QPageLayout::QPageLayout(const QPageSize &pageSize, QPageLayout::Orientation orientation, const QMarginsF &margins, QPageLayout::Unit units = Point, const QMarginsF &minMargins = QMarginsF(0, 0, 0, 0))
Crea un QPageLayout con los valores indicados para pageSize, orientation y margins en el units especificado.
Opcionalmente, define los márgenes mínimos permitidos minMargins, por ejemplo, los márgenes mínimos que puede imprimir un dispositivo de impresión físico.
El QPageLayout creado se encontrará en StandardMode.
El archivo margins proporcionado se ajustará a los márgenes mínimos y máximos permitidos por el tamaño de la página.
QPageLayout::QPageLayout(const QPageLayout &other)
Constructor de copia: copia ` other ` en `this`.
[noexcept] QPageLayout::~QPageLayout()
Alterará el diseño de la página.
QRectF QPageLayout::fullRect() const
Devuelve el rectángulo de la página completa en las unidades de maquetación actuales.
El rectángulo de la página tiene en cuenta el tamaño y la orientación de la página, pero no los márgenes.
Véanse también paintRect() y units().
QRectF QPageLayout::fullRect(QPageLayout::Unit units) const
Devuelve el rectángulo de la página completa en el formato requerido units.
El rectángulo de la página tiene en cuenta el tamaño y la orientación de la página, pero no los márgenes.
Véase también paintRect().
QRect QPageLayout::fullRectPixels(int resolution) const
Devuelve el rectángulo de la página completa en píxeles del dispositivo para el ` resolution` indicado.
El rectángulo de la página tiene en cuenta el tamaño y la orientación de la página, pero no los márgenes.
Véase también paintRect().
QRect QPageLayout::fullRectPoints() const
Devuelve el rectángulo de la página completa en puntos PostScript (1/72 de pulgada).
El rectángulo de la página tiene en cuenta el tamaño y la orientación de la página, pero no los márgenes.
Véase también paintRect().
bool QPageLayout::isEquivalentTo(const QPageLayout &other) const
Devuelve « true » si este diseño de página es equivalente al diseño de página « other », es decir, si la página tiene el mismo tamaño, los mismos márgenes y la misma orientación.
bool QPageLayout::isValid() const
Devuelve « true » si el diseño de esta página es válido.
QMarginsF QPageLayout::margins() const
Devuelve los márgenes del diseño de página utilizando las unidades configuradas actualmente.
Véase también setMargins() y units().
QMarginsF QPageLayout::margins(QPageLayout::Unit units) const
Devuelve los márgenes de la maquetación de la página utilizando el « units » solicitado.
Véase también setMargins() y margins().
QMargins QPageLayout::marginsPixels(int resolution) const
Devuelve los márgenes del diseño de página en píxeles del dispositivo para el resolution especificado.
Véase también setMargins().
QMargins QPageLayout::marginsPoints() const
Devuelve los márgenes del diseño de página en puntos PostScript (1/72 de pulgada).
Véase también setMargins() y margins().
QMarginsF QPageLayout::maximumMargins() const
Devuelve los márgenes máximos que se aplicarían si el diseño de la página fuera « StandardMode ».
Los márgenes máximos permitidos se calculan restando de la anchura total de la página los márgenes mínimos establecidos. Por ejemplo, si la anchura de la página es de 100 puntos y el margen derecho mínimo es de 10 puntos, el margen izquierdo máximo será de 90 puntos.
Véase también setMinimumMargins() y minimumMargins().
QMarginsF QPageLayout::minimumMargins() const
Devuelve los márgenes mínimos de la maquetación de la página.
Véase también setMinimumMargins() y maximumMargins().
QPageLayout::Mode QPageLayout::mode() const
Devuelve el modo de diseño de la página.
Véase también setMode().
QPageLayout::Orientation QPageLayout::orientation() const
Devuelve la orientación de la página del diseño de página.
Véase también setOrientation().
QPageSize QPageLayout::pageSize() const
Devuelve el tamaño de la página del diseño de página.
Ten en cuenta que la función « QPageSize » siempre se define en orientación vertical. Para obtener un tamaño que tenga en cuenta la orientación establecida, debes utilizar la función « fullRect()».
Véase también setPageSize().
QRectF QPageLayout::paintRect() const
Devuelve el rectángulo de la página en las unidades de diseño actuales.
El rectángulo pintable tiene en cuenta el tamaño de la página, la orientación y los márgenes.
Si se establece el modo « FullPageMode », se devuelve el objeto ` fullRect()` y los márgenes deben gestionarse manualmente.
QRectF QPageLayout::paintRect(QPageLayout::Unit units) const
Devuelve el rectángulo de la página en el formato requerido units.
El rectángulo pintable tiene en cuenta el tamaño de la página, la orientación y los márgenes.
Si se establece el modo « FullPageMode », se devuelve el método ` fullRect()` y los márgenes deben gestionarse manualmente.
QRect QPageLayout::paintRectPixels(int resolution) const
Devuelve el rectángulo pintable en píxeles redondeados del dispositivo para el ` resolution` dado.
El rectángulo pintable tiene en cuenta el tamaño de la página, la orientación y los márgenes.
Si se activa el modo « FullPageMode », se devuelve la función « fullRect()» y los márgenes deben gestionarse manualmente.
QRect QPageLayout::paintRectPoints() const
Devuelve el rectángulo pintable en puntos PostScript redondeados (1/72 de pulgada).
El rectángulo pintable tiene en cuenta el tamaño de la página, la orientación y los márgenes.
Si se activa el modo « FullPageMode », se devuelve el objeto « fullRect()» y los márgenes deben gestionarse manualmente.
bool QPageLayout::setBottomMargin(qreal bottomMargin, QPageLayout::OutOfBoundsPolicy outOfBoundsPolicy = OutOfBoundsPolicy::Reject)
Establece el margen inferior del diseño de página en bottomMargin. Devuelve «true» si el margen se ha establecido correctamente.
Las unidades utilizadas son las definidas actualmente para el diseño. Para utilizar unidades diferentes, llama primero a ` setUnits()`.
Desde Qt 6.8, se puede utilizar el parámetro opcional ` outOfBoundsPolicy ` para especificar cómo se gestionan los márgenes que se salen de los límites.
Véanse también setMargins() y margins().
bool QPageLayout::setLeftMargin(qreal leftMargin, QPageLayout::OutOfBoundsPolicy outOfBoundsPolicy = OutOfBoundsPolicy::Reject)
Establece el margen izquierdo del diseño de página en leftMargin. Devuelve «true» si el margen se ha establecido correctamente.
Las unidades utilizadas son las definidas actualmente para el diseño. Para utilizar unidades diferentes, llama primero a ` setUnits()`.
Desde Qt 6.8, se puede utilizar el parámetro opcional ` outOfBoundsPolicy ` para especificar cómo se gestionan los márgenes que se salen de los límites.
Véanse también setMargins() y margins().
bool QPageLayout::setMargins(const QMarginsF &margins, QPageLayout::OutOfBoundsPolicy outOfBoundsPolicy = OutOfBoundsPolicy::Reject)
Establece los márgenes de la página del diseño en margins. Devuelve «true» si los márgenes se han establecido correctamente.
Las unidades utilizadas son las definidas actualmente para el diseño. Para utilizar unidades diferentes, llama primero a ` setUnits()`.
Desde Qt 6.8, se puede utilizar el parámetro opcional ` outOfBoundsPolicy ` para especificar cómo se gestionan los márgenes que se salen de los límites.
Véanse también margins() y units().
void QPageLayout::setMinimumMargins(const QMarginsF &minMargins)
Establece los márgenes mínimos de la página en minMargins.
No se recomienda anular los valores predeterminados establecidos para un tamaño de página, ya que puede tratarse del área mínima imprimible para un dispositivo de impresión físico.
Si se establece el modo « StandardMode », los márgenes existentes se limitarán al nuevo valor de « minMargins » y al máximo permitido por el tamaño de la página. Si se establece « FullPageMode », los márgenes existentes no se modificarán.
Véanse también « minimumMargins()» y « setMargins()».
void QPageLayout::setMode(QPageLayout::Mode mode)
Establece el modo de diseño de página en « mode ».
Véase también mode().
void QPageLayout::setOrientation(QPageLayout::Orientation orientation)
Establece la orientación de la página del diseño de página en « orientation ».
Cambiar la orientación no afecta a los márgenes actuales ni a los márgenes mínimos.
Véase también orientation().
void QPageLayout::setPageSize(const QPageSize &pageSize, const QMarginsF &minMargins = QMarginsF(0, 0, 0, 0))
Establece el tamaño de la página del diseño de página en pageSize.
Opcionalmente, se pueden definir los márgenes mínimos permitidos minMargins, por ejemplo, los márgenes mínimos que puede imprimir un dispositivo de impresión físico; de lo contrario, los márgenes mínimos se establecerán por defecto en 0.
Si se establece ` StandardMode `, los márgenes existentes se ajustarán a los nuevos márgenes mínimos y a los márgenes máximos permitidos por el tamaño de la página. Si se establece ` FullPageMode `, los márgenes existentes no se modificarán.
Véase también pageSize().
bool QPageLayout::setRightMargin(qreal rightMargin, QPageLayout::OutOfBoundsPolicy outOfBoundsPolicy = OutOfBoundsPolicy::Reject)
Establece el margen derecho del diseño de página en rightMargin. Devuelve «true» si el margen se ha establecido correctamente.
Las unidades utilizadas son las definidas actualmente para el diseño. Para utilizar unidades diferentes, llama primero a ` setUnits()`.
Desde Qt 6.8, se puede utilizar el parámetro opcional ` outOfBoundsPolicy ` para especificar cómo se gestionan los márgenes que se salen de los límites.
Véanse también setMargins() y margins().
bool QPageLayout::setTopMargin(qreal topMargin, QPageLayout::OutOfBoundsPolicy outOfBoundsPolicy = OutOfBoundsPolicy::Reject)
Establece el margen superior del diseño de página en topMargin. Devuelve «true» si el margen se ha establecido correctamente.
Las unidades utilizadas son las definidas actualmente para el diseño. Para utilizar unidades diferentes, llama primero a ` setUnits()`.
Desde Qt 6.8, se puede utilizar el parámetro opcional ` outOfBoundsPolicy ` para especificar cómo se gestionan los márgenes que se salen de los límites.
Véase también setMargins() y margins().
void QPageLayout::setUnits(QPageLayout::Unit units)
Establece el objeto « units » utilizado para definir el diseño de la página.
Véase también units().
[noexcept] void QPageLayout::swap(QPageLayout &other)
Cambia el diseño de esta página por el de other. Esta operación es muy rápida y nunca falla.
QPageLayout::Unit QPageLayout::units() const
Devuelve las unidades en las que está definido actualmente el diseño de la página.
Véase también setUnits().
[noexcept] QPageLayout &QPageLayout::operator=(QPageLayout &&other)
La operación «move-assign» asigna other a esta instancia QPageLayout, transfiriendo la propiedad del puntero gestionado a esta instancia.
QPageLayout &QPageLayout::operator=(const QPageLayout &other)
Operador de asignación: asigna « other » a «this».
Elementos no miembros relacionados
bool operator!=(const QPageLayout &lhs, const QPageLayout &rhs)
Devuelve ` true ` si el diseño de página lhs no es igual al diseño de página rhs, es decir, si alguno de los atributos difiere.
Ten en cuenta que se trata de una igualdad estricta, especialmente en el caso del tamaño de la página, donde el ID, el nombre y el tamaño de QPageSize deben coincidir exactamente, y en el de los márgenes, donde las unidades deben coincidir.
Véase también QPageLayout::isEquivalentTo().
bool operator==(const QPageLayout &lhs, const QPageLayout &rhs)
Devuelve ` true ` si el diseño de página lhs es igual al diseño de página rhs, es decir, si todos los atributos son exactamente iguales.
Ten en cuenta que se trata de una igualdad estricta, especialmente en el caso del tamaño de la página, donde el ID, el nombre y el tamaño de QPageSize deben coincidir exactamente, y en el de los márgenes, donde las unidades deben coincidir.
Véase también QPageLayout::isEquivalentTo().
© 2026 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.