QHelpIndexModel Class

Dokumentation der Mitgliedsfunktionen

void QHelpIndexModel::createIndex(const QString &filter)

Erstellt einen neuen Index, indem das Hilfesystem nach Schlüsselwörtern für den angegebenen benutzerdefinierten Namen filter abgefragt wird.

[since 6.8] void QHelpIndexModel::createIndexForCurrentFilter()

Erzeugt einen neuen Index, indem das Hilfesystem nach Schlüsselwörtern für den aktuellen Filter abgefragt wird.

Diese Funktion wurde in Qt 6.8 eingeführt.

QModelIndex QHelpIndexModel::filter(const QString &filter, const QString &wildcard = {})

Filtert die Indizes und gibt den Modellindex des am besten passenden Stichworts zurück. In einem ersten Schritt werden nur die Schlüsselwörter, die filter enthalten, in der Indexliste des Modells behalten. Wenn wildcard nicht leer ist, verbleiben nur die übereinstimmenden Schlüsselwörter in der Indexliste. In einem zweiten Schritt wird die beste Übereinstimmung ermittelt und ihr Indexmodell zurückgegeben. Bei der Angabe eines Platzhalterausdrucks wird die Zeichenfolge filter für die Suche nach der besten Übereinstimmung verwendet.

QHelpEngineCore *QHelpIndexModel::helpEngine() const

Gibt die zugehörige Hilfemaschine zurück, die dieses Modell verwaltet.

[signal] void QHelpIndexModel::indexCreated()

Dieses Signal wird ausgegeben, wenn der Index erstellt wurde.

[signal] void QHelpIndexModel::indexCreationStarted()

Dieses Signal wird ausgegeben, wenn die Erstellung eines neuen Index begonnen hat. Der aktuelle Index ist von diesem Zeitpunkt an ungültig, bis das Signal indexCreated() ausgegeben wird.

Siehe auch isCreatingIndex().

bool QHelpIndexModel::isCreatingIndex() const

Gibt true zurück, wenn der Index gerade aufgebaut wird, andernfalls false.