GI.WebKit2.Objects.UserContentManager

Manages user-defined content which affects web pages.

Using a UserContentManager user CSS style sheets can be set to be injected in the web pages loaded by a WebView, by userContentManagerAddStyleSheet.

To use a UserContentManager, it must be created using userContentManagerNew, and then passed to webViewNewWithUserContentManager. User style sheets can be created with userStyleSheetNew.

User style sheets can be added and removed at any time, but they will affect the web pages loaded afterwards.

Since: 2.6

Exported types

newtype UserContentManager

Memory-managed wrapper type.

Constructors

UserContentManager (ManagedPtr UserContentManager)

Instances

Eq UserContentManager

Defined in GI.WebKit2.Objects.UserContentManager

Methods

(==) :: UserContentManager -> UserContentManager -> Bool

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

GObject UserContentManager

Defined in GI.WebKit2.Objects.UserContentManager

ManagedPtrNewtype UserContentManager

Defined in GI.WebKit2.Objects.UserContentManager

Methods

toManagedPtr :: UserContentManager -> ManagedPtr UserContentManager

TypedObject UserContentManager

Defined in GI.WebKit2.Objects.UserContentManager

Methods

glibType :: IO GType

HasParentTypes UserContentManager

Defined in GI.WebKit2.Objects.UserContentManager

IsGValue (Maybe UserContentManager)

Convert UserContentManager to and from GValue. See toGValue and fromGValue.

Defined in GI.WebKit2.Objects.UserContentManager

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe UserContentManager -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe UserContentManager)

type ParentTypes UserContentManager

Defined in GI.WebKit2.Objects.UserContentManager

type ParentTypes UserContentManager = '[Object]

class (GObject o, IsDescendantOf UserContentManager o) => IsUserContentManager o

Type class for types which can be safely cast to UserContentManager, for instance with toUserContentManager.

Instances

(GObject o, IsDescendantOf UserContentManager o) => IsUserContentManager o

Defined in GI.WebKit2.Objects.UserContentManager

toUserContentManager :: (MonadIO m, IsUserContentManager o) => o -> m UserContentManager

Cast to UserContentManager, for types for which this is known to be safe. For general casts, use castTo.

Methods

Click to display all available methods, including inherited ones

Methods

addFilter, addScript, addStyleSheet, bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, ref, refSink, registerScriptMessageHandler, registerScriptMessageHandlerInWorld, removeAllFilters, removeAllScripts, removeAllStyleSheets, removeFilter, removeFilterById, removeScript, removeStyleSheet, runDispose, stealData, stealQdata, thawNotify, unref, unregisterScriptMessageHandler, unregisterScriptMessageHandlerInWorld, watchClosure.

Getters

getData, getProperty, getQdata.

Setters

setData, setDataFull, setProperty.

addFilter

userContentManagerAddFilter

Arguments

:: (HasCallStack, MonadIO m, IsUserContentManager a)

=> a

manager: A UserContentManager

-> UserContentFilter

filter: A UserContentFilter

-> m ()

Adds a UserContentFilter to the given UserContentManager.

The same UserContentFilter can be reused with multiple UserContentManager instances.

Filters need to be saved and loaded from UserContentFilterStore.

Since: 2.24

addScript

userContentManagerAddScript

Arguments

:: (HasCallStack, MonadIO m, IsUserContentManager a)

=> a

manager: A UserContentManager

-> UserScript

script: A UserScript

-> m ()

Adds a UserScript to the given UserContentManager.

The same UserScript can be reused with multiple UserContentManager instances.

Since: 2.6

addStyleSheet

userContentManagerAddStyleSheet

Arguments

:: (HasCallStack, MonadIO m, IsUserContentManager a)

=> a

manager: A UserContentManager

-> UserStyleSheet

stylesheet: A UserStyleSheet

-> m ()

Adds a UserStyleSheet to the given UserContentManager.

The same UserStyleSheet can be reused with multiple UserContentManager instances.

Since: 2.6

new

userContentManagerNew

Arguments

:: (HasCallStack, MonadIO m)

=> m UserContentManager

Returns: A UserContentManager

Creates a new user content manager.

Since: 2.6

registerScriptMessageHandler

userContentManagerRegisterScriptMessageHandler

Arguments

:: (HasCallStack, MonadIO m, IsUserContentManager a)

=> a

manager: A UserContentManager

-> Text

name: Name of the script message channel

-> m Bool

Returns: True if message handler was registered successfully, or False otherwise.

Registers a new user script message handler.

After it is registered, scripts can use window.webkit.messageHandlers.<name>.postMessage(value) to send messages. Those messages are received by connecting handlers to the UserContentManager::scriptMessageReceived signal. The handler name is used as the detail of the signal. To avoid race conditions between registering the handler name, and starting to receive the signals, it is recommended to connect to the signal *before* registering the handler name:

c code

WebKitWebView *view = webkit_web_view_new ();
WebKitUserContentManager *manager = webkit_web_view_get_user_content_manager ();
g_signal_connect (manager, "script-message-received::foobar",
                  G_CALLBACK (handle_script_message), NULL);
webkit_user_content_manager_register_script_message_handler (manager, "foobar");

Registering a script message handler will fail if the requested name has been already registered before.

Since: 2.8

registerScriptMessageHandlerInWorld

userContentManagerRegisterScriptMessageHandlerInWorld

Arguments

:: (HasCallStack, MonadIO m, IsUserContentManager a)

=> a

manager: A UserContentManager

-> Text

name: Name of the script message channel

-> Text

worldName: the name of a WebKitScriptWorld

-> m Bool

Returns: True if message handler was registered successfully, or False otherwise.

Registers a new user script message handler in script world.

Registers a new user script message handler in script world with name worldName. See userContentManagerRegisterScriptMessageHandler for full description.

Registering a script message handler will fail if the requested name has been already registered before.

Since: 2.22

removeAllFilters

userContentManagerRemoveAllFilters

Arguments

:: (HasCallStack, MonadIO m, IsUserContentManager a)

=> a

manager: A UserContentManager

-> m ()

Removes all content filters from the given UserContentManager.

Since: 2.24

removeAllScripts

userContentManagerRemoveAllScripts

Arguments

:: (HasCallStack, MonadIO m, IsUserContentManager a)

=> a

manager: A UserContentManager

-> m ()

Removes all user scripts from the given UserContentManager

See also userContentManagerRemoveScript.

Since: 2.6

removeAllStyleSheets

userContentManagerRemoveAllStyleSheets

Arguments

:: (HasCallStack, MonadIO m, IsUserContentManager a)

=> a

manager: A UserContentManager

-> m ()

Removes all user style sheets from the given UserContentManager.

Since: 2.6

removeFilter

userContentManagerRemoveFilter

Arguments

:: (HasCallStack, MonadIO m, IsUserContentManager a)

=> a

manager: A UserContentManager

-> UserContentFilter

filter: A UserContentFilter

-> m ()

Removes a filter from the given UserContentManager.

Since 2.24

removeFilterById

userContentManagerRemoveFilterById

Arguments

:: (HasCallStack, MonadIO m, IsUserContentManager a)

=> a

manager: A UserContentManager

-> Text

filterId: Filter identifier

-> m ()

Removes a filter by the given identifier.

Removes a filter from the given UserContentManager given the identifier of a UserContentFilter as returned by userContentFilterGetIdentifier.

Since: 2.26

removeScript

userContentManagerRemoveScript

Arguments

:: (HasCallStack, MonadIO m, IsUserContentManager a)

=> a

manager: A UserContentManager

-> UserScript

script: A UserScript

-> m ()

Removes a UserScript from the given UserContentManager.

See also userContentManagerRemoveAllScripts.

Since: 2.32

removeStyleSheet

userContentManagerRemoveStyleSheet

Arguments

:: (HasCallStack, MonadIO m, IsUserContentManager a)

=> a

manager: A UserContentManager

-> UserStyleSheet

stylesheet: A UserStyleSheet

-> m ()

Removes a UserStyleSheet from the given UserContentManager.

See also userContentManagerRemoveAllStyleSheets.

Since: 2.32

unregisterScriptMessageHandler

userContentManagerUnregisterScriptMessageHandler

Arguments

:: (HasCallStack, MonadIO m, IsUserContentManager a)

=> a

manager: A UserContentManager

-> Text

name: Name of the script message channel

-> m ()

Unregisters a previously registered message handler.

Note that this does *not* disconnect handlers for the UserContentManager::scriptMessageReceived signal; they will be kept connected, but the signal will not be emitted unless the handler name is registered again.

See also userContentManagerRegisterScriptMessageHandler.

Since: 2.8

unregisterScriptMessageHandlerInWorld

userContentManagerUnregisterScriptMessageHandlerInWorld

Arguments

:: (HasCallStack, MonadIO m, IsUserContentManager a)

=> a

manager: A UserContentManager

-> Text

name: Name of the script message channel

-> Text

worldName: the name of a WebKitScriptWorld

-> m ()

Unregisters a previously registered message handler in script world with name worldName.

Note that this does *not* disconnect handlers for the UserContentManager::scriptMessageReceived signal; they will be kept connected, but the signal will not be emitted unless the handler name is registered again.

See also userContentManagerRegisterScriptMessageHandlerInWorld.

Since: 2.22

Signals

scriptMessageReceived

type UserContentManagerScriptMessageReceivedCallback

Arguments

 = JavascriptResult

jsResult: the JavascriptResult holding the value received from the JavaScript world.

-> IO ()

This signal is emitted when JavaScript in a web view calls <code>window.webkit.messageHandlers.<name>.postMessage()</code>, after registering <code><name></code> using userContentManagerRegisterScriptMessageHandler

Since: 2.8

afterUserContentManagerScriptMessageReceived :: (IsUserContentManager a, MonadIO m) => a -> Maybe Text -> ((?self :: a) => UserContentManagerScriptMessageReceivedCallback) -> m SignalHandlerId

Connect a signal handler for the scriptMessageReceived signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after userContentManager #scriptMessageReceived callback

This signal admits a optional parameter detail. If it's not Nothing, we will connect to “script-message-received::detail” instead.

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onUserContentManagerScriptMessageReceived :: (IsUserContentManager a, MonadIO m) => a -> Maybe Text -> ((?self :: a) => UserContentManagerScriptMessageReceivedCallback) -> m SignalHandlerId

Connect a signal handler for the scriptMessageReceived signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on userContentManager #scriptMessageReceived callback

This signal admits a optional parameter detail. If it's not Nothing, we will connect to “script-message-received::detail” instead.