WebEngineProfile QML Type
Contient des paramètres, des scripts et des liens visités communs à plusieurs moteurs web. Plus...
| Import Statement: | import QtWebEngine |
| Since: | QtWebEngine 1.1 |
| In C++: | QQuickWebEngineProfile |
Propriétés
- cachePath : string
- downloadPath : string
(since QtWebEngine 1.9) - httpAcceptLanguage : string
(since QtWebEngine 1.2) - httpCacheMaximumSize : int
- httpCacheType : enumeration
- httpUserAgent : string
- isPushServiceEnabled : bool
(since QtWebEngine 6.5) - offTheRecord : bool
- persistentCookiesPolicy : enumeration
- persistentPermissionsPolicy : enumeration
(since 6.8) - persistentStoragePath : string
- spellCheckEnabled : bool
(since QtWebEngine 1.4) - spellCheckLanguages : list<string>
(since QtWebEngine 1.4) - storageName : string
- userScripts : WebEngineScriptCollection
Signaux
- clearHttpCacheCompleted()
(since QtWebEngine 6.7) - downloadFinished(WebEngineDownloadRequest download)
- downloadRequested(WebEngineDownloadRequest download)
- presentNotification(WebEngineNotification notification)
(since QtWebEngine 1.9)
Méthodes
- void clearHttpCache()
(since QtWebEngine 1.3) - list<webEnginePermission> listAllPermissions()
(since 6.8) - list<webEnginePermission> listPermissionsForOrigin(url securityOrigin)
(since 6.8) - list<webEnginePermission> listPermissionsForPermissionType(WebEnginePermission.PermissionType permissionType)
(since 6.8) - void queryPermission(url securityOrigin, WebEnginePermission.PermissionType permissionType)
(since 6.8)
Description détaillée
WebEngineProfile contient des paramètres, des scripts et la liste des liens visités partagés par toutes les vues qui appartiennent au profil.
Les informations sur les liens visités sont stockées avec les cookies persistants et d'autres données persistantes dans un stockage déterminé par la propriété storageName. Les données persistantes sont stockées dans un sous-répertoire déterminé par la propriété persistentStoragePath et le cache dans un sous-répertoire déterminé par la propriété cachePath. La propriété httpCacheType décrit le type de cache : en mémoire ou sur disque. Si seule la propriété storageName est définie, les autres valeurs sont générées automatiquement en fonction de celle-ci. Si vous spécifiez l'une des valeurs manuellement, vous devez le faire avant de créer des pages appartenant au profil.
Les profils peuvent être utilisés pour isoler les pages les unes des autres. Un cas d'utilisation typique est celui d'un profil dédié à un mode de navigation privée. Un profil hors enregistrement oblige les cookies, le cache HTTP et d'autres données normalement persistantes à n'être stockés qu'en mémoire. La propriété offTheRecord indique si un profil est hors enregistrement.
Chaque vue du moteur web est associée à un profil. Les vues qui n'ont pas de profil spécifique partagent un profil commun, qui n'est pas enregistré par défaut.
Remarque : il est recommandé d'utiliser la nouvelle propriété WebEngineProfilePrototype pour la création de profils à partir de la version 6.9.
Documentation sur les propriétés
cachePath : string
Le chemin vers l'emplacement où sont stockés les caches du profil, en particulier le cache HTTP.
Par défaut, les caches sont stockés sous QStandardPaths::writableLocation(QStandardPaths::CacheLocation) dans un répertoire nommé using storageName.
downloadPath : string [since QtWebEngine 1.9]
Chemin d'accès à l'emplacement où sont stockés les fichiers téléchargés.
Remplace le chemin par défaut utilisé pour l'emplacement de téléchargement.
S'il s'agit d'une chaîne vide, le chemin par défaut est rétabli.
Note : Par défaut, le chemin de téléchargement est QStandardPaths::DownloadLocation.
Cette propriété a été introduite dans QtWebEngine 1.9.
httpAcceptLanguage : string [since QtWebEngine 1.2]
La valeur du champ Accept-Language de l'en-tête de requête HTTP.
Cette propriété a été introduite dans QtWebEngine 1.2.
httpCacheMaximumSize : int
La taille maximale du cache HTTP. Si 0, la taille sera contrôlée automatiquement par QtWebEngine. La valeur par défaut est 0.
Voir également httpCacheType.
httpCacheType : enumeration
Cette énumération décrit le type de cache HTTP :
| Constante | Description |
|---|---|
WebEngineProfile.MemoryHttpCache | Utilise un cache en mémoire. C'est le seul paramètre possible si offTheRecord est défini ou si aucun storageName n'est disponible, ce qui est la valeur par défaut. |
WebEngineProfile.DiskHttpCache | Utilise un cache sur disque. Il s'agit de la valeur par défaut pour les profils non-off-the-record avec storageName. |
WebEngineProfile.NoCache | Désactive la mise en cache. (Ajouté dans la version 5.7) |
httpUserAgent : string
Chaîne de l'agent utilisateur envoyée avec HTTP pour identifier le navigateur.
Remarque : sous Windows 8.1 et les versions plus récentes, l'agent utilisateur par défaut indiquera toujours "Windows NT 6.2" (Windows 8), à moins que l'application ne contienne un manifeste déclarant que des versions plus récentes de Windows sont prises en charge.
isPushServiceEnabled : bool [since QtWebEngine 6.5]
Si le service de messagerie push est activé.
Remarque : par défaut, le service de messagerie push est désactivé.
Remarque : Qt WebEngine utilise Firebase Cloud Messaging (FCM) comme service de push pour le navigateur. Par conséquent, tous les messages push passeront par le service push de Google et ses serveurs respectifs.
Cette propriété a été introduite dans QtWebEngine 6.5.
offTheRecord : bool
Si le profil du moteur web est "off-the-record". Un profil "off-the-record" oblige les cookies, le cache HTTP et d'autres données normalement persistantes à n'être stockés qu'en mémoire. Le profil est désactivé par défaut.
Le passage d'un profil "off-the-record " à un comportement basé sur le disque nécessite également la définition d'une adresse storageName.
Voir également storageName.
persistentCookiesPolicy : enumeration
Cette énumération décrit la politique de persistance des cookies :
| Constante | Description |
|---|---|
WebEngineProfile.NoPersistentCookies | Les cookies de session et les cookies persistants sont stockés en mémoire. C'est le seul paramètre possible si offTheRecord est défini ou si aucun storageName n'est disponible, ce qui est la valeur par défaut. |
WebEngineProfile.AllowPersistentCookies | Les cookies persistants sont enregistrés sur le disque et restaurés à partir de celui-ci, tandis que les cookies de session ne sont stockés sur le disque qu'à des fins de récupération en cas de panne. Il s'agit de la valeur par défaut pour les profils non confidentiels avec storageName. |
WebEngineProfile.OnlyPersistentCookies | Les cookies persistants sont enregistrés et restaurés sur le disque, tandis que les cookies de session ne sont jamais enregistrés sur le disque, même en cas de récupération après une panne. |
WebEngineProfile.ForcePersistentCookies | Les cookies de session et les cookies persistants sont tous deux enregistrés et restaurés sur le disque. |
persistentPermissionsPolicy : enumeration [since 6.8]
Cette énumération décrit la politique de persistance des autorisations :
| Constante | Description |
|---|---|
WebEngineProfile.AskEveryTime | L'application demandera des autorisations à chaque fois qu'elles seront nécessaires, qu'elles aient été accordées auparavant ou non. Cette pratique est destinée à assurer la compatibilité ascendante avec les applications existantes et n'est pas recommandée par ailleurs. |
WebEngineProfile.StoreInMemory | Une demande ne sera faite que la première fois qu'une permission est nécessaire. Toute demande ultérieure sera automatiquement accordée ou refusée, en fonction du choix initial de l'utilisateur. Ceci s'applique à toutes les pages utilisant la même instance de QWebEngineProfile, jusqu'à ce que l'application soit fermée. C'est le paramètre appliqué si off-the-record est défini ou si aucun chemin de données persistant n'est disponible. |
WebEngineProfile.StoreOnDisk | Fonctionne de la même manière que PersistentPermissionsInMemory, mais les autorisations sont enregistrées sur le disque et restaurées à partir de celui-ci. Il s'agit du paramètre par défaut. |
Cette propriété a été introduite dans Qt 6.8.
persistentStoragePath : string
Chemin d'accès à l'emplacement où sont stockées les données persistantes du navigateur et du contenu web. Les données persistantes comprennent les cookies persistants, le stockage local HTML5 et les liens visités.
Par défaut, le stockage est situé sous QStandardPaths::writableLocation(QStandardPaths::AppDataLocation) dans un répertoire nommé storageName.
spellCheckEnabled : bool [since QtWebEngine 1.4]
Cette propriété indique si le correcteur orthographique du moteur web est activé.
Cette propriété a été introduite dans QtWebEngine 1.4.
spellCheckLanguages : list<string> [since QtWebEngine 1.4]
Cette propriété contient la liste des langues utilisées par le correcteur orthographique. Chaque langue doit correspondre au nom du dictionnaire .bdic. Par exemple, la langue en-US chargera le fichier de dictionnaire en-US.bdic.
Voir la documentation sur les fonctionnalités du correcteur orthographique pour savoir comment les fichiers de dictionnaire sont recherchés.
Pour plus d'informations sur la compilation des dictionnaires .bdic, voir l'exemple de Spellchecker.
Cette propriété a été introduite dans QtWebEngine 1.4.
storageName : string
Le nom de stockage utilisé pour créer des sous-répertoires distincts pour chaque profil qui utilise le disque pour stocker des données persistantes et du cache.
Voir également WebEngineProfile::persistentStoragePath et WebEngineProfile::cachePath.
userScripts : WebEngineScriptCollection [read-only]
Collection d'objets WebEngineScript injectés dans toutes les pages qui partagent ce profil.
Documentation sur le signal
[since QtWebEngine 6.7] clearHttpCacheCompleted()
Ce signal est émis lorsque l'opération clearHttpCache() est terminée.
Note : Le gestionnaire correspondant est onClearHttpCacheCompleted.
Ce signal a été introduit dans QtWebEngine 6.7.
Voir aussi clearHttpCache().
downloadFinished(WebEngineDownloadRequest download)
Ce signal est émis lorsque le téléchargement s'arrête, parce qu'il s'est terminé avec succès, qu'il a été annulé ou qu'il a été interrompu (par exemple, en raison d'une perte de connectivité). L'argument download contient l'état de l'instance de téléchargement terminée.
Remarque : le gestionnaire correspondant est onDownloadFinished.
downloadRequested(WebEngineDownloadRequest download)
Ce signal est émis lorsqu'un téléchargement a été déclenché. L'argument download contient l'état du téléchargement. Le téléchargement doit être explicitement accepté avec WebEngineDownloadRequest::accept() ou le téléchargement sera annulé par défaut.
Remarque : le gestionnaire correspondant est onDownloadRequested.
[since QtWebEngine 1.9] presentNotification(WebEngineNotification notification)
Ce signal est émis chaque fois qu'il y a une notification d'utilisateur nouvellement créée. L'argument notification contient l'instance WebEngineNotification avec laquelle il faut interroger les données et interagir.
Note : Le gestionnaire correspondant est onPresentNotification.
Ce signal a été introduit dans QtWebEngine 1.9.
Documentation de la méthode
[since QtWebEngine 1.3] void clearHttpCache()
Supprime les entrées du cache du profil.
Note : Veillez à ne pas commencer une nouvelle navigation ou toute autre opération sur le profil pendant que l'opération d'effacement est en cours. Le signal clearHttpCacheCompleted() notifie l'achèvement de l'opération.
Cette méthode a été introduite dans QtWebEngine 1.3.
Voir aussi WebEngineProfile::cachePath et clearHttpCacheCompleted().
[since 6.8] list<webEnginePermission> listAllPermissions()
Renvoie un list d'objets webEnginePermission, chacun représentant une seule autorisation actuellement présente dans la base de données des autorisations. La liste renvoyée contient toutes les autorisations précédemment accordées/refusées pour ce profil, à condition qu'elles soient de type persistant.
Remarque : lorsque la propriété persistentPermissionPolicy est définie sur AskEveryTime, cette méthode renvoie une liste vide.
Cette méthode a été introduite dans Qt 6.8.
Voir aussi queryPermission(), listPermissionsForOrigin(), listPermissionsForPermissionType() et webEnginePermission::isPersistent().
[since 6.8] list<webEnginePermission> listPermissionsForOrigin(url securityOrigin)
Renvoie un list d'objets webEnginePermission, chacun représentant une seule autorisation actuellement présente dans le magasin des autorisations. La liste renvoyée contient toutes les autorisations précédemment accordées/refusées associées à un securityOrigin spécifique pour ce profil, à condition qu'elles soient d'un type persistant.
Remarque : les autorisations étant accordées en fonction de l'origine, l'adresse securityOrigin fournie sera réduite à sa forme d'origine et la liste renvoyée contiendra toutes les autorisations relatives à l'origine. Ainsi, passer https://www.example.com/some/page.html revient à passer uniquement https://www.example.com/.
Note : Lorsque persistentPermissionPolicy() est réglé sur AskEveryTime, cette méthode renverra une liste vide.
Cette méthode a été introduite dans Qt 6.8.
Voir aussi queryPermission(), listAllPermissions(), listPermissionsForPermissionType(), et webEnginePermission::isPersistent().
[since 6.8] list<webEnginePermission> listPermissionsForPermissionType(WebEnginePermission.PermissionType permissionType)
Renvoie un list d'objets webEnginePermission, chacun représentant une seule autorisation actuellement présente dans le registre des autorisations. La liste renvoyée contient toutes les autorisations précédemment accordées/refusées pour l'objet permissionType fourni. Si le type de permission est non persistant, la liste sera vide.
Note : Lorsque persistentPermissionPolicy() est réglé sur AskEveryTime, cette méthode renvoie une liste vide.
Cette méthode a été introduite dans Qt 6.8.
Voir aussi queryPermission(), listAllPermissions(), listPermissionsForOrigin(), et webEnginePermission::isPersistent().
[since 6.8] void queryPermission(url securityOrigin, WebEnginePermission.PermissionType permissionType)
Renvoie un objet webEnginePermission correspondant à une seule autorisation pour les sites securityOrigin et permissionType fournis. L'objet peut être utilisé pour demander l'état actuel de la permission ou pour la modifier. Il n'est pas nécessaire qu'une autorisation existe déjà ; l'objet retourné peut également être utilisé pour pré-attribuer une autorisation si un site web est connu pour l'utiliser.
Remarque : cette fonction ne peut être utilisée que pour les types de permission persistants. L'appeler avec une autorisation non persistante ( permissionType ) renverra un objet non valide.
Cette méthode a été introduite dans Qt 6.8.
Voir aussi listAllPermissions(), listPermissionsForOrigin(), et listPermissionsForPermissionType().
© 2026 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.
