PySide6.QtWebEngineCore.QWebEngineExtensionInfo

class QWebEngineExtensionInfo

The QWebEngineExtensionInfo provides information about a browser extension.

Details

QWebEngineExtensionInfo provides information of an extension loaded into Qt WebEngine. Extensions can be loaded via the QWebEngineExtensionManager . You can check if the extension was successfully loaded using its isLoaded() property. The error() property contains error messages if the loading process failed. Extensions are always loaded in disabled state. To run an extension, it has to be enabled via setExtensionEnabled() .

An extension can be removed using unloadExtension() .

You can access extensions with extensions() which provides a list of the loaded extensions, or connect to the manager’s signals to be notified if the loading process is complete.

See also

QWebEngineExtensionManager extensionManager()

Added in version 6.10.

Synopsis

Properties

• actionPopupUrlᅟ - Returns the url of the extension’s popup

• descriptionᅟ

• errorᅟ - Errors happened during loading, installing or uninstalling the extension

• idᅟ - Of the extension

• isEnabledᅟ - This property holds whether the extension is enabled

• isInstalledᅟ

• isLoadedᅟ - This property holds whether the extension is loaded

• nameᅟ - Description of the extension

• pathᅟ - Install path of the extension

Methods

• def __init__()

• def actionPopupUrl()

• def description()

• def error()

• def id()

• def isEnabled()

• def isInstalled()

• def isLoaded()

• def name()

• def path()

• def swap()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property actionPopupUrlᅟ: QUrl

This property holds Returns the url of the extension’s popup..

Extension developers usually provide a popup menu where users can control their extension. The menu can be accessed via this url.

Empty if the load failed.

Access functions:

• actionPopupUrl()

property descriptionᅟ: str

Access functions:

• description()

property errorᅟ: str

This property holds Errors happened during loading, installing or uninstalling the extension..

Multiple errors can happen during load time, like missing manifest, invalid file format or path. The loading process stops at the first error.

Empty if the load succeeded.

Access functions:

• error()

property idᅟ: str

This property holds The id of the extension..

Generated at load time. Multiple QWebEngineExtensionInfo objects with the same id represent the same underlying extension.

The id is generated from the filesystem path where the extension was loaded from and the extensions manfiest file. Loading the same extension from the same path always have the same id.

Empty if the load failed.

Access functions:

• id()

property isEnabledᅟ: bool

This property holds This property holds whether the extension is enabled..

See also

setExtensionEnabled()

Access functions:

• isEnabled()

property isInstalledᅟ: bool

Access functions:

• isInstalled()

property isLoadedᅟ: bool

This property holds This property holds whether the extension is loaded..

If the extension was loaded or installed successfully this property returns true. Returns false if the extension was unloaded, uninstalled or the loading process failed.

See also

loadExtension() unloadExtension()

Access functions:

• isLoaded()

property nameᅟ: str

This property holds The description of the extension..

Acquired from the extension’s manifest file’s description property.

Empty if the load failed.

Access functions:

• name()

property pathᅟ: str

This property holds The install path of the extension..

The filesystem path where the extension was loaded from.

Access functions:

• path()

__init__()

__init__(other)

Parameters:

other – QWebEngineExtensionInfo

actionPopupUrl()

Return type:

QUrl

Getter of property actionPopupUrlᅟ .

description()

Return type:

str

Getter of property descriptionᅟ .

error()

Return type:

str

Getter of property errorᅟ .

id()

Return type:

str

Getter of property idᅟ .

isEnabled()

Return type:

bool

Getter of property isEnabledᅟ .

isInstalled()

Return type:

bool

Getter of property isInstalledᅟ .

isLoaded()

Return type:

bool

Getter of property isLoadedᅟ .

name()

Return type:

str

Getter of property nameᅟ .

path()

Return type:

str

Getter of property pathᅟ .

swap(other)

Parameters:

other – QWebEngineExtensionInfo