QHelpFilterEngine Class
Die Klasse QHelpFilterEngine bietet eine gefilterte Ansicht der Hilfeinhalte. Mehr...
| Kopfzeile: | #include <QHelpFilterEngine> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS Help)target_link_libraries(mytarget PRIVATE Qt6::Help) |
| qmake: | QT += help |
| Vererbt: | QObject |
Öffentliche Funktionen
| QString | activeFilter() const |
| QStringList | availableComponents() const |
| QList<QVersionNumber> | availableVersions() const |
| QHelpFilterData | filterData(const QString &filterName) const |
| QStringList | filters() const |
| QStringList | indices() const |
| QStringList | indices(const QString &filterName) const |
| QMap<QString, QString> | namespaceToComponent() const |
| QMap<QString, QVersionNumber> | namespaceToVersion() const |
| QStringList | namespacesForFilter(const QString &filterName) const |
| bool | removeFilter(const QString &filterName) |
| bool | setActiveFilter(const QString &filterName) |
| bool | setFilterData(const QString &filterName, const QHelpFilterData &filterData) |
Signale
| void | filterActivated(const QString &newFilter) |
Detaillierte Beschreibung
Die Filter-Engine ermöglicht die Verwaltung von Filtern, die mit einer QHelpEngineCore -Instanz verbunden sind. Die Hilfe-Engine erstellt intern eine Instanz der Filter-Engine, auf die durch den Aufruf von QHelpEngineCore::filterEngine() zugegriffen werden kann. Daher ist der öffentliche Konstruktor dieser Klasse deaktiviert.
Die Filter werden durch eine Zeichenkette für den Filternamen identifiziert. Die Details der Filter werden von der Klasse QHelpFilterData beschrieben.
Die Filter-Engine ermöglicht das Hinzufügen neuer Filter und das Ändern der Daten vorhandener Filter durch die Methode setFilterData(). Ein vorhandener Filter kann mit der Methode removeFilter() entfernt werden.
Von den registrierten Filtern kann einer als aktiver Filter markiert werden. Der aktive Filter wird von der zugehörigen Hilfemaschine für die Rückgabe gefilterter Ergebnisse vieler verschiedener Funktionen, wie Inhalt, Index oder Suchergebnisse, verwendet. Wenn kein Filter als aktiv markiert ist, gibt die Hilfemaschine die gesamte verfügbare Ergebnisliste zurück.
Der aktive Filter wird durch activeFilter() zurückgegeben und kann durch setActiveFilter() geändert werden.
Siehe auch QHelpEngineCore.
Dokumentation der Mitgliedsfunktionen
QString QHelpFilterEngine::activeFilter() const
Gibt den Namen des derzeit aktiven Filters zurück.
Siehe auch setActiveFilter().
QStringList QHelpFilterEngine::availableComponents() const
Gibt die Liste aller verfügbaren Komponenten zurück, die in allen registrierten Dokumentationsdateien definiert sind.
QList<QVersionNumber> QHelpFilterEngine::availableVersions() const
Gibt die Liste aller verfügbaren Versionen zurück, die in allen registrierten Dokumentationsdateien definiert sind.
[signal] void QHelpFilterEngine::filterActivated(const QString &newFilter)
Dieses Signal wird ausgesendet, wenn der aktive Filter gesetzt ist. newFilter gibt den Namen des Filters an.
Siehe auch setActiveFilter().
QHelpFilterData QHelpFilterEngine::filterData(const QString &filterName) const
Gibt die mit filterName verbundenen Filterdetails zurück.
Siehe auch setFilterData().
QStringList QHelpFilterEngine::filters() const
Gibt die Liste aller in der Filter-Engine definierten Filternamen zurück.
QStringList QHelpFilterEngine::indices() const
Gibt eine sortierte Liste der verfügbaren Indizes zurück. Der Inhalt der zurückgegebenen Liste hängt vom aktiven Filter ab. Es werden daher nur die für den aktiven Filter registrierten Indizes zurückgegeben.
QStringList QHelpFilterEngine::indices(const QString &filterName) const
Gibt eine sortierte Liste der verfügbaren Indizes zurück, gefiltert nach filterName. Der Inhalt der zurückgegebenen Liste hängt von dem übergebenen Filter ab, daher werden nur die für diesen Filter registrierten Indizes zurückgegeben. Wenn Sie alle verfügbaren Indizes ungefiltert erhalten möchten, übergeben Sie einen leeren String als filterName.
QMap<QString, QString> QHelpFilterEngine::namespaceToComponent() const
Gibt die Map aller verfügbaren Namespaces als Schlüssel zusammen mit ihren zugehörigen Komponenten als Werte zurück.
QMap<QString, QVersionNumber> QHelpFilterEngine::namespaceToVersion() const
Gibt die Map aller verfügbaren Namespaces als Schlüssel zusammen mit ihren zugehörigen Versionen als Werte zurück.
QStringList QHelpFilterEngine::namespacesForFilter(const QString &filterName) const
Gibt die Liste aller registrierten Dokumentations-Namespaces zurück, die dem durch filterName identifizierten Filter entsprechen.
bool QHelpFilterEngine::removeFilter(const QString &filterName)
Entfernt den durch filterName identifizierten Filter.
Gibt true zurück, wenn das Entfernen des Filters erfolgreich war, andernfalls false.
bool QHelpFilterEngine::setActiveFilter(const QString &filterName)
Ändert den derzeit aktiven Filter in filterName.
Gibt true zurück, wenn die Änderung des Filters erfolgreich war, andernfalls false.
Siehe auch activeFilter().
bool QHelpFilterEngine::setFilterData(const QString &filterName, const QHelpFilterData &filterData)
Ändert die bestehenden Filterdetails des durch filterName identifizierten Filters in filterData. Wenn der Filter nicht existiert, wird ein neuer Filter erstellt.
Gibt true zurück, wenn das Setzen des Filters erfolgreich war, andernfalls false.
Siehe auch filterData().
© 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.
