WebKit2.ScriptDialog

Fields

None

Methods

close ()

confirm_set_confirmed (confirmed)

get_dialog_type ()

get_message ()

prompt_get_default_text ()

prompt_set_text (text)

ref ()

unref ()

Details

class WebKit2.ScriptDialog

Carries details to be shown in user-facing dialogs.

close()

Close self.

When handling a WebKit2.ScriptDialog asynchronously (WebKit2.ScriptDialog.ref() was called in WebKit2.WebView ::script-dialog callback), this function needs to be called to notify that we are done with the script dialog. The dialog will be closed on destruction if this function hasn’t been called before.

New in version 2.24.

confirm_set_confirmed(confirmed)
Parameters:

confirmed (bool) – whether user confirmed the dialog

Set whether the user confirmed the dialog.

This method is used for WebKit2.ScriptDialogType.CONFIRM and WebKit2.ScriptDialogType.BEFORE_UNLOAD_CONFIRM dialogs when WebKit2.WebView ::script-dialog signal is emitted to set whether the user confirmed the dialog or not. The default implementation of WebKit2.WebView ::script-dialog signal sets True when the OK or Stay buttons are clicked and False otherwise. It’s an error to use this method with a WebKit2.ScriptDialog that is not of type WebKit2.ScriptDialogType.CONFIRM or WebKit2.ScriptDialogType.BEFORE_UNLOAD_CONFIRM

get_dialog_type()
Returns:

the WebKit2.ScriptDialogType of self

Return type:

WebKit2.ScriptDialogType

Get the dialog type of a WebKit2.ScriptDialog.

get_message()
Returns:

the message of self.

Return type:

str

Get the message of a WebKit2.ScriptDialog.

prompt_get_default_text()
Returns:

the default text of self

Return type:

str

Get the default text of a WebKit2.ScriptDialog of type WebKit2.ScriptDialogType.PROMPT.

It’s an error to use this method with a WebKit2.ScriptDialog that is not of type WebKit2.ScriptDialogType.PROMPT.

prompt_set_text(text)
Parameters:

text (str) – the text to set

Set the text entered by the user in the dialog.

This method is used for WebKit2.ScriptDialogType.PROMPT dialogs when WebKit2.WebView ::script-dialog signal is emitted to set the text entered by the user. The default implementation of WebKit2.WebView ::script-dialog signal sets the text of the entry form when OK button is clicked, otherwise None is set. It’s an error to use this method with a WebKit2.ScriptDialog that is not of type WebKit2.ScriptDialogType.PROMPT.

ref()
Returns:

The passed in WebKit2.ScriptDialog

Return type:

WebKit2.ScriptDialog

Atomically increments the reference count of self by one.

This function is MT-safe and may be called from any thread.

New in version 2.24.

unref()

Atomically decrements the reference count of self by one.

If the reference count drops to 0, all memory allocated by the #WebKitScriptdialog is released. This function is MT-safe and may be called from any thread.

New in version 2.24.