Copyright | Will Thompson and Iñaki García Etxebarria |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Carries details to be shown in user-facing dialogs.
Synopsis
- newtype ScriptDialog = ScriptDialog (ManagedPtr ScriptDialog)
- scriptDialogClose :: (HasCallStack, MonadIO m) => ScriptDialog -> m ()
- scriptDialogConfirmSetConfirmed :: (HasCallStack, MonadIO m) => ScriptDialog -> Bool -> m ()
- scriptDialogGetDialogType :: (HasCallStack, MonadIO m) => ScriptDialog -> m ScriptDialogType
- scriptDialogGetMessage :: (HasCallStack, MonadIO m) => ScriptDialog -> m Text
- scriptDialogPromptGetDefaultText :: (HasCallStack, MonadIO m) => ScriptDialog -> m Text
- scriptDialogPromptSetText :: (HasCallStack, MonadIO m) => ScriptDialog -> Text -> m ()
- scriptDialogRef :: (HasCallStack, MonadIO m) => ScriptDialog -> m ScriptDialog
- scriptDialogUnref :: (HasCallStack, MonadIO m) => ScriptDialog -> m ()
Exported types
newtype ScriptDialog Source #
Memory-managed wrapper type.
ScriptDialog (ManagedPtr ScriptDialog) |
Instances
Eq ScriptDialog Source # | |
Defined in GI.WebKit2.Structs.ScriptDialog (==) :: ScriptDialog -> ScriptDialog -> Bool # (/=) :: ScriptDialog -> ScriptDialog -> Bool # | |
GBoxed ScriptDialog Source # | |
Defined in GI.WebKit2.Structs.ScriptDialog | |
ManagedPtrNewtype ScriptDialog Source # | |
Defined in GI.WebKit2.Structs.ScriptDialog toManagedPtr :: ScriptDialog -> ManagedPtr ScriptDialog | |
TypedObject ScriptDialog Source # | |
Defined in GI.WebKit2.Structs.ScriptDialog | |
HasParentTypes ScriptDialog Source # | |
Defined in GI.WebKit2.Structs.ScriptDialog | |
IsGValue (Maybe ScriptDialog) Source # | Convert |
Defined in GI.WebKit2.Structs.ScriptDialog gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe ScriptDialog -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe ScriptDialog) | |
type ParentTypes ScriptDialog Source # | |
Defined in GI.WebKit2.Structs.ScriptDialog |
Methods
Click to display all available methods, including inherited ones
Methods
close, confirmSetConfirmed, promptGetDefaultText, promptSetText, ref, unref.
Getters
Setters
None.
close
:: (HasCallStack, MonadIO m) | |
=> ScriptDialog |
|
-> m () |
Close dialog
.
When handling a ScriptDialog
asynchronously (scriptDialogRef
was called in WebView::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 #
:: (HasCallStack, MonadIO m) | |
=> ScriptDialog |
|
-> Bool |
|
-> m () |
Set whether the user confirmed the dialog.
This method is used for ScriptDialogTypeConfirm
and ScriptDialogTypeBeforeUnloadConfirm
dialogs when
WebView::scriptDialog signal is emitted to set whether the user
confirmed the dialog or not. The default implementation of WebView::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 #
:: (HasCallStack, MonadIO m) | |
=> ScriptDialog |
|
-> m ScriptDialogType | Returns: the |
Get the dialog type of a ScriptDialog
.
getMessage
scriptDialogGetMessage Source #
:: (HasCallStack, MonadIO m) | |
=> ScriptDialog |
|
-> m Text | Returns: the message of |
Get the message of a ScriptDialog
.
promptGetDefaultText
scriptDialogPromptGetDefaultText Source #
:: (HasCallStack, MonadIO m) | |
=> ScriptDialog |
|
-> m Text | Returns: the default text of |
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 #
:: (HasCallStack, MonadIO m) | |
=> ScriptDialog |
|
-> Text |
|
-> m () |
Set the text entered by the user in the dialog.
This method is used for ScriptDialogTypePrompt
dialogs when
WebView::scriptDialog signal is emitted to set the text
entered by the user. The default implementation of WebView::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
:: (HasCallStack, MonadIO m) | |
=> ScriptDialog |
|
-> m ScriptDialog | Returns: The passed in |
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
:: (HasCallStack, MonadIO m) | |
=> 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