Copyright	Will Thompson, Iñaki García Etxebarria and Jonas Platte
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria (garetxe@gmail.com)
Safe Haskell	None
Language	Haskell2010

GI.WebKit2.Structs.UserScript

Contents

Exported types
Methods
- new
- ref
- unref

Description

Synopsis

Exported types

newtype UserScript Source #

Constructors

UserScript (ManagedPtr UserScript)

Instances

BoxedObject UserScript Source #
Methods boxedType :: UserScript -> IO GType #
((~) * info (ResolveUserScriptMethod t UserScript), MethodInfo * info UserScript p) => IsLabel t (UserScript -> p) Source #
Methods fromLabel :: Proxy# Symbol t -> UserScript -> p #
((~) * info (ResolveUserScriptMethod t UserScript), MethodInfo * info UserScript p) => IsLabelProxy t (UserScript -> p) Source #
Methods fromLabelProxy :: Proxy Symbol t -> UserScript -> p #
HasAttributeList * UserScript Source #

((~) * signature (m ()), MonadIO m) => MethodInfo * UserScriptUnrefMethodInfo UserScript signature Source #
Methods overloadedMethod :: MethodProxy UserScriptUnrefMethodInfo UserScript -> signature -> s #
((~) * signature (m UserScript), MonadIO m) => MethodInfo * UserScriptRefMethodInfo UserScript signature Source #
Methods overloadedMethod :: MethodProxy UserScriptRefMethodInfo UserScript -> signature -> s #
type AttributeList UserScript Source #
type AttributeList UserScript

noUserScript :: Maybe UserScript Source #

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

ref

data UserScriptRefMethodInfo Source #

Instances

((~) * signature (m UserScript), MonadIO m) => MethodInfo * UserScriptRefMethodInfo UserScript signature Source #
Methods overloadedMethod :: MethodProxy UserScriptRefMethodInfo UserScript -> signature -> s #

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

data UserScriptUnrefMethodInfo Source #

Instances

((~) * signature (m ()), MonadIO m) => MethodInfo * UserScriptUnrefMethodInfo UserScript signature Source #
Methods overloadedMethod :: MethodProxy UserScriptUnrefMethodInfo UserScript -> signature -> s #

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