GI.WebKit.Objects.FileChooserRequest

Whenever the user interacts with an <input type='file' /> HTML element, WebKit will need to show a dialog to choose one or more files to be uploaded to the server along with the rest of the form data. For that to happen in a general way, instead of just opening a FileChooserDialog (which might be not desirable in some cases, such as when an embedding applications prefers to use its own file chooser dialog), WebKit will fire the WebView::run-file-chooser signal with a FileChooserRequest object, which will allow the client application to specify the files to be selected, to inspect the details of the request (e.g. if multiple selection should be allowed) and to cancel the request, in case nothing was selected.

In case the client application does not wish to handle this signal, WebKit will provide a default handler which will asynchronously run a regular FileChooserDialog for the user to interact with.

Exported types

newtype FileChooserRequest

Constructors

FileChooserRequest (ManagedPtr FileChooserRequest)

Instances

GObject FileChooserRequest

Methods

gobjectType :: FileChooserRequest -> IO GType

IsObject FileChooserRequest

IsFileChooserRequest FileChooserRequest

((~) * info (ResolveFileChooserRequestMethod t FileChooserRequest), MethodInfo * info FileChooserRequest p) => IsLabel t (FileChooserRequest -> p)

Methods

fromLabel :: Proxy# Symbol t -> FileChooserRequest -> p

((~) * info (ResolveFileChooserRequestMethod t FileChooserRequest), MethodInfo * info FileChooserRequest p) => IsLabelProxy t (FileChooserRequest -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> FileChooserRequest -> p

HasAttributeList * FileChooserRequest

type AttributeList FileChooserRequest

type AttributeList FileChooserRequest

type SignalList FileChooserRequest

type SignalList FileChooserRequest

class GObject o => IsFileChooserRequest o

Instances

(GObject a, UnknownAncestorError Constraint FileChooserRequest a) => IsFileChooserRequest a

IsFileChooserRequest FileChooserRequest

toFileChooserRequest :: IsFileChooserRequest o => o -> IO FileChooserRequest

noFileChooserRequest :: Maybe FileChooserRequest

Methods

getMimeTypes

data FileChooserRequestGetMimeTypesMethodInfo

Instances

((~) * signature (m [Text]), MonadIO m, IsFileChooserRequest a) => MethodInfo * FileChooserRequestGetMimeTypesMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserRequestGetMimeTypesMethodInfo a -> signature -> s

fileChooserRequestGetMimeTypes

Arguments

:: (HasCallStack, MonadIO m, IsFileChooserRequest a)

=> a

request: a FileChooserRequest

-> m [Text]

Returns: a Nothing-terminated array of strings if a list of accepted MIME types is defined or Nothing otherwise, meaning that any MIME type should be accepted. This array and its contents are owned by WebKitGTK+ and should not be modified or freed.

Get the list of MIME types the file chooser dialog should handle, in the format specified in RFC 2046 for "media types". Its contents depend on the value of the 'accept' attribute for HTML input elements. This function should normally be called before presenting the file chooser dialog to the user, to decide whether to allow the user to select multiple files at once or only one.

Since: 1.10

getMimeTypesFilter

data FileChooserRequestGetMimeTypesFilterMethodInfo

Instances

((~) * signature (m FileFilter), MonadIO m, IsFileChooserRequest a) => MethodInfo * FileChooserRequestGetMimeTypesFilterMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserRequestGetMimeTypesFilterMethodInfo a -> signature -> s

fileChooserRequestGetMimeTypesFilter

Arguments

:: (HasCallStack, MonadIO m, IsFileChooserRequest a)

=> a

request: a FileChooserRequest

-> m FileFilter

Returns: a FileFilter if a list of accepted MIME types is defined or Nothing otherwise. The returned object is owned by WebKitGTK+ should not be modified or freed.

Get the filter currently associated with the request, ready to be used by FileChooser. This function should normally be called before presenting the file chooser dialog to the user, to decide whether to apply a filter so the user would not be allowed to select files with other MIME types.

See fileChooserRequestGetMimeTypes if you are interested in getting the list of accepted MIME types.

Since: 1.10

getSelectMultiple

data FileChooserRequestGetSelectMultipleMethodInfo

Instances

((~) * signature (m Bool), MonadIO m, IsFileChooserRequest a) => MethodInfo * FileChooserRequestGetSelectMultipleMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserRequestGetSelectMultipleMethodInfo a -> signature -> s

fileChooserRequestGetSelectMultiple

Arguments

:: (HasCallStack, MonadIO m, IsFileChooserRequest a)

=> a

request: a FileChooserRequest

-> m Bool

Returns: True if the file chooser should allow selecting multiple files or False otherwise.

Determine whether the file chooser associated to this FileChooserRequest should allow selecting multiple files, which depends on the HTML input element having a 'multiple' attribute defined.

Since: 1.10

getSelectedFiles

data FileChooserRequestGetSelectedFilesMethodInfo

Instances

((~) * signature (m [Text]), MonadIO m, IsFileChooserRequest a) => MethodInfo * FileChooserRequestGetSelectedFilesMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserRequestGetSelectedFilesMethodInfo a -> signature -> s

fileChooserRequestGetSelectedFiles

Arguments

:: (HasCallStack, MonadIO m, IsFileChooserRequest a)

=> a

request: a FileChooserRequest

-> m [Text]

Returns: a Nothing-terminated array of strings if there are selected files associated with the request or Nothing otherwise. This array and its contents are owned by WebKitGTK+ and should not be modified or freed.

Get the list of selected files currently associated to the request. Initially, the return value of this method contains any files selected in previous file chooser requests for this HTML input element. Once webkit_file_chooser_request_select_files, the value will reflect whatever files are given.

This function should normally be called only before presenting the file chooser dialog to the user, to decide whether to perform some extra action, like pre-selecting the files from a previous request.

Since: 1.10

selectFiles

data FileChooserRequestSelectFilesMethodInfo

Instances

((~) * signature ([Text] -> m ()), MonadIO m, IsFileChooserRequest a) => MethodInfo * FileChooserRequestSelectFilesMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FileChooserRequestSelectFilesMethodInfo a -> signature -> s

fileChooserRequestSelectFiles

Arguments

:: (HasCallStack, MonadIO m, IsFileChooserRequest a)

=> a

request: a FileChooserRequest

-> [Text]

files: a Nothing-terminated array of strings, containing paths to local files.

-> m ()

Ask WebKit to select local files for upload and complete the request.

Since: 1.10

Properties

filter

data FileChooserRequestFilterPropertyInfo

Instances

AttrInfo FileChooserRequestFilterPropertyInfo

Associated Types

type AttrAllowedOps FileChooserRequestFilterPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint FileChooserRequestFilterPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint FileChooserRequestFilterPropertyInfo :: * -> Constraint

type AttrGetType FileChooserRequestFilterPropertyInfo :: *

type AttrLabel FileChooserRequestFilterPropertyInfo :: Symbol

type AttrOrigin FileChooserRequestFilterPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint FileChooserRequestFilterPropertyInfo o => Proxy * FileChooserRequestFilterPropertyInfo -> o -> IO (AttrGetType FileChooserRequestFilterPropertyInfo)

attrSet :: (AttrBaseTypeConstraint FileChooserRequestFilterPropertyInfo o, AttrSetTypeConstraint FileChooserRequestFilterPropertyInfo b) => Proxy * FileChooserRequestFilterPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint FileChooserRequestFilterPropertyInfo o => Proxy * FileChooserRequestFilterPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint FileChooserRequestFilterPropertyInfo o, AttrSetTypeConstraint FileChooserRequestFilterPropertyInfo b) => Proxy * FileChooserRequestFilterPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin FileChooserRequestFilterPropertyInfo

type AttrOrigin FileChooserRequestFilterPropertyInfo = FileChooserRequest

type AttrLabel FileChooserRequestFilterPropertyInfo

type AttrLabel FileChooserRequestFilterPropertyInfo = "filter"

type AttrGetType FileChooserRequestFilterPropertyInfo

type AttrGetType FileChooserRequestFilterPropertyInfo = Maybe FileFilter

type AttrBaseTypeConstraint FileChooserRequestFilterPropertyInfo

type AttrBaseTypeConstraint FileChooserRequestFilterPropertyInfo = IsFileChooserRequest

type AttrSetTypeConstraint FileChooserRequestFilterPropertyInfo

type AttrSetTypeConstraint FileChooserRequestFilterPropertyInfo = * ~ ()

type AttrAllowedOps FileChooserRequestFilterPropertyInfo

type AttrAllowedOps FileChooserRequestFilterPropertyInfo = (:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag))

fileChooserRequestFilter :: AttrLabelProxy "filter"

getFileChooserRequestFilter :: (MonadIO m, IsFileChooserRequest o) => o -> m (Maybe FileFilter)

mimeTypes

data FileChooserRequestMimeTypesPropertyInfo

Instances

AttrInfo FileChooserRequestMimeTypesPropertyInfo

Associated Types

type AttrAllowedOps FileChooserRequestMimeTypesPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint FileChooserRequestMimeTypesPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint FileChooserRequestMimeTypesPropertyInfo :: * -> Constraint

type AttrGetType FileChooserRequestMimeTypesPropertyInfo :: *

type AttrLabel FileChooserRequestMimeTypesPropertyInfo :: Symbol

type AttrOrigin FileChooserRequestMimeTypesPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint FileChooserRequestMimeTypesPropertyInfo o => Proxy * FileChooserRequestMimeTypesPropertyInfo -> o -> IO (AttrGetType FileChooserRequestMimeTypesPropertyInfo)

attrSet :: (AttrBaseTypeConstraint FileChooserRequestMimeTypesPropertyInfo o, AttrSetTypeConstraint FileChooserRequestMimeTypesPropertyInfo b) => Proxy * FileChooserRequestMimeTypesPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint FileChooserRequestMimeTypesPropertyInfo o => Proxy * FileChooserRequestMimeTypesPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint FileChooserRequestMimeTypesPropertyInfo o, AttrSetTypeConstraint FileChooserRequestMimeTypesPropertyInfo b) => Proxy * FileChooserRequestMimeTypesPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin FileChooserRequestMimeTypesPropertyInfo

type AttrOrigin FileChooserRequestMimeTypesPropertyInfo = FileChooserRequest

type AttrLabel FileChooserRequestMimeTypesPropertyInfo

type AttrLabel FileChooserRequestMimeTypesPropertyInfo = "mime-types"

type AttrGetType FileChooserRequestMimeTypesPropertyInfo

type AttrGetType FileChooserRequestMimeTypesPropertyInfo = [Text]

type AttrBaseTypeConstraint FileChooserRequestMimeTypesPropertyInfo

type AttrBaseTypeConstraint FileChooserRequestMimeTypesPropertyInfo = IsFileChooserRequest

type AttrSetTypeConstraint FileChooserRequestMimeTypesPropertyInfo

type AttrSetTypeConstraint FileChooserRequestMimeTypesPropertyInfo = * ~ ()

type AttrAllowedOps FileChooserRequestMimeTypesPropertyInfo

type AttrAllowedOps FileChooserRequestMimeTypesPropertyInfo = (:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag))

fileChooserRequestMimeTypes :: AttrLabelProxy "mimeTypes"

getFileChooserRequestMimeTypes :: (MonadIO m, IsFileChooserRequest o) => o -> m [Text]

selectMultiple

data FileChooserRequestSelectMultiplePropertyInfo

Instances

AttrInfo FileChooserRequestSelectMultiplePropertyInfo

Associated Types

type AttrAllowedOps FileChooserRequestSelectMultiplePropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint FileChooserRequestSelectMultiplePropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint FileChooserRequestSelectMultiplePropertyInfo :: * -> Constraint

type AttrGetType FileChooserRequestSelectMultiplePropertyInfo :: *

type AttrLabel FileChooserRequestSelectMultiplePropertyInfo :: Symbol

type AttrOrigin FileChooserRequestSelectMultiplePropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint FileChooserRequestSelectMultiplePropertyInfo o => Proxy * FileChooserRequestSelectMultiplePropertyInfo -> o -> IO (AttrGetType FileChooserRequestSelectMultiplePropertyInfo)

attrSet :: (AttrBaseTypeConstraint FileChooserRequestSelectMultiplePropertyInfo o, AttrSetTypeConstraint FileChooserRequestSelectMultiplePropertyInfo b) => Proxy * FileChooserRequestSelectMultiplePropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint FileChooserRequestSelectMultiplePropertyInfo o => Proxy * FileChooserRequestSelectMultiplePropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint FileChooserRequestSelectMultiplePropertyInfo o, AttrSetTypeConstraint FileChooserRequestSelectMultiplePropertyInfo b) => Proxy * FileChooserRequestSelectMultiplePropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin FileChooserRequestSelectMultiplePropertyInfo

type AttrOrigin FileChooserRequestSelectMultiplePropertyInfo = FileChooserRequest

type AttrLabel FileChooserRequestSelectMultiplePropertyInfo

type AttrLabel FileChooserRequestSelectMultiplePropertyInfo = "select-multiple"

type AttrGetType FileChooserRequestSelectMultiplePropertyInfo

type AttrGetType FileChooserRequestSelectMultiplePropertyInfo = Bool

type AttrBaseTypeConstraint FileChooserRequestSelectMultiplePropertyInfo

type AttrBaseTypeConstraint FileChooserRequestSelectMultiplePropertyInfo = IsFileChooserRequest

type AttrSetTypeConstraint FileChooserRequestSelectMultiplePropertyInfo

type AttrSetTypeConstraint FileChooserRequestSelectMultiplePropertyInfo = * ~ ()

type AttrAllowedOps FileChooserRequestSelectMultiplePropertyInfo

type AttrAllowedOps FileChooserRequestSelectMultiplePropertyInfo = (:) AttrOpTag AttrGet ([] AttrOpTag)

fileChooserRequestSelectMultiple :: AttrLabelProxy "selectMultiple"

getFileChooserRequestSelectMultiple :: (MonadIO m, IsFileChooserRequest o) => o -> m Bool

selectedFiles

data FileChooserRequestSelectedFilesPropertyInfo

Instances

AttrInfo FileChooserRequestSelectedFilesPropertyInfo

Associated Types

type AttrAllowedOps FileChooserRequestSelectedFilesPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint FileChooserRequestSelectedFilesPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint FileChooserRequestSelectedFilesPropertyInfo :: * -> Constraint

type AttrGetType FileChooserRequestSelectedFilesPropertyInfo :: *

type AttrLabel FileChooserRequestSelectedFilesPropertyInfo :: Symbol

type AttrOrigin FileChooserRequestSelectedFilesPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint FileChooserRequestSelectedFilesPropertyInfo o => Proxy * FileChooserRequestSelectedFilesPropertyInfo -> o -> IO (AttrGetType FileChooserRequestSelectedFilesPropertyInfo)

attrSet :: (AttrBaseTypeConstraint FileChooserRequestSelectedFilesPropertyInfo o, AttrSetTypeConstraint FileChooserRequestSelectedFilesPropertyInfo b) => Proxy * FileChooserRequestSelectedFilesPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint FileChooserRequestSelectedFilesPropertyInfo o => Proxy * FileChooserRequestSelectedFilesPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint FileChooserRequestSelectedFilesPropertyInfo o, AttrSetTypeConstraint FileChooserRequestSelectedFilesPropertyInfo b) => Proxy * FileChooserRequestSelectedFilesPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin FileChooserRequestSelectedFilesPropertyInfo

type AttrOrigin FileChooserRequestSelectedFilesPropertyInfo = FileChooserRequest

type AttrLabel FileChooserRequestSelectedFilesPropertyInfo

type AttrLabel FileChooserRequestSelectedFilesPropertyInfo = "selected-files"

type AttrGetType FileChooserRequestSelectedFilesPropertyInfo

type AttrGetType FileChooserRequestSelectedFilesPropertyInfo = [Text]

type AttrBaseTypeConstraint FileChooserRequestSelectedFilesPropertyInfo

type AttrBaseTypeConstraint FileChooserRequestSelectedFilesPropertyInfo = IsFileChooserRequest

type AttrSetTypeConstraint FileChooserRequestSelectedFilesPropertyInfo

type AttrSetTypeConstraint FileChooserRequestSelectedFilesPropertyInfo = * ~ ()

type AttrAllowedOps FileChooserRequestSelectedFilesPropertyInfo

type AttrAllowedOps FileChooserRequestSelectedFilesPropertyInfo = (:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag))

fileChooserRequestSelectedFiles :: AttrLabelProxy "selectedFiles"

getFileChooserRequestSelectedFiles :: (MonadIO m, IsFileChooserRequest o) => o -> m [Text]