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

GI.WebKit2.Objects.FormSubmissionRequest

Description

Represents a form submission request.

When a form is about to be submitted in a WebView, the WebView::submitForm signal is emitted. Its request argument contains information about the text fields of the form, that are typically used to store login information, returned as lists by formSubmissionRequestListTextFields. You can submit the form with formSubmissionRequestSubmit.

Synopsis

Exported types

newtype FormSubmissionRequest Source #

Memory-managed wrapper type.

Constructors

FormSubmissionRequest (ManagedPtr FormSubmissionRequest) 

class (GObject o, IsDescendantOf FormSubmissionRequest o) => IsFormSubmissionRequest o Source #

Type class for types which can be safely cast to FormSubmissionRequest, for instance with toFormSubmissionRequest.

Instances

Instances details
(GObject o, IsDescendantOf FormSubmissionRequest o) => IsFormSubmissionRequest o Source # 
Instance details

Defined in GI.WebKit2.Objects.FormSubmissionRequest

toFormSubmissionRequest :: (MonadIO m, IsFormSubmissionRequest o) => o -> m FormSubmissionRequest Source #

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

Methods

getTextFields

formSubmissionRequestGetTextFields Source #

Arguments

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

request: a FormSubmissionRequest

-> m (Maybe (Map (Ptr ()) (Ptr ())))

Returns: a HashTable with the form text fields, or Nothing if the form doesn't contain text fields.

Deprecated: (Since version 2.20.)Use formSubmissionRequestListTextFields instead.

Get the values of the text fields contained in the form associated to request.

Get a HashTable with the values of the text fields contained in the form associated to request. Note that fields will be missing if the form contains multiple text input elements with the same name, so this function does not reliably return all text fields.

listTextFields

formSubmissionRequestListTextFields Source #

Arguments

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

request: a FormSubmissionRequest

-> m (Bool, [Text], [Text])

Returns: True if the form contains text fields, or False otherwise

Get lists of the text fields contained in the form associated to request.

Get lists with the names and values of the text fields contained in the form associated to request. Note that names and values may be Nothing.

If this function returns False, then both fieldNames and fieldValues will be empty.

Since: 2.20

submit

formSubmissionRequestSubmit Source #

Arguments

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

request: a FormSubmissionRequest

-> m () 

Continue the form submission.