QTextListFormat Class
Die Klasse QTextListFormat stellt Formatierungsinformationen für Listen in einem QTextDocument bereit. Mehr...
| Kopfzeile: | #include <QTextListFormat> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS Gui)target_link_libraries(mytarget PRIVATE Qt6::Gui) |
| qmake: | QT += gui |
| Vererbungen: | QTextFormat |
- Liste aller Mitglieder, einschließlich geerbter Mitglieder
- QTextListFormat ist Teil von Rich Text Processing APIs und Implicitly Shared Classes.
Hinweis: Alle Funktionen in dieser Klasse sind reentrant.
Öffentliche Typen
| enum | Style { ListDisc, ListCircle, ListSquare, ListDecimal, ListLowerAlpha, …, ListUpperRoman } |
Öffentliche Funktionen
| 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 |
Detaillierte Beschreibung
Eine Liste besteht aus einem oder mehreren Elementen, die als Textblöcke dargestellt werden. Das Format der Liste legt das Aussehen der Elemente in der Liste fest. Insbesondere bestimmt es die Einrückung und den Stil der einzelnen Elemente.
Die Einrückung der Elemente ist ein ganzzahliger Wert, der bewirkt, dass jedes Element um einen bestimmten Betrag vom linken Rand versetzt ist. Dieser Wert wird mit indent() ausgelesen und mit setIndent() eingestellt.
Der Stil, mit dem die einzelnen Elemente gestaltet werden, wird mit setStyle() festgelegt und kann mit der Funktion style() ausgelesen werden. Der Stil steuert die Art der Aufzählungspunkte und das Nummerierungsschema, das für die Elemente in der Liste verwendet wird. Beachten Sie, dass Listen, die das dezimale Nummerierungsschema verwenden, mit der Zählung bei 1 und nicht bei 0 beginnen, es sei denn, dies wurde mit setStart() außer Kraft gesetzt.
Die Eigenschaften ListNumberPrefix und ListNumberSuffix können zum Beispiel verwendet werden, um die in einer geordneten Liste verwendeten Zahlen so anzupassen, dass sie als (1), (2), (3) usw. erscheinen:
QTextListFormat listFormat; listFormat.setStyle(QTextListFormat::ListDecimal); listFormat.setNumberPrefix("("); listFormat.setNumberSuffix(")"); cursor.insertList(listFormat);
Siehe auch QTextList.
Dokumentation der Mitgliedstypen
enum QTextListFormat::Style
Diese Aufzählung beschreibt die Symbole, die zur Verzierung von Listenelementen verwendet werden:
| Konstante | Wert | Beschreibung |
|---|---|---|
QTextListFormat::ListDisc | -1 | ein gefüllter Kreis |
QTextListFormat::ListCircle | -2 | ein leerer Kreis |
QTextListFormat::ListSquare | -3 | ein ausgefülltes Quadrat |
QTextListFormat::ListDecimal | -4 | Dezimalwerte in aufsteigender Reihenfolge |
QTextListFormat::ListLowerAlpha | -5 | Lateinische Kleinbuchstaben in alphabetischer Reihenfolge |
QTextListFormat::ListUpperAlpha | -6 | lateinische Großbuchstaben in alphabetischer Reihenfolge |
QTextListFormat::ListLowerRoman | -7 | Römische Kleinbuchstaben (unterstützt nur bis zu 4999 Einträge) |
QTextListFormat::ListUpperRoman | -8 | Großbuchstaben in römischen Ziffern (nur bis zu 4999 Einträge möglich) |
Dokumentation der Mitgliedsfunktionen
QTextListFormat::QTextListFormat()
Konstruiert ein neues Listenformat-Objekt.
int QTextListFormat::indent() const
Gibt die Einrückung des Listenformats zurück. Die Einrückung wird mit der Eigenschaft QTextDocument::indentWidth multipliziert, um die effektive Einrückung in Pixel zu erhalten.
Siehe auch setIndent().
bool QTextListFormat::isValid() const
Gibt true zurück, wenn dieses Listenformat gültig ist; andernfalls wird false zurückgegeben.
QString QTextListFormat::numberPrefix() const
Gibt das Nummernpräfix des Listenformats zurück.
Siehe auch setNumberPrefix().
QString QTextListFormat::numberSuffix() const
Gibt das Nummernsuffix des Listenformats zurück.
Siehe auch setNumberSuffix().
void QTextListFormat::setIndent(int indentation)
Legt die Einrückung des Listenformats indentation fest. Die Einrückung wird mit der Eigenschaft QTextDocument::indentWidth multipliziert, um den effektiven Einzug in Pixel zu erhalten.
Siehe auch indent().
void QTextListFormat::setNumberPrefix(const QString &numberPrefix)
Setzt das Zahlenpräfix des Listenformats auf die durch numberPrefix angegebene Zeichenkette. Dies kann mit allen sortierten Listentypen verwendet werden. Es hat keine Auswirkung auf unsortierte Listentypen.
Das Standardpräfix ist eine leere Zeichenkette.
Siehe auch numberPrefix().
void QTextListFormat::setNumberSuffix(const QString &numberSuffix)
Setzt das Nummernsuffix des Listenformats auf die durch numberSuffix angegebene Zeichenkette. Dies kann mit allen sortierten Listentypen verwendet werden. Es hat keine Auswirkung auf unsortierte Listentypen.
Das Standardsuffix ist ".".
Siehe auch numberSuffix().
[since 6.6] void QTextListFormat::setStart(int start)
Setzt den Index des Listenformats start.
Dies ermöglicht es Ihnen, eine Liste mit einem anderen Index als 1 zu beginnen. Dies kann bei allen sortierten Listentypen verwendet werden: Wenn zum Beispiel style() QTextListFormat::ListLowerAlpha und start() 4 ist, beginnt das erste Listenelement mit "d". Bei unsortierten Listenarten hat dies keine Auswirkungen.
Der Standardstart ist 1.
Diese Funktion wurde in Qt 6.6 eingeführt.
Siehe auch start().
void QTextListFormat::setStyle(QTextListFormat::Style style)
Setzt das Listenformat auf style.
[since 6.6] int QTextListFormat::start() const
Gibt die Nummer zurück, die beim ersten Listenelement angezeigt werden soll, wenn style() QTextListFormat::ListDecimal ist, oder um andere sortierte Listentypen auszugleichen.
Diese Funktion wurde in Qt 6.6 eingeführt.
Siehe auch setStart().
QTextListFormat::Style QTextListFormat::style() const
Gibt den Stil des Listenformats zurück.
© 2025 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.
