Class
WPEWebKitWebView
Description [src]
class WPEWebKit.WebView : GObject.Object {
parent: GObject
}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.
Constructors
webkit_web_view_new
Creates a new web view with a default configuration.
webkit_web_view_new_with_context
Creates a new web view with a given context.
webkit_web_view_new_with_related_view
Creates a new web view sharing the same configuration and web process as another.
Available since: 2.4
webkit_web_view_new_with_settings
Creates a new web view with the given settings.
Available since: 2.6
webkit_web_view_new_with_user_content_manager
Creates a new web view with the given user content manager.
Available since: 2.6
Instance methods
webkit_web_view_add_frame_displayed_callback
Add a callback to be called when the backend notifies that a frame has been displayed in web_view.
Available since: 2.24
webkit_web_view_can_execute_editing_command
Asynchronously check if it is possible to execute the given editing command.
webkit_web_view_can_execute_editing_command_finish
Finish an asynchronous operation started with webkit_web_view_can_execute_editing_command().
webkit_web_view_can_go_back
Determines whether web_view has a previous history item.
webkit_web_view_can_go_forward
Determines whether web_view has a next history item.
webkit_web_view_can_show_mime_type
Whether or not a MIME type can be displayed in web_view.
webkit_web_view_download_uri
Requests downloading of the specified URI string for web_view.
webkit_web_view_execute_editing_command
Request to execute the given command for web_view. You can use
webkit_web_view_can_execute_editing_command() to check whether
it’s possible to execute the command.
webkit_web_view_execute_editing_command_with_argument
Request to execute the given command with argument for web_view. You can use
webkit_web_view_can_execute_editing_command() to check whether
it’s possible to execute the command.
Available since: 2.10
webkit_web_view_get_automation_presentation_type
Get the presentation type of WebKitWebView when created for automation.
Available since: 2.28
webkit_web_view_get_back_forward_list
Obtains the WebKitBackForwardList associated with the given WebKitWebView. The
WebKitBackForwardList is owned by the WebKitWebView.
webkit_web_view_get_background_color
Gets the color that is used to draw the web_view background before the
actual contents are rendered. For more information see also webkit_web_view_set_background_color().
Available since: 2.24
webkit_web_view_get_camera_capture_state
Get the camera capture state of a WebKitWebView.
Available since: 2.34
webkit_web_view_get_context
Gets the web context of web_view.
webkit_web_view_get_custom_charset
Returns the current custom character encoding name of web_view.
webkit_web_view_get_display_capture_state
Get the display capture state of a WebKitWebView.
Available since: 2.34
webkit_web_view_get_estimated_load_progress
Gets the value of the WebKitWebView: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.
webkit_web_view_get_find_controller
Gets the WebKitFindController that will allow the caller to query
the WebKitWebView for the text to look for.
webkit_web_view_get_input_method_context
Get the WebKitInputMethodContext currently in use by web_view, or NULL if no input method is being used.
Available since: 2.28
webkit_web_view_get_is_web_process_responsive
Get whether the current web process of a WebKitWebView is responsive.
Available since: 2.34
webkit_web_view_get_main_resource
Return the main resource of web_view.
webkit_web_view_get_microphone_capture_state
Get the microphone capture state of a WebKitWebView.
Available since: 2.34
webkit_web_view_get_page_id
Get the identifier of the WebKitWebPage corresponding to
the WebKitWebView.
webkit_web_view_get_settings
Gets the WebKitSettings currently applied to web_view.
If no other WebKitSettings have been explicitly applied to
web_view with webkit_web_view_set_settings(), the default
WebKitSettings will be returned. This method always returns
a valid WebKitSettings object.
To modify any of the web_view settings, you can either create
a new WebKitSettings object with webkit_settings_new(), setting
the desired preferences, and then replace the existing web_view
settings with webkit_web_view_set_settings() or get the existing
web_view settings and update it directly. WebKitSettings objects
can be shared by multiple WebKitWebViews, so modifying
the settings of a WebKitWebView would affect other
WebKitWebViews using the same WebKitSettings.
webkit_web_view_get_title
Gets the value of the WebKitWebView:title property.
You can connect to notify::title signal of web_view to
be notified when the title has been received.
webkit_web_view_get_tls_info
Retrieves the GTlsCertificate associated with the main resource of web_view,
and the GTlsCertificateFlags 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 WebKitWebView::load-changed and call this function
when it’s emitted with WEBKIT_LOAD_COMMITTED event.
webkit_web_view_get_uri
Returns the current active URI of web_view. The active URI might change during
a load operation:
webkit_web_view_get_user_content_manager
Gets the user content manager associated to web_view.
Available since: 2.6
webkit_web_view_get_website_data_manager
Get the WebKitWebsiteDataManager associated to web_view. If web_view is not ephemeral,
the returned WebKitWebsiteDataManager will be the same as the WebKitWebsiteDataManager
of web_view‘s WebKitWebContext.
Available since: 2.16
webkit_web_view_get_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
WebKitWebView::decide-policy signal handler.
Available since: 2.30
webkit_web_view_get_window_properties
Get the WebKitWindowProperties object containing the properties
that the window containing web_view should have.
webkit_web_view_get_zoom_level
Get the zoom level of web_view, i.e. the factor by which the
view contents are scaled with respect to their original size.
webkit_web_view_go_back
Loads the previous history item.
You can monitor the load operation by connecting to
WebKitWebView::load-changed signal.
webkit_web_view_go_forward
Loads the next history item.
You can monitor the load operation by connecting to
WebKitWebView::load-changed signal.
webkit_web_view_go_to_back_forward_list_item
Loads the specific history item list_item.
You can monitor the load operation by connecting to
WebKitWebView::load-changed signal.
webkit_web_view_is_controlled_by_automation
Get whether a WebKitWebView was created with WebKitWebView:is-controlled-by-automation
property enabled. Only WebKitWebViews controlled by automation can be used in an
automation session.
Available since: 2.18
webkit_web_view_is_editable
Gets whether the user is allowed to edit the HTML document. When web_view
is not editable an element in the HTML document can only be edited if the
CONTENTEDITABLE attribute has been set on the element or one of its parent
elements. By default a WebKitWebView is not editable.
Available since: 2.8
webkit_web_view_is_ephemeral
Get whether a WebKitWebView is ephemeral. To create an ephemeral WebKitWebView you need to
use g_object_new() and pass is-ephemeral property with TRUE value. See
WebKitWebView:is-ephemeral for more details.
If web_view was created with a ephemeral WebKitWebView:related-view or an
ephemeral WebKitWebView:web-context it will also be ephemeral.
Available since: 2.16
webkit_web_view_is_loading
Gets the value of the WebKitWebView:is-loading property.
You can monitor when a WebKitWebView is loading a page by connecting to
notify::is-loading signal of web_view. This is useful when you are
interesting in knowing when the view is loading something but not in the
details about the status of the load operation, for example to start a spinner
when the view is loading a page and stop it when it finishes.
webkit_web_view_is_playing_audio
Gets the value of the WebKitWebView:is-playing-audio property.
You can monitor when a page in a WebKitWebView is playing audio by
connecting to the notify::is-playing-audio signal of web_view. This
is useful when the application wants to provide visual feedback when a
page is producing sound.
Available since: 2.8
webkit_web_view_load_alternate_html
Load the given content string for the URI content_uri.
This allows clients to display page-loading errors in the WebKitWebView itself.
When this method is called from WebKitWebView::load-failed signal to show an
error page, then the back-forward list is maintained appropriately.
For everything else this method works the same way as webkit_web_view_load_html().
webkit_web_view_load_bytes
Load the specified bytes into web_view using the given mime_type and encoding.
When mime_type is NULL, it defaults to “text/html”.
When encoding is NULL, it defaults to “UTF-8”.
When base_uri is NULL, it defaults to “about:blank”.
You can monitor the load operation by connecting to WebKitWebView::load-changed signal.
Available since: 2.6
webkit_web_view_load_html
Load the given content string with the specified base_uri.
If base_uri is not NULL, relative URLs in the content will be
resolved against base_uri and absolute local paths must be children of the base_uri.
For security reasons absolute local paths that are not children of base_uri
will cause the web process to terminate.
If you need to include URLs in content that are local paths in a different
directory than base_uri you can build a data URI for them. When base_uri is NULL,
it defaults to “about:blank”. The mime type of the document will be “text/html”.
You can monitor the load operation by connecting to WebKitWebView::load-changed signal.
webkit_web_view_load_plain_text
Load the specified plain_text string into web_view. The mime type of
document will be “text/plain”. You can monitor the load
operation by connecting to WebKitWebView::load-changed signal.
webkit_web_view_load_request
Requests loading of the specified WebKitURIRequest.
You can monitor the load operation by connecting to
WebKitWebView::load-changed signal.
webkit_web_view_load_uri
Requests loading of the specified URI string.
You can monitor the load operation by connecting to
WebKitWebView::load-changed signal.
webkit_web_view_reload
Reloads the current contents of web_view.
See also webkit_web_view_reload_bypass_cache().
webkit_web_view_reload_bypass_cache
Reloads the current contents of web_view without
using any cached data.
webkit_web_view_remove_frame_displayed_callback
Removes a WebKitFrameDisplayedCallback previously added to web_view with webkit_web_view_add_frame_displayed_callback().
Available since: 2.24
webkit_web_view_restore_session_state
Restore the web_view session state from state.
Available since: 2.12
webkit_web_view_run_javascript
Asynchronously run script in the context of the current page in web_view. If
WebKitSettings:enable-javascript is FALSE, this method will do nothing.
webkit_web_view_run_javascript_finish
Finish an asynchronous operation started with webkit_web_view_run_javascript().
webkit_web_view_run_javascript_from_gresource
Asynchronously run the script from resource in the context of the
current page in web_view.
webkit_web_view_run_javascript_from_gresource_finish
Finish an asynchronous operation started with webkit_web_view_run_javascript_from_gresource().
webkit_web_view_run_javascript_in_world
Asynchronously run script 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.
Available since: 2.22
webkit_web_view_run_javascript_in_world_finish
Finish an asynchronous operation started with webkit_web_view_run_javascript_in_world().
Available since: 2.22
webkit_web_view_save
Asynchronously save the current web page associated to the
WebKitWebView into a self-contained format using the mode
specified in save_mode.
webkit_web_view_save_finish
Finish an asynchronous operation started with webkit_web_view_save().
webkit_web_view_save_to_file
Asynchronously save the current web page associated to the
WebKitWebView into a self-contained format using the mode
specified in save_mode and writing it to file.
webkit_web_view_save_to_file_finish
Finish an asynchronous operation started with webkit_web_view_save_to_file().
webkit_web_view_send_message_to_page
Send message to the WebKitWebPage corresponding to web_view. If message is floating, it’s consumed.
Available since: 2.28
webkit_web_view_send_message_to_page_finish
Finish an asynchronous operation started with webkit_web_view_send_message_to_page().
Available since: 2.28
webkit_web_view_set_background_color
Sets the color that will be used to draw the web_view background before
the actual contents are rendered. Note that if the web page loaded in web_view
specifies a background color, it will take precedence over the background color.
By default the web_view background color is opaque white.
Available since: 2.24
webkit_web_view_set_camera_capture_state
Set the camera capture state of a WebKitWebView.
Available since: 2.34
webkit_web_view_set_cors_allowlist
Sets the allowlist for which
Cross-Origin Resource Sharing
checks are disabled in web_view. URI patterns must be of the form
[protocol]://[host]/[path], each component may contain the wildcard
character (*) to represent zero or more other characters. All three
components are required and must not be omitted from the URI patterns.
Available since: 2.34
webkit_web_view_set_custom_charset
Sets the current custom character encoding override of web_view. The custom
character encoding will override any text encoding detected via HTTP headers or
META tags. Calling this method will stop any current load operation and reload the
current page. Setting the custom character encoding to NULL removes the character
encoding override.
webkit_web_view_set_display_capture_state
Set the display capture state of a WebKitWebView.
Available since: 2.34
webkit_web_view_set_editable
Sets whether the user is allowed to edit the HTML document.
Available since: 2.8
webkit_web_view_set_input_method_context
Set the WebKitInputMethodContext to be used by web_view, or NULL to not use any input method.
Note that the same WebKitInputMethodContext can’t be set on more than one WebKitWebView at the same time.
Available since: 2.28
webkit_web_view_set_microphone_capture_state
Set the microphone capture state of a WebKitWebView.
Available since: 2.34
webkit_web_view_set_settings
Sets the WebKitSettings to be applied to web_view. The
existing WebKitSettings of web_view will be replaced by
settings. New settings are applied immediately on web_view.
The same WebKitSettings object can be shared
by multiple WebKitWebViews.
webkit_web_view_set_zoom_level
Set the zoom level of web_view, i.e. the factor by which the
view contents are scaled with respect to their original size.
webkit_web_view_stop_loading
Stops any ongoing loading operation in web_view.
This method does nothing if no content is being loaded.
If there is a loading operation in progress, it will be cancelled and
WebKitWebView::load-failed signal will be emitted with
WEBKIT_NETWORK_ERROR_CANCELLED error.
webkit_web_view_terminate_web_process
Terminates the web process associated to web_view. When the web process gets terminated
using this method, the WebKitWebView::web-process-terminated signal is emitted with
WEBKIT_WEB_PROCESS_TERMINATED_BY_API as the reason for termination.
Available since: 2.34
webkit_web_view_try_close
Tries to close the web_view. This will fire the onbeforeunload event
to ask the user for confirmation to close the page. If there isn’t an
onbeforeunload event handler or the user confirms to close the page,
the WebKitWebView::close signal is emitted, otherwise nothing happens.
Available since: 2.12
Properties
WPEWebKit.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.
Available since: 2.28
WPEWebKit.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.
Available since: 2.34
WPEWebKit.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`.
Available since: 2.34
WPEWebKit.WebView:editable
Whether the pages loaded inside WebKitWebView are editable. For more
information see webkit_web_view_set_editable().
Available since: 2.8
WPEWebKit.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.
WPEWebKit.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.
Available since: 2.18
WPEWebKit.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().
Available since: 2.16
WPEWebKit.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.
WPEWebKit.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.
Available since: 2.30
WPEWebKit.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.
Available since: 2.8
WPEWebKit.WebView:is-web-process-responsive
Whether the web process currently associated to the WebKitWebView is responsive.
Available since: 2.34
WPEWebKit.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.
Available since: 2.34
WPEWebKit.WebView:page-id
The identifier of the WebKitWebPage corresponding to the WebKitWebView.
Available since: 2.28
WPEWebKit.WebView:related-view
The related WebKitWebView used when creating the view to share the
same web process. This property is not readable because the related
web view is only valid during the object construction.
Available since: 2.4
WPEWebKit.WebView:title
The main frame document title of this WebKitWebView. If
the title has not been received yet, it will be NULL.
WPEWebKit.WebView:uri
The current active URI of the WebKitWebView.
See webkit_web_view_get_uri() for more details.
WPEWebKit.WebView:user-content-manager
The WebKitUserContentManager of the view.
Available since: 2.6
WPEWebKit.WebView:web-context
The WebKitWebContext of the view.
WPEWebKit.WebView:zoom-level
The zoom level of the WebKitWebView content.
See webkit_web_view_set_zoom_level() for more details.
Signals
WPEWebKit.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.
Available since: 2.2
WPEWebKit.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.
WPEWebKit.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.
WPEWebKit.WebView::context-menu-dismissed
Emitted after WebKitWebView::context-menu signal, if the context menu is shown,
to notify that the context menu is dismissed.
WPEWebKit.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.
WPEWebKit.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:
WPEWebKit.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).
WPEWebKit.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.
WPEWebKit.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.
WPEWebKit.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.
WPEWebKit.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.
WPEWebKit.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().
Available since: 2.6
WPEWebKit.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.
WPEWebKit.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.
WPEWebKit.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().
WPEWebKit.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.
WPEWebKit.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.
WPEWebKit.WebView::run-file-chooser
This signal is emitted when the user interacts with a <input
type=’file’ /> 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.
WPEWebKit.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.
WPEWebKit.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.
Available since: 2.8
WPEWebKit.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.
To handle this signal asynchronously you should keep a ref of the menu.
Available since: 2.28
WPEWebKit.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.
WPEWebKit.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().
Available since: 2.28
WPEWebKit.WebView::web-process-terminated
This signal is emitted when the web process terminates abnormally due
to reason.
Available since: 2.20
Signals inherited from GObject (1)
GObject.Object::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.
Class structure
struct WPEWebKitWebViewClass {
GObjectClass 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
);
WebKitWebView* (* 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
);
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,
void* 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
);
void (* web_process_terminated) (
WebKitWebView* web_view,
WebKitWebProcessTerminationReason reason
);
gboolean (* user_message_received) (
WebKitWebView* web_view,
WebKitUserMessage* message
);
gboolean (* show_option_menu) (
WebKitWebView* web_view,
WebKitOptionMenu* menu,
WebKitRectangle* rectangle
);
void (* _webkit_reserved0) (
void
);
void (* _webkit_reserved1) (
void
);
void (* _webkit_reserved2) (
void
);
void (* _webkit_reserved3) (
void
);
void (* _webkit_reserved4) (
void
);
void (* _webkit_reserved5) (
void
);
}Class members
parent |
|
| No description available. | |
load_changed |
|
| No description available. | |
load_failed |
|
| No description available. | |
create |
|
| No description available. | |
ready_to_show |
|
| No description available. | |
run_as_modal |
|
| No description available. | |
close |
|
| No description available. | |
script_dialog |
|
| No description available. | |
decide_policy |
|
| No description available. | |
permission_request |
|
| No description available. | |
mouse_target_changed |
|
| No description available. | |
resource_load_started |
|
| No description available. | |
enter_fullscreen |
|
| No description available. | |
leave_fullscreen |
|
| No description available. | |
run_file_chooser |
|
| No description available. | |
context_menu |
|
| No description available. | |
context_menu_dismissed |
|
| No description available. | |
submit_form |
|
| No description available. | |
insecure_content_detected |
|
| No description available. | |
web_process_crashed |
|
| No description available. | |
authenticate |
|
| No description available. | |
load_failed_with_tls_errors |
|
| No description available. | |
show_notification |
|
| No description available. | |
web_process_terminated |
|
| No description available. | |
user_message_received |
|
| No description available. | |
show_option_menu |
|
| No description available. | |
_webkit_reserved0 |
|
| No description available. | |
_webkit_reserved1 |
|
| No description available. | |
_webkit_reserved2 |
|
| No description available. | |
_webkit_reserved3 |
|
| No description available. | |
_webkit_reserved4 |
|
| No description available. | |
_webkit_reserved5 |
|
| No description available. |