Класс QWebEngineUrlScheme

Класс QWebEngineUrlScheme настраивает пользовательскую схему URL. Подробнее...

Этот класс был представлен в Qt 5.12.

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

Типы public

Функции public

Статические public члены

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

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

Пользовательские схемы URL необходимо настроить на ранней стадии запуска приложения, до создания любых классов Qt WebEngine. Как правило, это означает, что схемы необходимо настроить до создания экземпляра QGuiApplication или QApplication.

Каждая зарегистрированная конфигурация схемы применяется глобально ко всем профилям.

int main(int argc, char **argv)
{
    QWebEngineUrlScheme scheme("myscheme");
    scheme.setSyntax(QWebEngineUrlScheme::Syntax::HostAndPort);
    scheme.setDefaultPort(2345);
    scheme.setFlags(QWebEngineUrlScheme::SecureScheme);
    QWebEngineUrlScheme::registerScheme(scheme);
    ...
}

Чтобы фактически использовать пользовательскую схему URL, необходимо создать и зарегистрировать QWebEngineUrlSchemeHandler в профиле.

См. такжеQWebEngineUrlSchemeHandler.

Документация по типам членов

перечисление QWebEngineUrlScheme::Flagфлаги QWebEngineUrlScheme::Flags

Этот тип перечисления определяет параметры безопасности, которые следует применять к схеме URL.

Тип Flags — это синоним для QFlags<Flag>. Он хранит сочетание значений Flag.

перечисление QWebEngineUrlScheme::SpecialPort

Этот тип перечисления определяет специальные значения для defaultPort.

перечисление QWebEngineUrlScheme::Syntax

Это перечисление типов синтаксиса URL.

Чтобы применить политику одного источника к пользовательской схеме URL, WebEngine должен уметь вычислять источник (комбинацию хоста и порта) URL-адреса. Параметры Host... указывают, что схема URL соответствует стандартному синтаксису URL (например, http) и автоматически включают политику одного источника. Параметр Path указывает, что схема URL использует нестандартный синтаксис и политика одного источника не может быть применена.

Документация по функциям-членам

QWebEngineUrlScheme::QWebEngineUrlScheme(QWebEngineUrlScheme &&that)

Перемещает that.

QWebEngineUrlScheme::QWebEngineUrlScheme(const QWebEngineUrlScheme &that)

Копирует that.

QWebEngineUrlScheme::QWebEngineUrlScheme(const QByteArray &name)

Создаёт схему URL веб-движка с заданным именем name.

QWebEngineUrlScheme::QWebEngineUrlScheme()

Создаёт схему URL веб-движка со значениями по умолчанию.

QWebEngineUrlScheme &QWebEngineUrlScheme::operator=(QWebEngineUrlScheme &&that)

Перемещает that.

QWebEngineUrlScheme &QWebEngineUrlScheme::operator=(const QWebEngineUrlScheme &that)

Копирует that.

QWebEngineUrlScheme::~QWebEngineUrlScheme()

Деструктор данного объекта.

int QWebEngineUrlScheme::defaultPort() const

Возвращает порт по умолчанию для этой схемы URL.

Значение по умолчанию — PortUnspecified.

См. также setDefaultPort().

QWebEngineUrlScheme::Flags QWebEngineUrlScheme::flags() const

Возвращает флаги для этой схемы URL.

Значение по умолчанию — пустой набор флагов.

См. также Flags и setFlags().

QByteArray QWebEngineUrlScheme::name() const

Возвращает имя этой схемы URL.

Значение по умолчанию — пустая строка.

См. также setName().

[static] void QWebEngineUrlScheme::registerScheme(const QWebEngineUrlScheme &scheme)

Регистрирует scheme в парсере URL и модели безопасности веб-движка.

Рекомендуется регистрировать все пользовательские схемы URL с помощью этой функции при запуске приложения, даже если будут использоваться значения по умолчанию.

Предупреждение: Эта функция должна вызываться на ранней стадии запуска приложения, до создания каких-либо классов WebEngine. Поздние вызовы будут игнорироваться.

См. также schemeByName().

[static] QWebEngineUrlScheme QWebEngineUrlScheme::schemeByName(const QByteArray &name)

Возвращает схему URL веб-движка с заданным именем name или схему по умолчанию.

См. также registerScheme().

void QWebEngineUrlScheme::setDefaultPort(int newValue)

Устанавливает порт по умолчанию для этой схемы URL в newValue.

См. также defaultPort().

void QWebEngineUrlScheme::setFlags(QWebEngineUrlScheme::Flags newValue)

Устанавливает флаги для этой схемы URL в newValue.

См. также Flags и flags().

void QWebEngineUrlScheme::setName(const QByteArray &newValue)

Устанавливает имя этой схемы URL в newValue.

Примечание: Имя автоматически преобразуется в нижний регистр.

См. также name().

void QWebEngineUrlScheme::setSyntax(QWebEngineUrlScheme::Syntax newValue)

Устанавливает тип синтаксиса этой схемы URL в newValue.

См. также Syntax и syntax().

QWebEngineUrlScheme::Syntax QWebEngineUrlScheme::syntax() const

Возвращает тип синтаксиса этой схемы URL.

Значение по умолчанию — Path.

См. также Syntax и setSyntax().

bool QWebEngineUrlScheme::operator!=(const QWebEngineUrlScheme &that) const

Возвращает true если этот и that объекты не равны.

bool QWebEngineUrlScheme::operator==(const QWebEngineUrlScheme &that) const

Возвращает true если этот и that объекты равны.