GI.WebKit2.Objects.UserContentManager

Exported types

newtype UserContentManager

Constructors

UserContentManager (ManagedPtr UserContentManager)

Instances

GObject UserContentManager

Methods

gobjectType :: UserContentManager -> IO GType

IsObject UserContentManager

IsUserContentManager UserContentManager

class GObject o => IsUserContentManager o

Instances

(GObject a, UnknownAncestorError Constraint UserContentManager a) => IsUserContentManager a

IsUserContentManager UserContentManager

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

noUserContentManager :: Maybe UserContentManager

Methods

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::script-message-received 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:

<informalexample><programlisting> 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"); </programlisting></informalexample>

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

Since: 2.8

removeAllScripts

userContentManagerRemoveAllScripts

Arguments

:: (HasCallStack, MonadIO m, IsUserContentManager a)

=> a

manager: A UserContentManager

-> m ()

Removes all user scripts from the given UserContentManager

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

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::script-message-received 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

Signals

scriptMessageReceived

type C_UserContentManagerScriptMessageReceivedCallback = Ptr () -> Ptr JavascriptResult -> Ptr () -> IO ()

type UserContentManagerScriptMessageReceivedCallback = JavascriptResult -> IO ()

afterUserContentManagerScriptMessageReceived :: (IsUserContentManager a, MonadIO m) => a -> UserContentManagerScriptMessageReceivedCallback -> m SignalHandlerId

genClosure_UserContentManagerScriptMessageReceived :: UserContentManagerScriptMessageReceivedCallback -> IO Closure

mk_UserContentManagerScriptMessageReceivedCallback :: C_UserContentManagerScriptMessageReceivedCallback -> IO (FunPtr C_UserContentManagerScriptMessageReceivedCallback)

noUserContentManagerScriptMessageReceivedCallback :: Maybe UserContentManagerScriptMessageReceivedCallback

onUserContentManagerScriptMessageReceived :: (IsUserContentManager a, MonadIO m) => a -> UserContentManagerScriptMessageReceivedCallback -> m SignalHandlerId

wrap_UserContentManagerScriptMessageReceivedCallback :: UserContentManagerScriptMessageReceivedCallback -> Ptr () -> Ptr JavascriptResult -> Ptr () -> IO ()