WebView#

class WebView(**properties: Any)#

Superclasses: WebViewBase, Widget, InitiallyUnowned, Object

Implemented Interfaces: Accessible, Buildable, ConstraintTarget

The central class of the WPE WebKit and WebKitGTK APIs.

WebView is the central class of the WPE WebKit and WebKitGTK APIs. It is responsible for managing the drawing of the content and forwarding of events. You can load any URI into the WebView or a data string. With Settings you can control various aspects of the rendering and loading of the content.

Note that in WebKitGTK, WebView is scrollable by itself, so you don’t need to embed it in a ScrolledWindow.

Constructors#

class WebView

classmethod new() → Widget#

Creates a new WebView with the default WebContext.

Creates a new WebView with the default WebContext and no UserContentManager associated with it. See also webkit_web_view_new_with_context(), webkit_web_view_new_with_user_content_manager(), and webkit_web_view_new_with_settings().

Methods#

class WebView

async call_async_javascript_function(self, body: str, length: int, arguments: Variant | None = None, world_name: str | None = None, source_uri: str | None = None) → Value#

This is the awaitable version of call_async_javascript_function().

Added in version 2.40.

Parameters:

body – the function body
length – length of body, or -1 if body is a nul-terminated string
arguments – a Variant with format a{sv} storing the function arguments, or None
world_name – the name of a WebKitScriptWorld or None to use the default
source_uri – the source URI

call_async_javascript_function(body: str, length: int, arguments: Variant | None = None, world_name: str | None = None, source_uri: str | None = None, cancellable: Cancellable | None = None, callback: Callable[[Object | None, AsyncResult, Any], None] | None = None, user_data: Any = None) → None#

Asynchronously call body with arguments in the script world with name world_name of the main frame current context in web_view. The arguments values must be one of the following types, or contain only the following GVariant types: number, string and dictionary. The result of the operation can be a Promise that will be properly passed to the callback. If world_name is None, the default world is used. Any value that is not None is a distin ct world. The source_uri will be shown in exceptions and doesn’t affect the behavior of the script. When not provided, the document URL is used.

Note that if Settings:enable-javascript is False, this method will do nothing. If you want to use this method but still prevent web content from executing its own JavaScript, then use Settings:enable-javascript-markup.

When the operation is finished, callback will be called. You can then call call_async_javascript_function_finish() to get the result of the operation.

This is an example that shows how to pass arguments to a JS function that returns a Promise that resolves with the passed argument:

static void
web_view_javascript_finished (GObject      *object,
                              GAsyncResult *result,
                              gpointer      user_data)
{
    JSCValue               *value;
    GError                 *error = NULL;

    value = webkit_web_view_call_async_javascript_function_finish (WEBKIT_WEB_VIEW (object), result, &error);
    if (!value) {
        g_warning ("Error running javascript: %s", error->message);
        g_error_free (error);
        return;
    }

    if (jsc_value_is_number (value)) {
        gint32        int_value = jsc_value_to_string (value);
        JSCException *exception = jsc_context_get_exception (jsc_value_get_context (value));
        if (exception)
            g_warning ("Error running javascript: %s", jsc_exception_get_message (exception));
        else
            g_print ("Script result: %d\n", int_value);
        g_free (str_value);
    } else {
        g_warning ("Error running javascript: unexpected return value");
    }
    g_object_unref (value);
}

static void
web_view_evaluate_promise (WebKitWebView *web_view)
{
    GVariantDict dict;
    g_variant_dict_init (&dict, NULL);
    g_variant_dict_insert (&dict, "count", "u", 42);
    GVariant *args = g_variant_dict_end (&dict);
    const gchar *body = "return new Promise((resolve) => { resolve(count); });";
    webkit_web_view_call_async_javascript_function (web_view, body, -1, arguments, NULL, NULL, NULL, web_view_javascript_finished, NULL);
}

Added in version 2.40.

Parameters:

body – the function body
length – length of body, or -1 if body is a nul-terminated string
arguments – a Variant with format a{sv} storing the function arguments, or None
world_name – the name of a WebKitScriptWorld or None to use the default
source_uri – the source URI
cancellable – a Cancellable or None to ignore
callback – a AsyncReadyCallback to call when the script finished
user_data – the data to pass to callback function

call_async_javascript_function_finish(result: AsyncResult) → Value#

Finish an asynchronous operation started with call_async_javascript_function().

Added in version 2.40.

Parameters:: result – a AsyncResult

async can_execute_editing_command(self, command: str) → bool#

This is the awaitable version of can_execute_editing_command().

Parameters:: command – the command to check

can_execute_editing_command(command: str, cancellable: Cancellable | None = None, callback: Callable[[Object | None, AsyncResult, Any], None] | None = None, user_data: Any = None) → None#

Asynchronously check if it is possible to execute the given editing command.

When the operation is finished, callback will be called. You can then call can_execute_editing_command_finish() to get the result of the operation.

Parameters:

command – the command to check
cancellable – a Cancellable or None to ignore
callback – a AsyncReadyCallback to call when the request is satisfied
user_data – the data to pass to callback function

can_execute_editing_command_finish(result: AsyncResult) → bool#

Finish an asynchronous operation started with can_execute_editing_command().

Parameters:: result – a AsyncResult

can_go_back() → bool#: Determines whether web_view has a previous history item.

can_go_forward() → bool#: Determines whether web_view has a next history item.

can_show_mime_type(mime_type: str) → bool#

Whether or not a MIME type can be displayed in web_view.

Parameters:: mime_type – a MIME type

do_authenticate(self, request: AuthenticationRequest) → bool#

Parameters:: request

do_close(self) → None#

do_context_menu(self, context_menu: ContextMenu, hit_test_result: HitTestResult) → bool#

Parameters:

context_menu
hit_test_result

do_context_menu_dismissed(self) → None#

do_decide_policy(self, decision: PolicyDecision, type: PolicyDecisionType) → bool#

Parameters:

decision
type

do_enter_fullscreen(self) → bool#

do_insecure_content_detected(self, event: InsecureContentEvent) → None#

Parameters:: event

do_leave_fullscreen(self) → bool#

do_load_changed(self, load_event: LoadEvent) → None#

Parameters:: load_event

do_load_failed(self, load_event: LoadEvent, failing_uri: str, error: GError) → bool#

Parameters:

load_event
failing_uri
error

do_load_failed_with_tls_errors(self, failing_uri: str, certificate: TlsCertificate, errors: TlsCertificateFlags) → bool#

Parameters:

failing_uri
certificate
errors

do_mouse_target_changed(self, hit_test_result: HitTestResult, modifiers: int) → None#

Parameters:

hit_test_result
modifiers

do_permission_request(self, permission_request: PermissionRequest) → bool#

Parameters:: permission_request

do_print_(self, print_operation: PrintOperation) → bool#

Parameters:: print_operation

do_query_permission_state(self, query: PermissionStateQuery) → bool#

Parameters:: query

do_ready_to_show(self) → None#

do_resource_load_started(self, resource: WebResource, request: URIRequest) → None#

Parameters:

resource
request

do_run_as_modal(self) → None#

do_run_color_chooser(self, request: ColorChooserRequest) → bool#

Parameters:: request

do_run_file_chooser(self, request: FileChooserRequest) → bool#

Parameters:: request

do_script_dialog(self, dialog: ScriptDialog) → bool#

Parameters:: dialog

do_show_notification(self, notification: Notification) → bool#

Parameters:: notification

do_show_option_menu(self, menu: OptionMenu, rectangle: Rectangle) → bool#

Parameters:

menu
rectangle

do_submit_form(self, request: FormSubmissionRequest) → None#

Parameters:: request

do_user_message_received(self, message: UserMessage) → bool#

Parameters:: message

do_web_process_crashed(self) → bool#

do_web_process_terminated(self, reason: WebProcessTerminationReason) → None#

Parameters:: reason

download_uri(uri: str) → Download#

Requests downloading of the specified URI string for web_view.

Parameters:: uri – the URI to download

async evaluate_javascript(self, script: str, length: int, world_name: str | None = None, source_uri: str | None = None) → Value#

This is the awaitable version of evaluate_javascript().

Added in version 2.40.

Parameters:

script – the script to evaluate
length – length of script, or -1 if script is a nul-terminated string
world_name – the name of a WebKitScriptWorld or None to use the default
source_uri – the source URI

evaluate_javascript(script: str, length: int, world_name: str | None = None, source_uri: str | None = None, cancellable: Cancellable | None = None, callback: Callable[[Object | None, AsyncResult, Any], None] | None = None, user_data: Any = None) → None#

Asynchronously evaluate script in the script world with name world_name of the main frame current context in web_view. If world_name is None, the default world is used. Any value that is not None is a distinct world. The source_uri will be shown in exceptions and doesn’t affect the behavior of the script. When not provided, the document URL is used.

When the operation is finished, callback will be called. You can then call evaluate_javascript_finish() to get the result of the operation.

This is an example of using evaluate_javascript() with a script returning a string:

static void
web_view_javascript_finished (GObject      *object,
                              GAsyncResult *result,
                              gpointer      user_data)
{
    JSCValue               *value;
    GError                 *error = NULL;

    value = webkit_web_view_evaluate_javascript_finish (WEBKIT_WEB_VIEW (object), result, &error);
    if (!value) {
        g_warning ("Error running javascript: %s", error->message);
        g_error_free (error);
        return;
    }

    if (jsc_value_is_string (value)) {
        gchar        *str_value = jsc_value_to_string (value);
        JSCException *exception = jsc_context_get_exception (jsc_value_get_context (value));
        if (exception)
            g_warning ("Error running javascript: %s", jsc_exception_get_message (exception));
        else
            g_print ("Script result: %s\n", str_value);
        g_free (str_value);
    } else {
        g_warning ("Error running javascript: unexpected return value");
    }
    g_object_unref (value);
}

static void
web_view_get_link_url (WebKitWebView *web_view,
                       const gchar   *link_id)
{
    gchar *script = g_strdup_printf ("window.document.getElementById('%s').href;", link_id);
    webkit_web_view_evaluate_javascript (web_view, script, -1, NULL, NULL, NULL, web_view_javascript_finished, NULL);
    g_free (script);
}

Added in version 2.40.

Parameters:

script – the script to evaluate
length – length of script, or -1 if script is a nul-terminated string
world_name – the name of a WebKitScriptWorld or None to use the default
source_uri – the source URI
cancellable – a Cancellable or None to ignore
callback – a AsyncReadyCallback to call when the script finished
user_data – the data to pass to callback function

evaluate_javascript_finish(result: AsyncResult) → Value#

Finish an asynchronous operation started with evaluate_javascript().

Added in version 2.40.

Parameters:: result – a AsyncResult

execute_editing_command(command: str) → None#

Request to execute the given command for web_view.

You can use can_execute_editing_command() to check whether it’s possible to execute the command.

Parameters:: command – the command to execute

execute_editing_command_with_argument(command: str, argument: str) → None#

Request to execute the given command with argument for web_view.

You can use can_execute_editing_command() to check whether it’s possible to execute the command.

Added in version 2.10.

Parameters:

command – the command to execute
argument – the command argument

get_automation_presentation_type() → AutomationBrowsingContextPresentation#: Get the presentation type of WebView when created for automation.

Added in version 2.28.

get_back_forward_list() → BackForwardList#

Obtains the BackForwardList associated with the given WebView.

The BackForwardList is owned by the WebView.

get_background_color() → RGBA#

Gets the color that is used to draw the web_view background.

Gets the color that is used to draw the web_view background before the actual contents are rendered. For more information see also set_background_color()

Added in version 2.8.

get_camera_capture_state() → MediaCaptureState#: Get the camera capture state of a WebView.

Added in version 2.34.

get_context() → WebContext#: Gets the web context of web_view.

get_custom_charset() → str#: Returns the current custom character encoding name of web_view.

get_default_content_security_policy() → str | None#: Gets the configured default Content-Security-Policy.

Added in version 2.38.

get_display_capture_state() → MediaCaptureState#: Get the display capture state of a WebView.

Added in version 2.34.

get_editor_state() → EditorState#: Gets the web editor state of web_view.

Added in version 2.10.

get_estimated_load_progress() → float#

Gets the value of the WebView:estimated-load-progress property.

You can monitor the estimated progress of a load operation by connecting to the notify::estimated-load-progress signal of web_view.

get_favicon() → Texture#

Returns favicon currently associated to web_view.

Returns favicon currently associated to web_view, if any. You can connect to notify::favicon signal of web_view to be notified when the favicon is available.

get_find_controller() → FindController#

Gets the FindController.

Gets the FindController that will allow the caller to query the WebView for the text to look for.

get_input_method_context() → InputMethodContext | None#

Get the InputMethodContext currently in use by web_view.

Get the InputMethodContext currently in use by web_view, or None if no input method is being used.

Added in version 2.28.

get_inspector() → WebInspector#: Get the WebInspector associated to web_view

get_is_muted() → bool#: Gets the mute state of web_view.

Added in version 2.30.

get_is_web_process_responsive() → bool#: Get whether the current web process of a WebView is responsive.

Added in version 2.34.

get_main_resource() → WebResource#: Return the main resource of web_view.

get_microphone_capture_state() → MediaCaptureState#: Get the microphone capture state of a WebView.

Added in version 2.34.

get_network_session() → NetworkSession#: Get the NetworkSession associated to web_view.

Added in version 2.40.

get_page_id() → int#: Get the identifier of the WebKitWebPage corresponding to the WebView

get_session_state() → WebViewSessionState#: Gets the current session state of web_view

Added in version 2.12.

get_settings() → Settings#

Gets the Settings currently applied to web_view.

If no other Settings have been explicitly applied to web_view with set_settings(), the default Settings will be returned. This method always returns a valid Settings object. To modify any of the web_view settings, you can either create a new Settings object with new(), setting the desired preferences, and then replace the existing web_view settings with set_settings() or get the existing web_view settings and update it directly. Settings objects can be shared by multiple WebView<!– –>s, so modifying the settings of a WebView would affect other WebView<!– –>s using the same Settings.

async get_snapshot(self, region: SnapshotRegion, options: SnapshotOptions) → Texture#

This is the awaitable version of get_snapshot().

Parameters:

region – the SnapshotRegion for this snapshot
options – SnapshotOptions for the snapshot

get_snapshot(region: SnapshotRegion, options: SnapshotOptions, cancellable: Cancellable | None = None, callback: Callable[[Object | None, AsyncResult, Any], None] | None = None, user_data: Any = None) → None#

Asynchronously retrieves a snapshot of web_view for region.

options specifies how the snapshot should be rendered.

When the operation is finished, callback will be called. You must call get_snapshot_finish() to get the result of the operation.

Parameters:

region – the SnapshotRegion for this snapshot
options – SnapshotOptions for the snapshot
cancellable – a Cancellable
callback – a AsyncReadyCallback
user_data – user data

get_snapshot_finish(result: AsyncResult) → Texture#

Finishes an asynchronous operation started with get_snapshot().

Parameters:: result – a AsyncResult

get_title() → str#

Gets the value of the WebView:title property.

You can connect to notify::title signal of web_view to be notified when the title has been received.

get_tls_info() → tuple[bool, TlsCertificate, TlsCertificateFlags]#

Retrieves the TlsCertificate associated with the main resource of web_view.

Retrieves the TlsCertificate associated with the main resource of web_view, and the TlsCertificateFlags showing what problems, if any, have been found with that certificate. If the connection is not HTTPS, this function returns False. This function should be called after a response has been received from the server, so you can connect to WebView::load-changed and call this function when it’s emitted with COMMITTED event.

Note that this function provides no information about the security of the web page if the current TLSErrorsPolicy is IGNORE, as subresources of the page may be controlled by an attacker. This function may safely be used to determine the security status of the current page only if the current TLSErrorsPolicy is FAIL, in which case subresources that fail certificate verification will be blocked.

get_uri() → str#

Returns the current active URI of web_view.

The active URI might change during a load operation:

When nothing has been loaded yet on web_view the active URI is None.

</para></listitem> <listitem><para>

When a new load operation starts the active URI is the requested URI: <itemizedlist> <listitem><para>

If the load operation was started by load_uri(), the requested URI is the given one.

</para></listitem> <listitem><para>

If the load operation was started by load_html(), the requested URI is “about:blank”.

</para></listitem> <listitem><para>

If the load operation was started by load_alternate_html(), the requested URI is content URI provided.

</para></listitem> <listitem><para>

If the load operation was started by go_back() or go_forward(), the requested URI is the original URI of the previous/next item in the BackForwardList of web_view.

</para></listitem> <listitem><para>

If the load operation was started by go_to_back_forward_list_item(), the requested URI is the opriginal URI of the given BackForwardListItem.

</para></listitem> </itemizedlist>

</para></listitem> <listitem><para>

If there is a server redirection during the load operation, the active URI is the redirected URI. When the signal WebView::load-changed is emitted with REDIRECTED event, the active URI is already updated to the redirected URI.

</para></listitem> <listitem><para>

When the signal WebView::load-changed is emitted with COMMITTED event, the active URI is the final one and it will not change unless a new load operation is started or a navigation action within the same page is performed.

</para></listitem> </orderedlist>

You can monitor the active URI by connecting to the notify::uri signal of web_view.

get_user_content_manager() → UserContentManager#: Gets the user content manager associated to web_view.

Added in version 2.6.

get_web_extension_mode() → WebExtensionMode#: Get the view’s WebExtensionMode.

Added in version 2.38.

get_website_policies() → WebsitePolicies#

Gets the default website policies.

Gets the default website policies set on construction in the web_view. These can be overridden on a per-origin basis via the WebView::decide-policy signal handler.

Properties#

class WebView

props.automation_presentation_type: AutomationBrowsingContextPresentation#: The type of the None singleton.

Added in version 2.28.

props.camera_capture_state: MediaCaptureState#: The type of the None singleton.

Added in version 2.34.

props.default_content_security_policy: str#: The type of the None singleton.

Added in version 2.38.

props.display_capture_state: MediaCaptureState#: The type of the None singleton.

Added in version 2.34.

props.editable: bool#: The type of the None singleton.

Added in version 2.8.

props.estimated_load_progress: float#: The type of the None singleton.

props.favicon: Texture#: The type of the None singleton.

props.is_controlled_by_automation: bool#: The type of the None singleton.

Added in version 2.18.

props.is_loading: bool#: The type of the None singleton.

props.is_muted: bool#: The type of the None singleton.

Added in version 2.30.

props.is_playing_audio: bool#: The type of the None singleton.

Added in version 2.8.

props.is_web_process_responsive: bool#: The type of the None singleton.

Added in version 2.34.

props.microphone_capture_state: MediaCaptureState#: The type of the None singleton.

Added in version 2.34.

props.network_session: NetworkSession#: The type of the None singleton.

Added in version 2.40.

props.page_id: int#: The type of the None singleton.

Added in version 2.28.

props.related_view: WebView#: The type of the None singleton.

Added in version 2.4.

props.settings: Settings#: The type of the None singleton.

Added in version 2.6.

props.title: str#: The type of the None singleton.

props.uri: str#: The type of the None singleton.

props.user_content_manager: UserContentManager#: The type of the None singleton.

Added in version 2.6.

props.web_context: WebContext#: The type of the None singleton.

props.web_extension_mode: WebExtensionMode#: The type of the None singleton.

Added in version 2.38.

props.website_policies: WebsitePolicies#: The type of the None singleton.

Added in version 2.30.

props.zoom_level: float#: The type of the None singleton.