QTextListFormat Class
La classe QTextListFormat fournit des informations de formatage pour les listes dans un site QTextDocument. Plus....
| En-tête : | #include <QTextListFormat> |
| CMake : | find_package(Qt6 REQUIRED COMPONENTS Gui)target_link_libraries(mytarget PRIVATE Qt6::Gui) |
| qmake : | QT += gui |
| Héritages : | QTextFormat |
- Liste de tous les membres, y compris les membres hérités
- QTextListFormat fait partie de Rich Text Processing APIs et de Implicitly Shared Classes.
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 par des blocs de texte. Le format de la liste spécifie l'apparence des éléments de la liste. Il détermine notamment l'indentation et le style de chaque élément.
L'indentation des éléments est une valeur entière qui fait que chaque élément est décalé d'une certaine quantité par rapport à la marge de gauche. Cette valeur est lue avec indent() et fixée avec setIndent().
Le style utilisé pour décorer chaque élément est défini avec setStyle() et peut être lu avec la fonction style(). Le style contrôle le type de puces et le schéma de numérotation utilisés pour les éléments de la liste. Notez que les listes qui utilisent la numérotation décimale commencent à compter à 1 plutôt qu'à 0, à moins que cela n'ait été remplacé par setStart().
Les propriétés de style peuvent être définies pour configurer davantage l'apparence des éléments de la liste ; par exemple, les propriétés ListNumberPrefix et ListNumberSuffix peuvent être utilisées pour personnaliser les nombres utilisés dans une liste ordonnée afin qu'ils apparaissent comme (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 de la liste :
| Constante | Valeur | Description |
|---|---|---|
QTextListFormat::ListDisc | -1 | un cercle rempli |
QTextListFormat::ListCircle | -2 | un cercle vide |
QTextListFormat::ListSquare | -3 | un carré rempli |
QTextListFormat::ListDecimal | -4 | valeurs décimales par ordre croissant |
QTextListFormat::ListLowerAlpha | -5 | caractères latins minuscules dans l'ordre alphabétique |
QTextListFormat::ListUpperAlpha | -6 | caractères latins majuscules dans l'ordre alphabétique |
QTextListFormat::ListLowerRoman | -7 | chiffres romains minuscules (jusqu'à 4999 éléments uniquement) |
QTextListFormat::ListUpperRoman | -8 | chiffres romains majuscules (jusqu'à 4999 éléments uniquement) |
Documentation sur les fonctions membres
QTextListFormat::QTextListFormat()
Construit 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 le format de liste indentation. L'indentation est multipliée par la propriété QTextDocument::indentWidth pour obtenir l'indentation effective en pixels.
Voir aussi indent().
void QTextListFormat::setNumberPrefix(const QString &numberPrefix)
Fixe le préfixe numérique du format de liste à la chaîne spécifiée par numberPrefix. Cette fonction 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 aussi numberPrefix().
void QTextListFormat::setNumberSuffix(const QString &numberSuffix)
Fixe le suffixe numérique du format de liste à la chaîne spécifiée par numberSuffix. Cette fonction peut être utilisée avec tous les types de listes triées. Il n'a aucun effet sur les types de listes non triées.
Le suffixe par défaut est ".".
Voir aussi numberSuffix().
[since 6.6] void QTextListFormat::setStart(int start)
Définit l'index start du format de la liste, ce qui permet de commencer une liste avec un index différent de 1.
Cela vous permet de commencer une liste avec un index différent de 1. Cela peut être utilisé avec tous les types de listes triées : par exemple, si style() est QTextListFormat::ListLowerAlpha et start() est 4, le premier élément de la liste commence par "d". Elle n'a aucun effet sur les listes non triées.
Le début par défaut est 1.
Cette fonction a été introduite dans Qt 6.6.
Voir aussi start().
void QTextListFormat::setStyle(QTextListFormat::Style style)
Définit le format de la liste style.
[since 6.6] int QTextListFormat::start() const
Renvoie le nombre à afficher par le premier élément de la liste, si style() est QTextListFormat::ListDecimal, ou pour compenser d'autres types de listes triées.
Cette fonction a été introduite dans Qt 6.6.
Voir aussi 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.
