QWebEngineUrlScheme — PyQt Documentation v6.9.0 (original) (raw)
PyQt6.QtWebEngineCore.QWebEngineUrlScheme
Description¶
The QWebEngineUrlScheme class configures a custom URL scheme.
A web engine URL scheme describes a URL scheme from the web engine’s perspective, specifying how URLs of this scheme should be parsed, and which security restrictions should be placed on resources originating from such URLs.
Custom URL schemes must be configured early at application startup, before creating any Qt WebEngine classes. In general this means the schemes need to be configured before a QGuiApplication or QApplication instance is created.
Every registered scheme configuration applies globally to all profiles.
int main(int argc, char **argv) { QWebEngineUrlScheme scheme("myscheme"); scheme.setSyntax(QWebEngineUrlScheme::Syntax::HostAndPort); scheme.setDefaultPort(2345); scheme.setFlags(QWebEngineUrlScheme::SecureScheme); QWebEngineUrlScheme::registerScheme(scheme); ... }
To actually make use of the custom URL scheme, a QWebEngineUrlSchemeHandler must be created and registered in a profile.
Enums¶
Flag
This enum type specifies security options that should apply to a URL scheme.
| Member | Value | Description |
|---|---|---|
| ContentSecurityPolicyIgnored | 0x40 | Indicates that accesses to this scheme should bypass all Content-Security-Policy checks. |
| CorsEnabled | 0x80 | Enables cross-origin resource sharing (CORS) for this scheme. This flag is required in order for content to be loaded by documents of a different origin, this includes access from other schemes. The appropriate CORS headers are generated automatically by the QWebEngineUrlRequestJob class. By default only http and https are CORS enabled. (Added in Qt 5.14) |
| FetchApiAllowed | 0x100 | Enables a URL scheme to be used by the HTML5 fetch API and XMLHttpRequest.send with a body. By default only http and https can be send to using the Fetch API or with an XMLHttpRequest with a body. |
| LocalAccessAllowed | 0x4 | Indicates that content from this scheme should be allowed to load resources from schemes with the LocalScheme flag. |
| LocalScheme | 0x2 | Indicates that the URL scheme provides access to local resources. The purpose of this flag is to prevent network content from accessing local resources. Only schemes with the LocalAccessAllowed flag may load resources from a scheme with the LocalScheme flag. The only builtin scheme with this flag is file. |
| NoAccessAllowed | 0x8 | Indicates that all content from this scheme should be forced to have unique opaque origins: no two resources will have the same origin. |
| SecureScheme | 0x1 | Indicates that the URL scheme is potentially trustworthy. This flag should only be applied to URL schemes which ensure data authenticity, confidentiality, and integrity, either through encryption or other means. Examples of secure builtin schemes include https (authenticated and encrypted) and qrc (local resources only), whereas http is an example of an insecure scheme. |
| ServiceWorkersAllowed | 0x10 | Indicates that the Service Workers API should be enabled. |
| ViewSourceAllowed | 0x20 | Indicates that the View Source feature should be enabled. |
SpecialPort
This enum type defines special values for defaultPort().
| Member | Value | Description |
|---|---|---|
| PortUnspecified | -1 | Indicates that the URL scheme does not have a port element. |
Syntax
This enum type lists types of URL syntax.
To apply the same-origin policy to a custom URL scheme, WebEngine must be able to compute the origin (host and port combination) of a URL. The Host... options indicate that the URL scheme conforms to the standard URL syntax (like http) and automatically enable the same-origin policy. The Path option indicates that the URL scheme uses a non-standard syntax and that the same-origin policy cannot be applied.
| Member | Value | Description |
|---|---|---|
| Host | 2 | The authority component of a URL of this type has only the host part and no port. The defaultPort() must be set to PortUnspecified. |
| HostAndPort | 1 | The authority component of a URL of this type has only the host and port elements. A URL without a port will use the defaultPort() (which must not be PortUnspecified). |
| HostPortAndUserInformation | 0 | The authority component of a URL of this type has all of the standard elements: host, port, user name, and password. A URL without a port will use the defaultPort() (which must not be PortUnspecified). |
| Path | 3 | A URL of this type has no authority component at all. Everything after scheme name and separator character (:) will be preserved as is without validation or canonicalization. All URLs of such a scheme will be considered as having the same origin (unless the NoAccessAllowed flag is used). |
Methods¶
__init__()
Constructs a web engine URL scheme with default values.
__init__(Union[QByteArray, bytes, bytearray, memoryview])
Constructs a web engine URL scheme with given name.
__init__(QWebEngineUrlScheme)
Copies that.
defaultPort() → int
Returns the default port of this URL scheme.
The default value is PortUnspecified.
See also
__eq__(QWebEngineUrlScheme) → bool
TODO
flags() → Flag
Returns the flags for this URL scheme.
The default value is an empty set of flags.
See also
Flags, setFlags().
name() → QByteArray
Returns the name of this URL scheme.
The default value is an empty string.
__ne__(QWebEngineUrlScheme) → bool
TODO
@staticmethod
registerScheme(QWebEngineUrlScheme)
Registers scheme with the web engine’s URL parser and security model.
It is recommended that all custom URL schemes are first registered with this function at application startup, even if the default options are to be used.
Warning: This function must be called early at application startup, before creating any WebEngine classes. Late calls will be ignored.
@staticmethod
schemeByName(Union[QByteArray, bytes, bytearray, memoryview]) → QWebEngineUrlScheme
Returns the web engine URL scheme with the given name or the default-constructed scheme.
See also
setDefaultPort(int)
Sets the default port of this URL scheme to newValue.
setFlags(Flag)
Sets the flags for this URL scheme to newValue.
setName(Union[QByteArray, bytes, bytearray, memoryview])
Sets the name of this URL scheme to newValue.
Note: The name is automatically converted to lower case.
setSyntax(Syntax)
Sets the syntax type of this URL scheme to newValue.
See also
Syntax, syntax().
syntax() → Syntax
Returns the syntax type of this URL scheme.
The default value is Path.
See also
Syntax, setSyntax().