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

GI.WebKit2.Structs.UserScript

Contents

Exported types
Methods

Description

A JavaScript snippet which can be injected in loaded pages.

Since: 2.6

Synopsis

newtype UserScript = UserScript (ManagedPtr UserScript)
userScriptNew :: (HasCallStack, MonadIO m) => Text -> UserContentInjectedFrames -> UserScriptInjectionTime -> Maybe [Text] -> Maybe [Text] -> m UserScript
userScriptNewForWorld :: (HasCallStack, MonadIO m) => Text -> UserContentInjectedFrames -> UserScriptInjectionTime -> Text -> Maybe [Text] -> Maybe [Text] -> m UserScript
userScriptRef :: (HasCallStack, MonadIO m) => UserScript -> m UserScript
userScriptUnref :: (HasCallStack, MonadIO m) => UserScript -> m ()

Exported types

newtype UserScript Source #

Memory-managed wrapper type.

Constructors

UserScript (ManagedPtr UserScript)

Instances

Instances details

Eq UserScript Source #
Instance details Defined in GI.WebKit2.Structs.UserScript Methods (==) :: UserScript -> UserScript -> Bool # (/=) :: UserScript -> UserScript -> Bool #
GBoxed UserScript Source #
Instance details Defined in GI.WebKit2.Structs.UserScript
ManagedPtrNewtype UserScript Source #
Instance details Defined in GI.WebKit2.Structs.UserScript Methods toManagedPtr :: UserScript -> ManagedPtr UserScript
TypedObject UserScript Source #
Instance details Defined in GI.WebKit2.Structs.UserScript Methods glibType :: IO GType
HasParentTypes UserScript Source #
Instance details Defined in GI.WebKit2.Structs.UserScript
IsGValue (Maybe UserScript) Source #	Convert `UserScript` to and from `GValue`. See `toGValue` and `fromGValue`.
Instance details Defined in GI.WebKit2.Structs.UserScript Methods gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe UserScript -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe UserScript)
type ParentTypes UserScript Source #
Instance details Defined in GI.WebKit2.Structs.UserScript type ParentTypes UserScript = '[] :: [Type]

Methods

Click to display all available methods, including inherited ones

Expand

Methods

ref, unref.

Getters

None.

Setters

None.

new

userScriptNew Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Text	`source`: Source code of the user script.
-> UserContentInjectedFrames	`injectedFrames`: A `UserContentInjectedFrames` value
-> UserScriptInjectionTime	`injectionTime`: A `UserScriptInjectionTime` value
-> Maybe [Text]	`allowList`: An allow_list of URI patterns or `Nothing`
-> Maybe [Text]	`blockList`: A block_list of URI patterns or `Nothing`
-> m UserScript	Returns: A new `UserScript`

Creates a new user script.

Scripts can be applied to some URIs only by passing non-null values for allowList or blockList. Passing a Nothing allow_list implies that all URIs are on the allow_list. The script is applied if an URI matches the allow_list and not the block_list. URI patterns must be of the form [protocol]://[host]/[path], where the *host* and *path* components can contain the wildcard character (*) to represent zero or more other characters.

Since: 2.6

newForWorld

userScriptNewForWorld Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Text	`source`: Source code of the user script.
-> UserContentInjectedFrames	`injectedFrames`: A `UserContentInjectedFrames` value
-> UserScriptInjectionTime	`injectionTime`: A `UserScriptInjectionTime` value
-> Text	`worldName`: the name of a `WebKitScriptWorld`
-> Maybe [Text]	`allowList`: An allow_list of URI patterns or `Nothing`
-> Maybe [Text]	`blockList`: A block_list of URI patterns or `Nothing`
-> m UserScript	Returns: A new `UserScript`

Creates a new user script for script world with name worldName.

See userScriptNew for a full description.

Since: 2.22

ref

userScriptRef Source #

Arguments

:: (HasCallStack, MonadIO m)
=> UserScript	`userScript`: a `UserScript`
-> m UserScript	Returns: The passed `UserScript`

Atomically increments the reference count of userScript by one.

This function is MT-safe and may be called from any thread.

Since: 2.6

unref

userScriptUnref Source #

Arguments

:: (HasCallStack, MonadIO m)
=> UserScript	`userScript`: a `UserScript`
-> m ()

Atomically decrements the reference count of userScript by one.

If the reference count drops to 0, all memory allocated by UserScript is released. This function is MT-safe and may be called from any thread.

Since: 2.6