QHelpEngineCore Class

Dokumentation zu den Mitgliedsfunktionen

[explicit] QHelpEngineCore::QHelpEngineCore(const QString &collectionFile, QObject *parent = nullptr)

Erstellt eine neue Kern-Hilfe-Engine mit einer „ parent “. Die Hilfe-Engine nutzt die in der „ collectionFile “ gespeicherten Informationen, um Hilfe bereitzustellen. Falls die Sammlungsdatei noch nicht existiert, wird sie angelegt.

[virtual noexcept] QHelpEngineCore::~QHelpEngineCore()

Löscht die Hilfe-Engine.

bool QHelpEngineCore::copyCollectionFile(const QString &fileName)

Erstellt die Datei „ fileName “ und kopiert den gesamten Inhalt der aktuellen Sammlungsdatei in die neu erstellte Datei; gibt bei Erfolg „true“ zurück, andernfalls „false“.

Der Kopiervorgang stellt sicher, dass Dateiverweise auf Qt-Sammlungsdateien (.qch) entsprechend aktualisiert werden.

QVariant QHelpEngineCore::customValue(const QString &key, const QVariant &defaultValue = {}) const

Gibt den Wert zurück, der dem Schlüssel „ key “ zugewiesen wurde. Falls der angeforderte Schlüssel nicht existiert, wird der angegebene Wert „ defaultValue “ zurückgegeben.

Siehe auch ` setCustomValue()` und ` removeCustomValue()`.

QString QHelpEngineCore::documentationFileName(const QString &namespaceName)

Gibt den absoluten Dateinamen der durch den namespaceName identifizierten komprimierten Qt-Hilfedatei (.qch) zurück. Ist keine komprimierte Qt-Hilfedatei mit dem angegebenen Namensraum registriert, wird eine leere Zeichenkette zurückgegeben.

Siehe auch namespaceName().

QList<QHelpLink> QHelpEngineCore::documentsForIdentifier(const QString &id) const

Gibt eine Liste aller Dokumentlinks zurück, die für die „ id “ gefunden wurden. Der Inhalt der zurückgegebenen Liste hängt vom aktuellen Filter ab; daher werden nur die für den aktuellen Filter registrierten Schlüsselwörter zurückgegeben.

QList<QHelpLink> QHelpEngineCore::documentsForIdentifier(const QString &id, const QString &filterName) const

Gibt eine Liste der für „ id “ gefundenen Dokument-Links zurück, gefiltert nach „ filterName “. Der Inhalt der zurückgegebenen Liste hängt vom übergebenen Filter ab; daher werden nur die für diesen Filter registrierten Schlüsselwörter zurückgegeben. Wenn Sie alle Ergebnisse ungefiltert abrufen möchten, übergeben Sie eine leere Zeichenkette als „ filterName “.

QList<QHelpLink> QHelpEngineCore::documentsForKeyword(const QString &keyword) const

Gibt eine Liste aller Dokumentlinks zurück, die für die „ keyword “ gefunden wurden. Der Inhalt der zurückgegebenen Liste hängt vom aktuellen Filter ab; daher werden nur die für den aktuellen Filter registrierten Schlüsselwörter zurückgegeben.

QList<QHelpLink> QHelpEngineCore::documentsForKeyword(const QString &keyword, const QString &filterName) const

Gibt eine Liste der für „ keyword “ gefundenen Dokumentlinks zurück, gefiltert nach „ filterName “. Der Inhalt der zurückgegebenen Liste hängt vom übergebenen Filter ab; daher werden nur die für diesen Filter registrierten Schlüsselwörter zurückgegeben. Wenn Sie alle Ergebnisse ungefiltert abrufen möchten, übergeben Sie eine leere Zeichenfolge als „ filterName “.

QString QHelpEngineCore::error() const

Gibt eine Beschreibung des zuletzt aufgetretenen Fehlers zurück.

QByteArray QHelpEngineCore::fileData(const QUrl &url) const

Gibt die Daten der durch ` url` angegebenen Datei zurück. Wenn die Datei nicht existiert, wird ein leeres ` QByteArray ` zurückgegeben.

Siehe auch findFile().

QList<QUrl> QHelpEngineCore::files(const QString namespaceName, const QString &filterName, const QString &extensionFilter = {})

Gibt eine Liste der Dateien zurück, die in der komprimierten Qt-Hilfedatei für namespaceName enthalten sind. Die Dateien können sowohl nach filterName als auch nach ihrer Dateiendung extensionFilter (z. B. „html“) gefiltert werden.

QHelpFilterEngine *QHelpEngineCore::filterEngine() const

Gibt die zu dieser Hilfe-Engine gehörende Filter-Engine zurück. Die Filter-Engine ermöglicht das Hinzufügen, Ändern und Entfernen bestehender Filter für diese Hilfe-Engine. Um die Engine zu nutzen, müssen Sie außerdem die Funktion ` setUsesFilterEngine()` aufrufen, wobei ` true` als Parameter übergeben werden muss.

QUrl QHelpEngineCore::findFile(const QUrl &url) const

Gibt die korrigierte URL für die Datei „ url “ zurück, die möglicherweise auf einen anderen Namensraum verweist, der durch den virtuellen Ordner definiert ist, der als Teil des „ url “ festgelegt wurde. Wenn der virtuelle Ordner mit dem Namensraum der Datei „ url “ übereinstimmt, prüft die Methode lediglich, ob die Datei vorhanden ist, und gibt dieselbe URL „ url “ zurück. Wenn der virtuelle Ordner nicht mit dem Namensraum von url übereinstimmt, wird versucht, den am besten passenden Namensraum gemäß dem aktiven Filter zu finden. Wurde der Namensraum gefunden, wird die korrigierte URL zurückgegeben, sofern die Datei existiert; andernfalls wird eine ungültige URL zurückgegeben.

[static] QVariant QHelpEngineCore::metaData(const QString &documentationFileName, const QString &name)

Gibt die Metadaten für die komprimierte Qt-Hilfedatei documentationFileName zurück. Sind für name keine Daten verfügbar, wird ein ungültiges QVariant() zurückgegeben. Die Metadaten werden beim Erstellen der komprimierten Qt-Hilfedatei festgelegt und können später nicht mehr geändert werden. Zu den üblichen Metadaten gehört beispielsweise der Autor der Dokumentation.

[static] QString QHelpEngineCore::namespaceName(const QString &documentationFileName)

Gibt den Namespace-Namen zurück, der für die durch den Parameter „ documentationFileName “ angegebene komprimierte Qt-Hilfedatei (.qch) definiert ist. Ist die Datei ungültig, wird eine leere Zeichenkette zurückgegeben.

Siehe auch ` documentationFileName()` ().

bool QHelpEngineCore::registerDocumentation(const QString &documentationFileName)

Registriert die in der Datei „ documentationFileName “ enthaltene komprimierte Qt-Hilfedatei (.qch). Eine komprimierte Hilfedatei, die durch ihren Namensraum eindeutig identifiziert wird, kann nur einmal registriert werden. Bei erfolgreicher Registrierung wird „true“ zurückgegeben, andernfalls „false“.

Siehe auch unregisterDocumentation() und error().

QStringList QHelpEngineCore::registeredDocumentations() const

Gibt eine Liste aller registrierten komprimierten Qt-Hilfedateien der aktuellen Sammeldatei zurück. Bei den zurückgegebenen Namen handelt es sich um die Namespaces der registrierten komprimierten Qt-Hilfedateien (.qch).

bool QHelpEngineCore::removeCustomValue(const QString &key)

Entfernt den Eintrag „ key “ aus dem Abschnitt „settings“ in der Sammlungsdatei. Gibt „true“ zurück, wenn der Wert erfolgreich entfernt wurde, andernfalls „false“.

Siehe auch „ customValue()“ und „ setCustomValue()“.

bool QHelpEngineCore::setCustomValue(const QString &key, const QVariant &value)

Speichern Sie den value unter dem key. Falls der Schlüssel bereits vorhanden ist, wird der Wert überschrieben. Gibt „true“ zurück, wenn der Wert erfolgreich gespeichert wurde, andernfalls „false“.

Siehe auch ` customValue()` und ` removeCustomValue()`.

void QHelpEngineCore::setUsesFilterEngine(bool uses)

Aktiviert oder deaktiviert die neue Filter-Engine-Funktionalität innerhalb der Hilfe-Engine entsprechend dem übergebenen Parameter „ uses “.

Siehe auch „ usesFilterEngine()“ und „ filterEngine()“.

bool QHelpEngineCore::setupData()

Richtet die Hilfe-Engine ein, indem die in der Sammeldatei enthaltenen Informationen verarbeitet werden, und gibt bei Erfolg „true“ zurück; andernfalls wird „false“ zurückgegeben.

Durch den Aufruf der Funktion wird die Hilfe-Engine gezwungen, sich sofort zu initialisieren. In den meisten Fällen muss diese Funktion nicht explizit aufgerufen werden, da Getter-Funktionen, die auf eine korrekt eingerichtete Hilfe-Engine angewiesen sind, dies selbst übernehmen.

[signal] void QHelpEngineCore::setupFinished()

Dieses Signal wird ausgegeben, sobald die Einrichtung abgeschlossen ist.

[signal] void QHelpEngineCore::setupStarted()

Dieses Signal wird beim Start des Einrichtungsvorgangs ausgegeben.

bool QHelpEngineCore::unregisterDocumentation(const QString &namespaceName)

Entfernt die durch ihren namespaceName identifizierte komprimierte Qt-Hilfedatei (.qch) aus der Hilfesammlung. Gibt bei Erfolg „true“ zurück, andernfalls „false“.

Siehe auch „ registerDocumentation()“ und „ error()“.

bool QHelpEngineCore::usesFilterEngine() const

Gibt zurück, ob die Hilfe-Engine die neue Filterfunktion nutzt.

Siehe auch setUsesFilterEngine() und filterEngine().

[signal] void QHelpEngineCore::warning(const QString &msg)

Dieses Signal wird ausgegeben, wenn ein nicht kritischer Fehler auftritt. Die Warnmeldung wird in „ msg “ gespeichert.