QTextListFormat Class
La clase QTextListFormat proporciona información de formato para las listas en un QTextDocument. Más...
| Cabecera: | #include <QTextListFormat> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS Gui)target_link_libraries(mytarget PRIVATE Qt6::Gui) |
| qmake: | QT += gui |
| Hereda: | QTextFormat |
- Lista de todos los miembros, incluyendo los heredados
- QTextListFormat es parte de APIs de Procesamiento de Texto Enriquecido y Clases Implícitamente Compartidas.
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 se compone de uno o más elementos, representados como bloques de texto. El formato de la lista especifica la apariencia de los elementos de la lista. 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 del margen izquierdo una determinada cantidad. Este valor se lee con indent() y se fija con setIndent().
El estilo utilizado para decorar cada elemento se establece con setStyle() y puede leerse con la función style(). El estilo controla el tipo de viñetas y el esquema de numeración utilizado para los elementos de la lista. Tenga en cuenta que las listas que utilizan el esquema de numeración decimal comienzan a contar en 1 en lugar de 0, a menos que se haya anulado mediante setStart().
Las propiedades de estilo se pueden establecer para configurar aún más la apariencia de los elementos de la lista; por ejemplo, las propiedades ListNumberPrefix y ListNumberSuffix se pueden utilizar para personalizar los números utilizados en una lista ordenada para 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 de tipos de miembros
enum QTextListFormat::Style
Este enum describe los símbolos utilizados para decorar los elementos de la lista:
| Constante | Valor | Descripción |
|---|---|---|
QTextListFormat::ListDisc | -1 | un círculo relleno |
QTextListFormat::ListCircle | -2 | un círculo vacío |
QTextListFormat::ListSquare | -3 | un cuadrado relleno |
QTextListFormat::ListDecimal | -4 | valores decimales en orden ascendente |
QTextListFormat::ListLowerAlpha | -5 | caracteres latinos en minúsculas por orden alfabético |
QTextListFormat::ListUpperAlpha | -6 | caracteres latinos en mayúsculas por orden alfabético |
QTextListFormat::ListLowerRoman | -7 | números romanos en minúsculas (sólo admite hasta 4999 elementos) |
QTextListFormat::ListUpperRoman | -8 | números romanos en mayúsculas (sólo admite hasta 4999 elementos) |
Documentación de las funciones de los miembros
QTextListFormat::QTextListFormat()
Construye 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 el formato de lista indentation. 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 lista en la cadena especificada por numberPrefix. Puede utilizarse con todos los tipos de listas ordenadas. No tiene ningún efecto en los tipos de lista no ordenados.
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 lista en la cadena especificada por numberSuffix. Puede utilizarse con todos los tipos de listas ordenadas. No tiene ningún efecto en los tipos de lista no ordenados.
El sufijo por defecto es ".".
Véase también numberSuffix().
[since 6.6] void QTextListFormat::setStart(int start)
Establece el índice del formato de lista start.
Permite iniciar una lista con un índice distinto de 1. Puede utilizarse con todos los tipos de lista ordenados: 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 lista no ordenados.
El inicio por defecto 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 mostrar el primer elemento de la lista, si style() es QTextListFormat::ListDecimal, o para compensar 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.
© 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.
