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 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606
|
<!--
SPDX-FileCopyrightText: The WebKit GTK and WPE teams
SPDX-License-Identifier: BSD, LGPL-2.1
-->
<!DOCTYPE html>
<html lang="en">
<head>
<title>WPEWebKit.UserContentManager</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta charset="utf-8" />
<meta property="og:type" content="website"/>
<meta property="og:title" content="WPEWebKit.UserContentManager"/>
<meta property="og:description" content="Reference for WPEWebKit.UserContentManager"/>
<meta name="twitter:title" content="WPEWebKit.UserContentManager"/>
<meta name="twitter:description" content="Reference for WPEWebKit.UserContentManager"/>
<meta name="twitter:card" content="summary"/>
<link rel="stylesheet" href="style.css" type="text/css" />
<script src="wpe2-urlmap.js"></script>
<script src="fzy.js"></script>
<script src="search.js"></script>
<script src="main.js"></script>
</head>
<body>
<div id="body-wrapper" tabindex="-1">
<nav class="sidebar devhelp-hidden">
<div class="search section">
<form id="search-form" autocomplete="off">
<input id="search-input" type="text" name="do-not-autocomplete" placeholder="Click, or press 's' to search" autocomplete="off"/>
</form>
</div>
<div class="section namespace">
<h3><a href="index.html">WPEWebKit</a></h3>
<p>API Version: 2.0</p>
<p>Library Version: 2.50.5</p>
</div>
<div class="section">
<h5>Type</h5>
<div class="links">
<a class="current" href="class.UserContentManager.html#description">UserContentManager</a>
</div>
</div>
<div class="section">
<h5>Constructors</h5>
<div class="links">
<a class="ctor" href="ctor.UserContentManager.new.html">new</a>
</div>
</div>
<div class="section">
<h5>Instance methods</h5>
<div class="links">
<a class="method" href="method.UserContentManager.add_filter.html">add_filter</a>
<a class="method" href="method.UserContentManager.add_script.html">add_script</a>
<a class="method" href="method.UserContentManager.add_style_sheet.html">add_style_sheet</a>
<a class="method" href="method.UserContentManager.register_script_message_handler.html">register_script_message_handler</a>
<a class="method" href="method.UserContentManager.register_script_message_handler_with_reply.html">register_script_message_handler_with_reply</a>
<a class="method" href="method.UserContentManager.remove_all_filters.html">remove_all_filters</a>
<a class="method" href="method.UserContentManager.remove_all_scripts.html">remove_all_scripts</a>
<a class="method" href="method.UserContentManager.remove_all_style_sheets.html">remove_all_style_sheets</a>
<a class="method" href="method.UserContentManager.remove_filter.html">remove_filter</a>
<a class="method" href="method.UserContentManager.remove_filter_by_id.html">remove_filter_by_id</a>
<a class="method" href="method.UserContentManager.remove_script.html">remove_script</a>
<a class="method" href="method.UserContentManager.remove_style_sheet.html">remove_style_sheet</a>
<a class="method" href="method.UserContentManager.unregister_script_message_handler.html">unregister_script_message_handler</a>
</div>
</div>
<div class="section">
<h5>Signals</h5>
<div class="links">
<a class="signal" href="signal.UserContentManager.script-message-received.html">script-message-received</a>
<a class="signal" href="signal.UserContentManager.script-message-with-reply-received.html">script-message-with-reply-received</a>
</div>
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
</div>
</nav>
<button id="btn-to-top" class="hidden"><span class="up-arrow"></span></button>
<section id="main" class="content">
<header>
<h3>Class</h3>
<h1 aria-label="Name"><a href="index.html">WPEWebKit</a><span class="sep" role="presentation"></span>UserContentManager</h1>
</header>
<section>
<summary>
<div class="docblock">
<p><span class="emblem available">since: 2.6</span></p>
</div>
<div class="toggle-wrapper">
<h4 id="description" style="display:flex;">
Description
<a href="#description" class="anchor"></a>
<a class="srclink" title="go to source location" href="https://github.com/WebKit/WebKit/tree/main/Source/WebKit/UIProcess/API/glib/WebKitUserContentManager.cpp#L55">[src]</a>
</h4>
<pre><code>final class WPEWebKit.UserContentManager : GObject.Object {
/* No available fields */
}</pre></code>
<div class="docblock">
<p>Manages user-defined content which affects web pages.</p>
<p>Using a <code>WebKitUserContentManager</code> user <span class="caps">CSS</span> style sheets can be set to
be injected in the web pages loaded by a <code>WebKitWebView</code>, by webkit_user_content_manager_add_style_sheet().</p>
<p>To use a <code>WebKitUserContentManager</code>, it must be created using
webkit_user_content_manager_new(), and then used to construct
a <code>WebKitWebView</code>. User style sheets can be created with webkit_user_style_sheet_new().</p>
<p>User style sheets can be added and removed at any time, but
they will affect the web pages loaded afterwards.</p>
</div>
<div class="docblock">
<p>Available since: 2.6</p>
</div>
</div>
</summary>
<div class="toggle-wrapper hierarchy">
<h4 id="hierarchy">
Hierarchy
<a href="#hierarchy" class="anchor"></a>
</h4>
<div class="docblock" alt="Hierarchy for WPEWebKit.UserContentManager">
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
"http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<!-- Generated by graphviz version 2.40.1 (20161225.0304)
-->
<!-- Title: hierarchy Pages: 1 -->
<svg width="189pt" height="116pt"
viewBox="0.00 0.00 188.82 116.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 112)">
<title>hierarchy</title>
<!-- this -->
<g id="node1" class="node">
<title>this</title>
<g id="a_node1"><a xlink:title="WebKitUserContentManager">
<path fill="none" stroke="#000000" d="M168.7373,-36C168.7373,-36 12.0875,-36 12.0875,-36 6.0875,-36 .0875,-30 .0875,-24 .0875,-24 .0875,-12 .0875,-12 .0875,-6 6.0875,0 12.0875,0 12.0875,0 168.7373,0 168.7373,0 174.7373,0 180.7373,-6 180.7373,-12 180.7373,-12 180.7373,-24 180.7373,-24 180.7373,-30 174.7373,-36 168.7373,-36"/>
<text text-anchor="middle" x="90.4124" y="-13.8" font-family="Times,serif" font-size="14.00" fill="#000000">WebKitUserContentManager</text>
</a>
</g>
</g>
<!-- ancestor_0 -->
<g id="node2" class="node">
<title>ancestor_0</title>
<g id="a_node2"><a xlink:title="GObject.Object">
<path fill="none" stroke="#000000" d="M110.3374,-108C110.3374,-108 70.4874,-108 70.4874,-108 64.4874,-108 58.4874,-102 58.4874,-96 58.4874,-96 58.4874,-84 58.4874,-84 58.4874,-78 64.4874,-72 70.4874,-72 70.4874,-72 110.3374,-72 110.3374,-72 116.3374,-72 122.3374,-78 122.3374,-84 122.3374,-84 122.3374,-96 122.3374,-96 122.3374,-102 116.3374,-108 110.3374,-108"/>
<text text-anchor="middle" x="90.4124" y="-85.8" font-family="Times,serif" font-size="14.00" fill="#000000">GObject</text>
</a>
</g>
</g>
<!-- ancestor_0--this -->
<g id="edge1" class="edge">
<title>ancestor_0--this</title>
<path fill="none" stroke="#000000" d="M90.4124,-71.8314C90.4124,-61 90.4124,-47.2876 90.4124,-36.4133"/>
</g>
</g>
</svg>
</div>
</div>
<div class="toggle-wrapper ancestors">
<h4 id="ancestors">
Ancestors
<a href="#ancestors" class="anchor"></a>
</h4>
<div class="docblock">
<ul>
<li class="class"><a class="external" href="javascript:void(0)" data-link="class.Object.html" data-namespace="GObject">GObject</a></li>
</ul>
</div>
</div>
<div class="toggle-wrapper constructors">
<h4 id="constructors">
Constructors
<a href="#constructors" class="anchor"></a>
</h4>
<div class="docblock">
<div class="">
<h6><a href="ctor.UserContentManager.new.html">webkit_user_content_manager_new</a></h6>
<div class="docblock">
<p>Creates a new user content manager.</p>
</div>
<div class="docblock">
<p><span class="emblem available">since: 2.6</span></p>
</div>
</div>
</div>
</div>
<div class="toggle-wrapper methods">
<h4 id="methods">
Instance methods
<a href="#methods" class="anchor"></a>
</h4>
<div class="docblock">
<div class="">
<h6><a href="method.UserContentManager.add_filter.html">webkit_user_content_manager_add_filter</a></h6>
<div class="docblock">
<p>Adds a <code>WebKitUserContentFilter</code> to the given <code>WebKitUserContentManager</code>.</p>
</div>
<div class="docblock">
<p><span class="emblem available">since: 2.24</span></p>
</div>
</div>
<div class="">
<h6><a href="method.UserContentManager.add_script.html">webkit_user_content_manager_add_script</a></h6>
<div class="docblock">
<p>Adds a <code>WebKitUserScript</code> to the given <code>WebKitUserContentManager</code>.</p>
</div>
<div class="docblock">
<p><span class="emblem available">since: 2.6</span></p>
</div>
</div>
<div class="">
<h6><a href="method.UserContentManager.add_style_sheet.html">webkit_user_content_manager_add_style_sheet</a></h6>
<div class="docblock">
<p>Adds a <code>WebKitUserStyleSheet</code> to the given <code>WebKitUserContentManager</code>.</p>
</div>
<div class="docblock">
<p><span class="emblem available">since: 2.6</span></p>
</div>
</div>
<div class="">
<h6><a href="method.UserContentManager.register_script_message_handler.html">webkit_user_content_manager_register_script_message_handler</a></h6>
<div class="docblock">
<p>Registers a new user script message handler in script world.</p>
</div>
<div class="docblock">
<p><span class="emblem available">since: 2.40</span></p>
</div>
</div>
<div class="">
<h6><a href="method.UserContentManager.register_script_message_handler_with_reply.html">webkit_user_content_manager_register_script_message_handler_with_reply</a></h6>
<div class="docblock">
<p>Registers a new user script message handler in script world with name <code>world_name</code>.</p>
</div>
<div class="docblock">
<p><span class="emblem available">since: 2.40</span></p>
</div>
</div>
<div class="">
<h6><a href="method.UserContentManager.remove_all_filters.html">webkit_user_content_manager_remove_all_filters</a></h6>
<div class="docblock">
<p>Removes all content filters from the given <code>WebKitUserContentManager</code>.</p>
</div>
<div class="docblock">
<p><span class="emblem available">since: 2.24</span></p>
</div>
</div>
<div class="">
<h6><a href="method.UserContentManager.remove_all_scripts.html">webkit_user_content_manager_remove_all_scripts</a></h6>
<div class="docblock">
<p>Removes all user scripts from the given <code>WebKitUserContentManager</code>.</p>
</div>
<div class="docblock">
<p><span class="emblem available">since: 2.6</span></p>
</div>
</div>
<div class="">
<h6><a href="method.UserContentManager.remove_all_style_sheets.html">webkit_user_content_manager_remove_all_style_sheets</a></h6>
<div class="docblock">
<p>Removes all user style sheets from the given <code>WebKitUserContentManager</code>.</p>
</div>
<div class="docblock">
<p><span class="emblem available">since: 2.6</span></p>
</div>
</div>
<div class="">
<h6><a href="method.UserContentManager.remove_filter.html">webkit_user_content_manager_remove_filter</a></h6>
<div class="docblock">
<p>Removes a filter from the given <code>WebKitUserContentManager</code>.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.UserContentManager.remove_filter_by_id.html">webkit_user_content_manager_remove_filter_by_id</a></h6>
<div class="docblock">
<p>Removes a filter by the given identifier.</p>
</div>
<div class="docblock">
<p><span class="emblem available">since: 2.26</span></p>
</div>
</div>
<div class="">
<h6><a href="method.UserContentManager.remove_script.html">webkit_user_content_manager_remove_script</a></h6>
<div class="docblock">
<p>Removes a <code>WebKitUserScript</code> from the given <code>WebKitUserContentManager</code>.</p>
</div>
<div class="docblock">
<p><span class="emblem available">since: 2.32</span></p>
</div>
</div>
<div class="">
<h6><a href="method.UserContentManager.remove_style_sheet.html">webkit_user_content_manager_remove_style_sheet</a></h6>
<div class="docblock">
<p>Removes a <code>WebKitUserStyleSheet</code> from the given <code>WebKitUserContentManager</code>.</p>
</div>
<div class="docblock">
<p><span class="emblem available">since: 2.32</span></p>
</div>
</div>
<div class="">
<h6><a href="method.UserContentManager.unregister_script_message_handler.html">webkit_user_content_manager_unregister_script_message_handler</a></h6>
<div class="docblock">
<p>Unregisters a previously registered message handler in script world with name <code>world_name</code>.
If <code>NULL</code> is passed as the <code>world_name</code>, the default world will be used.</p>
</div>
<div class="docblock">
<p><span class="emblem available">since: 2.40</span></p>
</div>
</div>
</div>
<div class="toggle-wrapper default-hide ancestor-methods"><h5 style="display:block;">Methods inherited from <a class="external" href="javascript:void(0)" data-link="class.Object.html" data-namespace="GObject">GObject</a> (43)</h5>
<div class="docblock">
<div class="docblock">
<p>Please see <a class="external" href="javascript:void(0)" data-link="class.Object.html#methods" data-namespace="GObject">GObject</a> for a full list of methods.</em></p>
</div>
</div>
</div>
</div>
<div class="signals toggle-wrapper">
<h4 id="signals">
Signals
<a href="#signals" class="anchor"></a>
</h4>
<div class="docblock">
<div class="">
<h6><a href="signal.UserContentManager.script-message-received.html">WPEWebKit.UserContentManager::script-message-received</a></h6>
<div class="docblock">
<p>This signal is emitted when JavaScript in a web view calls
<code>window.webkit.messageHandlers.<name>.postMessage()</code>, after registering
<code><name></code> using
<code>webkit_user_content_manager_register_script_message_handler()</code></p>
</div>
<div class="docblock">
<p><span class="emblem available">since: 2.8</span></p>
</div>
</div>
<div class="">
<h6><a href="signal.UserContentManager.script-message-with-reply-received.html">WPEWebKit.UserContentManager::script-message-with-reply-received</a></h6>
<div class="docblock">
<p>This signal is emitted when JavaScript in a web view calls
<code>window.webkit.messageHandlers.<name>.postMessage()</code>, after registering
<code><name></code> using
<code>webkit_user_content_manager_register_script_message_handler_with_reply()</code></p>
</div>
<div class="docblock">
<p><span class="emblem available">since: 2.40</span></p>
</div>
</div>
</div>
<div class="toggle-wrapper default-hide ancestor-signals"><h5 style="display:block;">Signals inherited from <a class="external" href="javascript:void(0)" data-link="class.Object.html" data-namespace="GObject">GObject</a> (1)</h5>
<div class="docblock">
<h6><a class="external" href="javascript:void(0)" data-namespace="GObject" data-link="signal.Object.notify.html">GObject::notify</a></h6>
<div class="docblock">
<p>The notify signal is emitted on an object when one of its properties has
its value set through g_object_set_property(), g_object_set(), et al.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
</div>
</div>
<div class="class toggle-wrapper default-hide">
<h4 id="class-struct">
Class structure
<a href="#class-struct" class="anchor"></a>
</h4>
<div class="docblock">
<pre><code>struct WPEWebKitUserContentManagerClass {
GObjectClass parent_class;
}</code></pre>
</div>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<h6>Class members</h6>
<dl class="members">
<dt><code>parent_class: GObjectClass</code></dt>
<dd>No description available.</dd>
</dd>
</div>
</div>
</section>
</section>
<div id="toc" class="toc">
<nav aria-labelledby="toc-title">
<p id="toc-title">Content</p>
<ul class="toc-list">
<li class="toc-list-item"><a href="#description"><span class="link-text">Description</span></a></li>
<li class="toc-list-item"><a href="#hierarchy"><span class="link-text">Hierarchy</span></a></li>
<li class="toc-list-item"><a href="#ancestors"><span class="link-text">Ancestors</span></a></li>
<li class="toc-list-item"><a href="#constructors"><span class="link-text">Constructors</span></a></li>
<li class="toc-list-item"><a href="#methods"><span class="link-text">Methods</span></a></li>
<li class="toc-list-item"><a href="#signals"><span class="link-text">Signals</span></a></li>
</ul>
</nav>
</div>
<section id="search" class="content hidden"></section>
<footer>
</footer>
</div>
</body>
</html>
|