gi-webkit2webextension-4.0.30: WebKit2-WebExtension bindings
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellSafe-Inferred
LanguageHaskell2010

GI.WebKit2WebExtension.Objects.WebFormManager

Description

Form manager of a WebPage in a ScriptWorld

Since: 2.40

Synopsis

Exported types

newtype WebFormManager Source #

Memory-managed wrapper type.

Constructors

WebFormManager (ManagedPtr WebFormManager) 

Instances

Instances details
Eq WebFormManager Source # 
Instance details

Defined in GI.WebKit2WebExtension.Objects.WebFormManager

GObject WebFormManager Source # 
Instance details

Defined in GI.WebKit2WebExtension.Objects.WebFormManager

ManagedPtrNewtype WebFormManager Source # 
Instance details

Defined in GI.WebKit2WebExtension.Objects.WebFormManager

TypedObject WebFormManager Source # 
Instance details

Defined in GI.WebKit2WebExtension.Objects.WebFormManager

Methods

glibType :: IO GType

HasParentTypes WebFormManager Source # 
Instance details

Defined in GI.WebKit2WebExtension.Objects.WebFormManager

IsGValue (Maybe WebFormManager) Source #

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

Instance details

Defined in GI.WebKit2WebExtension.Objects.WebFormManager

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes WebFormManager Source # 
Instance details

Defined in GI.WebKit2WebExtension.Objects.WebFormManager

type ParentTypes WebFormManager = '[Object]

class (GObject o, IsDescendantOf WebFormManager o) => IsWebFormManager o Source #

Type class for types which can be safely cast to WebFormManager, for instance with toWebFormManager.

Instances

Instances details
(GObject o, IsDescendantOf WebFormManager o) => IsWebFormManager o Source # 
Instance details

Defined in GI.WebKit2WebExtension.Objects.WebFormManager

toWebFormManager :: (MonadIO m, IsWebFormManager o) => o -> m WebFormManager Source #

Cast to WebFormManager, for types for which this is known to be safe. For general casts, use castTo.

Methods

inputElementAutoFill

webFormManagerInputElementAutoFill Source #

Arguments

:: (HasCallStack, MonadIO m, IsValue a) 
=> a

element: a Value

-> Text

value: the text to set

-> m () 

Set the value of an HTML input element as if it had been edited by the user, triggering a change event, and set it as filled automatically. If element is not an HTML input element this function does nothing.

Since: 2.40

inputElementIsAutoFilled

webFormManagerInputElementIsAutoFilled Source #

Arguments

:: (HasCallStack, MonadIO m, IsValue a) 
=> a

element: a Value

-> m Bool

Returns: True if element is an HTML input element that has been filled automatically, or False otherwise

Get whether element is an HTML input element that has been filled automatically.

Since: 2.40

inputElementIsUserEdited

webFormManagerInputElementIsUserEdited Source #

Arguments

:: (HasCallStack, MonadIO m, IsValue a) 
=> a

element: a Value

-> m Bool

Returns: True if element is an HTML text input element that has been edited by a user action, or False otherwise

Get whether element is an HTML text input element that has been edited by a user action.

Since: 2.40

Signals

formControlsAssociated

type WebFormManagerFormControlsAssociatedCallback Source #

Arguments

 = Frame

frame: a Frame

-> [Value]

elements: a PtrArray of Value with the list of forms in the page

-> IO () 

Emitted after form elements (or form associated elements) are associated to frame. This is useful to implement form auto filling for web pages where form fields are added dynamically. This signal might be emitted multiple times for the same frame.

Note that this signal could be also emitted when form controls are moved between forms. In that case, the elements array carries the list of those elements which have moved.

Clients should take a reference to the members of the elements array if it is desired to keep them alive after the signal handler returns.

Since: 2.40

afterWebFormManagerFormControlsAssociated :: (IsWebFormManager a, MonadIO m) => a -> ((?self :: a) => WebFormManagerFormControlsAssociatedCallback) -> m SignalHandlerId Source #

Connect a signal handler for the formControlsAssociated signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after webFormManager #formControlsAssociated callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onWebFormManagerFormControlsAssociated :: (IsWebFormManager a, MonadIO m) => a -> ((?self :: a) => WebFormManagerFormControlsAssociatedCallback) -> m SignalHandlerId Source #

Connect a signal handler for the formControlsAssociated signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on webFormManager #formControlsAssociated callback

willSendSubmitEvent

type WebFormManagerWillSendSubmitEventCallback Source #

Arguments

 = Value

form: the Value to be submitted, which will always correspond to an HTMLFormElement

-> Frame

sourceFrame: the Frame containing the form to be submitted

-> Frame

targetFrame: the Frame containing the form's target, which may be the same as sourceFrame if no target was specified

-> IO () 

This signal is emitted when the DOM submit event is about to be fired for form. JavaScript code may rely on the submit event to detect that the user has clicked on a submit button, and to possibly cancel the form submission before WebFormManager::willSubmitForm signal is emitted. However, beware that, for historical reasons, the submit event is not emitted at all if the form submission is triggered by JavaScript. For these reasons, this signal may not be used to reliably detect whether a form will be submitted. Instead, use it to detect if a user has clicked on a form's submit button even if JavaScript later cancels the form submission, or to read the values of the form's fields even if JavaScript later clears certain fields before submitting. This may be needed, for example, to implement a robust browser password manager, as some misguided websites may use such techniques to attempt to thwart password managers.

Since: 2.40

afterWebFormManagerWillSendSubmitEvent :: (IsWebFormManager a, MonadIO m) => a -> ((?self :: a) => WebFormManagerWillSendSubmitEventCallback) -> m SignalHandlerId Source #

Connect a signal handler for the willSendSubmitEvent signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after webFormManager #willSendSubmitEvent callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onWebFormManagerWillSendSubmitEvent :: (IsWebFormManager a, MonadIO m) => a -> ((?self :: a) => WebFormManagerWillSendSubmitEventCallback) -> m SignalHandlerId Source #

Connect a signal handler for the willSendSubmitEvent signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on webFormManager #willSendSubmitEvent callback

willSubmitForm

type WebFormManagerWillSubmitFormCallback Source #

Arguments

 = Value

form: the Value to be submitted, which will always correspond to an HTMLFormElement

-> Frame

sourceFrame: the Frame containing the form to be submitted

-> Frame

targetFrame: the Frame containing the form's target, which may be the same as sourceFrame if no target was specified

-> IO () 

This signal is emitted when form will imminently be submitted. It can no longer be cancelled. This event always occurs immediately before a form is submitted to its target, so use this event to reliably detect when a form is submitted. This signal is emitted after WebFormManager::willSendSubmitEvent if that signal is emitted.

Since: 2.40

afterWebFormManagerWillSubmitForm :: (IsWebFormManager a, MonadIO m) => a -> ((?self :: a) => WebFormManagerWillSubmitFormCallback) -> m SignalHandlerId Source #

Connect a signal handler for the willSubmitForm signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after webFormManager #willSubmitForm callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onWebFormManagerWillSubmitForm :: (IsWebFormManager a, MonadIO m) => a -> ((?self :: a) => WebFormManagerWillSubmitFormCallback) -> m SignalHandlerId Source #

Connect a signal handler for the willSubmitForm signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on webFormManager #willSubmitForm callback