Auf dieser Seite

QHelpIndexModel Class

Die Klasse „QHelpIndexModel“ stellt ein Modell bereit, das den Ansichten Index-Schlüsselwörter zur Verfügung stellt. Mehr...

Kopfzeile: #include <QHelpIndexModel>
CMake: find_package(Qt6 REQUIRED COMPONENTS Help)
target_link_libraries(mytarget PRIVATE Qt6::Help)
qmake: QT += help
Erbt von: QStringListModel

Öffentliche Funktionen

void createIndex(const QString &filter)
(since 6.8) void createIndexForCurrentFilter()
QModelIndex filter(const QString &filter, const QString &wildcard = {})
QHelpEngineCore *helpEngine() const
bool isCreatingIndex() const

Signale

Ausführliche Beschreibung

Dokumentation der Mitgliedsfunktionen

void QHelpIndexModel::createIndex(const QString &filter)

Erstellt einen neuen Index, indem das Hilfesystem nach Stichwörtern für den angegebenen benutzerdefinierten Namen „ filter “ durchsucht wird.

[since 6.8] void QHelpIndexModel::createIndexForCurrentFilter()

Erstellt einen neuen Index, indem das Hilfesystem nach Stichwö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 Schlüsselworts zurück. In einem ersten Schritt werden nur die Schlüsselwörter, die „ filter “ enthalten, in der Indexliste des Modells beibehalten. Analog dazu bleiben, wenn „ wildcard “ nicht leer ist, nur die übereinstimmenden Schlüsselwörter in der Indexliste erhalten. In einem zweiten Schritt wird die beste Übereinstimmung ermittelt und deren Modellindex zurückgegeben. Bei der Angabe eines Platzhalterausdrucks wird die Zeichenfolge „ filter “ verwendet, um nach der besten Übereinstimmung zu suchen.

QHelpEngineCore *QHelpIndexModel::helpEngine() const

Gibt die zugehörige Hilfe-Engine zurück, die dieses Modell verwaltet.

[signal] void QHelpIndexModel::indexCreated()

Dieses Signal wird ausgegeben, sobald der Index angelegt wurde.

[signal] void QHelpIndexModel::indexCreationStarted()

Dieses Signal wird ausgelöst, wenn die Erstellung eines neuen Indexes begonnen hat. Der aktuelle Index ist ab diesem Zeitpunkt ungültig, bis das Signal „ indexCreated()“ ausgelöst wird.

Siehe auch ` isCreatingIndex()`.

bool QHelpIndexModel::isCreatingIndex() const

Gibt „true“ zurück, wenn der Index derzeit aufgebaut ist, andernfalls „false“.

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