QHelpEngineCore Class

Dokumentation der Mitgliedsfunktionen

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

Konstruiert eine neue Kern-Hilfe-Engine mit einer parent. Die Hilfe-Engine verwendet die in der collectionFile gespeicherten Informationen, um Hilfe bereitzustellen. Wenn die Sammlungsdatei noch nicht vorhanden ist, wird sie erstellt.

[virtual noexcept] QHelpEngineCore::~QHelpEngineCore()

Zerstört die Hilfemaschine.

bool QHelpEngineCore::copyCollectionFile(const QString &fileName)

Erstellt die Datei fileName und kopiert alle Inhalte aus der aktuellen Sammlungsdatei in die neu erstellte Datei und gibt bei Erfolg true zurück; andernfalls wird false zurückgegeben.

Der Kopiervorgang sorgt dafür, 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 key zugewiesen wurde. Wenn der angeforderte Schlüssel nicht existiert, wird der angegebene defaultValue zurückgegeben.

Siehe auch setCustomValue() und removeCustomValue().

QString QHelpEngineCore::documentationFileName(const QString &namespaceName)

Gibt den absoluten Dateinamen der komprimierten Qt-Hilfedatei (.qch) zurück, die durch namespaceName identifiziert wird. Wenn keine komprimierte Qt-Hilfedatei mit dem angegebenen Namensraum registriert ist, wird ein leerer String zurückgegeben.

Siehe auch namespaceName().

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

Gibt eine Liste aller für id gefundenen Dokumentenlinks zurück. 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 Dokumentenlinks zurück, gefiltert nach filterName. Der Inhalt der zurückgegebenen Liste hängt von dem übergebenen Filter ab, so dass nur die für diesen Filter registrierten Schlüsselwörter zurückgegeben werden. Wenn Sie alle Ergebnisse ungefiltert erhalten möchten, übergeben Sie einen leeren String als filterName.

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

Gibt eine Liste aller für keyword gefundenen Dokumentenlinks zurück. 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 Dokumentenlinks zurück, gefiltert nach filterName. Der Inhalt der zurückgegebenen Liste hängt von dem übergebenen Filter ab, so dass nur die für diesen Filter registrierten Schlüsselwörter zurückgegeben werden. Wenn Sie alle Ergebnisse ungefiltert erhalten möchten, übergeben Sie einen leeren String 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. Existiert die Datei nicht, 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 Erweiterung extensionFilter (z. B. 'html') gefiltert werden.

QHelpFilterEngine *QHelpEngineCore::filterEngine() const

Gibt die mit dieser Hilfe-Engine verbundene 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 verwenden, müssen Sie auch setUsesFilterEngine() aufrufen, das auf true gesetzt ist.

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

Gibt die korrigierte URL für url zurück, die sich auf einen anderen Namensraum beziehen kann, der durch den virtuellen Ordner definiert ist, der als Teil von url definiert ist. Wenn der virtuelle Ordner mit dem Namensraum von url übereinstimmt, prüft die Methode nur, ob die Datei existiert und gibt dieselbe 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. Wenn der Namensraum gefunden wird, wird die korrigierte URL zurückgegeben, wenn 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 Help Datei documentationFileName zurück. Wenn keine Daten für name verfügbar sind, wird eine ungültige QVariant() zurückgegeben. Die Metadaten werden bei der Erstellung der komprimierten Qt-Hilfedatei definiert und können später nicht mehr geändert werden. Übliche Metadaten sind z.B. der Autor der Dokumentation.

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

Gibt den Namen des Namensraums zurück, der für die komprimierte Qt-Hilfedatei (.qch) definiert ist, die durch ihre documentationFileName angegeben ist. Wenn die Datei nicht gültig ist, wird ein leerer String zurückgegeben.

Siehe auch documentationFileName().

bool QHelpEngineCore::registerDocumentation(const QString &documentationFileName)

Registriert die komprimierte Qt-Hilfedatei (.qch), die in der Datei documentationFileName enthalten ist. Eine komprimierte Hilfedatei, die durch ihren Namespace eindeutig identifiziert wird, kann nur einmal registriert werden. True wird zurückgegeben, wenn die Registrierung erfolgreich war, andernfalls false.

Siehe auch unregisterDocumentation() und error().

QStringList QHelpEngineCore::registeredDocumentations() const

Gibt eine Liste aller registrierten komprimierten Qt-Hilfedateien der aktuellen Sammlungsdatei zurück. Die zurückgegebenen Namen sind die Namespaces der registrierten komprimierten Qt-Hilfedateien (.qch).

bool QHelpEngineCore::removeCustomValue(const QString &key)

Entfernt den Wert key aus dem Einstellungsabschnitt 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)

Speichert die value unter der key. Wenn der Schlüssel bereits existiert, 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 uses Parameter.

Siehe auch usesFilterEngine() und filterEngine().

bool QHelpEngineCore::setupData()

Richtet das Hilfesystem ein, indem es die in der Sammlungsdatei gefundenen Informationen verarbeitet und bei Erfolg true zurückgibt; andernfalls wird false zurückgegeben.

Durch den Aufruf der Funktion wird die Hilfemaschine gezwungen, sich sofort zu initialisieren. In den meisten Fällen muss diese Funktion nicht explizit aufgerufen werden, da Getter-Funktionen, die von einer korrekt eingerichteten Help-Engine abhängen, dies selbst tun.

[signal] void QHelpEngineCore::setupFinished()

Dieses Signal wird ausgegeben, wenn die Einrichtung abgeschlossen ist.

[signal] void QHelpEngineCore::setupStarted()

Dieses Signal wird ausgegeben, wenn die Einrichtung gestartet wird.

bool QHelpEngineCore::unregisterDocumentation(const QString &namespaceName)

Hebt die Registrierung der komprimierten Qt-Hilfedatei (.qch), die durch ihre namespaceName identifiziert wird, aus der Hilfesammlung auf. Gibt bei Erfolg true zurück, andernfalls false.

Siehe auch registerDocumentation() und error().

bool QHelpEngineCore::usesFilterEngine() const

Gibt zurück, ob die Hilfemaschine die neue Filterfunktionalität verwendet.

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.