Class
WebKit2WebView
unstable since: 4.0
Description [src]
class WebKit2.WebView : WebKit2.WebViewBase
implements Atk.ImplementorIface, Gtk.Buildable {
priv: WebKitWebViewPrivate*
}
The central class of the WPE WebKit and WebKitGTK APIs.
WebKitWebView 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 WebKitWebView or
a data string. With WebKitSettings you can control various aspects
of the rendering and loading of the content.
Note that in WebKitGTK, WebKitWebView is scrollable by itself, so
you don’t need to embed it in a GtkScrolledWindow.
Available since: 4.0
Constructors
webkit_web_view_new
Creates a new WebKitWebView with the default WebKitWebContext.
unstable since: 4.0
webkit_web_view_new_with_context
Creates a new WebKitWebView with the given WebKitWebContext.
unstable since: 4.0
webkit_web_view_new_with_related_view
Creates a new WebKitWebView sharing the same web process with web_view.
since: 2.4
webkit_web_view_new_with_settings
Creates a new WebKitWebView with the given WebKitSettings.
since: 2.6
webkit_web_view_new_with_user_content_manager
Creates a new WebKitWebView with the given WebKitUserContentManager.
since: 2.6
Instance methods
webkit_web_view_call_async_javascript_function
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 NULL, the default world is used. Any value that is not NULL 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.
since: 2.40
webkit_web_view_call_async_javascript_function_finish
Finish an asynchronous operation started with webkit_web_view_call_async_javascript_function().
since: 2.40
webkit_web_view_can_execute_editing_command
Asynchronously check if it is possible to execute the given editing command.
unstable since: 4.0
webkit_web_view_can_execute_editing_command_finish
Finish an asynchronous operation started with webkit_web_view_can_execute_editing_command().
unstable since: 4.0
webkit_web_view_can_go_back
Determines whether web_view has a previous history item.
unstable since: 4.0
webkit_web_view_can_go_forward
Determines whether web_view has a next history item.
unstable since: 4.0
webkit_web_view_can_show_mime_type
Whether or not a MIME type can be displayed in web_view.
unstable since: 4.0
webkit_web_view_download_uri
Requests downloading of the specified URI string for web_view.
unstable since: 4.0
webkit_web_view_evaluate_javascript
Asynchronously evaluate script in the script world with name world_name of the main frame current context in web_view.
If world_name is NULL, the default world is used. Any value that is not NULL 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.
since: 2.40
webkit_web_view_evaluate_javascript_finish
Finish an asynchronous operation started with webkit_web_view_evaluate_javascript().
since: 2.40
webkit_web_view_execute_editing_command
Request to execute the given command for web_view.
unstable since: 4.0
webkit_web_view_execute_editing_command_with_argument
Request to execute the given command with argument for web_view.
since: 2.10
webkit_web_view_get_automation_presentation_type
Get the presentation type of WebKitWebView when created for automation.
since: 2.28
webkit_web_view_get_back_forward_list
Obtains the WebKitBackForwardList associated with the given WebKitWebView.
unstable since: 4.0
webkit_web_view_get_background_color
Gets the color that is used to draw the web_view background.
since: 2.8
webkit_web_view_get_camera_capture_state
Get the camera capture state of a WebKitWebView.
since: 2.34
webkit_web_view_get_custom_charset
Returns the current custom character encoding name of web_view.
unstable since: 4.0
webkit_web_view_get_default_content_security_policy
Gets the configured default Content-Security-Policy.
since: 2.38
webkit_web_view_get_display_capture_state
Get the display capture state of a WebKitWebView.
since: 2.34
webkit_web_view_get_estimated_load_progress
Gets the value of the WebKitWebView:estimated-load-progress property.
unstable since: 4.0
webkit_web_view_get_input_method_context
Get the WebKitInputMethodContext currently in use by web_view.
since: 2.28
webkit_web_view_get_inspector
Get the WebKitWebInspector associated to web_view.
unstable since: 4.0
webkit_web_view_get_is_web_process_responsive
Get whether the current web process of a WebKitWebView is responsive.
since: 2.34
webkit_web_view_get_javascript_global_context
Get the global JavaScript context.
unstable deprecated: 2.22 since: 4.0
webkit_web_view_get_microphone_capture_state
Get the microphone capture state of a WebKitWebView.
since: 2.34
webkit_web_view_get_page_id
Get the identifier of the WebKitWebPage corresponding to
the WebKitWebView.
unstable since: 4.0
webkit_web_view_get_settings
Gets the WebKitSettings currently applied to web_view.
unstable since: 4.0
webkit_web_view_get_snapshot
Asynchronously retrieves a snapshot of web_view for region.
unstable since: 4.0
webkit_web_view_get_snapshot_finish
Finishes an asynchronous operation started with webkit_web_view_get_snapshot().
unstable since: 4.0
webkit_web_view_get_tls_info
Retrieves the GTlsCertificate associated with the main resource of web_view.
unstable since: 4.0
webkit_web_view_get_user_content_manager
Gets the user content manager associated to web_view.
since: 2.6
webkit_web_view_get_website_data_manager
Get the WebKitWebsiteDataManager associated to web_view.
since: 2.16
webkit_web_view_go_to_back_forward_list_item
Loads the specific history item list_item.
unstable since: 4.0
webkit_web_view_is_controlled_by_automation
Get whether a WebKitWebView was created with WebKitWebView:is-controlled-by-automation
property enabled.
since: 2.18
webkit_web_view_is_loading
Gets the value of the WebKitWebView:is-loading property.
unstable since: 4.0
webkit_web_view_is_playing_audio
Gets the value of the WebKitWebView:is-playing-audio property.
since: 2.8
webkit_web_view_load_alternate_html
Load the given content string for the URI content_uri.
unstable since: 4.0
webkit_web_view_load_bytes
Load the specified bytes into web_view using the given mime_type and encoding.
since: 2.6
webkit_web_view_load_html
Load the given content string with the specified base_uri.
unstable since: 4.0
webkit_web_view_load_plain_text
Load the specified plain_text string into web_view.
unstable since: 4.0
webkit_web_view_load_request
Requests loading of the specified WebKitURIRequest.
unstable since: 4.0
webkit_web_view_reload_bypass_cache
Reloads the current contents of web_view without
using any cached data.
unstable since: 4.0
webkit_web_view_run_async_javascript_function_in_world
Asynchronously run body in the script world with name world_name of the current page context in
web_view. If WebKitSettings:enable-javascript is FALSE, this method will do nothing. This API
differs from webkit_web_view_run_javascript_in_world() in that the JavaScript function can return a
Promise and its result will be properly passed to the callback.
deprecated: 2.40 since: 2.38
webkit_web_view_run_javascript
Asynchronously run script in the context of the current page in web_view.
unstable deprecated: 2.40 since: 4.0
webkit_web_view_run_javascript_finish
Finish an asynchronous operation started with webkit_web_view_run_javascript().
unstable deprecated: 2.40 since: 4.0
webkit_web_view_run_javascript_from_gresource
Asynchronously run the script from resource.
unstable deprecated: 2.40 since: 4.0
webkit_web_view_run_javascript_from_gresource_finish
Finish an asynchronous operation started with webkit_web_view_run_javascript_from_gresource().
unstable deprecated: 2.40 since: 4.0
webkit_web_view_run_javascript_in_world
Asynchronously run script in the script world.
deprecated: 2.40 since: 2.22
webkit_web_view_run_javascript_in_world_finish
Finish an asynchronous operation started with webkit_web_view_run_javascript_in_world().
deprecated: 2.40 since: 2.22
webkit_web_view_save_finish
Finish an asynchronous operation started with webkit_web_view_save().
unstable since: 4.0
webkit_web_view_save_to_file_finish
Finish an asynchronous operation started with webkit_web_view_save_to_file().
unstable since: 4.0
webkit_web_view_send_message_to_page
Send message to the WebKitWebPage corresponding to web_view.
since: 2.28
webkit_web_view_send_message_to_page_finish
Finish an asynchronous operation started with webkit_web_view_send_message_to_page().
since: 2.28
webkit_web_view_set_background_color
Sets the color that will be used to draw the web_view background.
since: 2.8
webkit_web_view_set_camera_capture_state
Set the camera capture state of a WebKitWebView.
since: 2.34
webkit_web_view_set_custom_charset
Sets the current custom character encoding override of web_view.
unstable since: 4.0
webkit_web_view_set_display_capture_state
Set the display capture state of a WebKitWebView.
since: 2.34
webkit_web_view_set_input_method_context
Set the WebKitInputMethodContext to be used by web_view.
since: 2.28
webkit_web_view_set_microphone_capture_state
Set the microphone capture state of a WebKitWebView.
since: 2.34
webkit_web_view_terminate_web_process
Terminates the web process associated to web_view.
since: 2.34
Methods inherited from GtkContainer (33)
Please see GtkContainer for a full list of methods.
Methods inherited from GtkBuildable (10)
gtk_buildable_add_child
Adds a child to buildable. type is an optional string
describing how the child should be added.
since: 2.12
gtk_buildable_construct_child
Constructs a child of buildable with the name name.
since: 2.12
gtk_buildable_custom_finished
This is similar to gtk_buildable_parser_finished() but is
called once for each custom tag handled by the buildable.
since: 2.12
gtk_buildable_custom_tag_end
This is called at the end of each custom element handled by the buildable.
since: 2.12
gtk_buildable_custom_tag_start
This is called for each unknown element under <child>.
since: 2.12
gtk_buildable_get_internal_child
Get the internal child called childname of the buildable object.
since: 2.12
gtk_buildable_get_name
Gets the name of the buildable object.
since: 2.12
gtk_buildable_parser_finished
Called when the builder finishes the parsing of a
[GtkBuilder UI definition][BUILDER-UI].
Note that this will be called once for each time
gtk_builder_add_from_file() or gtk_builder_add_from_string()
is called on a builder.
since: 2.12
gtk_buildable_set_buildable_property
Sets the property name name to value on the buildable object.
since: 2.12
gtk_buildable_set_name
Sets the name of the buildable object.
since: 2.12
Properties
WebKit2.WebView:automation-presentation-type
The WebKitAutomationBrowsingContextPresentation of WebKitWebView. This should only be used when
creating a new WebKitWebView as a response to WebKitAutomationSession::create-web-view
signal request. If the new WebView was added to a new tab of current browsing context window
WEBKIT_AUTOMATION_BROWSING_CONTEXT_PRESENTATION_TAB should be used.
since: 2.28
WebKit2.WebView:camera-capture-state
Capture state of the camera device. Whenever the user grants a media-request sent by the web
page, requesting video capture capabilities (navigator.mediaDevices.getUserMedia({video:
true})) this property will be set to WEBKIT_MEDIA_CAPTURE_STATE_ACTIVE.
since: 2.34
WebKit2.WebView:default-content-security-policy
The default Content-Security-Policy used by the webview as if it were set by an HTTP header.
since: 2.38
WebKit2.WebView:display-capture-state
Capture state of the display device. Whenever the user grants a media-request sent by the web
page, requesting screencasting capabilities (navigator.mediaDevices.getDisplayMedia() this
property will be set toWEBKIT_MEDIA_CAPTURE_STATE_ACTIVE`.
since: 2.34
WebKit2.WebView:editable
Whether the pages loaded inside WebKitWebView are editable. For more
information see webkit_web_view_set_editable().
since: 2.8
WebKit2.WebView:estimated-load-progress
An estimate of the percent completion for the current loading operation. This value will range from 0.0 to 1.0 and, once a load completes, will remain at 1.0 until a new load starts, at which point it will be reset to 0.0. The value is an estimate based on the total number of bytes expected to be received for a document, including all its possible subresources and child documents.
unstable since: 4.0
WebKit2.WebView:favicon
The favicon currently associated to the WebKitWebView.
See webkit_web_view_get_favicon() for more details.
unstable since: 4.0
WebKit2.WebView:is-controlled-by-automation
Whether the WebKitWebView is controlled by automation. This should only be used when
creating a new WebKitWebView as a response to WebKitAutomationSession::create-web-view
signal request.
since: 2.18
WebKit2.WebView:is-ephemeral
Whether the WebKitWebView is ephemeral. An ephemeral web view never writes
website data to the client storage, no matter what WebKitWebsiteDataManager
its context is using. This is normally used to implement private browsing mode.
This is a G_PARAM_CONSTRUCT_ONLY property, so you have to create an ephemeral
WebKitWebView and it can’t be changed. The ephemeral WebKitWebsiteDataManager
created for the WebKitWebView will inherit the network settings from the
WebKitWebContext‘s WebKitWebsiteDataManager. To use different settings
you can get the WebKitWebsiteDataManager with webkit_web_view_get_website_data_manager()
and set the new ones.
Note that all WebKitWebViews created with an ephemeral WebKitWebContext
will be ephemeral automatically.
See also webkit_web_context_new_ephemeral().
since: 2.16
WebKit2.WebView:is-loading
Whether the WebKitWebView is currently loading a page. This property becomes
TRUE as soon as a new load operation is requested and before the
WebKitWebView::load-changed signal is emitted with WEBKIT_LOAD_STARTED and
at that point the active URI is the requested one.
When the load operation finishes the property is set to FALSE before
WebKitWebView::load-changed is emitted with WEBKIT_LOAD_FINISHED.
unstable since: 4.0
WebKit2.WebView:is-muted
Whether the WebKitWebView audio is muted. When TRUE, audio is silenced.
It may still be playing, i.e. WebKitWebView:is-playing-audio may be TRUE.
since: 2.30
WebKit2.WebView:is-playing-audio
Whether the WebKitWebView is currently playing audio from a page.
This property becomes TRUE as soon as web content starts playing any
kind of audio. When a page is no longer playing any kind of sound,
the property is set back to FALSE.
since: 2.8
WebKit2.WebView:is-web-process-responsive
Whether the web process currently associated to the WebKitWebView is responsive.
since: 2.34
WebKit2.WebView:microphone-capture-state
Capture state of the microphone device. Whenever the user grants a media-request sent by the web
page, requesting audio capture capabilities (navigator.mediaDevices.getUserMedia({audio:
true})) this property will be set to WEBKIT_MEDIA_CAPTURE_STATE_ACTIVE.
since: 2.34
WebKit2.WebView:page-id
The identifier of the WebKitWebPage corresponding to the WebKitWebView.
since: 2.28
WebKit2.WebView:related-view
The related WebKitWebView used when creating the view to share the
same web process and network session. This property is not readable
because the related web view is only valid during the object construction.
since: 2.4
WebKit2.WebView:title
The main frame document title of this WebKitWebView. If
the title has not been received yet, it will be NULL.
unstable since: 4.0
WebKit2.WebView:uri
The current active URI of the WebKitWebView.
See webkit_web_view_get_uri() for more details.
unstable since: 4.0
WebKit2.WebView:web-extension-mode
This configures web_view to treat the content as a WebExtension.
since: 2.38
WebKit2.WebView:zoom-level
The zoom level of the WebKitWebView content.
See webkit_web_view_set_zoom_level() for more details.
unstable since: 4.0
Properties inherited from GtkContainer (3)
Gtk.Container:border-width
unstable since: 3.0
Gtk.Container:child
unstable since: 3.0
Gtk.Container:resize-mode
unstable since: 3.0
Properties inherited from GtkWidget (39)
Gtk.Widget:app-paintable
unstable since: 3.0
Gtk.Widget:can-default
unstable since: 3.0
Gtk.Widget:can-focus
unstable since: 3.0
Gtk.Widget:composite-child
unstable since: 3.0
Gtk.Widget:double-buffered
Whether the widget is double buffered.
deprecated: 3.14 since: 2.18
Gtk.Widget:events
unstable since: 3.0
Gtk.Widget:expand
Whether to expand in both directions. Setting this sets both GtkWidget:hexpand and GtkWidget:vexpand.
unstable since: 3.0
Gtk.Widget:focus-on-click
Whether the widget should grab focus when it is clicked with the mouse.
unstable since: 3.20
Gtk.Widget:halign
How to distribute horizontal space if widget gets extra space, see GtkAlign.
unstable since: 3.0
Gtk.Widget:has-default
unstable since: 3.0
Gtk.Widget:has-focus
unstable since: 3.0
Gtk.Widget:has-tooltip
Enables or disables the emission of GtkWidget::query-tooltip on widget.
A value of TRUE indicates that widget can have a tooltip, in this case
the widget will be queried using GtkWidget::query-tooltip to determine
whether it will provide a tooltip or not.
since: 2.12
Gtk.Widget:height-request
unstable since: 3.0
Gtk.Widget:hexpand
Whether to expand horizontally. See gtk_widget_set_hexpand().
unstable since: 3.0
Gtk.Widget:hexpand-set
Whether to use the GtkWidget:hexpand property. See gtk_widget_get_hexpand_set().
unstable since: 3.0
Gtk.Widget:is-focus
unstable since: 3.0
Gtk.Widget:margin
Sets all four sides’ margin at once. If read, returns max margin on any side.
unstable since: 3.0
Gtk.Widget:margin-bottom
Margin on bottom side of widget.
unstable since: 3.0
Gtk.Widget:margin-end
Margin on end of widget, horizontally. This property supports left-to-right and right-to-left text directions.
unstable since: 3.12
Gtk.Widget:margin-left
Margin on left side of widget.
unstable deprecated: 3.12 since: 3.0
Gtk.Widget:margin-right
Margin on right side of widget.
unstable deprecated: 3.12 since: 3.0
Gtk.Widget:margin-start
Margin on start of widget, horizontally. This property supports left-to-right and right-to-left text directions.
unstable since: 3.12
Gtk.Widget:margin-top
Margin on top side of widget.
unstable since: 3.0
Gtk.Widget:name
unstable since: 3.0
Gtk.Widget:no-show-all
unstable since: 3.0
Gtk.Widget:opacity
The requested opacity of the widget. See gtk_widget_set_opacity() for
more details about window opacity.
unstable since: 3.8
Gtk.Widget:parent
unstable since: 3.0
Gtk.Widget:receives-default
unstable since: 3.0
Gtk.Widget:scale-factor
The scale factor of the widget. See gtk_widget_get_scale_factor() for
more details about widget scaling.
unstable since: 3.10
Gtk.Widget:sensitive
unstable since: 3.0
Gtk.Widget:style
The style of the widget, which contains information about how it will look (colors, etc).
unstable deprecated: Unknown since: 3.0
Gtk.Widget:tooltip-markup
Sets the text of tooltip to be the given string, which is marked up with the [Pango text markup language][PangoMarkupFormat]. Also see gtk_tooltip_set_markup().
since: 2.12
Gtk.Widget:tooltip-text
Sets the text of tooltip to be the given string.
since: 2.12
Gtk.Widget:valign
How to distribute vertical space if widget gets extra space, see GtkAlign.
unstable since: 3.0
Gtk.Widget:vexpand
Whether to expand vertically. See gtk_widget_set_vexpand().
unstable since: 3.0
Gtk.Widget:vexpand-set
Whether to use the GtkWidget:vexpand property. See gtk_widget_get_vexpand_set().
unstable since: 3.0
Gtk.Widget:visible
unstable since: 3.0
Gtk.Widget:width-request
unstable since: 3.0
Gtk.Widget:window
The widget’s window if it is realized, NULL otherwise.
since: 2.14
Signals
WebKit2.WebView::authenticate
This signal is emitted when the user is challenged with HTTP
authentication. To let the application access or supply
the credentials as well as to allow the client application
to either cancel the request or perform the authentication,
the signal will pass an instance of the
WebKitAuthenticationRequest in the request argument.
To handle this signal asynchronously you should keep a ref
of the request and return TRUE. To disable HTTP authentication
entirely, connect to this signal and simply return TRUE.
since: 2.2
WebKit2.WebView::close
Emitted when closing a WebKitWebView is requested. This occurs when a
call is made from JavaScript’s web_view with webkit_web_view_try_close().
It is the owner’s responsibility to handle this signal to hide or
destroy the WebKitWebView, if necessary.
unstable since: 4.0
WebKit2.WebView::context-menu
Emitted when a context menu is about to be displayed to give the application
a chance to customize the proposed menu, prevent the menu from being displayed,
or build its own context menu.
webkit_context_menu_append() or webkit_context_menu_insert() to add new
WebKitContextMenuItems to context_menu, webkit_context_menu_move_item()
to reorder existing items, or webkit_context_menu_remove() to remove an
existing item. The signal handler should return FALSE, and the menu represented
by context_menu will be shown.
TRUE so that the proposed menu will not be shown.
FALSE so
that the menu will be shown. You can also ignore the proposed WebKitContextMenu,
build your own GtkMenu and return TRUE to prevent the proposed menu from being shown.
unstable since: 4.0
WebKit2.WebView::context-menu-dismissed
Emitted after WebKitWebView::context-menu signal, if the context menu is shown,
to notify that the context menu is dismissed.
unstable since: 4.0
WebKit2.WebView::create
Emitted when the creation of a new WebKitWebView is requested.
If this signal is handled the signal handler should return the
newly created WebKitWebView.
unstable since: 4.0
WebKit2.WebView::decide-policy
This signal is emitted when WebKit is requesting the client to decide a policy
decision, such as whether to navigate to a page, open a new window or whether or
not to download a resource. The WebKitNavigationPolicyDecision passed in the
decision argument is a generic type, but should be casted to a more
specific type when making the decision. For example:
unstable since: 4.0
WebKit2.WebView::enter-fullscreen
Emitted when JavaScript code calls
WebKitWebView will proceed to full screen
its top level window. This signal can be used by client code to
request permission to the user prior doing the full screen
transition and eventually prepare the top-level window
(e.g. hide some widgets that would otherwise be part of the
full screen window).
unstable since: 4.0
WebKit2.WebView::insecure-content-detected
This signal is emitted when insecure content has been detected in a page loaded through a secure connection. This typically means that a external resource from an unstrusted source has been run or displayed, resulting in a mix of HTTPS and non-HTTPS content.
unstable since: 4.0
WebKit2.WebView::leave-fullscreen
Emitted when the WebKitWebView is about to restore its top level
window out of its full screen state. This signal can be used by
client code to restore widgets hidden during the
WebKitWebView::enter-fullscreen stage for instance.
unstable since: 4.0
WebKit2.WebView::load-changed
Emitted when a load operation in web_view changes.
The signal is always emitted with WEBKIT_LOAD_STARTED when a
new load request is made and WEBKIT_LOAD_FINISHED when the load
finishes successfully or due to an error. When the ongoing load
operation fails WebKitWebView::load-failed signal is emitted
before WebKitWebView::load-changed is emitted with
WEBKIT_LOAD_FINISHED.
If a redirection is received from the server, this signal is emitted
with WEBKIT_LOAD_REDIRECTED after the initial emission with
WEBKIT_LOAD_STARTED and before WEBKIT_LOAD_COMMITTED.
When the page content starts arriving the signal is emitted with
WEBKIT_LOAD_COMMITTED event.
unstable since: 4.0
WebKit2.WebView::load-failed
Emitted when an error occurs during a load operation.
If the error happened when starting to load data for a page
load_event will be WEBKIT_LOAD_STARTED. If it happened while
loading a committed data source load_event will be WEBKIT_LOAD_COMMITTED.
Since a load error causes the load operation to finish, the signal
WebKitWebView::load-changed will always be emitted with
WEBKIT_LOAD_FINISHED event right after this one.
unstable since: 4.0
WebKit2.WebView::load-failed-with-tls-errors
Emitted when a TLS error occurs during a load operation.
To allow an exception for this certificate
and the host of failing_uri use webkit_web_context_allow_tls_certificate_for_host().
since: 2.6
WebKit2.WebView::mouse-target-changed
This signal is emitted when the mouse cursor moves over an
element such as a link, image or a media element. To determine
what type of element the mouse cursor is over, a Hit Test is performed
on the current mouse coordinates and the result is passed in the
hit_test_result argument. The modifiers argument is a bitmask of
GdkModifierType flags indicating the state of modifier keys.
The signal is emitted again when the mouse is moved out of the
current element with a new hit_test_result.
unstable since: 4.0
WebKit2.WebView::permission-request
This signal is emitted when WebKit is requesting the client to decide about a permission request, such as allowing the browser to switch to fullscreen mode, sharing its location or similar operations.
unstable since: 4.0
WebKit2.WebView::print
Emitted when printing is requested on web_view, usually by a JavaScript call,
before the print dialog is shown. This signal can be used to set the initial
print settings and page setup of print_operation to be used as default values in
the print dialog. You can call webkit_print_operation_set_print_settings() and
webkit_print_operation_set_page_setup() and then return FALSE to propagate the
event so that the print dialog is shown.
unstable since: 4.0
WebKit2.WebView::query-permission-state
This signal allows the User-Agent to respond to permission requests for powerful features, as specified by the Permissions W3C Specification. You can reply to the query using webkit_permission_state_query_finish().
since: 2.40
WebKit2.WebView::ready-to-show
Emitted after WebKitWebView::create on the newly created WebKitWebView
when it should be displayed to the user. When this signal is emitted
all the information about how the window should look, including
size, position, whether the location, status and scrollbars
should be displayed, is already set on the WebKitWindowProperties
of web_view. See also webkit_web_view_get_window_properties().
unstable since: 4.0
WebKit2.WebView::resource-load-started
Emitted when a new resource is going to be loaded. The request parameter
contains the WebKitURIRequest that will be sent to the server.
You can monitor the load operation by connecting to the different signals
of resource.
unstable since: 4.0
WebKit2.WebView::run-as-modal
Emitted after WebKitWebView::ready-to-show on the newly
created WebKitWebView when JavaScript code calls
WebKitWebView until the new dialog is closed.
unstable since: 4.0
WebKit2.WebView::run-color-chooser
This signal is emitted when the user interacts with a HTML element, requesting from WebKit to show
a dialog to select a color. To let the application know the details of
the color chooser, as well as to allow the client application to either
cancel the request or perform an actual color selection, the signal will
pass an instance of the WebKitColorChooserRequest in the request
argument.
since: 2.8
WebKit2.WebView::run-file-chooser
This signal is emitted when the user interacts with a HTML element, requesting from WebKit to show
a dialog to select one or more files to be uploaded. To let the
application know the details of the file chooser, as well as to
allow the client application to either cancel the request or
perform an actual selection of files, the signal will pass an
instance of the WebKitFileChooserRequest in the request
argument.
unstable since: 4.0
WebKit2.WebView::script-dialog
Emitted when JavaScript code calls dialog parameter should be used to build the dialog.
If the signal is not handled a different dialog will be built and shown depending
on the dialog type:
WEBKIT_SCRIPT_DIALOG_ALERT: message dialog with a single Close button.
WEBKIT_SCRIPT_DIALOG_CONFIRM: message dialog with OK and Cancel buttons.
WEBKIT_SCRIPT_DIALOG_PROMPT: message dialog with OK and Cancel buttons and
a text entry with the default text.
WEBKIT_SCRIPT_DIALOG_BEFORE_UNLOAD_CONFIRM: message dialog with Stay and Leave buttons.
unstable since: 4.0
WebKit2.WebView::show-notification
This signal is emitted when a notification should be presented to the
user. The notification is kept alive until either: 1) the web page cancels it
or 2) a navigation happens.
since: 2.8
WebKit2.WebView::show-option-menu
This signal is emitted when a select element in web_view needs to display a
dropdown menu. This signal can be used to show a custom menu, using menu to get
the details of all items that should be displayed. The area of the element in the
WebKitWebView is given as rectangle parameter, it can be used to position the
menu. If this was triggered by a user interaction, like a mouse click,
event parameter provides the GdkEvent.
To handle this signal asynchronously you should keep a ref of the menu.
since: 2.18
WebKit2.WebView::submit-form
This signal is emitted when a form is about to be submitted. The request
argument passed contains information about the text fields of the form. This
is typically used to store login information that can be used later to
pre-fill the form.
The form will not be submitted until webkit_form_submission_request_submit() is called.
unstable since: 4.0
WebKit2.WebView::user-message-received
This signal is emitted when a WebKitUserMessage is received from the
WebKitWebPage corresponding to web_view. You can reply to the message
using webkit_user_message_send_reply().
since: 2.28
WebKit2.WebView::web-process-crashed
This signal is emitted when the web process crashes.
unstable deprecated: 2.20 since: 4.0
WebKit2.WebView::web-process-terminated
This signal is emitted when the web process terminates abnormally due
to reason.
since: 2.20
Signals inherited from GtkContainer (4)
GtkContainer::add
unstable since: 3.0
GtkContainer::check-resize
unstable since: 3.0
GtkContainer::remove
unstable since: 3.0
GtkContainer::set-focus-child
unstable since: 3.0
Signals inherited from GtkWidget (69)
GtkWidget::accel-closures-changed
unstable since: 3.0
GtkWidget::button-press-event
The ::button-press-event signal will be emitted when a button (typically from a mouse) is pressed.
unstable since: 3.0
GtkWidget::button-release-event
The ::button-release-event signal will be emitted when a button (typically from a mouse) is released.
unstable since: 3.0
GtkWidget::can-activate-accel
Determines whether an accelerator that activates the signal
identified by signal_id can currently be activated.
This signal is present to allow applications and derived
widgets to override the default GtkWidget handling
for determining whether an accelerator can be activated.
unstable since: 3.0
GtkWidget::child-notify
The ::child-notify signal is emitted for each [child property][child-properties] that has changed on an object. The signal’s detail holds the property name.
unstable since: 3.0
GtkWidget::composited-changed
The ::composited-changed signal is emitted when the composited
status of widgets screen changes.
See gdk_screen_is_composited().
unstable deprecated: 3.22 since: 3.0
GtkWidget::configure-event
The ::configure-event signal will be emitted when the size, position or
stacking of the widget‘s window has changed.
unstable since: 3.0
GtkWidget::damage-event
Emitted when a redirected window belonging to widget gets drawn into.
The region/area members of the event shows what area of the redirected
drawable was drawn into.
since: 2.14
GtkWidget::delete-event
The ::delete-event signal is emitted if a user requests that
a toplevel window is closed. The default handler for this signal
destroys the window. Connecting gtk_widget_hide_on_delete() to
this signal will cause the window to be hidden instead, so that
it can later be shown again without reconstructing it.
unstable since: 3.0
GtkWidget::destroy
Signals that all holders of a reference to the widget should release the reference that they hold. May result in finalization of the widget if all references are released.
unstable since: 3.0
GtkWidget::destroy-event
The ::destroy-event signal is emitted when a GdkWindow is destroyed.
You rarely get this signal, because most widgets disconnect themselves
from their window before they destroy it, so no widget owns the
window at destroy time.
unstable since: 3.0
GtkWidget::direction-changed
The ::direction-changed signal is emitted when the text direction of a widget changes.
unstable since: 3.0
GtkWidget::drag-begin
The ::drag-begin signal is emitted on the drag source when a drag is started. A typical reason to connect to this signal is to set up a custom drag icon with e.g. gtk_drag_source_set_icon_pixbuf().
unstable since: 3.0
GtkWidget::drag-data-delete
The ::drag-data-delete signal is emitted on the drag source when a drag
with the action GDK_ACTION_MOVE is successfully completed. The signal
handler is responsible for deleting the data that has been dropped. What
“delete” means depends on the context of the drag operation.
unstable since: 3.0
GtkWidget::drag-data-get
The ::drag-data-get signal is emitted on the drag source when the drop
site requests the data which is dragged. It is the responsibility of
the signal handler to fill data with the data in the format which
is indicated by info. See gtk_selection_data_set() and gtk_selection_data_set_text().
unstable since: 3.0
GtkWidget::drag-data-received
The ::drag-data-received signal is emitted on the drop site when the
dragged data has been received. If the data was received in order to
determine whether the drop will be accepted, the handler is expected
to call gdk_drag_status() and not finish the drag.
If the data was received in response to a GtkWidget::drag-drop signal
(and this is the last target to be received), the handler for this
signal is expected to process the received data and then call
gtk_drag_finish(), setting the success parameter depending on
whether the data was processed successfully.
unstable since: 3.0
GtkWidget::drag-drop
The ::drag-drop signal is emitted on the drop site when the user drops
the data onto the widget. The signal handler must determine whether
the cursor position is in a drop zone or not. If it is not in a drop
zone, it returns FALSE and no further processing is necessary.
Otherwise, the handler returns TRUE. In this case, the handler must
ensure that gtk_drag_finish() is called to let the source know that
the drop is done. The call to gtk_drag_finish() can be done either
directly or in a GtkWidget::drag-data-received handler which gets
triggered by calling gtk_drag_get_data() to receive the data for one
or more of the supported targets.
unstable since: 3.0
GtkWidget::drag-end
The ::drag-end signal is emitted on the drag source when a drag is
finished. A typical reason to connect to this signal is to undo
things done in GtkWidget::drag-begin.
unstable since: 3.0
GtkWidget::drag-failed
The ::drag-failed signal is emitted on the drag source when a drag has
failed. The signal handler may hook custom code to handle a failed DnD
operation based on the type of error, it returns TRUE is the failure has
been already handled (not showing the default “drag operation failed”
animation), otherwise it returns FALSE.
since: 2.12
GtkWidget::drag-leave
The ::drag-leave signal is emitted on the drop site when the cursor
leaves the widget. A typical reason to connect to this signal is to
undo things done in GtkWidget::drag-motion, e.g. undo highlighting
with gtk_drag_unhighlight().
unstable since: 3.0
GtkWidget::drag-motion
The ::drag-motion signal is emitted on the drop site when the user
moves the cursor over the widget during a drag. The signal handler
must determine whether the cursor position is in a drop zone or not.
If it is not in a drop zone, it returns FALSE and no further processing
is necessary. Otherwise, the handler returns TRUE. In this case, the
handler is responsible for providing the necessary information for
displaying feedback to the user, by calling gdk_drag_status().
unstable since: 3.0
GtkWidget::draw
This signal is emitted when a widget is supposed to render itself.
The widget‘s top left corner must be painted at the origin of
the passed in context and be sized to the values returned by
gtk_widget_get_allocated_width() and gtk_widget_get_allocated_height().
unstable since: 3.0
GtkWidget::enter-notify-event
The ::enter-notify-event will be emitted when the pointer enters
the widget‘s window.
unstable since: 3.0
GtkWidget::event
The GTK+ main loop will emit three signals for each GDK event delivered
to a widget: one generic ::event signal, another, more specific,
signal that matches the type of event delivered (e.g.
GtkWidget::key-press-event) and finally a generic
GtkWidget::event-after signal.
unstable since: 3.0
GtkWidget::event-after
After the emission of the GtkWidget::event signal and (optionally)
the second more specific signal, ::event-after will be emitted
regardless of the previous two signals handlers return values.
unstable since: 3.0
GtkWidget::focus
unstable since: 3.0
GtkWidget::focus-in-event
The ::focus-in-event signal will be emitted when the keyboard focus
enters the widget‘s window.
unstable since: 3.0
GtkWidget::focus-out-event
The ::focus-out-event signal will be emitted when the keyboard focus
leaves the widget‘s window.
unstable since: 3.0
GtkWidget::grab-broken-event
Emitted when a pointer or keyboard grab on a window belonging
to widget gets broken.
since: 2.8
GtkWidget::grab-focus
unstable since: 3.0
GtkWidget::grab-notify
The ::grab-notify signal is emitted when a widget becomes shadowed by a GTK+ grab (not a pointer or keyboard grab) on another widget, or when it becomes unshadowed due to a grab being removed.
unstable since: 3.0
GtkWidget::hide
The ::hide signal is emitted when widget is hidden, for example with gtk_widget_hide().
unstable since: 3.0
GtkWidget::hierarchy-changed
The ::hierarchy-changed signal is emitted when the
anchored state of a widget changes. A widget is
“anchored” when its toplevel
ancestor is a GtkWindow. This signal is emitted when
a widget changes from un-anchored to anchored or vice-versa.
unstable since: 3.0
GtkWidget::key-press-event
The ::key-press-event signal is emitted when a key is pressed. The signal emission will reoccur at the key-repeat rate when the key is kept pressed.
unstable since: 3.0
GtkWidget::key-release-event
The ::key-release-event signal is emitted when a key is released.
unstable since: 3.0
GtkWidget::keynav-failed
Gets emitted if keyboard navigation fails.
See gtk_widget_keynav_failed() for details.
since: 2.12
GtkWidget::leave-notify-event
The ::leave-notify-event will be emitted when the pointer leaves
the widget‘s window.
unstable since: 3.0
GtkWidget::map
The ::map signal is emitted when widget is going to be mapped, that is
when the widget is visible (which is controlled with
gtk_widget_set_visible()) and all its parents up to the toplevel widget
are also visible. Once the map has occurred, GtkWidget::map-event will
be emitted.
unstable since: 3.0
GtkWidget::map-event
The ::map-event signal will be emitted when the widget‘s window is
mapped. A window is mapped when it becomes visible on the screen.
unstable since: 3.0
GtkWidget::mnemonic-activate
The default handler for this signal activates widget if group_cycling
is FALSE, or just makes widget grab focus if group_cycling is TRUE.
unstable since: 3.0
GtkWidget::motion-notify-event
The ::motion-notify-event signal is emitted when the pointer moves
over the widget’s GdkWindow.
unstable since: 3.0
GtkWidget::move-focus
unstable since: 3.0
GtkWidget::parent-set
The ::parent-set signal is emitted when a new parent has been set on a widget.
unstable since: 3.0
GtkWidget::popup-menu
This signal gets emitted whenever a widget should pop up a context
menu. This usually happens through the standard key binding mechanism;
by pressing a certain key while a widget is focused, the user can cause
the widget to pop up a menu. For example, the GtkEntry widget creates
a menu with clipboard commands. See the
[Popup Menu Migration Checklist][checklist-popup-menu]
for an example of how to use this signal.
unstable since: 3.0
GtkWidget::property-notify-event
The ::property-notify-event signal will be emitted when a property on
the widget‘s window has been changed or deleted.
unstable since: 3.0
GtkWidget::proximity-in-event
To receive this signal the GdkWindow associated to the widget needs
to enable the #GDK_PROXIMITY_IN_MASK mask.
unstable since: 3.0
GtkWidget::proximity-out-event
To receive this signal the GdkWindow associated to the widget needs
to enable the #GDK_PROXIMITY_OUT_MASK mask.
unstable since: 3.0
GtkWidget::query-tooltip
Emitted when GtkWidget:has-tooltip is TRUE and the hover timeout
has expired with the cursor hovering “above” widget; or emitted when widget got
focus in keyboard mode.
since: 2.12
GtkWidget::realize
The ::realize signal is emitted when widget is associated with a
GdkWindow, which means that gtk_widget_realize() has been called or the
widget has been mapped (that is, it is going to be drawn).
unstable since: 3.0
GtkWidget::screen-changed
The ::screen-changed signal gets emitted when the screen of a widget has changed.
unstable since: 3.0
GtkWidget::scroll-event
The ::scroll-event signal is emitted when a button in the 4 to 7 range is pressed. Wheel mice are usually configured to generate button press events for buttons 4 and 5 when the wheel is turned.
unstable since: 3.0
GtkWidget::selection-clear-event
The ::selection-clear-event signal will be emitted when the
the widget‘s window has lost ownership of a selection.
unstable since: 3.0
GtkWidget::selection-get
unstable since: 3.0
GtkWidget::selection-notify-event
unstable since: 3.0
GtkWidget::selection-received
unstable since: 3.0
GtkWidget::selection-request-event
The ::selection-request-event signal will be emitted when
another client requests ownership of the selection owned by
the widget‘s window.
unstable since: 3.0
GtkWidget::show
The ::show signal is emitted when widget is shown, for example with gtk_widget_show().
unstable since: 3.0
GtkWidget::show-help
unstable since: 3.0
GtkWidget::size-allocate
unstable since: 3.0
GtkWidget::state-changed
The ::state-changed signal is emitted when the widget state changes. See gtk_widget_get_state().
unstable deprecated: 3.0 since: 3.0
GtkWidget::state-flags-changed
The ::state-flags-changed signal is emitted when the widget state changes, see gtk_widget_get_state_flags().
unstable since: 3.0
GtkWidget::style-set
The ::style-set signal is emitted when a new style has been set
on a widget. Note that style-modifying functions like
gtk_widget_modify_base() also cause this signal to be emitted.
unstable deprecated: 3.0 since: 3.0
GtkWidget::style-updated
The ::style-updated signal is a convenience signal that is emitted when the
GtkStyleContext::changed signal is emitted on the widget‘s associated
GtkStyleContext as returned by gtk_widget_get_style_context().
unstable since: 3.0
GtkWidget::touch-event
unstable since: 3.0
GtkWidget::unmap
The ::unmap signal is emitted when widget is going to be unmapped, which
means that either it or any of its parents up to the toplevel widget have
been set as hidden.
unstable since: 3.0
GtkWidget::unmap-event
The ::unmap-event signal will be emitted when the widget‘s window is
unmapped. A window is unmapped when it becomes invisible on the screen.
unstable since: 3.0
GtkWidget::unrealize
The ::unrealize signal is emitted when the GdkWindow associated with
widget is destroyed, which means that gtk_widget_unrealize() has been
called or the widget has been unmapped (that is, it is going to be hidden).
unstable since: 3.0
GtkWidget::visibility-notify-event
The ::visibility-notify-event will be emitted when the widget‘s
window is obscured or unobscured.
unstable deprecated: 3.12 since: 3.0
GtkWidget::window-state-event
The ::window-state-event will be emitted when the state of the
toplevel window associated to the widget changes.
unstable since: 3.0
Signals inherited from GObject (1)
GObject::notify
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.
since: 2.0
Class structure
struct WebKit2WebViewClass {
WebKitWebViewBaseClass parent;
void (* load_changed) (
WebKitWebView* web_view,
WebKitLoadEvent load_event
);
gboolean (* load_failed) (
WebKitWebView* web_view,
WebKitLoadEvent load_event,
const gchar* failing_uri,
GError* error
);
GtkWidget* (* create) (
WebKitWebView* web_view,
WebKitNavigationAction* navigation_action
);
void (* ready_to_show) (
WebKitWebView* web_view
);
void (* run_as_modal) (
WebKitWebView* web_view
);
void (* close) (
WebKitWebView* web_view
);
gboolean (* script_dialog) (
WebKitWebView* web_view,
WebKitScriptDialog* dialog
);
gboolean (* decide_policy) (
WebKitWebView* web_view,
WebKitPolicyDecision* decision,
WebKitPolicyDecisionType type
);
gboolean (* permission_request) (
WebKitWebView* web_view,
WebKitPermissionRequest* permission_request
);
void (* mouse_target_changed) (
WebKitWebView* web_view,
WebKitHitTestResult* hit_test_result,
guint modifiers
);
gboolean (* print) (
WebKitWebView* web_view,
WebKitPrintOperation* print_operation
);
void (* resource_load_started) (
WebKitWebView* web_view,
WebKitWebResource* resource,
WebKitURIRequest* request
);
gboolean (* enter_fullscreen) (
WebKitWebView* web_view
);
gboolean (* leave_fullscreen) (
WebKitWebView* web_view
);
gboolean (* run_file_chooser) (
WebKitWebView* web_view,
WebKitFileChooserRequest* request
);
gboolean (* context_menu) (
WebKitWebView* web_view,
WebKitContextMenu* context_menu,
GdkEvent* event,
WebKitHitTestResult* hit_test_result
);
void (* context_menu_dismissed) (
WebKitWebView* web_view
);
void (* submit_form) (
WebKitWebView* web_view,
WebKitFormSubmissionRequest* request
);
void (* insecure_content_detected) (
WebKitWebView* web_view,
WebKitInsecureContentEvent event
);
gboolean (* web_process_crashed) (
WebKitWebView* web_view
);
gboolean (* authenticate) (
WebKitWebView* web_view,
WebKitAuthenticationRequest* request
);
gboolean (* load_failed_with_tls_errors) (
WebKitWebView* web_view,
const gchar* failing_uri,
GTlsCertificate* certificate,
GTlsCertificateFlags errors
);
gboolean (* show_notification) (
WebKitWebView* web_view,
WebKitNotification* notification
);
gboolean (* run_color_chooser) (
WebKitWebView* web_view,
WebKitColorChooserRequest* request
);
gboolean (* show_option_menu) (
WebKitWebView* web_view,
WebKitOptionMenu* menu,
GdkEvent* event,
GdkRectangle* rectangle
);
void (* web_process_terminated) (
WebKitWebView* web_view,
WebKitWebProcessTerminationReason reason
);
gboolean (* user_message_received) (
WebKitWebView* web_view,
WebKitUserMessage* message
);
gboolean (* query_permission_state) (
WebKitWebView* web_view,
WebKitPermissionStateQuery* query
);
}
Class members
parent: WebKitWebViewBaseClass- No description available.
load_changed: void (* load_changed) ( WebKitWebView* web_view, WebKitLoadEvent load_event )- No description available.
load_failed: gboolean (* load_failed) ( WebKitWebView* web_view, WebKitLoadEvent load_event, const gchar* failing_uri, GError* error )- No description available.
create: GtkWidget* (* create) ( WebKitWebView* web_view, WebKitNavigationAction* navigation_action )- No description available.
ready_to_show: void (* ready_to_show) ( WebKitWebView* web_view )- No description available.
run_as_modal: void (* run_as_modal) ( WebKitWebView* web_view )- No description available.
close: void (* close) ( WebKitWebView* web_view )- No description available.
script_dialog: gboolean (* script_dialog) ( WebKitWebView* web_view, WebKitScriptDialog* dialog )- No description available.
decide_policy: gboolean (* decide_policy) ( WebKitWebView* web_view, WebKitPolicyDecision* decision, WebKitPolicyDecisionType type )- No description available.
permission_request: gboolean (* permission_request) ( WebKitWebView* web_view, WebKitPermissionRequest* permission_request )- No description available.
mouse_target_changed: void (* mouse_target_changed) ( WebKitWebView* web_view, WebKitHitTestResult* hit_test_result, guint modifiers )- No description available.
print: gboolean (* print) ( WebKitWebView* web_view, WebKitPrintOperation* print_operation )- No description available.
resource_load_started: void (* resource_load_started) ( WebKitWebView* web_view, WebKitWebResource* resource, WebKitURIRequest* request )- No description available.
enter_fullscreen: gboolean (* enter_fullscreen) ( WebKitWebView* web_view )- No description available.
leave_fullscreen: gboolean (* leave_fullscreen) ( WebKitWebView* web_view )- No description available.
run_file_chooser: gboolean (* run_file_chooser) ( WebKitWebView* web_view, WebKitFileChooserRequest* request )- No description available.
context_menu: gboolean (* context_menu) ( WebKitWebView* web_view, WebKitContextMenu* context_menu, GdkEvent* event, WebKitHitTestResult* hit_test_result )- No description available.
context_menu_dismissed: void (* context_menu_dismissed) ( WebKitWebView* web_view )- No description available.
submit_form: void (* submit_form) ( WebKitWebView* web_view, WebKitFormSubmissionRequest* request )- No description available.
insecure_content_detected: void (* insecure_content_detected) ( WebKitWebView* web_view, WebKitInsecureContentEvent event )- No description available.
web_process_crashed: gboolean (* web_process_crashed) ( WebKitWebView* web_view )- No description available.
authenticate: gboolean (* authenticate) ( WebKitWebView* web_view, WebKitAuthenticationRequest* request )- No description available.
load_failed_with_tls_errors: gboolean (* load_failed_with_tls_errors) ( WebKitWebView* web_view, const gchar* failing_uri, GTlsCertificate* certificate, GTlsCertificateFlags errors )- No description available.
show_notification: gboolean (* show_notification) ( WebKitWebView* web_view, WebKitNotification* notification )- No description available.
run_color_chooser: gboolean (* run_color_chooser) ( WebKitWebView* web_view, WebKitColorChooserRequest* request )- No description available.
show_option_menu: gboolean (* show_option_menu) ( WebKitWebView* web_view, WebKitOptionMenu* menu, GdkEvent* event, GdkRectangle* rectangle )- No description available.
web_process_terminated: void (* web_process_terminated) ( WebKitWebView* web_view, WebKitWebProcessTerminationReason reason )- No description available.
user_message_received: gboolean (* user_message_received) ( WebKitWebView* web_view, WebKitUserMessage* message )- No description available.
query_permission_state: gboolean (* query_permission_state) ( WebKitWebView* web_view, WebKitPermissionStateQuery* query )- No description available.