класс WebEngineSettings

(SailfishOS::WebEngineSettings)

Предоставляет доступ к глобальным настройкам веб-движка. Подробнее…

Подключение:

#include <WebEngineSettings>

Список всех членов класса, включая унаследованные

Публичные типы

enum CookieBehavior { AcceptAll, BlockThirdParty, BlockAll }
enum PermissionRequestPolicy { Unknown, Allow, Block, Ask }
enum PreferenceType { UnknownPref, StringPref, IntPref, BoolPref }

Свойства

allowSelectText : bool
autoLoadImages : bool
cameraRequestPolicy : PermissionRequestPolicy
cookieBehavior : CookieBehavior
downloadDir : QString
geolocationRequestPolicy : PermissionRequestPolicy
initialized : const bool
javascriptEnabled : bool
microphoneRequestPolicy : PermissionRequestPolicy
pixelRatio : qreal
popupEnabled : bool
useDownloadDir : bool

Публичные функции

bool allowSelectText() const
bool autoLoadImages() const
PermissionRequestPolicy cameraRequestPolicy() const
CookieBehavior cookieBehavior() const
QString downloadDir() const
void enableLowPrecisionBuffers(bool enabled)
void enableProgressivePainting(bool enabled)
PermissionRequestPolicy geolocationRequestPolicy() const
bool isInitialized() const
bool javascriptEnabled() const
PermissionRequestPolicy microphoneRequestPolicy() const
qreal pixelRatio() const
bool popupEnabled() const
void setAllowSelectText(bool allow)
void setAutoLoadImages(bool enabled)
void setCameraRequestPolicy(PermissionRequestPolicy behavior)
void setCookieBehavior(CookieBehavior cookieBehavior)
void setDownloadDir(const QString &downloadDir)
void setGeolocationRequestPolicy(PermissionRequestPolicy behavior)
void setJavascriptEnabled(bool enabled)
void setMicrophoneRequestPolicy(PermissionRequestPolicy behavior)
void setPixelRatio(qreal pixelRatio)
void setPopupEnabled(bool enabled)
void setPreference(const QString &key, const QVariant &value)
void setPreference(const QString &key, const QVariant &value, PreferenceType preferenceType)
void setTileSize(const QSize &size)
void setUseDownloadDir(bool useDownloadDir)
bool useDownloadDir() const

Сигналы

void allowSelectTextChanged()
void autoLoadImagesChanged()
void cameraRequestPolicyChanged()
void cookieBehaviorChanged()
void downloadDirChanged()
void geolocationBehaviorChanged()
void initialized()
void javascriptEnabledChanged()
void microphoneRequestPolicyChanged()
void pixelRatioChanged()
void popupEnabledChanged()
void useDownloadDirChanged()

Статические публичные члены

void	initialize()
WebEngineSettings *	instance()

Подробное описание

Предоставляет доступ к глобальным настройкам веб-движка.

Класс-синглтон, предоставляющий доступ к глобальным настройкам веб-движка.

Описание типов класса

enum WebEngineSettings::CookieBehavior

Перечисление определяет поведение файлов cookie для использования движком.

Константа	Значение	Описание
`SailfishOS::WebEngineSettings::AcceptAll`	`0`	Принимать все cookie независимо от их происхождения.
`SailfishOS::WebEngineSettings::BlockThirdParty`	`1`	Принимать cookie, только если они принадлежат запрашиваемому домену.
`SailfishOS::WebEngineSettings::BlockAll`	`2`	Не принимать cookie.

enum WebEngineSettings::PermissionRequestPolicy

enum WebEngineSettings::PreferenceType

Перечисление определяет возможные типы настроек, которые можно использовать.

Константа	Значение	Описание
`SailfishOS::WebEngineSettings::UnknownPref`	`0`	Неизвестный тип настройки. `WebEngineSettings` интерпретирует значение с максимальной эффективностью.
`SailfishOS::WebEngineSettings::StringPref`	`32`	Настройка интерпретируется как строковый тип, также обычно используемый с `float`.
`SailfishOS::WebEngineSettings::IntPref`	`64`	Настройка интерпретируется как тип `int`.
`SailfishOS::WebEngineSettings::BoolPref`	`128`	Настройка интерпретируется как тип `bool` (`true` или `false`).

Описание свойств

allowSelectText : bool

Свойство устанавливает, разрешать ли пользователям выбирать текст на веб-странице.

Если установлено значение true, пользователю будет разрешено выбирать текст. Если установлено значение false, запросы на выделение текста будут заблокированы.

Значение по умолчанию: true.

Свойство соответствует настройке gecko "dom.allow_select_text".

Методы доступа:

bool allowSelectText() const
void setAllowSelectText(bool allow)

Сигнал уведомления:

void allowSelectTextChanged()

autoLoadImages : bool

Свойство указывает, следует ли автоматически загружать изображения.

Если установлено значение true, изображения будут загружаться и отображаться автоматически. При значении false изображения не будут загружаться.

Значение по умолчанию: true.

Свойство соответствует настройке gecko "permissions.default.image".

Установка значения false может помочь избежать отслеживания внешними серверами при отображении локального контента, но может помешать правильному отображению страницы.

Методы доступа:

bool autoLoadImages() const
void setAutoLoadImages(bool enabled)

Сигнал уведомления:

void autoLoadImagesChanged()

cameraRequestPolicy : PermissionRequestPolicy

Свойство определяет политику запроса камеры.

Политика запроса камеры может быть одной из следующих:

Константа	Описание
`WebEngineSettings.Ask`	Всегда спрашивать разрешения.
`WebEngineSettings.Allow`	Всегда разрешать.
`WebEngineSettings.Block`	Не запрашивать разрешение и отклонить запрос.

Свойство соответствует настройке gecko "permissions.default.camera".

Методы доступа:

PermissionRequestPolicy cameraRequestPolicy() const
void setCameraRequestPolicy(PermissionRequestPolicy behavior)

Сигнал уведомления:

void cameraRequestPolicyChanged()

cookieBehavior : CookieBehavior

Свойство задаёт поведение файлов cookie.

Поведение cookie может быть одним из следующих:

Константа	Описание
`WebEngineSettings.AcceptAll`	Принимать все cookie независимо от их происхождения, по умолчанию.
`WebEngineSettings.BlockThirdParty`	Принимать cookie, только если они принадлежат запрашиваемому домену.
`WebEngineSettings.BlockAll`	Не принимать cookie.

Свойство соответствует настройке gecko "network.cookie.cookieBehavior".

Методы доступа:

CookieBehavior cookieBehavior() const
void setCookieBehavior(CookieBehavior cookieBehavior)

Сигнал уведомления:

void cookieBehaviorChanged()

См. также WebEngineSettings::CookieBehavior.

downloadDir : QString

Свойство задаёт место для сохранения загруженных файлов.

Указывает абсолютный путь для сохранения загруженных файлов. Свойство применяется, только если для useDownloadDir установлено значение true.

Свойство соответствует настройке gecko "browser.download.downloadDir".

Методы доступа:

QString downloadDir() const
void setDownloadDir(const QString &downloadDir)

Сигнал уведомления:

void downloadDirChanged()

См. также useDownloadDir.

geolocationRequestPolicy : PermissionRequestPolicy

Свойство определяет политику запроса местоположения.

Политика запроса местоположения может быть одной из следующих:

Константа	Описание
`WebEngineSettings.Ask`	Всегда спрашивать разрешения.
`WebEngineSettings.Allow`	Всегда разрешать.
`WebEngineSettings.Block`	Не запрашивать разрешение и отклонить запрос.

Свойство соответствует настройке gecko "permissions.default.geo".

Методы доступа:

PermissionRequestPolicy geolocationRequestPolicy() const
void setGeolocationRequestPolicy(PermissionRequestPolicy behavior)

initialized : const bool

Свойство определяет, были ли инициализированы настройки движка.

Свойство возвращает значение true, если параметры ядра были инициализированы, и значение false в противном случае.

Методы доступа:

bool isInitialized() const

Сигнал уведомления:

void initialized()

См. также WebEngine::initialize и QMozContext::initialize.

javascriptEnabled : bool

Свойство указывает, будет ли JavaScript на странице выполняться автоматически.

При значении true JavaScript на странице будет выполняться. При значении false JavaScript не будет выполняться.

Значение по умолчанию: true.

Свойство соответствует настройке gecko "javascript.enabled".

Отключение JavaScript может быть полезным по соображениям безопасности, конфиденциальности или эффективности, но также может помешать правильному отображению страниц.

Методы доступа:

bool javascriptEnabled() const
void setJavascriptEnabled(bool enabled)

Сигнал уведомления:

void javascriptEnabledChanged()

microphoneRequestPolicy : PermissionRequestPolicy

Свойство определяет политику запроса микрофона.

Политика запроса микрофона может быть одной из следующих:

Константа	Описание
`WebEngineSettings.Ask`	Всегда спрашивать разрешения.
`WebEngineSettings.Allow`	Всегда разрешать.
`WebEngineSettings.Block`	Не запрашивать разрешение и отклонить запрос.

Свойство соответствует настройке gecko "permissions.default.microphone".

Методы доступа:

PermissionRequestPolicy microphoneRequestPolicy() const
void setMicrophoneRequestPolicy(PermissionRequestPolicy behavior)

Сигнал уведомления:

void microphoneRequestPolicyChanged()

pixelRatio : qreal

Свойство определяет отношение устройства к логическому пикселю.

Свойство представляет собой количество пикселей физического устройства, используемых для представления каждого логического пикселя веб-рендеринга.

Следовательно, pixelRatio, равное 2, приведёт к тому, что элементы будут отображаться на экране в два раза больше (покрывая в четыре раза большую площадь), чем, например, pixelRatio, равное 1.

Свойство соответствует настройке gecko "layout.css.devPixelsPerPx".

Примечание. В отличие от десктопного Firefox, изменение данного значения изменит только отображение веб-контента; оно не влияет на масштабирование пользовательского интерфейса..

Методы доступа:

qreal pixelRatio() const
void setPixelRatio(qreal pixelRatio)

Сигнал уведомления:

void pixelRatioChanged()

См. также WebView::resolution.

popupEnabled : bool

Свойство указывает, разрешать ли открывать всплывающие окна во время загрузки страницы.

Если установлено значение true, любые всплывающие окна, которые страница запрашивает открыть во время загрузки, будут разрешены для открытия. Если установлено значение false, запросы всплывающих окон будут заблокированы.

Значение по умолчанию: false.

Свойство соответствует настройке gecko "dom.disable_open_during_load".

Методы доступа:

bool popupEnabled() const
void setPopupEnabled(bool enabled)

Сигнал уведомления:

void popupEnabledChanged()

useDownloadDir : bool

Свойство устанавливает, следует ли использовать расположение загрузки по умолчанию.

Если установлено значение true, загруженные файлы будут сохраняться в место загрузки по умолчанию, как указано в свойстве downloadDir. Если установлено значение false, пользователю будет предложено указать место для каждого загружаемого файла.

Свойство соответствует настройке gecko "browser.download.useDownloadDir".

Методы доступа:

bool useDownloadDir() const
void setUseDownloadDir(bool useDownloadDir)

Сигнал уведомления:

void useDownloadDirChanged()

См. также downloadDir.

Описание функций-членов

void WebEngineSettings::enableLowPrecisionBuffers(bool enabled)

Устанавливает, следует ли включать буферы низкой точности.

Когда enabled равно true, механизм рендеринга будет отображать на экране тайлы с низким разрешением, в то время как рендерятся тайлы с полным разрешением.

Это можно использовать, чтобы сделать прокрутку более отзывчивой, но сначала показывать только версию страницы с более низким разрешением.

Метод соответствует настройке gecko "layers.low-precision-buffer".

void WebEngineSettings::enableProgressivePainting(bool enabled)

Устанавливает, использовать ли прогрессивный рендеринг.

Когда enabled равно true, движок рендеринга будет использовать прогрессивный рендеринг для страницы.

Метод соответствует настройке gecko "layers.progressive-paint".

[signal] void WebEngineSettings::geolocationBehaviorChanged()

[static] void WebEngineSettings::initialize()

Инициализирует класс WebEngineSettings.

Метод initialize устанавливает настройки gecko по умолчанию, необходимые для правильной работы WebView.

Если нужно установить определённые настройки, которые отличаются от вариантов по умолчанию, рекомендуется сделать это после вызова данной инициализации, чтобы она не перезаписала настройки.

Метод будет вызываться автоматически во время инициализации QML, но его также можно вызвать вручную в коде, чтобы управлять порядком инициализации. Вызов этого метода после того, как инициализация уже выполнена, не имеет никакого эффекта.

Поэтому следующий код безопасен:

 SailfishOS::WebEngine::instance() *engineSettings = SailfishOS::WebEngineSettings::instance();
 engineSettings->initialize();
 engineSettings->setPreference(QStringLiteral("ui.textSelectBackground"), QLatin1String("#55ff55"));

[static] WebEngineSettings *WebEngineSettings::instance()

Возвращает экземпляр синглтона WebEngineSettings.

Возвращённый экземпляр может быть не инициализирован.

См. также initialize.

void WebEngineSettings::setPreference(const QString &key, const QVariant &value)

Непосредственно задаёт настройки движка gecko.

Устанавливает настройке key значение value.

Это низкоуровневый API для настройки параметров движка. Предпочтительно использовать вызовы более высокого уровня, такие как API WebEngineSettings, WebEngine и WebView, когда это возможно.

void WebEngineSettings::setPreference(const QString &key, const QVariant &value, PreferenceType preferenceType)

Непосредственно задаёт настройки движка gecko.

Метод перегружает setPreference().

Устанавливает настройке key значение value. type — это тип значения настройки.

См. также setPreference.

void WebEngineSettings::setTileSize(const QSize &size)

Устанавливает размер size тайла, используемый для рендеринга страниц.

Установка size тайла эквивалентна установке двух свойств gecko: "layers.tile-width" и "layers.tile-height".