QWebEngineScript#

The QWebEngineScript class encapsulates a JavaScript program. More…

Synopsis#

Properties#

injectionPoint
name
runsOnSubFrames
sourceCode
sourceUrl
worldId

Functions#

def injectionPoint ()
def name ()
def __ne__ (other)
def __eq__ (other)
def runsOnSubFrames ()
def setInjectionPoint (arg__1)
def setName (arg__1)
def setRunsOnSubFrames (on)
def setSourceCode (arg__1)
def setSourceUrl (url)
def setWorldId (arg__1)
def sourceCode ()
def sourceUrl ()
def swap (other)
def worldId ()

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

Detailed Description#

QWebEngineScript enables the programmatic injection of so called user scripts in the JavaScript engine at different points, determined by injectionPoint() , during the loading of web contents.

Scripts can be executed either in the main JavaScript world, along with the rest of the JavaScript coming from the web contents, or in their own isolated world. While the DOM of the page can be accessed from any world, JavaScript variables of a function defined in one world are not accessible from a different one. ScriptWorldId provides some predefined IDs for this purpose.

The following Greasemonkey attributes are supported since Qt 5.8: @exclude, @include, @name, @match, and @run-at.

Use scripts() and scripts() to access the collection of scripts associated with a single page or a number of pages sharing the same profile.

See also

Script Injection

class PySide6.QtWebEngineCore.QWebEngineScript#

PySide6.QtWebEngineCore.QWebEngineScript(other)

Parameters:: other – PySide6.QtWebEngineCore.QWebEngineScript

Constructs a null script.

Constructs a user script using the contents of other.

Note

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

property PᅟySide6.QtWebEngineCore.QWebEngineScript.injectionPoint: InjectionPoint#

Access functions:

injectionPoint ()
setInjectionPoint (arg__1)

property PᅟySide6.QtWebEngineCore.QWebEngineScript.name: str#

Access functions:

name ()
setName (arg__1)

property PᅟySide6.QtWebEngineCore.QWebEngineScript.runsOnSubFrames: bool#

Access functions:

runsOnSubFrames ()
setRunsOnSubFrames (on)

property PᅟySide6.QtWebEngineCore.QWebEngineScript.sourceCode: str#

Access functions:

sourceCode ()
setSourceCode (arg__1)

property PᅟySide6.QtWebEngineCore.QWebEngineScript.sourceUrl: PySide6.QtCore.QUrl#

Access functions:

sourceUrl ()
setSourceUrl (url)

property PᅟySide6.QtWebEngineCore.QWebEngineScript.worldId: int#

Access functions:

worldId ()
setWorldId (arg__1)

PySide6.QtWebEngineCore.QWebEngineScript.InjectionPoint#

This enum describes the timing of the script injection:

Constant

Description

QWebEngineScript.DocumentCreation

The script will be executed as soon as the document is created. This is not suitable for any DOM operation.

QWebEngineScript.DocumentReady

The script will run as soon as the DOM is ready. This is equivalent to the DOMContentLoaded event firing in JavaScript.

QWebEngineScript.Deferred

The script will run when the page load finishes, or 500ms after the document is ready, whichever comes first.

Constant	Description
QWebEngineScript.DocumentCreation	The script will be executed as soon as the document is created. This is not suitable for any DOM operation.
QWebEngineScript.DocumentReady	The script will run as soon as the DOM is ready. This is equivalent to the `DOMContentLoaded` event firing in JavaScript.
QWebEngineScript.Deferred	The script will run when the page load finishes, or 500ms after the document is ready, whichever comes first.

PySide6.QtWebEngineCore.QWebEngineScript.ScriptWorldId#

(inherits enum.IntEnum) This enum provides pre-defined world IDs for isolating user scripts into different worlds:

Constant

Description

QWebEngineScript.MainWorld

The world used by the page’s web contents. It can be useful in order to expose custom functionality to web contents in certain scenarios.

QWebEngineScript.ApplicationWorld

The default isolated world used for application level functionality implemented in JavaScript.

QWebEngineScript.UserWorld

The first isolated world to be used by scripts set by users if the application is not making use of more worlds. As a rule of thumb, if that functionality is exposed to the application users, each individual script should probably get its own isolated world.

Constant	Description
QWebEngineScript.MainWorld	The world used by the page’s web contents. It can be useful in order to expose custom functionality to web contents in certain scenarios.
QWebEngineScript.ApplicationWorld	The default isolated world used for application level functionality implemented in JavaScript.
QWebEngineScript.UserWorld	The first isolated world to be used by scripts set by users if the application is not making use of more worlds. As a rule of thumb, if that functionality is exposed to the application users, each individual script should probably get its own isolated world.

PySide6.QtWebEngineCore.QWebEngineScript.injectionPoint()#

Return type:: InjectionPoint

Returns the point in the loading process at which the script will be executed. The default value is Deferred .

See also

setInjectionPoint()

Getter of property injectionPoint .

PySide6.QtWebEngineCore.QWebEngineScript.name()#

Return type:: str

Returns the name of the script. Can be useful to retrieve a particular script from a QWebEngineScriptCollection .

See also

setName() find()

Getter of property name .

PySide6.QtWebEngineCore.QWebEngineScript.__ne__(other)#

Parameters:: other – PySide6.QtWebEngineCore.QWebEngineScript
Return type:: bool

Returns true if the script is not equal to other, otherwise returns false.

PySide6.QtWebEngineCore.QWebEngineScript.__eq__(other)#

Parameters:: other – PySide6.QtWebEngineCore.QWebEngineScript
Return type:: bool

Returns true if the script is equal to other, otherwise returns false.

PySide6.QtWebEngineCore.QWebEngineScript.runsOnSubFrames()#

Return type:: bool

Returns true if the script is executed on every frame in the page, or false if it is only ran for the main frame.

See also

setRunsOnSubFrames()

Getter of property runsOnSubFrames .

PySide6.QtWebEngineCore.QWebEngineScript.setInjectionPoint(arg__1)#

Parameters:: arg__1 – InjectionPoint

Sets the point at which to execute the script to be p.

See also

injectionPoint() InjectionPoint

Setter of property injectionPoint .

PySide6.QtWebEngineCore.QWebEngineScript.setName(arg__1)#

Parameters:: arg__1 – str

Sets the script name to scriptName.

See also

name()

Setter of property name .

PySide6.QtWebEngineCore.QWebEngineScript.setRunsOnSubFrames(on)#

Parameters:: on – bool

Executes the script on sub frames in addition to the main frame if on returns true.

See also

runsOnSubFrames()

Setter of property runsOnSubFrames .

PySide6.QtWebEngineCore.QWebEngineScript.setSourceCode(arg__1)#

Parameters:: arg__1 – str

Sets the script source to scriptSource.

See also

sourceCode()

Setter of property sourceCode .

PySide6.QtWebEngineCore.QWebEngineScript.setSourceUrl(url)#

Parameters:: url – PySide6.QtCore.QUrl