En esta página

QTextListFormat Class

La clase `QTextListFormat` proporciona información de formato para las listas de un ` QTextDocument`. Más información...

Encabezado: #include <QTextListFormat>
CMake: find_package(Qt6 REQUIRED COMPONENTS Gui)
target_link_libraries(mytarget PRIVATE Qt6::Gui)
qmake: QT += gui
Heredado de: QTextFormat

Nota: Todas las funciones de esta clase son reentrantes.

Tipos públicos

enum Style { ListDisc, ListCircle, ListSquare, ListDecimal, ListLowerAlpha, …, ListUpperRoman }

Funciones públicas

QTextListFormat()
int indent() const
bool isValid() const
QString numberPrefix() const
QString numberSuffix() const
void setIndent(int indentation)
void setNumberPrefix(const QString &numberPrefix)
void setNumberSuffix(const QString &numberSuffix)
(since 6.6) void setStart(int start)
void setStyle(QTextListFormat::Style style)
(since 6.6) int start() const
QTextListFormat::Style style() const

Descripción detallada

Una lista está compuesta por uno o más elementos, representados como bloques de texto. El formato de la lista especifica el aspecto de los elementos que la componen. En concreto, determina la sangría y el estilo de cada elemento.

La sangría de los elementos es un valor entero que hace que cada elemento se desplace una cierta distancia respecto al margen izquierdo. Este valor se lee con ` indent()` y se establece con ` setIndent()`.

El estilo utilizado para decorar cada elemento se establece con setStyle() y se puede leer con la función style(). El estilo controla el tipo de viñetas y el esquema de numeración utilizados para los elementos de la lista. Ten en cuenta que las listas que utilizan el esquema de numeración decimal comienzan a contar a partir del 1 en lugar del 0, a menos que se haya anulado mediante setStart().

Se pueden establecer propiedades de estilo para configurar con mayor detalle el aspecto de los elementos de la lista; por ejemplo, las propiedades ListNumberPrefix y ListNumberSuffix se pueden utilizar para personalizar los números empleados en una lista ordenada, de modo que aparezcan como (1), (2), (3), etc.:

QTextListFormat listFormat;

listFormat.setStyle(QTextListFormat::ListDecimal);
listFormat.setNumberPrefix("(");
listFormat.setNumberSuffix(")");

cursor.insertList(listFormat);

Véase también QTextList.

Documentación sobre tipos de miembros

enum QTextListFormat::Style

Esta enumeración describe los símbolos que se utilizan para decorar los elementos de una lista:

ConstanteValorDescripción
QTextListFormat::ListDisc-1un círculo relleno
QTextListFormat::ListCircle-2un círculo vacío
QTextListFormat::ListSquare-3un cuadrado relleno
QTextListFormat::ListDecimal-4valores decimales en orden ascendente
QTextListFormat::ListLowerAlpha-5letras latinas minúsculas en orden alfabético
QTextListFormat::ListUpperAlpha-6caracteres latinos mayúsculos en orden alfabético
QTextListFormat::ListLowerRoman-7números romanos en minúscula (solo admite hasta 4999 elementos)
QTextListFormat::ListUpperRoman-8números romanos en mayúsculas (solo admite hasta 4999 elementos)

Documentación de funciones de miembro

QTextListFormat::QTextListFormat()

Crea un nuevo objeto de formato de lista.

int QTextListFormat::indent() const

Devuelve la sangría del formato de lista. La sangría se multiplica por la propiedad ` QTextDocument::indentWidth ` para obtener la sangría efectiva en píxeles.

Véase también setIndent().

bool QTextListFormat::isValid() const

Devuelve « true » si este formato de lista es válido; en caso contrario, devuelve « false ».

QString QTextListFormat::numberPrefix() const

Devuelve el prefijo numérico del formato de lista.

Véase también setNumberPrefix().

QString QTextListFormat::numberSuffix() const

Devuelve el sufijo numérico del formato de lista.

Véase también ` setNumberSuffix()`.

void QTextListFormat::setIndent(int indentation)

Establece la « indentation » del formato de lista. La sangría se multiplica por la propiedad « QTextDocument::indentWidth » para obtener la sangría efectiva en píxeles.

Véase también indent().

void QTextListFormat::setNumberPrefix(const QString &numberPrefix)

Establece el prefijo numérico del formato de la lista en la cadena especificada por ` numberPrefix`. Se puede utilizar con todos los tipos de listas ordenadas. No tiene ningún efecto en los tipos de listas no ordenadas.

El prefijo por defecto es una cadena vacía.

Véase también numberPrefix().

void QTextListFormat::setNumberSuffix(const QString &numberSuffix)

Establece el sufijo numérico del formato de la lista en la cadena especificada por ` numberSuffix`. Se puede utilizar con todos los tipos de listas ordenadas. No tiene ningún efecto en los tipos de listas no ordenadas.

El sufijo por defecto es «.».

Véase también numberSuffix().

[since 6.6] void QTextListFormat::setStart(int start)

Establece el índice start del formato de la lista.

Esto permite comenzar una lista con un índice distinto de 1. Se puede utilizar con todos los tipos de listas ordenadas: por ejemplo, si style() es QTextListFormat::ListLowerAlpha y start() es 4, el primer elemento de la lista comienza por «d». No tiene ningún efecto en los tipos de listas no ordenadas.

El valor predeterminado es 1.

Esta función se introdujo en Qt 6.6.

Véase también start().

void QTextListFormat::setStyle(QTextListFormat::Style style)

Establece el formato de la lista « style ».

Véase también style() y Style.

[since 6.6] int QTextListFormat::start() const

Devuelve el número que debe mostrarse en el primer elemento de la lista, si la función ` style()` es ` QTextListFormat::ListDecimal`, o para desplazar otros tipos de listas ordenadas.

Esta función se introdujo en Qt 6.6.

Véase también ` setStart()`.

QTextListFormat::Style QTextListFormat::style() const

Devuelve el estilo del formato de lista.

Véase también setStyle() y Style.

© 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.