QHelpEngineCore Class

Documentation des fonctions membres

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

Construit un nouveau moteur d'aide avec un fichier parent. Le moteur d'aide utilise les informations stockées dans le fichier collectionFile pour fournir de l'aide. Si le fichier de collecte n'existe pas encore, il sera créé.

[virtual noexcept] QHelpEngineCore::~QHelpEngineCore()

Détruit le moteur d'aide.

bool QHelpEngineCore::copyCollectionFile(const QString &fileName)

Crée le fichier fileName et copie tout le contenu du fichier de collection actuel dans le fichier nouvellement créé, et renvoie true en cas de succès ; sinon, renvoie false.

Le processus de copie s'assure que les références aux fichiers de la collection Qt XML (.qch) sont mises à jour en conséquence.

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

Renvoie la valeur attribuée à la clé key. Si la clé demandée n'existe pas, la valeur spécifiée defaultValue est renvoyée.

Voir également setCustomValue() et removeCustomValue().

QString QHelpEngineCore::documentationFileName(const QString &namespaceName)

Renvoie le nom de fichier absolu du fichier d'aide compressé Qt (.qch) identifié par namespaceName. S'il n'y a pas de fichier d'aide compressé Qt avec l'espace de noms spécifié, une chaîne vide est renvoyée.

Voir aussi namespaceName().

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

Renvoie une liste de tous les liens documentaires trouvés pour le site id. Le contenu de la liste renvoyée dépend du filtre actuel et, par conséquent, seuls les mots-clés enregistrés pour le filtre actuel seront renvoyés.

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

Renvoie une liste des liens documentaires trouvés pour id, filtrés par filterName. Le contenu de la liste renvoyée dépend du filtre passé, et donc seuls les mots-clés enregistrés pour ce filtre seront renvoyés. Si vous souhaitez obtenir tous les résultats sans filtre, transmettez une chaîne vide à filterName.

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

Renvoie une liste de tous les liens documentaires trouvés pour le site keyword. Le contenu de la liste renvoyée dépend du filtre actuel et, par conséquent, seuls les mots-clés enregistrés pour le filtre actuel seront renvoyés.

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

Renvoie une liste des liens documentaires trouvés pour keyword, filtrés par filterName. Le contenu de la liste renvoyée dépend du filtre passé, et donc seuls les mots-clés enregistrés pour ce filtre seront renvoyés. Si vous souhaitez obtenir tous les résultats sans filtre, transmettez une chaîne vide à filterName.

QString QHelpEngineCore::error() const

Renvoie une description de la dernière erreur survenue.

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

Renvoie les données du fichier spécifié par url. Si le fichier n'existe pas, un QByteArray vide est renvoyé.

Voir aussi findFile().

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

Renvoie une liste de fichiers contenus dans le fichier d'aide compressé de Qt Help pour namespaceName. Les fichiers peuvent être filtrés par filterName ainsi que par leur extension extensionFilter (par exemple, 'html').

QHelpFilterEngine *QHelpEngineCore::filterEngine() const

Renvoie le moteur de filtre associé à ce moteur d'aide. Le moteur de filtrage permet d'ajouter, de modifier et de supprimer les filtres existants pour ce moteur d'aide. Pour utiliser le moteur, vous devez également appeler setUsesFilterEngine() et le faire correspondre à true.

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

Renvoie l'URL corrigée pour url qui peut faire référence à un espace de noms différent défini par le dossier virtuel défini en tant que partie de url. Si le dossier virtuel correspond à l'espace de noms de url, la méthode vérifie simplement si le fichier existe et renvoie le même url. Si le dossier virtuel ne correspond pas à l'espace de noms de url, la méthode tente de trouver l'espace de noms qui correspond le mieux en fonction du filtre actif. Lorsque l'espace de noms est trouvé, elle renvoie l'URL corrigée si le fichier existe, sinon elle renvoie une URL invalide.

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

Renvoie les métadonnées du fichier d'aide compressé de Qt Help documentationFileName. S'il n'y a pas de données disponibles pour name, une QVariant() invalide est renvoyée. Les métadonnées sont définies lors de la création du fichier d'aide compressé Qt et ne peuvent pas être modifiées ultérieurement. Les métadonnées courantes comprennent par exemple l'auteur de la documentation.

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

Renvoie le nom de l'espace de noms défini pour le fichier d'aide compressé Qt Help (.qch) spécifié par son documentationFileName. Si le fichier n'est pas valide, une chaîne vide est renvoyée.

Voir aussi documentationFileName().

bool QHelpEngineCore::registerDocumentation(const QString &documentationFileName)

Enregistre le fichier d'aide compressé Qt Help (.qch) contenu dans le fichier documentationFileName. Un fichier d'aide compressé, identifié de manière unique par son espace de noms, ne peut être enregistré qu'une seule fois. True est renvoyé si l'enregistrement a réussi, sinon false.

Voir aussi unregisterDocumentation() et error().

QStringList QHelpEngineCore::registeredDocumentations() const

Renvoie une liste de tous les fichiers d'aide compressés Qt enregistrés dans le fichier de collecte actuel. Les noms renvoyés sont les espaces de noms des fichiers d'aide compressés Qt enregistrés (.qch).

bool QHelpEngineCore::removeCustomValue(const QString &key)

Supprime la valeur key de la section "settings" du fichier de collecte. Retourne true si la valeur a été supprimée avec succès, sinon false.

Voir aussi customValue() et setCustomValue().

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

Enregistre la valeur de value sous key. Si la clé existe déjà, la valeur sera écrasée. Retourne true si la valeur a été sauvegardée avec succès, sinon false.

Voir aussi customValue() et removeCustomValue().

void QHelpEngineCore::setUsesFilterEngine(bool uses)

Active ou désactive la nouvelle fonctionnalité du moteur de filtrage dans le moteur d'aide, en fonction du paramètre uses transmis.

Voir aussi usesFilterEngine() et filterEngine().

bool QHelpEngineCore::setupData()

Configure le moteur d'aide en traitant les informations trouvées dans le fichier de collecte et renvoie true en cas de succès, sinon renvoie false.

L'appel de cette fonction oblige le moteur d'aide à s'initialiser immédiatement. La plupart du temps, cette fonction n'a pas besoin d'être appelée explicitement car les fonctions getter qui dépendent d'un moteur d'aide correctement configuré le font elles-mêmes.

[signal] void QHelpEngineCore::setupFinished()

Ce signal est émis lorsque l'installation est terminée.

[signal] void QHelpEngineCore::setupStarted()

Ce signal est émis lorsque l'installation est lancée.

bool QHelpEngineCore::unregisterDocumentation(const QString &namespaceName)

Supprime le fichier d'aide compressé Qt Help (.qch) identifié par son adresse namespaceName de la collection d'aide. Retourne true en cas de succès, sinon false.

Voir aussi registerDocumentation() et error().

bool QHelpEngineCore::usesFilterEngine() const

Indique si le moteur d'aide utilise la nouvelle fonctionnalité de filtrage.

Voir aussi setUsesFilterEngine() et filterEngine().

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

Ce signal est émis lorsqu'une erreur non critique se produit. Le message d'avertissement est stocké dans msg.