QWebEngineExtensionInfo Class
The QWebEngineExtensionInfo provides information about a browser extension. More...
| Header: | #include <QWebEngineExtensionInfo> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS WebEngineCore)target_link_libraries(mytarget PRIVATE Qt6::WebEngineCore) |
| qmake: | QT += webenginecore |
| Since: | Qt 6.10 |
Properties
|
Public Functions
| QUrl | actionPopupUrl() const |
| QString | description() const |
| QString | error() const |
| QString | id() const |
| bool | isEnabled() const |
| bool | isInstalled() const |
| bool | isLoaded() const |
| QString | name() const |
| QString | path() const |
Detailed Description
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 QWebEngineExtensionManager::setExtensionEnabled().
An extension can be removed using QWebEngineExtensionManager::unloadExtension().
You can access extensions with QWebEngineExtensionManager::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 and QWebEngineProfile::extensionManager().
Property Documentation
[read-only] actionPopupUrl : const QUrl
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:
| QUrl | actionPopupUrl() const |
[read-only] error : const QString
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:
| QString | error() const |
[read-only] id : const QString
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:
| QString | id() const |
[read-only] isEnabled : const bool
This property holds whether the extension is enabled.
Access functions:
| bool | isEnabled() const |
See also QWebEngineExtensionManager::setExtensionEnabled().
[read-only] isLoaded : const bool
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.
Access functions:
| bool | isLoaded() const |
See also QWebEngineExtensionManager::loadExtension() and QWebEngineExtensionManager::unloadExtension().
[read-only] name : const QString
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:
| QString | name() const |
[read-only] path : const QString
This property holds the install path of the extension.
The filesystem path where the extension was loaded from.
Access functions:
| QString | path() const |
© 2025 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.
