Package org.webkitgtk

Class ScriptDialog

java.lang.Object

org.javagi.base.ProxyInstance

org.webkitgtk.ScriptDialog

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public class ScriptDialog
extends ProxyInstance

Carries details to be shown in user-facing dialogs.

Field Summary

Fields inherited from class org.javagi.base.ProxyInstance

address

Constructor Summary

Constructors

Constructor	Description
ScriptDialog(MemorySegment address)	Create a ScriptDialog proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
void	close()	Close this ScriptDialog.
void	confirmSetConfirmed(boolean confirmed)	Set whether the user confirmed the dialog.
ScriptDialogType	getDialogType()	Get the dialog type of a WebKitScriptDialog.
String	getMessage()	Get the message of a WebKitScriptDialog.
static Type	getType()	Get the GType of the ScriptDialog class
String	promptGetDefaultText()	Get the default text of a WebKitScriptDialog of type ScriptDialogType.PROMPT.
void	promptSetText(String text)	Set the text entered by the user in the dialog.
ScriptDialog	ref()	Atomically increments the reference count of this ScriptDialog by one.
void	unref()	Atomically decrements the reference count of this ScriptDialog by one.

Methods inherited from class org.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ScriptDialog

public ScriptDialog(MemorySegment address)

Create a ScriptDialog proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

Method Details

getType

public static Type getType()

Get the GType of the ScriptDialog class

Returns:

the GType

close

public void close()

Close this ScriptDialog.

When handling a WebKitScriptDialog asynchronously (webkit_script_dialog_ref() was called in WebKitWebView::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.

Since:

2.24

confirmSetConfirmed

public void confirmSetConfirmed(boolean confirmed)

Set whether the user confirmed the dialog.

This method is used for ScriptDialogType.CONFIRM and ScriptDialogType.BEFORE_UNLOAD_CONFIRM dialogs when WebKitWebView::script-dialog signal is emitted to set whether the user confirmed the dialog or not. The default implementation of WebKitWebView::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 WebKitScriptDialog that is not of type ScriptDialogType.CONFIRM or ScriptDialogType.BEFORE_UNLOAD_CONFIRM

Parameters:

confirmed - whether user confirmed the dialog

getDialogType

public ScriptDialogType getDialogType()

Get the dialog type of a WebKitScriptDialog.

Returns:

the WebKitScriptDialogType of this ScriptDialog

getMessage

public String getMessage()

Get the message of a WebKitScriptDialog.

Returns:

the message of this ScriptDialog.

promptGetDefaultText

public String promptGetDefaultText()

Get the default text of a WebKitScriptDialog of type ScriptDialogType.PROMPT.

It's an error to use this method with a WebKitScriptDialog that is not of type ScriptDialogType.PROMPT.

Returns:

the default text of this ScriptDialog

promptSetText

public void promptSetText(String text)

Set the text entered by the user in the dialog.

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

Parameters:

text - the text to set

ref

public ScriptDialog ref()

Atomically increments the reference count of this ScriptDialog by one.

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

Returns:

The passed in WebKitScriptDialog

Since:

2.24

unref

public void unref()

Atomically decrements the reference count of this ScriptDialog 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.

Since:

2.24