gi-webkit2-4.0.27: WebKit2 bindings
CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellSafe-Inferred
LanguageHaskell2010

GI.WebKit2.Structs.ScriptDialog

Description

No description available in the introspection data.

Synopsis

Exported types

newtype ScriptDialog Source #

Memory-managed wrapper type.

Constructors

ScriptDialog (ManagedPtr ScriptDialog) 

Instances

Instances details
Eq ScriptDialog Source # 
Instance details

Defined in GI.WebKit2.Structs.ScriptDialog

GBoxed ScriptDialog Source # 
Instance details

Defined in GI.WebKit2.Structs.ScriptDialog

ManagedPtrNewtype ScriptDialog Source # 
Instance details

Defined in GI.WebKit2.Structs.ScriptDialog

Methods

toManagedPtr :: ScriptDialog -> ManagedPtr ScriptDialog

TypedObject ScriptDialog Source # 
Instance details

Defined in GI.WebKit2.Structs.ScriptDialog

Methods

glibType :: IO GType

HasParentTypes ScriptDialog Source # 
Instance details

Defined in GI.WebKit2.Structs.ScriptDialog

IsGValue (Maybe ScriptDialog) Source #

Convert ScriptDialog to and from GValue. See toGValue and fromGValue.

Instance details

Defined in GI.WebKit2.Structs.ScriptDialog

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe ScriptDialog -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe ScriptDialog)

type ParentTypes ScriptDialog Source # 
Instance details

Defined in GI.WebKit2.Structs.ScriptDialog

type ParentTypes ScriptDialog = '[] :: [Type]

Methods

Click to display all available methods, including inherited ones

Expand

Methods

close, confirmSetConfirmed, promptGetDefaultText, promptSetText, ref, unref.

Getters

getDialogType, getMessage.

Setters

None.

close

scriptDialogClose Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> ScriptDialog

dialog: a ScriptDialog

-> m () 

Close dialog. When handling a ScriptDialog asynchronously (scriptDialogRef was called in scriptDialog 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

scriptDialogConfirmSetConfirmed Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> ScriptDialog

dialog: a ScriptDialog

-> Bool

confirmed: whether user confirmed the dialog

-> m () 

This method is used for ScriptDialogTypeConfirm and ScriptDialogTypeBeforeUnloadConfirm dialogs when scriptDialog signal is emitted to set whether the user confirmed the dialog or not. The default implementation of scriptDialog signal sets True when the OK or Stay buttons are clicked and False otherwise. It's an error to use this method with a ScriptDialog that is not of type ScriptDialogTypeConfirm or ScriptDialogTypeBeforeUnloadConfirm

getDialogType

scriptDialogGetDialogType Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> ScriptDialog

dialog: a ScriptDialog

-> m ScriptDialogType

Returns: the ScriptDialogType of dialog

Get the dialog type of a ScriptDialog.

getMessage

scriptDialogGetMessage Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> ScriptDialog

dialog: a ScriptDialog

-> m Text

Returns: the message of dialog.

Get the message of a ScriptDialog.

promptGetDefaultText

scriptDialogPromptGetDefaultText Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> ScriptDialog

dialog: a ScriptDialog

-> m Text

Returns: the default text of dialog

Get the default text of a ScriptDialog of type ScriptDialogTypePrompt. It's an error to use this method with a ScriptDialog that is not of type ScriptDialogTypePrompt.

promptSetText

scriptDialogPromptSetText Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> ScriptDialog

dialog: a ScriptDialog

-> Text

text: the text to set

-> m () 

This method is used for ScriptDialogTypePrompt dialogs when scriptDialog signal is emitted to set the text entered by the user. The default implementation of scriptDialog signal sets the text of the entry form when OK button is clicked, otherwise Nothing is set. It's an error to use this method with a ScriptDialog that is not of type ScriptDialogTypePrompt.

ref

scriptDialogRef Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> ScriptDialog

dialog: a ScriptDialog

-> m ScriptDialog

Returns: The passed in ScriptDialog

Atomically increments the reference count of dialog by one. This function is MT-safe and may be called from any thread.

Since: 2.24

unref

scriptDialogUnref Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> ScriptDialog

dialog: a ScriptDialog

-> m () 

Atomically decrements the reference count of dialog 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