QHelpEngineCore Class

Documentation des fonctions membres

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

Crée un nouveau moteur d'aide principal à l'aide d'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 collection n'existe pas encore, il sera créé.

[virtual noexcept] QHelpEngineCore::~QHelpEngineCore()

Supprime 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éé ; renvoie « true » en cas de réussite ; sinon, renvoie « false ».

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

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

Renvoie la valeur attribuée à l'key. Si la clé demandée n'existe pas, l'defaultValue spécifiée 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 l'namespaceName. Si aucun fichier d'aide compressé Qt portant l'espace de noms spécifié n'est enregistré, 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 vers des documents trouvés pour l'id. Le contenu de la liste renvoyée dépend du filtre actuel ; par conséquent, seuls les mots-clés enregistrés pour ce filtre seront renvoyés.

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

Renvoie une liste des liens vers les documents trouvés pour l'id, filtrés selon filterName. Le contenu de la liste renvoyée dépend du filtre passé ; par conséquent, seuls les mots-clés enregistrés pour ce filtre seront renvoyés. Si vous souhaitez obtenir tous les résultats sans filtrage, passez une chaîne vide comme filterName.

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

Renvoie une liste de tous les liens vers des documents trouvés pour l'keyword. Le contenu de la liste renvoyée dépend du filtre actuel ; par conséquent, seuls les mots-clés enregistrés pour ce filtre seront renvoyés.

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

Renvoie une liste des liens vers les documents trouvés pour l'keyword, filtrés selon filterName. Le contenu de la liste renvoyée dépend du filtre passé ; par conséquent, seuls les mots-clés enregistrés pour ce filtre seront renvoyés. Si vous souhaitez obtenir tous les résultats sans filtrage, passez une chaîne vide comme 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 objet ` QByteArray ` vide est renvoyé.

Voir également findFile().

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

Renvoie une liste des fichiers contenus dans le fichier d'aide compressé Qt 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 filtrage associé à ce moteur d'aide. Le moteur de filtrage permet d'ajouter, de modifier et de supprimer des filtres existants pour ce moteur d'aide. Pour utiliser ce moteur, vous devez également appeler la fonction ` setUsesFilterEngine()` en lui passant la valeur ` true`.

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

Renvoie l'URL corrigée de l'url, qui peut faire référence à un espace de noms différent défini par le dossier virtuel associé à l'url. Si le dossier virtuel correspond à l'espace de noms de l'url, la méthode se contente de vérifier si le fichier existe et renvoie la même url. Lorsque le dossier virtuel ne correspond pas à l’espace de noms de url, la méthode tente de trouver l’espace de noms le plus pertinent en fonction du filtre actif. Une fois l’espace de noms trouvé, elle renvoie l’URL corrigée si le fichier existe, sinon elle renvoie une URL non valide.

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

Renvoie les métadonnées du fichier d'aide compressé Qt XML documentationFileName. S'il n'y a pas de données disponibles pour name, un QVariant() non valide est renvoyé. 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 par la suite. Parmi les métadonnées courantes, on trouve 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 (.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 (.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. La fonction renvoie « True » si l'enregistrement a réussi, « False » dans le cas contraire.

Voir également 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 collection actuel. Les noms renvoyés correspondent aux espaces de noms des fichiers d'aide compressés Qt (.qch) enregistrés.

bool QHelpEngineCore::removeCustomValue(const QString &key)

Supprime la propriété « key » de la section « settings » du fichier de collection. Renvoie « true » si la valeur a été supprimée avec succès, sinon « false ».

Voir également ` customValue()` et ` setCustomValue()`.

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

Enregistrer l'value sous la clé key. Si la clé existe déjà, la valeur sera écrasée. Renvoie « true » si la valeur a été enregistrée avec succès, sinon « false ».

Voir également customValue() et removeCustomValue().

void QHelpEngineCore::setUsesFilterEngine(bool uses)

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

Voir également usesFilterEngine() et filterEngine().

bool QHelpEngineCore::setupData()

Configure le moteur d'aide en traitant les informations contenues dans le fichier de collection et renvoie « true » en cas de réussite ; sinon, renvoie « false ».

L'appel de cette fonction force le moteur d'aide à s'initialiser immédiatement. La plupart du temps, il n'est pas nécessaire d'appeler explicitement cette fonction, car les fonctions getter qui dépendent d'un moteur d'aide correctement configuré s'en chargent elles-mêmes.

[signal] void QHelpEngineCore::setupFinished()

Ce signal est émis une fois la configuration terminée.

[signal] void QHelpEngineCore::setupStarted()

Ce signal est émis au démarrage de la configuration.

bool QHelpEngineCore::unregisterDocumentation(const QString &namespaceName)

Supprime de la collection d'aide le fichier d'aide compressé Qt (.qch) identifié par son namespaceName. Renvoie « true » en cas de succès, « false » dans le cas contraire.

Voir également registerDocumentation() et error().

bool QHelpEngineCore::usesFilterEngine() const

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

Voir également 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 enregistré dans msg.