GI.WebKit2.Structs.UserScript

No description available in the introspection data.

Exported types

newtype UserScript

Memory-managed wrapper type.

Constructors

UserScript (ManagedPtr UserScript)

Instances

Eq UserScript

Defined in GI.WebKit2.Structs.UserScript

Methods

(==) :: UserScript -> UserScript -> Bool

(/=) :: UserScript -> UserScript -> Bool

IsGValue UserScript

Convert UserScript to and from GValue with toGValue and fromGValue.

Defined in GI.WebKit2.Structs.UserScript

Methods

toGValue :: UserScript -> IO GValue

fromGValue :: GValue -> IO UserScript

BoxedObject UserScript

Defined in GI.WebKit2.Structs.UserScript

Methods

boxedType :: UserScript -> IO GType

noUserScript :: Maybe UserScript

A convenience alias for Nothing :: Maybe UserScript.

Methods

Overloaded methods

new

userScriptNew

Arguments

:: (HasCallStack, MonadIO m)

=> Text

source: Source code of the user script.

-> UserContentInjectedFrames

injectedFrames: A UserContentInjectedFrames value

-> UserScriptInjectionTime

injectionTime: A UserScriptInjectionTime value

-> Maybe [Text]

whitelist: A whitelist of URI patterns or Nothing

-> Maybe [Text]

blacklist: A blacklist 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 whitelist or blacklist. Passing a Nothing whitelist implies that all URIs are on the whitelist. The script is applied if an URI matches the whitelist and not the blacklist. 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

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]

whitelist: A whitelist of URI patterns or Nothing

-> Maybe [Text]

blacklist: A blacklist 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

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

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