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.Objects.UserContentManager
Contents
Description
No description available in the introspection data.
- newtype UserContentManager = UserContentManager (ManagedPtr UserContentManager)
- class GObject o => IsUserContentManager o
- toUserContentManager :: (MonadIO m, IsUserContentManager o) => o -> m UserContentManager
- noUserContentManager :: Maybe UserContentManager
- userContentManagerAddScript :: (HasCallStack, MonadIO m, IsUserContentManager a) => a -> UserScript -> m ()
- userContentManagerAddStyleSheet :: (HasCallStack, MonadIO m, IsUserContentManager a) => a -> UserStyleSheet -> m ()
- userContentManagerNew :: (HasCallStack, MonadIO m) => m UserContentManager
- userContentManagerRegisterScriptMessageHandler :: (HasCallStack, MonadIO m, IsUserContentManager a) => a -> Text -> m Bool
- userContentManagerRemoveAllScripts :: (HasCallStack, MonadIO m, IsUserContentManager a) => a -> m ()
- userContentManagerRemoveAllStyleSheets :: (HasCallStack, MonadIO m, IsUserContentManager a) => a -> m ()
- userContentManagerUnregisterScriptMessageHandler :: (HasCallStack, MonadIO m, IsUserContentManager a) => a -> Text -> m ()
- 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 -> C_UserContentManagerScriptMessageReceivedCallback
Exported types
newtype UserContentManager Source #
Memory-managed wrapper type.
Constructors
UserContentManager (ManagedPtr UserContentManager) |
class GObject o => IsUserContentManager o Source #
Type class for types which can be safely cast to UserContentManager
, for instance with toUserContentManager
.
Instances
toUserContentManager :: (MonadIO m, IsUserContentManager o) => o -> m UserContentManager Source #
Cast to UserContentManager
, for types for which this is known to be safe. For general casts, use castTo
.
noUserContentManager :: Maybe UserContentManager Source #
A convenience alias for Nothing
:: Maybe
UserContentManager
.
Methods
addScript
userContentManagerAddScript Source #
Arguments
:: (HasCallStack, MonadIO m, IsUserContentManager a) | |
=> 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 Source #
Arguments
:: (HasCallStack, MonadIO m, IsUserContentManager a) | |
=> 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 Source #
Arguments
:: (HasCallStack, MonadIO m) | |
=> m UserContentManager | Returns: A |
Creates a new user content manager.
Since: 2.6
registerScriptMessageHandler
userContentManagerRegisterScriptMessageHandler Source #
Arguments
:: (HasCallStack, MonadIO m, IsUserContentManager a) | |
=> a |
|
-> Text |
|
-> m Bool | Returns: |
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 Source #
Arguments
:: (HasCallStack, MonadIO m, IsUserContentManager a) | |
=> a |
|
-> m () |
Removes all user scripts from the given UserContentManager
Since: 2.6
removeAllStyleSheets
userContentManagerRemoveAllStyleSheets Source #
Arguments
:: (HasCallStack, MonadIO m, IsUserContentManager a) | |
=> a |
|
-> m () |
Removes all user style sheets from the given UserContentManager
.
Since: 2.6
unregisterScriptMessageHandler
userContentManagerUnregisterScriptMessageHandler Source #
Arguments
:: (HasCallStack, MonadIO m, IsUserContentManager a) | |
=> a |
|
-> Text |
|
-> 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 () Source #
Type for the callback on the (unwrapped) C side.
type UserContentManagerScriptMessageReceivedCallback Source #
Arguments
= JavascriptResult |
|
-> 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 -> UserContentManagerScriptMessageReceivedCallback -> m SignalHandlerId Source #
Connect a signal handler for the “script-message-received
” signal, to be run after the default handler.
When overloading is enabled, this is equivalent to
after
userContentManager #scriptMessageReceived callback
genClosure_UserContentManagerScriptMessageReceived :: UserContentManagerScriptMessageReceivedCallback -> IO Closure Source #
Wrap the callback into a Closure
.
mk_UserContentManagerScriptMessageReceivedCallback :: C_UserContentManagerScriptMessageReceivedCallback -> IO (FunPtr C_UserContentManagerScriptMessageReceivedCallback) Source #
Generate a function pointer callable from C code, from a C_UserContentManagerScriptMessageReceivedCallback
.
noUserContentManagerScriptMessageReceivedCallback :: Maybe UserContentManagerScriptMessageReceivedCallback Source #
A convenience synonym for
.Nothing
:: Maybe
UserContentManagerScriptMessageReceivedCallback
onUserContentManagerScriptMessageReceived :: (IsUserContentManager a, MonadIO m) => a -> UserContentManagerScriptMessageReceivedCallback -> m SignalHandlerId Source #
Connect a signal handler for the “script-message-received
” signal, to be run before the default handler.
When overloading is enabled, this is equivalent to
on
userContentManager #scriptMessageReceived callback