Top |
WebKitUserContentManagerWebKitUserContentManager — Manages user-defined content which affects web pages. |
Using a WebKitUserContentManager user CSS style sheets can be set to
be injected in the web pages loaded by a WebKitWebView, by
webkit_user_content_manager_add_style_sheet()
.
To use a WebKitUserContentManager, it must be created using
webkit_user_content_manager_new()
, and then passed to
webkit_web_view_new_with_user_content_manager()
. User style
sheets can be created with webkit_user_style_sheet_new()
.
User style sheets can be added and removed at any time, but they will affect the web pages loaded afterwards.
WebKitUserContentManager *
webkit_user_content_manager_new (void
);
Creates a new user content manager.
Since: 2.6
void webkit_user_content_manager_add_style_sheet (WebKitUserContentManager *manager
,WebKitUserStyleSheet *stylesheet
);
Adds a WebKitUserStyleSheet to the given WebKitUserContentManager. The same WebKitUserStyleSheet can be reused with multiple WebKitUserContentManager instances.
Since: 2.6
void webkit_user_content_manager_remove_style_sheet (WebKitUserContentManager *manager
,WebKitUserStyleSheet *stylesheet
);
Removes a WebKitUserStyleSheet from the given WebKitUserContentManager.
See also webkit_user_content_manager_remove_all_style_sheets()
.
Since: 2.32
void
webkit_user_content_manager_remove_all_style_sheets
(WebKitUserContentManager *manager
);
Removes all user style sheets from the given WebKitUserContentManager.
Since: 2.6
void webkit_user_content_manager_add_script (WebKitUserContentManager *manager
,WebKitUserScript *script
);
Adds a WebKitUserScript to the given WebKitUserContentManager. The same WebKitUserScript can be reused with multiple WebKitUserContentManager instances.
Since: 2.6
void webkit_user_content_manager_remove_script (WebKitUserContentManager *manager
,WebKitUserScript *script
);
Removes a WebKitUserScript from the given WebKitUserContentManager.
See also webkit_user_content_manager_remove_all_scripts()
.
Since: 2.32
void
webkit_user_content_manager_remove_all_scripts
(WebKitUserContentManager *manager
);
Removes all user scripts from the given WebKitUserContentManager
See also webkit_user_content_manager_remove_script()
.
Since: 2.6
gboolean webkit_user_content_manager_register_script_message_handler (WebKitUserContentManager *manager
,const gchar *name
);
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 “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:
1 2 3 4 5 |
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
void webkit_user_content_manager_unregister_script_message_handler (WebKitUserContentManager *manager
,const gchar *name
);
Unregisters a previously registered message handler.
Note that this does *not* disconnect handlers for the “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 webkit_user_content_manager_register_script_message_handler()
.
Since: 2.8
gboolean webkit_user_content_manager_register_script_message_handler_in_world (WebKitUserContentManager *manager
,const gchar *name
,const gchar *world_name
);
Registers a new user script message handler in script world with name world_name
.
See webkit_user_content_manager_register_script_message_handler()
for full description.
Registering a script message handler will fail if the requested name has been already registered before.
manager |
||
name |
Name of the script message channel |
|
world_name |
the name of a WebKitScriptWorld |
Since: 2.22
void webkit_user_content_manager_unregister_script_message_handler_in_world (WebKitUserContentManager *manager
,const gchar *name
,const gchar *world_name
);
Unregisters a previously registered message handler in script world with name world_name
.
Note that this does *not* disconnect handlers for the “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 webkit_user_content_manager_register_script_message_handler_in_world()
.
manager |
||
name |
Name of the script message channel |
|
world_name |
the name of a WebKitScriptWorld |
Since: 2.22
void webkit_user_content_manager_add_filter (WebKitUserContentManager *manager
,WebKitUserContentFilter *filter
);
Adds a WebKitUserContentFilter to the given WebKitUserContentManager. The same WebKitUserContentFilter can be reused with multiple WebKitUserContentManager instances.
Filters need to be saved and loaded from WebKitUserContentFilterStore.
Since: 2.24
void webkit_user_content_manager_remove_filter (WebKitUserContentManager *manager
,WebKitUserContentFilter *filter
);
Removes a filter from the given WebKitUserContentManager.
Since 2.24
void webkit_user_content_manager_remove_filter_by_id (WebKitUserContentManager *manager
,const char *filter_id
);
Removes a filter from the given WebKitUserContentManager given the
identifier of a WebKitUserContentFilter as returned by
webkit_user_content_filter_get_identifier()
.
Since: 2.26
void
webkit_user_content_manager_remove_all_filters
(WebKitUserContentManager *manager
);
Removes all content filters from the given WebKitUserContentManager.
Since: 2.24
“script-message-received”
signalvoid user_function (WebKitUserContentManager *manager, WebKitJavascriptResult *js_result, gpointer user_data)
This signal is emitted when JavaScript in a web view calls
window.webkit.messageHandlers.<name>.postMessage()
, after registering
<name>
using
webkit_user_content_manager_register_script_message_handler()
manager |
||
js_result |
the WebKitJavascriptResult holding the value received from the JavaScript world. |
|
user_data |
user data set when the signal handler was connected. |
Flags: Has Details
Since: 2.8