- Qt 5.5
- Qt WebEngine
- QML Types
- WebEngineProfile QML Type
- Qt 5.5.1 Reference Documentation

# WebEngineProfile QML Type

Contains common settings for multiple web engine views. More...

Import Statement: | import QtWebEngine 1.1
Since: | QtWebEngine 1.1

- List of all members, including inherited members

## Properties

- cachePath : QString
- httpCacheMaximumSize : int
- httpCacheType : enumeration
- httpUserAgent : QString
- offTheRecord : bool
- persistentCookiesPolicy : enumeration
- persistentStoragePath : QString
- storageName : QString

## Signals

- downloadFinished(WebEngineDownloadItem download)
- downloadRequested(WebEngineDownloadItem download)

## Detailed Description

Contains settings and history shared by all the web engine views that belong to the profile.

Each web engine view has an associated profile. Views that do not have a specific profile set share a common default one.

## Property Documentation

cachePath : QString

The path to the location where the profile's caches are stored, in particular the HTTP cache.

By default, the caches are stored below QStandardPaths::writableLocation(QStandardPaths::CacheLocation) in a directory named using storageName.

httpCacheMaximumSize : int

The maximum size of the HTTP cache. If `0`, the size will be controlled automatically by QtWebEngine. The default value is `0`.

See also httpCacheType.

httpCacheType : enumeration

This enumeration describes the type of the HTTP cache:

Constant | Description
--- | ---
`MemoryHttpCache` | Uses an in-memory cache. This is the only setting possible if offTheRecord is set or no persistentStoragePath is available.
`DiskHttpCache` | Uses a disk cache. This is the default value.

httpUserAgent : QString

The user-agent string sent with HTTP to identify the browser.

offTheRecord : bool

Whether the web engine profile is off-the-record. An off-the-record profile forces cookies, the HTTP cache, and other normally persistent data to be stored only in memory.

persistentCookiesPolicy : enumeration

This enumeration describes the policy of cookie persistency:

Constant | Description
--- | ---
`NoPersistentCookies` | Both session and persistent cookies are stored in memory. This is the only setting possible if offTheRecord is set or no persistentStoragePath is available.
`AllowPersistentCookies` | Cookies marked persistent are saved to and restored from disk, whereas session cookies are only stored to disk for crash recovery. This is the default setting.
`ForcePersistentCookies` | Both session and persistent cookies are saved to and restored from disk.

persistentStoragePath : QString

The path to the location where the persistent data for the browser and web content are stored. Persistent data includes persistent cookies, HTML5 local storage, and visited links.

By default, the storage is located below QStandardPaths::writableLocation(QStandardPaths::DataLocation) in a directory named using storageName.

storageName : QString

The storage name that is used to create separate subdirectories for each profile that uses the disk for storing persistent data and cache.

See also WebEngineProfile::persistentStoragePath and WebEngineProfile::cachePath.

## Signal Documentation

downloadFinished(WebEngineDownloadItem download)

This signal is emitted whenever downloading stops, because it finished successfully, was cancelled, or was interrupted (for example, because connectivity was lost). The download argument holds the state of the finished download instance.

downloadRequested(WebEngineDownloadItem download)

This signal is emitted whenever a download has been triggered. The download argument holds the state of the download. The download has to be explicitly accepted with WebEngineDownloadItem::accept() or the download will be cancelled by default.