QTextBlockFormat Class
La clase `QTextBlockFormat` proporciona información de formato para bloques de texto en un ` QTextDocument`. Más...
| Encabezado: | #include <QTextBlockFormat> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS Gui) target_link_libraries(mytarget PRIVATE Qt6::Gui) |
| qmake: | QT += gui |
| Heredan: | QTextFormat |
- Lista de todos los miembros, incluidos los heredados
- QTextBlockFormat forma parte de las API de procesamiento de texto enriquecido y de las clases compartidas implícitamente.
Nota: Todas las funciones de esta clase son reentrantes.
Tipos públicos
| enum | LineHeightTypes { SingleHeight, ProportionalHeight, FixedHeight, MinimumHeight, LineDistanceHeight } |
| enum class | MarkerType { NoMarker, Unchecked, Checked } |
Funciones públicas
| QTextBlockFormat() | |
| Qt::Alignment | alignment() const |
| qreal | bottomMargin() const |
| int | headingLevel() const |
| int | indent() const |
| bool | isValid() const |
| qreal | leftMargin() const |
| qreal | lineHeight() const |
| qreal | lineHeight(qreal scriptLineHeight, qreal scaling = 1.0) const |
| int | lineHeightType() const |
| QTextBlockFormat::MarkerType | marker() const |
| bool | nonBreakableLines() const |
| QTextFormat::PageBreakFlags | pageBreakPolicy() const |
| qreal | rightMargin() const |
| void | setAlignment(Qt::Alignment alignment) |
| void | setBottomMargin(qreal margin) |
| void | setHeadingLevel(int level) |
| void | setIndent(int indentation) |
| void | setLeftMargin(qreal margin) |
| void | setLineHeight(qreal height, int heightType) |
| void | setMarker(QTextBlockFormat::MarkerType marker) |
| void | setNonBreakableLines(bool b) |
| void | setPageBreakPolicy(QTextFormat::PageBreakFlags policy) |
| void | setRightMargin(qreal margin) |
| void | setTabPositions(const QList<QTextOption::Tab> &tabs) |
| void | setTextIndent(qreal indent) |
| void | setTopMargin(qreal margin) |
| QList<QTextOption::Tab> | tabPositions() const |
| qreal | textIndent() const |
| qreal | topMargin() const |
Descripción detallada
Un documento se compone de una lista de bloques, representados por objetos ` QTextBlock `. Cada bloque puede contener un elemento de algún tipo, como un párrafo de texto, una tabla, una lista o una imagen. Cada bloque tiene asociado un objeto `QTextBlockFormat` que especifica sus características.
Para adaptarse a idiomas que se escriben de izquierda a derecha y de derecha a izquierda, puedes establecer la dirección de un bloque con ` setLayoutDirection()` (). La alineación del párrafo se establece con ` setAlignment()` (). Los márgenes se controlan mediante ` setTopMargin()` (), ` setBottomMargin()` (), ` setLeftMargin()` (), ` setRightMargin()` (). La sangría general se establece con ` setIndent()` (), y la sangría de la primera línea con ` setTextIndent()` ().
El interlineado se establece con setLineHeight() y se obtiene mediante lineHeight() y lineHeightType(). Los tipos de interlineado disponibles se encuentran en la enumeración LineHeightTypes.
El salto de línea se puede activar y desactivar con ` setNonBreakableLines()` ().
El pincel utilizado para pintar el fondo del párrafo se establece con setBackground(), y otros aspectos de la apariencia del texto se pueden personalizar utilizando la función setProperty() con los valores OutlinePen, ForegroundBrush y BackgroundBrush QTextFormat::Property .
Si un bloque de texto forma parte de una lista, también puede tener un formato de lista al que se puede acceder mediante la función listFormat().
Véase también QTextBlock y QTextCharFormat.
Documentación sobre los tipos de miembros
enum QTextBlockFormat::LineHeightTypes
Esta enumeración describe los distintos tipos de espaciado entre líneas que pueden tener los párrafos.
| Constante | Valor | Descripción |
|---|---|---|
QTextBlockFormat::SingleHeight | 0 | Esta es la altura de línea predeterminada: interlineado simple. |
QTextBlockFormat::ProportionalHeight | 1 | Establece el espaciado proporcional a la línea (en porcentaje). Por ejemplo, se establece en 200 para el doble interlineado. |
QTextBlockFormat::FixedHeight | 2 | Esto establece la altura de línea en un valor fijo (en píxeles). |
QTextBlockFormat::MinimumHeight | 3 | Esto establece la altura mínima de línea (en píxeles). |
QTextBlockFormat::LineDistanceHeight | 4 | Esto añade la altura especificada entre líneas (en píxeles). |
Véase también lineHeight(), lineHeightType() y setLineHeight().
enum class QTextBlockFormat::MarkerType
Esta enumeración describe los tipos de marcadores que puede tener un elemento de lista. Si un elemento de lista (un párrafo para el que la función ` QTextBlock::textList()` devuelve la lista) tiene un marcador, este se muestra en lugar de la viñeta habitual. De este modo, los elementos de lista marcables pueden mezclarse con elementos de lista normales en la misma lista, anulando el tipo de viñeta especificado por QTextListFormat::style() para toda la lista.
| Constante | Valor | Descripción |
|---|---|---|
QTextBlockFormat::MarkerType::NoMarker | 0 | Este es el valor por defecto: se mostrará el marcador de la entrada de la lista. |
QTextBlockFormat::MarkerType::Unchecked | 1 | En lugar de la viñeta del elemento de la lista, se mostrará una casilla de selección desmarcada. |
QTextBlockFormat::MarkerType::Checked | 2 | En lugar de la viñeta del elemento de la lista, se mostrará una casilla de selección marcada. |
En el futuro, esto podría ampliarse para especificar otros tipos de decoraciones de párrafo.
Véase también QTextListFormat::style().
Documentación de funciones miembro
QTextBlockFormat::QTextBlockFormat()
Crea un nuevo objeto QTextBlockFormat.
Qt::Alignment QTextBlockFormat::alignment() const
Devuelve la alineación del párrafo.
Véase también setAlignment().
qreal QTextBlockFormat::bottomMargin() const
Devuelve el margen inferior del párrafo.
Véase también setBottomMargin() y topMargin().
int QTextBlockFormat::headingLevel() const
Devuelve el nivel de encabezado del párrafo si se trata de un encabezado, o 0 si no lo es.
Véase también setHeadingLevel().
int QTextBlockFormat::indent() const
Devuelve la sangría del párrafo.
Véase también setIndent().
bool QTextBlockFormat::isValid() const
Devuelve « true » si este formato de bloque es válido; en caso contrario, devuelve «false».
qreal QTextBlockFormat::leftMargin() const
Devuelve el margen izquierdo del párrafo.
Véase también setLeftMargin(), rightMargin() y indent().
qreal QTextBlockFormat::lineHeight() const
Esto devuelve la propiedad LineHeight del párrafo.
Véase también LineHeightTypes, setLineHeight() y lineHeightType().
qreal QTextBlockFormat::lineHeight(qreal scriptLineHeight, qreal scaling = 1.0) const
Devuelve la altura de las líneas del párrafo basándose en la altura de la línea de escritura indicada por « scriptLineHeight » y el factor « scaling » especificado.
El valor devuelto también depende del tipo de altura de línea (LineHeightType) del párrafo, así como de la configuración de altura de línea (LineHeight) establecida para dicho párrafo.
El escalado es necesario para las alturas que incluyen un número fijo de píxeles, a fin de escalarlas adecuadamente para su impresión.
Véase también LineHeightTypes, setLineHeight() y lineHeightType().
int QTextBlockFormat::lineHeightType() const
Esto devuelve la propiedad LineHeightType del párrafo.
Véase también LineHeightTypes, setLineHeight() y lineHeight().
QTextBlockFormat::MarkerType QTextBlockFormat::marker() const
Devuelve el marcador del párrafo si se ha establecido alguno, o « NoMarker » si no es así.
Véase también setMarker().
bool QTextBlockFormat::nonBreakableLines() const
Devuelve « true » si las líneas del párrafo son inamovibles; en caso contrario, devuelve « false ».
Véase también setNonBreakableLines().
QTextFormat::PageBreakFlags QTextBlockFormat::pageBreakPolicy() const
Devuelve la política de saltos de página establecida actualmente para el párrafo. El valor por defecto es « QTextFormat::PageBreak_Auto ».
Véase también setPageBreakPolicy().
qreal QTextBlockFormat::rightMargin() const
Devuelve el margen derecho del párrafo.
Véase también setRightMargin() y leftMargin().
void QTextBlockFormat::setAlignment(Qt::Alignment alignment)
Establece el valor de « alignment » del párrafo.
Véase también alignment().
void QTextBlockFormat::setBottomMargin(qreal margin)
Establece el margen inferior del párrafo margin.
Véase también bottomMargin(), setTopMargin(), setLeftMargin() y setRightMargin().
void QTextBlockFormat::setHeadingLevel(int level)
Establece el nivel de encabezado del párrafo level, donde 1 es el tipo de encabezado de mayor nivel (normalmente con el tamaño de fuente más grande posible para los encabezados), y los valores crecientes corresponden a niveles cada vez más profundos en el documento (y, por lo general, con tamaños de fuente más pequeños). Por ejemplo, al leer una etiqueta H1 de HTML, el nivel de encabezado se establece en 1. Establecer el nivel de encabezado no cambia automáticamente el tamaño de la fuente; sin embargo, QTextDocumentFragment::fromHtml() establece simultáneamente tanto el nivel de encabezado como el tamaño de la fuente.
Si el párrafo no es un encabezado, el nivel debe establecerse en 0 (el valor por defecto).
Véase también headingLevel().
void QTextBlockFormat::setIndent(int indentation)
Establece la « indentation » del párrafo. Los márgenes se definen independientemente de la sangría mediante las funciones « setLeftMargin()» y « setTextIndent()». El « indentation » es un número entero que se multiplica por la sangría estándar de todo el documento, lo que da como resultado la sangría real del párrafo.
Véanse también indent() y QTextDocument::indentWidth().
void QTextBlockFormat::setLeftMargin(qreal margin)
Establece la sangría izquierda del párrafo margin. La sangría se puede aplicar por separado con setIndent().
Véanse también leftMargin(), setRightMargin(), setTopMargin() y setBottomMargin().
void QTextBlockFormat::setLineHeight(qreal height, int heightType)
Establece la altura de línea del párrafo en el valor indicado en height, que depende de heightType tal y como se describe en la enumeración LineHeightTypes.
Véanse también LineHeightTypes, lineHeight() y lineHeightType().
void QTextBlockFormat::setMarker(QTextBlockFormat::MarkerType marker)
Establece el tipo de adorno que debe mostrarse junto al párrafo en « marker ». Por ejemplo, un elemento de una lista puede adornarse con una casilla de selección, marcada o sin marcar, en lugar de su viñeta. El valor por defecto es « NoMarker ».
Véase también marker().
void QTextBlockFormat::setNonBreakableLines(bool b)
Si b es verdadero, las líneas del párrafo se consideran no separables; en caso contrario, son separables.
Véase también nonBreakableLines().
void QTextBlockFormat::setPageBreakPolicy(QTextFormat::PageBreakFlags policy)
Establece la política de saltos de página del párrafo en « policy ».
Véase también pageBreakPolicy().
void QTextBlockFormat::setRightMargin(qreal margin)
Establece el margen derecho del párrafo margin.
Véase también rightMargin(), setLeftMargin(), setTopMargin() y setBottomMargin().
void QTextBlockFormat::setTabPositions(const QList<QTextOption::Tab> &tabs)
Establece las posiciones de las tabulaciones del bloque de texto según lo especificado en tabs.
Véase también tabPositions().
void QTextBlockFormat::setTextIndent(qreal indent)
Establece el valor de « indent » para la primera línea del bloque. Esto permite que la primera línea de un párrafo tenga una sangría diferente a la del resto de líneas, lo que mejora la legibilidad del texto.
Véase también textIndent(), setLeftMargin(), setRightMargin(), setTopMargin() y setBottomMargin().
void QTextBlockFormat::setTopMargin(qreal margin)
Establece el margen superior del párrafo margin.
Véase también topMargin(), setBottomMargin(), setLeftMargin() y setRightMargin().
QList<QTextOption::Tab> QTextBlockFormat::tabPositions() const
Devuelve una lista de las posiciones de tabulación definidas para el bloque de texto.
Véase también setTabPositions().
qreal QTextBlockFormat::textIndent() const
Devuelve la sangría del texto del párrafo.
Véase también setTextIndent().
qreal QTextBlockFormat::topMargin() const
Devuelve el margen superior del párrafo.
Véase también setTopMargin() y bottomMargin().
© 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.