@girs/sdk-gnome-49 5.2.0 → 5.4.0

package/webkit2webextension-4.1/webkit2webextension-4.1.d.ts

@@ -108,7 +108,7 @@ export namespace WebKit2WebExtension {
 
     /**
      * Enum values used to denote the stock actions for
-     * {@link WebKit2WebExtension.ContextMenuItem}<!-- -->s
+     * {@link WebKit2WebExtension.ContextMenuItem} objects
      * @gir-type Enum
      */
     enum ContextMenuAction {
@@ -169,7 +169,7 @@ export namespace WebKit2WebExtension {
          */
         RELOAD = 13,
         /**
-         * Copy current selection the clipboard.
+         * Copy current selection to the clipboard.
          */
         COPY = 14,
         /**
@@ -249,11 +249,11 @@ export namespace WebKit2WebExtension {
          */
         OPEN_AUDIO_IN_NEW_WINDOW = 33,
         /**
-         * Copy video link location in to the clipboard.
+         * Copy video link location to the clipboard.
          */
         COPY_VIDEO_LINK_TO_CLIPBOARD = 34,
         /**
-         * Copy audio link location in to the clipboard.
+         * Copy audio link location to the clipboard.
          */
         COPY_AUDIO_LINK_TO_CLIPBOARD = 35,
         /**
@@ -651,7 +651,7 @@ export namespace WebKit2WebExtension {
     const DOM_NODE_ENTITY_REFERENCE_NODE: number;
 
     /**
-     * Accept the node. Use this macro as return value of `webkit_dom_node_filter_accept_node()`
+     * Accept the node. Use this macro as the return value of a `webkit_dom_node_filter_accept_node()`
      * implementation to accept the given {@link WebKit2WebExtension.DOMNode}
      * @since 2.6
      * @deprecated since 2.22: Use JavaScriptCore API instead
@@ -660,7 +660,7 @@ export namespace WebKit2WebExtension {
     const DOM_NODE_FILTER_ACCEPT: number;
 
     /**
-     * Reject the node. Use this macro as return value of `webkit_dom_node_filter_accept_node()`
+     * Reject the node. Use this macro as the return value of a `webkit_dom_node_filter_accept_node()`
      * implementation to reject the given {@link WebKit2WebExtension.DOMNode}. The children of the given node will
      * be rejected too.
      * @since 2.6
@@ -774,7 +774,7 @@ export namespace WebKit2WebExtension {
     const DOM_NODE_FILTER_SHOW_TEXT: number;
 
     /**
-     * Skip the node. Use this macro as return value of `webkit_dom_node_filter_accept_node()`
+     * Skip the node. Use this macro as the return value of a `webkit_dom_node_filter_accept_node()`
      * implementation to skip the given {@link WebKit2WebExtension.DOMNode}. The children of the given node will
      * not be skipped.
      * @since 2.6
@@ -1439,7 +1439,7 @@ export namespace WebKit2WebExtension {
 
         /**
          * Version of `webkit_dom_event_target_add_event_listener()` using a closure
-         * instead of a callbacks for easier binding in other languages.
+         * instead of callbacks for easier binding in other languages.
          * @param event_name A `gchar`
          * @param handler A {@link GObject.Closure}
          * @param use_capture A `gboolean`
@@ -1458,7 +1458,7 @@ export namespace WebKit2WebExtension {
 
         /**
          * Version of `webkit_dom_event_target_remove_event_listener()` using a closure
-         * instead of a callbacks for easier binding in other languages.
+         * instead of callbacks for easier binding in other languages.
          * @param event_name A `gchar`
          * @param handler A {@link GObject.Closure}
          * @param use_capture A `gboolean`
@@ -2349,7 +2349,7 @@ export namespace WebKit2WebExtension {
 
         /**
          * Version of `webkit_dom_event_target_add_event_listener()` using a closure
-         * instead of a callbacks for easier binding in other languages.
+         * instead of callbacks for easier binding in other languages.
          * @param event_name A `gchar`
          * @param handler A {@link GObject.Closure}
          * @param use_capture A `gboolean`
@@ -2368,7 +2368,7 @@ export namespace WebKit2WebExtension {
 
         /**
          * Version of `webkit_dom_event_target_remove_event_listener()` using a closure
-         * instead of a callbacks for easier binding in other languages.
+         * instead of callbacks for easier binding in other languages.
          * @param event_name A `gchar`
          * @param handler A {@link GObject.Closure}
          * @param use_capture A `gboolean`
@@ -4008,14 +4008,17 @@ export namespace WebKit2WebExtension {
         stop(): void;
 
         /**
-         * @param handler 
-         * @param message 
+         * @param handler Name of the user message handler.
+         * @param message JavaScript value to be sent.
+         * @returns Whether the message was successfully sent.
+         * @since 2.8
+         * @deprecated since 2.22: Use JavaScriptCore API instead
          */
         webkit_message_handlers_post_message(handler: string, message: string): boolean;
 
         /**
          * Version of `webkit_dom_event_target_add_event_listener()` using a closure
-         * instead of a callbacks for easier binding in other languages.
+         * instead of callbacks for easier binding in other languages.
          * @param event_name A `gchar`
          * @param handler A {@link GObject.Closure}
          * @param use_capture A `gboolean`
@@ -4034,7 +4037,7 @@ export namespace WebKit2WebExtension {
 
         /**
          * Version of `webkit_dom_event_target_remove_event_listener()` using a closure
-         * instead of a callbacks for easier binding in other languages.
+         * instead of callbacks for easier binding in other languages.
          * @param event_name A `gchar`
          * @param handler A {@link GObject.Closure}
          * @param use_capture A `gboolean`
@@ -5386,7 +5389,7 @@ export namespace WebKit2WebExtension {
 
         /**
          * Version of `webkit_dom_event_target_add_event_listener()` using a closure
-         * instead of a callbacks for easier binding in other languages.
+         * instead of callbacks for easier binding in other languages.
          * @param event_name A `gchar`
          * @param handler A {@link GObject.Closure}
          * @param use_capture A `gboolean`
@@ -5405,7 +5408,7 @@ export namespace WebKit2WebExtension {
 
         /**
          * Version of `webkit_dom_event_target_remove_event_listener()` using a closure
-         * instead of a callbacks for easier binding in other languages.
+         * instead of callbacks for easier binding in other languages.
          * @param event_name A `gchar`
          * @param handler A {@link GObject.Closure}
          * @param use_capture A `gboolean`
@@ -5600,7 +5603,7 @@ export namespace WebKit2WebExtension {
 
         /**
          * Version of `webkit_dom_event_target_add_event_listener()` using a closure
-         * instead of a callbacks for easier binding in other languages.
+         * instead of callbacks for easier binding in other languages.
          * @param event_name A `gchar`
          * @param handler A {@link GObject.Closure}
          * @param use_capture A `gboolean`
@@ -5619,7 +5622,7 @@ export namespace WebKit2WebExtension {
 
         /**
          * Version of `webkit_dom_event_target_remove_event_listener()` using a closure
-         * instead of a callbacks for easier binding in other languages.
+         * instead of callbacks for easier binding in other languages.
          * @param event_name A `gchar`
          * @param handler A {@link GObject.Closure}
          * @param use_capture A `gboolean`
@@ -5808,7 +5811,7 @@ export namespace WebKit2WebExtension {
 
         /**
          * Version of `webkit_dom_event_target_add_event_listener()` using a closure
-         * instead of a callbacks for easier binding in other languages.
+         * instead of callbacks for easier binding in other languages.
          * @param event_name A `gchar`
          * @param handler A {@link GObject.Closure}
          * @param use_capture A `gboolean`
@@ -5827,7 +5830,7 @@ export namespace WebKit2WebExtension {
 
         /**
          * Version of `webkit_dom_event_target_remove_event_listener()` using a closure
-         * instead of a callbacks for easier binding in other languages.
+         * instead of callbacks for easier binding in other languages.
          * @param event_name A `gchar`
          * @param handler A {@link GObject.Closure}
          * @param use_capture A `gboolean`
@@ -6406,7 +6409,7 @@ export namespace WebKit2WebExtension {
         get_client_left(): number;
 
         /**
-         * Returns a collection of {@link WebKit2WebExtension.DOMClientRect} objects, each of which describe
+         * Returns a collection of {@link WebKit2WebExtension.DOMClientRect} objects, each of which describes
          * the size and position of a CSS border box relative to the viewport.
          * @returns A {@link WebKit2WebExtension.DOMClientRectList}
          * @since 2.18
@@ -6868,7 +6871,7 @@ export namespace WebKit2WebExtension {
 
         /**
          * Version of `webkit_dom_event_target_add_event_listener()` using a closure
-         * instead of a callbacks for easier binding in other languages.
+         * instead of callbacks for easier binding in other languages.
          * @param event_name A `gchar`
          * @param handler A {@link GObject.Closure}
          * @param use_capture A `gboolean`
@@ -6887,7 +6890,7 @@ export namespace WebKit2WebExtension {
 
         /**
          * Version of `webkit_dom_event_target_remove_event_listener()` using a closure
-         * instead of a callbacks for easier binding in other languages.
+         * instead of callbacks for easier binding in other languages.
          * @param event_name A `gchar`
          * @param handler A {@link GObject.Closure}
          * @param use_capture A `gboolean`
@@ -6977,7 +6980,7 @@ export namespace WebKit2WebExtension {
 
         /**
          * Version of `webkit_dom_event_target_add_event_listener()` using a closure
-         * instead of a callbacks for easier binding in other languages.
+         * instead of callbacks for easier binding in other languages.
          * @param event_name A `gchar`
          * @param handler A {@link GObject.Closure}
          * @param use_capture A `gboolean`
@@ -6996,7 +6999,7 @@ export namespace WebKit2WebExtension {
 
         /**
          * Version of `webkit_dom_event_target_remove_event_listener()` using a closure
-         * instead of a callbacks for easier binding in other languages.
+         * instead of callbacks for easier binding in other languages.
          * @param event_name A `gchar`
          * @param handler A {@link GObject.Closure}
          * @param use_capture A `gboolean`
@@ -21083,7 +21086,7 @@ export namespace WebKit2WebExtension {
 
         /**
          * Version of `webkit_dom_event_target_add_event_listener()` using a closure
-         * instead of a callbacks for easier binding in other languages.
+         * instead of callbacks for easier binding in other languages.
          * @param event_name A `gchar`
          * @param handler A {@link GObject.Closure}
          * @param use_capture A `gboolean`
@@ -21102,7 +21105,7 @@ export namespace WebKit2WebExtension {
 
         /**
          * Version of `webkit_dom_event_target_remove_event_listener()` using a closure
-         * instead of a callbacks for easier binding in other languages.
+         * instead of callbacks for easier binding in other languages.
          * @param event_name A `gchar`
          * @param handler A {@link GObject.Closure}
          * @param use_capture A `gboolean`
@@ -21244,7 +21247,7 @@ export namespace WebKit2WebExtension {
 
         /**
          * This function has been removed from the DOM spec and it just returns `false`.
-         * @returns A `gboolean`                                                                                                                                                                       *
+         * @returns A `gboolean`
          * @deprecated since 2.12
          */
         get_expand_entity_references(): boolean;
@@ -23149,7 +23152,7 @@ export namespace WebKit2WebExtension {
         get_uri(): string;
 
         /**
-         * Gets whether `frame` is the main frame of a {@link WebKit2WebExtension.WebPage}
+         * Gets whether `frame` is the main frame of a {@link WebKit2WebExtension.WebPage}.
          * @returns `true` if `frame` is a main frame or `false` otherwise
          * @since 2.2
          */
@@ -23464,7 +23467,7 @@ export namespace WebKit2WebExtension {
          * Get the default {@link WebKit2WebExtension.ScriptWorld}. This is the normal script world
          * where all scripts are executed by default.
          * You can get the JavaScript execution context of a {@link WebKit2WebExtension.ScriptWorld}
-         * for a given {@link WebKit2WebExtension.Frame} with `webkit_frame_get_javascript_context_for_script_world()`.
+         * for a given {@link WebKit2WebExtension.Frame} with `webkit_frame_get_js_context_for_script_world()`.
          * @since 2.2
          */
         static get_default(): ScriptWorld;
@@ -23910,7 +23913,7 @@ export namespace WebKit2WebExtension {
      * Access to editing capabilities of a {@link WebKit2WebExtension.WebPage}.
      * 
      * The WebKitWebEditor provides access to various editing capabilities of
-     * a {@link WebKit2WebExtension.WebPage} such as a possibility to react to the current selection in
+     * a {@link WebKit2WebExtension.WebPage} such as the possibility to react to the current selection in
      * {@link WebKit2WebExtension.WebPage}.
      * @gir-type Class
      * @since 2.10
@@ -23965,7 +23968,7 @@ export namespace WebKit2WebExtension {
             /**
              * This signal is emitted when a {@link WebKit2WebExtension.UserMessage} is received from the
              * `WebKitWebContext` corresponding to `extension`. Messages sent by `WebKitWebContext`
-             * are always broadcasted to all {@link WebKit2WebExtension.WebExtension}<!-- -->s and they can't be
+             * are always broadcast to all web extensions and they can't be
              * replied to. Calling `webkit_user_message_send_reply()` will do nothing.
              * @signal
              * @since 2.28
@@ -23982,7 +23985,7 @@ export namespace WebKit2WebExtension {
      * Represents an extension of the WebProcess.
      * 
      * WebKitWebExtension is a loadable module for the WebProcess. It allows you to execute code in the
-     * WebProcess and being able to use the DOM API, to change any request or to inject custom
+     * WebProcess and to use the DOM API, to change any request or to inject custom
      * JavaScript code, for example.
      * 
      * To create a WebKitWebExtension you should write a module with an initialization function that could
@@ -24090,7 +24093,7 @@ export namespace WebKit2WebExtension {
         /**
          * Send `message` to the `WebKitWebContext` corresponding to `extension`. If `message` is floating, it's consumed.
          * 
-         * If you don't expect any reply, or you simply want to ignore it, you can pass `null` as `calback`.
+         * If you don't expect any reply, or you simply want to ignore it, you can pass `null` as `callback`.
          * When the operation is finished, `callback` will be called. You can then call
          * `webkit_web_extension_send_message_to_context_finish()` to get the message reply.
          * @param message a {@link WebKit2WebExtension.UserMessage}
@@ -24102,7 +24105,7 @@ export namespace WebKit2WebExtension {
         /**
          * Send `message` to the `WebKitWebContext` corresponding to `extension`. If `message` is floating, it's consumed.
          * 
-         * If you don't expect any reply, or you simply want to ignore it, you can pass `null` as `calback`.
+         * If you don't expect any reply, or you simply want to ignore it, you can pass `null` as `callback`.
          * When the operation is finished, `callback` will be called. You can then call
          * `webkit_web_extension_send_message_to_context_finish()` to get the message reply.
          * @param message a {@link WebKit2WebExtension.UserMessage}
@@ -24115,7 +24118,7 @@ export namespace WebKit2WebExtension {
         /**
          * Send `message` to the `WebKitWebContext` corresponding to `extension`. If `message` is floating, it's consumed.
          * 
-         * If you don't expect any reply, or you simply want to ignore it, you can pass `null` as `calback`.
+         * If you don't expect any reply, or you simply want to ignore it, you can pass `null` as `callback`.
          * When the operation is finished, `callback` will be called. You can then call
          * `webkit_web_extension_send_message_to_context_finish()` to get the message reply.
          * @param message a {@link WebKit2WebExtension.UserMessage}
@@ -24140,7 +24143,7 @@ export namespace WebKit2WebExtension {
         // Signal signatures
         interface SignalSignatures extends GObject.Object.SignalSignatures {
             /**
-             * Emitted after form elements (or form associated elements) are associated to `frame`.
+             * Emitted after form elements (or form associated elements) are associated with `frame`.
              * This is useful to implement form auto filling for web pages where form fields are added
              * dynamically. This signal might be emitted multiple times for the same frame.
              * 
@@ -24190,7 +24193,7 @@ export namespace WebKit2WebExtension {
     }
 
     /**
-     * Form manager of a {@link WebKit2WebExtension.WebPage} in a {@link WebKit2WebExtension.ScriptWorld}
+     * Form manager of a {@link WebKit2WebExtension.WebPage} in a {@link WebKit2WebExtension.ScriptWorld}.
      * @gir-type Class
      * @since 2.40
      */
@@ -24279,7 +24282,7 @@ export namespace WebKit2WebExtension {
 
         // Properties
         /**
-         * The {@link WebKit2WebExtension.DOMNode}
+         * The {@link WebKit2WebExtension.DOMNode}.
          * @deprecated since 2.40
          * @construct-only
          */
@@ -24335,7 +24338,7 @@ export namespace WebKit2WebExtension {
              * Emitted when a message is sent to the console. This can be a message
              * produced by the use of JavaScript console API, a JavaScript exception,
              * a security error or other errors, warnings, debug or log messages.
-             * The `console_message` contains information of the message.
+             * The `console_message` contains information about the message.
              * @signal
              * @since 2.12
              * @run-last
@@ -24359,13 +24362,13 @@ export namespace WebKit2WebExtension {
              * This signal is emitted when the DOM document of a {@link WebKit2WebExtension.WebPage} has been
              * loaded.
              * 
-             * You can wait for this signal to get the DOM document
+             * You can wait for this signal to get the DOM document.
              * @signal
              * @run-last
              */
             "document-loaded": () => void;
             /**
-             * Emitted after form elements (or form associated elements) are associated to a particular web
+             * Emitted after form elements (or form associated elements) are associated with a particular web
              * page. This is useful to implement form auto filling for web pages where form fields are added
              * dynamically. This signal might be emitted multiple times for the same web page.
              * 
@@ -24376,12 +24379,12 @@ export namespace WebKit2WebExtension {
              * keep them alive after the signal handler returns.
              * @signal
              * @since 2.16
-             * @deprecated since 2.26: , use {@link WebKit2WebExtension.WebPage.SignalSignatures.form_controls_associated_for_frame | WebKit2WebExtension.WebPage::form-controls-associated-for-frame} instead.
+             * @deprecated since 2.26: Use {@link WebKit2WebExtension.WebPage.SignalSignatures.form_controls_associated_for_frame | WebKit2WebExtension.WebPage::form-controls-associated-for-frame} instead.
              * @run-last
              */
             "form-controls-associated": (elements: DOMElement[]) => void;
             /**
-             * Emitted after form elements (or form associated elements) are associated to a particular web
+             * Emitted after form elements (or form associated elements) are associated with a particular web
              * page. This is useful to implement form auto filling for web pages where form fields are added
              * dynamically. This signal might be emitted multiple times for the same web page.
              * 
@@ -24406,7 +24409,7 @@ export namespace WebKit2WebExtension {
              * emitted again with the `request` argument containing the new
              * request to be sent to the server due to the redirection and the
              * `redirected_response` parameter containing the response
-             * received by the server for the initial request.
+             * received from the server for the initial request.
              * 
              * Modifications to the {@link WebKit2WebExtension.URIRequest} and its associated
              * {@link Soup.MessageHeaders} will be taken into account when the request
@@ -24422,7 +24425,7 @@ export namespace WebKit2WebExtension {
              * 
              * You can handle the user message asynchronously by calling `g_object_ref()` on
              * `message` and returning `true`. If the last reference of `message` is removed
-             * and the message has been replied, the operation in the `WebKitWebView` will
+             * and the message has not been replied to, the operation in the `WebKitWebView` will
              * finish with error {@link WebKit2WebExtension.UserMessageError.USER_MESSAGE_UNHANDLED_MESSAGE}.
              * @signal
              * @since 2.28
@@ -24513,9 +24516,9 @@ export namespace WebKit2WebExtension {
 
         // Methods
         /**
-         * Get the {@link WebKit2WebExtension.DOMDocument} currently loaded in `web_page`
+         * Get the {@link WebKit2WebExtension.DOMDocument} currently loaded in `web_page`.
          * @returns the {@link WebKit2WebExtension.DOMDocument} currently loaded, or `null`    if no document is currently loaded.
-         * @deprecated since 2.40.: Use JavaScriptCore API instead.
+         * @deprecated since 2.40: Use JavaScriptCore API instead.
          */
         get_dom_document(): DOMDocument;
 
@@ -24535,7 +24538,7 @@ export namespace WebKit2WebExtension {
         get_form_manager(world: ScriptWorld | null): WebFormManager;
 
         /**
-         * Get the identifier of the {@link WebKit2WebExtension.WebPage}
+         * Get the identifier of the {@link WebKit2WebExtension.WebPage}.
          * @returns the identifier of `web_page`
          */
         get_id(): number;
@@ -24553,7 +24556,7 @@ export namespace WebKit2WebExtension {
          * 
          * You can monitor the active URI by connecting to the notify::uri
          * signal of `web_page`.
-         * @returns the current active URI of `web_view` or `null` if nothing has been    loaded yet.
+         * @returns the current active URI of `web_page` or `null` if nothing has been    loaded yet.
          */
         get_uri(): string;
 
@@ -24621,41 +24624,41 @@ export namespace WebKit2WebExtension {
         copy(): ConsoleMessage;
 
         /**
-         * Free the {@link WebKit2WebExtension.ConsoleMessage}
+         * Free the {@link WebKit2WebExtension.ConsoleMessage}.
          * @since 2.12
          */
         free(): void;
 
         /**
-         * Gets the log level of a {@link WebKit2WebExtension.ConsoleMessage}
+         * Gets the log level of a {@link WebKit2WebExtension.ConsoleMessage}.
          * @returns a {@link WebKit2WebExtension.ConsoleMessageLevel} indicating the log level of `console_message`
          * @since 2.12
          */
         get_level(): ConsoleMessageLevel;
 
         /**
-         * Gets the line number of a {@link WebKit2WebExtension.ConsoleMessage}
+         * Gets the line number of a {@link WebKit2WebExtension.ConsoleMessage}.
          * @returns the line number of `console_message`
          * @since 2.12
          */
         get_line(): number;
 
         /**
-         * Gets the source of a {@link WebKit2WebExtension.ConsoleMessage}
+         * Gets the source of a {@link WebKit2WebExtension.ConsoleMessage}.
          * @returns a {@link WebKit2WebExtension.ConsoleMessageSource} indicating the source of `console_message`
          * @since 2.12
          */
         get_source(): ConsoleMessageSource;
 
         /**
-         * Gets the source identifier of a {@link WebKit2WebExtension.ConsoleMessage}
+         * Gets the source identifier of a {@link WebKit2WebExtension.ConsoleMessage}.
          * @returns the source identifier of `console_message`
          * @since 2.12
          */
         get_source_id(): string;
 
         /**
-         * Gets the text message of a {@link WebKit2WebExtension.ConsoleMessage}
+         * Gets the text message of a {@link WebKit2WebExtension.ConsoleMessage}.
          * @returns the text message of `console_message`
          * @since 2.12
          */
@@ -25389,7 +25392,7 @@ export namespace WebKit2WebExtension {
         // Methods
         /**
          * Version of `webkit_dom_event_target_add_event_listener()` using a closure
-         * instead of a callbacks for easier binding in other languages.
+         * instead of callbacks for easier binding in other languages.
          * @param event_name A `gchar`
          * @param handler A {@link GObject.Closure}
          * @param use_capture A `gboolean`
@@ -25408,7 +25411,7 @@ export namespace WebKit2WebExtension {
 
         /**
          * Version of `webkit_dom_event_target_remove_event_listener()` using a closure
-         * instead of a callbacks for easier binding in other languages.
+         * instead of callbacks for easier binding in other languages.
          * @param event_name A `gchar`
          * @param handler A {@link GObject.Closure}
          * @param use_capture A `gboolean`
@@ -25476,7 +25479,7 @@ export namespace WebKit2WebExtension {
 
             // Virtual methods
             /**
-             * @param prefix The prefix to lookup
+             * @param prefix The prefix to look up
              * @deprecated since 2.22: Use JavaScriptCore API instead
              * @virtual
              */
@@ -25499,7 +25502,7 @@ export namespace WebKit2WebExtension {
 
         // Methods
         /**
-         * @param prefix The prefix to lookup
+         * @param prefix The prefix to look up
          * @returns a `gchar`
          * @deprecated since 2.22: Use JavaScriptCore API instead
          */