Copyright	Will Thompson Iñaki García Etxebarria and Jonas Platte
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria (inaki@blueleaf.cc)
Safe Haskell	None
Language	Haskell2010

GI.WebKit2.Structs.UserScript

Contents

Exported types
Methods

Description

No description available in the introspection data.

Synopsis

newtype UserScript = UserScript (ManagedPtr UserScript)
noUserScript :: Maybe 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

BoxedObject UserScript Source #
Instance details Defined in GI.WebKit2.Structs.UserScript Methods boxedType :: UserScript -> IO GType #

noUserScript :: Maybe UserScript Source #

A convenience alias for Nothing :: Maybe UserScript.

Methods

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]	`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 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]	`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 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