QTextListFormat Class
La classe `QTextListFormat` fournit des informations de mise en forme pour les listes dans un ` QTextDocument`. En savoir plus…
| En-tête : | #include <QTextListFormat> |
| CMake : | find_package(Qt6 REQUIRED COMPONENTS Gui) target_link_libraries(mytarget PRIVATE Qt6::Gui) |
| qmake : | QT += gui |
| Hérite de : | QTextFormat |
- Liste de tous les membres, y compris les membres hérités
- QTextListFormat fait partie des API de traitement de texte enrichi et des classes partagées implicitement.
Remarque : toutes les fonctions de cette classe sont réentrantes.
Types publics
| enum | Style { ListDisc, ListCircle, ListSquare, ListDecimal, ListLowerAlpha, …, ListUpperRoman } |
Fonctions publiques
| 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 |
Description détaillée
Une liste est composée d’un ou plusieurs éléments, représentés sous forme de blocs de texte. Le format de la liste spécifie l’apparence des éléments qui la composent. Il détermine notamment l’indentation et le style de chaque élément.
L'indentation des éléments est une valeur entière qui détermine le décalage de chaque élément par rapport à la marge gauche. Cette valeur est lue à l'aide de la fonction indent() et définie à l'aide de la fonction setIndent().
Le style utilisé pour mettre en forme chaque élément est défini à l’aide de la fonction ` setStyle()` et peut être lu à l’aide de la fonction ` style()`. Le style contrôle le type de puces et le système de numérotation utilisés pour les éléments de la liste. Notez que les listes utilisant le système de numérotation décimale commencent à compter à 1 plutôt qu’à 0, sauf si cela a été redéfini via la fonction ` setStart()`.
Des propriétés de style peuvent être définies pour configurer plus en détail l’apparence des éléments de la liste ; par exemple, les propriétés ListNumberPrefix et ListNumberSuffix peuvent être utilisées pour personnaliser les numéros utilisés dans une liste ordonnée afin qu’ils s’affichent sous la forme (1), (2), (3), etc. :
QTextListFormat listFormat;
listFormat.setStyle(QTextListFormat::ListDecimal);
listFormat.setNumberPrefix("(");
listFormat.setNumberSuffix(")");
cursor.insertList(listFormat);Voir également QTextList.
Documentation sur les types de membres
enum QTextListFormat::Style
Cette énumération décrit les symboles utilisés pour décorer les éléments d'une liste :
| Constante | Valeur | Description |
|---|---|---|
QTextListFormat::ListDisc | -1 | un cercle plein |
QTextListFormat::ListCircle | -2 | un cercle vide |
QTextListFormat::ListSquare | -3 | un carré plein |
QTextListFormat::ListDecimal | -4 | des valeurs décimales par ordre croissant |
QTextListFormat::ListLowerAlpha | -5 | les lettres latines minuscules par ordre alphabétique |
QTextListFormat::ListUpperAlpha | -6 | les lettres latines majuscules par ordre alphabétique |
QTextListFormat::ListLowerRoman | -7 | des chiffres romains minuscules (prend en charge jusqu'à 4 999 éléments uniquement) |
QTextListFormat::ListUpperRoman | -8 | chiffres romains majuscules (prend en charge jusqu'à 4 999 éléments uniquement) |
Documentation des fonctions membres
QTextListFormat::QTextListFormat()
Crée un nouvel objet de format de liste.
int QTextListFormat::indent() const
Renvoie l'indentation du format de liste. L'indentation est multipliée par la propriété « QTextDocument::indentWidth » pour obtenir l'indentation effective en pixels.
Voir aussi setIndent().
bool QTextListFormat::isValid() const
Renvoie « true » si ce format de liste est valide ; sinon, renvoie « false ».
QString QTextListFormat::numberPrefix() const
Renvoie le préfixe numérique du format de liste.
Voir aussi setNumberPrefix().
QString QTextListFormat::numberSuffix() const
Renvoie le suffixe numérique du format de liste.
Voir aussi setNumberSuffix().
void QTextListFormat::setIndent(int indentation)
Définit l'indentation e du format de liste. L'indentation est multipliée par la propriété QTextDocument::indentWidth pour obtenir l'indentation effective en pixels.
Voir également indent().
void QTextListFormat::setNumberPrefix(const QString &numberPrefix)
Définit le préfixe numérique du format de liste sur la chaîne spécifiée par ` numberPrefix`. Cette option peut être utilisée avec tous les types de listes triées. Elle n'a aucun effet sur les types de listes non triées.
Le préfixe par défaut est une chaîne vide.
Voir également numberPrefix().
void QTextListFormat::setNumberSuffix(const QString &numberSuffix)
Définit le suffixe numérique du format de liste sur la chaîne spécifiée par « numberSuffix ». Cette option peut être utilisée avec tous les types de listes triées. Elle n'a aucun effet sur les types de listes non triées.
Le suffixe par défaut est « . ».
Voir également numberSuffix().
[since 6.6] void QTextListFormat::setStart(int start)
Définit l'index de la fonction « start » du format de liste.
Cela vous permet de commencer une liste avec un index autre que 1. Cette option peut être utilisée avec tous les types de listes triées : par exemple, si la fonction ` style()` renvoie ` QTextListFormat::ListLowerAlpha ` et que la fonction ` start()` renvoie ` 4`, le premier élément de la liste commence par « d ». Elle n'a aucun effet sur les types de listes non triées.
La valeur par défaut est 1.
Cette fonction a été introduite dans Qt 6.6.
Voir également start().
void QTextListFormat::setStyle(QTextListFormat::Style style)
Définit l'style e du format de liste.
Voir également style() et Style.
[since 6.6] int QTextListFormat::start() const
Renvoie le numéro à afficher pour le premier élément de la liste, si la fonction ` style()` est définie comme ` QTextListFormat::ListDecimal`, ou pour décaler d’autres types de listes triées.
Cette fonction a été introduite dans Qt 6.6.
Voir également setStart().
QTextListFormat::Style QTextListFormat::style() const
Renvoie le style du format de liste.
© 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.
