QWebEngineScript Class

The QWebEngineScript class encapsulates a JavaScript program. More...

Header: #include <QWebEngineScript>
qmake: QT += webenginewidgets
Since: Qt 5.5

Public Types

enum InjectionPoint { DocumentCreation, DocumentReady, Deferred }
enum ScriptWorldId { MainWorld, ApplicationWorld, UserWorld }

Public Functions

QWebEngineScript()
QWebEngineScript(const QWebEngineScript &other)
~QWebEngineScript()
InjectionPoint injectionPoint() const
bool isNull() const
QString name() const
bool runsOnSubFrames() const
void setInjectionPoint(InjectionPoint p)
void setName(const QString &scriptName)
void setRunsOnSubFrames(bool on)
void setSourceCode(const QString &scriptSource)
void setWorldId(quint32 id)
QString sourceCode() const
void swap(QWebEngineScript &other)
quint32 worldId() const
bool operator!=(const QWebEngineScript &other) const
QWebEngineScript &operator=(const QWebEngineScript &other)
bool operator==(const QWebEngineScript &other) const

Detailed Description

The QWebEngineScript class encapsulates a JavaScript program.

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 QWebEnginePage::scripts() and QWebEngineProfile::scripts() to access the collection of scripts associated with a single page or a number of pages sharing the same profile.

Member Type Documentation

enum QWebEngineScript::InjectionPoint

This enum describes the timing of the script injection:

ConstantValueDescription
QWebEngineScript::DocumentCreation2The script will be executed as soon as the document is created. This is not suitable for any DOM operation.
QWebEngineScript::DocumentReady1The script will run as soon as the DOM is ready. This is equivalent to the DOMContentLoaded event firing in JavaScript.
QWebEngineScript::Deferred0The script will run when the page load finishes, or 500ms after the document is ready, whichever comes first.

enum QWebEngineScript::ScriptWorldId

This enum provides pre-defined world IDs for isolating user scripts into different worlds:

ConstantValueDescription
QWebEngineScript::MainWorld0The 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::ApplicationWorld1The default isolated world used for application level functionality implemented in JavaScript.
QWebEngineScript::UserWorld2The 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.

Member Function Documentation

QWebEngineScript::QWebEngineScript()

Constructs a null script.

QWebEngineScript::QWebEngineScript(const QWebEngineScript &other)

Constructs a user script using the contents of other.

QWebEngineScript::~QWebEngineScript()

Destroys a script.

InjectionPoint QWebEngineScript::injectionPoint() const

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

See also setInjectionPoint().

bool QWebEngineScript::isNull() const

Returns true is the script is null; otherwise returns false.

QString QWebEngineScript::name() const

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

See also setName(), QWebEngineScriptCollection::findScript(), and QWebEngineScriptCollection::findScripts().

bool QWebEngineScript::runsOnSubFrames() const

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().

void QWebEngineScript::setInjectionPoint(InjectionPoint p)

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

See also injectionPoint() and InjectionPoint.

void QWebEngineScript::setName(const QString &scriptName)

Sets the script name to scriptName.

See also name().

void QWebEngineScript::setRunsOnSubFrames(bool on)

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

See also runsOnSubFrames().

void QWebEngineScript::setSourceCode(const QString &scriptSource)

Sets the script source to scriptSource.

See also sourceCode().

void QWebEngineScript::setWorldId(quint32 id)

Sets the world ID of the isolated world to id when running this script.

See also worldId().

QString QWebEngineScript::sourceCode() const

Returns the source of the script.

See also setSourceCode().

void QWebEngineScript::swap(QWebEngineScript &other)

Swaps the contents of the script with the contents of other.

quint32 QWebEngineScript::worldId() const

Returns the world ID defining which world the script is executed in.

See also setWorldId().

bool QWebEngineScript::operator!=(const QWebEngineScript &other) const

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

QWebEngineScript &QWebEngineScript::operator=(const QWebEngineScript &other)

Assigns other to the script.

bool QWebEngineScript::operator==(const QWebEngineScript &other) const

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

© 2017 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.