QTextList Class

Die Klasse QTextList bietet eine dekorierte Liste von Elementen in einem QTextDocument. ...

Kopfzeile: #include <QTextList>
CMake: find_package(Qt6 REQUIRED COMPONENTS Gui)
target_link_libraries(mytarget PRIVATE Qt6::Gui)
qmake: QT += gui
Vererbungen: QTextBlockGroup

Hinweis: Alle Funktionen in dieser Klasse sind reentrant.

Öffentliche Funktionen

void add(const QTextBlock &block)
int count() const
QTextListFormat format() const
QTextBlock item(int i) const
int itemNumber(const QTextBlock &block) const
QString itemText(const QTextBlock &block) const
void remove(const QTextBlock &block)
void removeItem(int i)
void setFormat(const QTextListFormat &format)

Detaillierte Beschreibung

Eine Liste enthält eine Folge von Textblöcken, von denen jeder mit einem Aufzählungspunkt oder einem anderen Symbol gekennzeichnet ist. Es können mehrere Listenebenen verwendet werden, und die automatische Nummerierungsfunktion bietet Unterstützung für geordnete numerische und alphabetische Listen.

Listen werden erstellt, indem ein Textcursor verwendet wird, um eine leere Liste an der aktuellen Position einzufügen, oder indem vorhandener Text in eine neue Liste verschoben wird. Die Funktion QTextCursor::insertList() fügt einen leeren Block an der Cursorposition in das Dokument ein und macht ihn zum ersten Eintrag in einer Liste.

    QTextListFormat listFormat;
    if (list) {
        listFormat = list->format();
        listFormat.setIndent(listFormat.indent() + 1);
    }

    listFormat.setStyle(QTextListFormat::ListDisc);
    cursor.insertList(listFormat);

Die Funktion QTextCursor::createList() übernimmt den Inhalt des aktuellen Blocks des Cursors und macht ihn zum ersten Element einer neuen Liste.

Die aktuelle Liste des Cursors wird mit QTextCursor::currentList() ermittelt.

Die Anzahl der Elemente in einer Liste wird mit count() angegeben. Jedes Element kann über seinen Index in der Liste mit der Funktion item() ermittelt werden. In ähnlicher Weise kann der Index eines bestimmten Eintrags mit itemNumber() ermittelt werden. Der Text eines jeden Eintrags kann mit der Funktion itemText() ermittelt werden.

Beachten Sie, dass die Elemente in der Liste nicht unbedingt benachbarte Elemente des Dokuments sein müssen. Zum Beispiel werden die Elemente der obersten Ebene in einer mehrstufigen Liste durch die Elemente der unteren Ebenen der Liste getrennt.

Listenelemente können nach Index mit der Funktion removeItem() gelöscht werden. remove() löscht das angegebene Element in der Liste.

Das Format der Liste wird mit setFormat() gesetzt und mit format() gelesen. Das Format beschreibt die Gestaltung der Liste selbst und nicht die einzelnen Elemente.

Siehe auch QTextBlock, QTextListFormat, und QTextCursor.

Dokumentation der Mitgliedsfunktionen

void QTextList::add(const QTextBlock &block)

Macht das angegebene block zu einem Teil der Liste.

Siehe auch remove() und removeItem().

int QTextList::count() const

Gibt die Anzahl der Elemente in der Liste zurück.

QTextListFormat QTextList::format() const

Gibt das Format der Liste zurück.

Siehe auch setFormat().

QTextBlock QTextList::item(int i) const

Gibt den i-ten Textblock in der Liste zurück.

Siehe auch count() und itemText().

int QTextList::itemNumber(const QTextBlock &block) const

Gibt den Index des Listenelements zurück, das dem angegebenen block entspricht. Gibt -1 zurück, wenn der Block nicht in der Liste vorhanden war.

QString QTextList::itemText(const QTextBlock &block) const

Gibt den Text des Listeneintrags zurück, der dem angegebenen block entspricht.

void QTextList::remove(const QTextBlock &block)

Entfernt die angegebene block aus der Liste.

Siehe auch add() und removeItem().

void QTextList::removeItem(int i)

Entfernt das Element an der Position i aus der Liste. Wenn das letzte Element in der Liste entfernt wird, wird die Liste automatisch von dem QTextDocument gelöscht, dem sie gehört.

Siehe auch add() und remove().

void QTextList::setFormat(const QTextListFormat &format)

Setzt das Format der Liste auf format.

Siehe auch format().

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