1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289
|
/*
* Copyright (C) 2014, 2020 Igalia S.L.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public License
* along with this library; see the file COPYING.LIB. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
@WEBKIT_SINGLE_HEADER_CHECK@
#ifndef WebKitUserContentManager_h
#define WebKitUserContentManager_h
#include <glib-object.h>
#include <jsc/jsc.h>
#include <@API_INCLUDE_PREFIX@/WebKitDefines.h>
#include <@API_INCLUDE_PREFIX@/WebKitUserContent.h>
G_BEGIN_DECLS
#define WEBKIT_TYPE_USER_CONTENT_MANAGER (webkit_user_content_manager_get_type())
#if !ENABLE(2022_GLIB_API)
#define WEBKIT_USER_CONTENT_MANAGER(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), WEBKIT_TYPE_USER_CONTENT_MANAGER, WebKitUserContentManager))
#define WEBKIT_IS_USER_CONTENT_MANAGER(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), WEBKIT_TYPE_USER_CONTENT_MANAGER))
#define WEBKIT_USER_CONTENT_MANAGER_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), WEBKIT_TYPE_USER_CONTENT_MANAGER, WebKitUserContentManagerClass))
#define WEBKIT_IS_USER_CONTENT_MANAGER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), WEBKIT_TYPE_USER_CONTENT_MANAGER))
#define WEBKIT_USER_CONTENT_MANAGER_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), WEBKIT_TYPE_USER_CONTENT_MANAGER, WebKitUserContentManagerClass))
struct _WebKitUserContentManagerClass {
GObjectClass parent_class;
/*< private >*/
void (*_webkit_reserved0) (void);
void (*_webkit_reserved1) (void);
void (*_webkit_reserved2) (void);
void (*_webkit_reserved3) (void);
};
#endif
WEBKIT_DECLARE_FINAL_TYPE (WebKitUserContentManager, webkit_user_content_manager, WEBKIT, USER_CONTENT_MANAGER, GObject)
WEBKIT_API WebKitUserContentManager *
webkit_user_content_manager_new (void);
WEBKIT_API void
webkit_user_content_manager_add_style_sheet (WebKitUserContentManager *manager,
WebKitUserStyleSheet *stylesheet);
WEBKIT_API void
webkit_user_content_manager_remove_style_sheet (WebKitUserContentManager *manager,
WebKitUserStyleSheet *stylesheet);
WEBKIT_API void
webkit_user_content_manager_remove_all_style_sheets (WebKitUserContentManager *manager);
#if !ENABLE(2022_GLIB_API)
/**
* webkit_user_content_manager_register_script_message_handler:
* @manager: A #WebKitUserContentManager
* @name: Name of the script message channel
*
* 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 #WebKitUserContentManager::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:
*
* ```c
* 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.
*
* Returns: %TRUE if message handler was registered successfully, or %FALSE otherwise.
*
* Since: 2.8
*/
WEBKIT_API gboolean
webkit_user_content_manager_register_script_message_handler (WebKitUserContentManager *manager,
const gchar *name);
/**
* webkit_user_content_manager_unregister_script_message_handler:
* @manager: A #WebKitUserContentManager
* @name: Name of the script message channel
*
* Unregisters a previously registered message handler.
*
* Note that this does *not* disconnect handlers for the
* #WebKitUserContentManager::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
*/
WEBKIT_API void
webkit_user_content_manager_unregister_script_message_handler (WebKitUserContentManager *manager,
const gchar *name);
#else
/**
* webkit_user_content_manager_register_script_message_handler:
* @manager: A #WebKitUserContentManager
* @name: Name of the script message channel
* @world_name: (nullable): the name of a #WebKitScriptWorld
*
* Registers a new user script message handler in script world.
*
* 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 #WebKitUserContentManager::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:
*
* ```c
* 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.
*
* If %NULL is passed as the @world_name, the default world will be used.
*
* The registered handler can be unregistered by using
* webkit_user_content_manager_unregister_script_message_handler().
*
* Returns: %TRUE if message handler was registered successfully, or %FALSE otherwise.
*
* Since: 2.40
*/
WEBKIT_API gboolean
webkit_user_content_manager_register_script_message_handler (WebKitUserContentManager *manager,
const char *name,
const char *world_name);
/**
* webkit_user_content_manager_unregister_script_message_handler:
* @manager: A #WebKitUserContentManager
* @name: Name of the script message channel
* @world_name: (nullable): the name of a #WebKitScriptWorld
*
* Unregisters a previously registered message handler in script world with name @world_name.
* If %NULL is passed as the @world_name, the default world will be used.
*
* Note that this does *not* disconnect handlers for the
* #WebKitUserContentManager::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.40
*/
WEBKIT_API void
webkit_user_content_manager_unregister_script_message_handler (WebKitUserContentManager *manager,
const gchar *name,
const gchar *world_name);
#endif
WEBKIT_API gboolean
webkit_user_content_manager_register_script_message_handler_with_reply (WebKitUserContentManager *manager,
const char *name,
const char *world_name);
#if !ENABLE(2022_GLIB_API)
/**
* webkit_user_content_manager_register_script_message_handler_in_world:
* @manager: A #WebKitUserContentManager
* @name: Name of the script message channel
* @world_name: the name of a #WebKitScriptWorld
*
* Registers a new user script message handler in script world.
*
* 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.
*
* Returns: %TRUE if message handler was registered successfully, or %FALSE otherwise.
*
* Since: 2.22
*/
WEBKIT_API gboolean
webkit_user_content_manager_register_script_message_handler_in_world (WebKitUserContentManager *manager,
const gchar *name,
const gchar *world_name);
/**
* webkit_user_content_manager_unregister_script_message_handler_in_world:
* @manager: A #WebKitUserContentManager
* @name: Name of the script message channel
* @world_name: the name of a #WebKitScriptWorld
*
* Unregisters a previously registered message handler in script world with name @world_name.
*
* Note that this does *not* disconnect handlers for the
* #WebKitUserContentManager::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().
*
* Since: 2.22
*/
WEBKIT_API void
webkit_user_content_manager_unregister_script_message_handler_in_world (WebKitUserContentManager *manager,
const gchar *name,
const gchar *world_name);
#endif
WEBKIT_API void
webkit_user_content_manager_add_script (WebKitUserContentManager *manager,
WebKitUserScript *script);
WEBKIT_API void
webkit_user_content_manager_remove_script (WebKitUserContentManager *manager,
WebKitUserScript *script);
WEBKIT_API void
webkit_user_content_manager_remove_all_scripts (WebKitUserContentManager *manager);
WEBKIT_API void
webkit_user_content_manager_add_filter (WebKitUserContentManager *manager,
WebKitUserContentFilter *filter);
WEBKIT_API void
webkit_user_content_manager_remove_filter (WebKitUserContentManager *manager,
WebKitUserContentFilter *filter);
WEBKIT_API void
webkit_user_content_manager_remove_filter_by_id (WebKitUserContentManager *manager,
const char *filter_id);
WEBKIT_API void
webkit_user_content_manager_remove_all_filters (WebKitUserContentManager *manager);
#define WEBKIT_TYPE_SCRIPT_MESSAGE_REPLY (webkit_script_message_reply_get_type())
typedef struct _WebKitScriptMessageReply WebKitScriptMessageReply;
WEBKIT_API GType
webkit_script_message_reply_get_type (void);
WEBKIT_API WebKitScriptMessageReply *
webkit_script_message_reply_ref (WebKitScriptMessageReply *script_message_reply);
WEBKIT_API void
webkit_script_message_reply_unref (WebKitScriptMessageReply *script_message_reply);
WEBKIT_API void
webkit_script_message_reply_return_value (WebKitScriptMessageReply *script_message_reply,
JSCValue *reply_value);
WEBKIT_API void
webkit_script_message_reply_return_error_message (WebKitScriptMessageReply *script_message_reply,
const char *error_message);
G_END_DECLS
#endif
|