JavaScriptDialogRequest QML Type

A request for showing an alert, a confirmation, or a prompt dialog from within JavaScript to the user. More...

Import Statement: import QtWebEngine
Since: QtWebEngine 1.4



Detailed Description

A JavaScriptDialogRequest is passed as an argument of the WebEngineView::javaScriptDialogRequested signal. The request is emitted if JavaScript on the page calls HTML5's Simple Dialogs API, or in response to HTML5's BeforeUnloadEvent. The type of a particular dialog can be checked with the type property.

The accepted property of the request indicates whether the request is handled by the user code or the default dialog should be displayed. If you set the accepted property to true, make sure to call either dialogAccept() or dialogReject() afterwards. The JavaScript call causing the request will be blocked until then.

The following code uses a custom dialog to handle the request:

WebEngineView {
    // ...
    onJavaScriptDialogRequested: function(request) {
        request.accepted = true;
        myDialog.request = request // keep the reference to the request
        myDialog.visible = true;
    // ...

Property Documentation

accepted : bool

Indicates whether the JavaScript dialog request has been accepted by the signal handler.

If the property is false after any signal handlers for WebEngineView::javaScriptDialogRequested have been executed, a default dialog will be shown. To prevent this, set request.accepted to true.

The default is false.

defaultText : string [read-only]

The default prompt text, if the requested dialog is a prompt.

message : string [read-only]

The message to be shown to the user.

securityOrigin : url [read-only]

The URL of the security origin.

title : string [read-only]

A default title for the dialog.

type : enumeration [read-only]

Returns the type of the requested dialog box. For more information, see HTML5's Simple Dialogs.

JavaScriptDialogRequest.DialogTypeAlertA JavaScript alert dialog.
JavaScriptDialogRequest.DialogTypeConfirmA JavaScript confirmation dialog.
JavaScriptDialogRequest.DialogTypePromptA JavaScript prompt dialog.
JavaScriptDialogRequest.DialogTypeBeforeUnloadThe users should be asked if they want to leave the page.

Method Documentation

void dialogAccept()

This function notifies the engine that the user accepted the dialog.

void dialogAccept(string text)

This function notifies the engine that the user accepted the dialog, providing the text in case of a prompt message box.

void dialogReject()

This function notifies the engine that the user rejected the dialog.

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