webkit/org.gtkkn.bindings.webkit/WebView

WebView

open class WebView(pointer: <Error class: unknown class><<Error class: unknown class>>) : WebViewBase

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.

Skipped during bindings generation

parameter certificate: certificate: Out parameter is not supported
method editable: Property has no getter
method is-controlled-by-automation: Property has no getter nor setter
method is-loading: Property has no getter nor setter
method is-playing-audio: Property has no getter nor setter
method related-view: Property has no getter nor setter
method settings: Property has no getter
method web-context: Property has no getter nor setter

Constructors

WebView

constructor()

Creates a new #WebKitWebView with the default #WebKitWebContext.

constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Companion

object Companion

Properties

automationPresentationType

open val automationPresentationType: AutomationBrowsingContextPresentation

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.

cameraCaptureState

open var cameraCaptureState: MediaCaptureState

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.

defaultContentSecurityPolicy

open val defaultContentSecurityPolicy: String?

The default Content-Security-Policy used by the webview as if it were set by an HTTP header.

displayCaptureState

open var displayCaptureState: MediaCaptureState

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 to %WEBKIT_MEDIA_CAPTURE_STATE_ACTIVE.

estimatedLoadProgress

open val estimatedLoadProgress: <Error class: unknown class>

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.

favicon

open val favicon: <Error class: unknown class>

The favicon currently associated to the #WebKitWebView. See webkit_web_view_get_favicon() for more details.

gtkAccessiblePointer

open override val gtkAccessiblePointer: <Error class: unknown class><<Error class: unknown class>>

gtkBuildablePointer

open override val gtkBuildablePointer: <Error class: unknown class><<Error class: unknown class>>

gtkConstraintTargetPointer

open override val gtkConstraintTargetPointer: <Error class: unknown class><<Error class: unknown class>>

isMuted

open var isMuted: Boolean

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.

isWebProcessResponsive

open val isWebProcessResponsive: Boolean

Whether the web process currently associated to the #WebKitWebView is responsive.

microphoneCaptureState

open var microphoneCaptureState: MediaCaptureState

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.

networkSession

open val networkSession: NetworkSession

The #WebKitNetworkSession of the view

pageId

open val pageId: <Error class: unknown class>

The identifier of the #WebKitWebPage corresponding to the #WebKitWebView.

title

open val title: String

The main frame document title of this #WebKitWebView. If the title has not been received yet, it will be null.

uri

open val uri: String

The current active URI of the #WebKitWebView. See webkit_web_view_get_uri() for more details.

userContentManager

open val userContentManager: UserContentManager

The #WebKitUserContentManager of the view.

webExtensionMode

open val webExtensionMode: WebExtensionMode

This configures @web_view to treat the content as a WebExtension.

webkitWebViewBasePointer

val webkitWebViewBasePointer: <Error class: unknown class><<Error class: unknown class>>

webkitWebViewPointer

val webkitWebViewPointer: <Error class: unknown class><<Error class: unknown class>>

websitePolicies

open val websitePolicies: WebsitePolicies

The #WebKitWebsitePolicies for the view.

zoomLevel

open var zoomLevel: <Error class: unknown class>

The zoom level of the #WebKitWebView content. See webkit_web_view_set_zoom_level() for more details.

Functions

callAsyncJavascriptFunction

open fun callAsyncJavascriptFunction(body: String, length: Long, arguments: <Error class: unknown class>? = null, worldName: String? = null, sourceUri: String? = null, cancellable: <Error class: unknown class>? = null, callback: <Error class: unknown class>?)

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.

callAsyncJavascriptFunctionFinish

open fun callAsyncJavascriptFunctionFinish(result: <Error class: unknown class>): <Error class: unknown class><<Error class: unknown class>>

Finish an asynchronous operation started with webkit_web_view_call_async_javascript_function().

canExecuteEditingCommand

open fun canExecuteEditingCommand(command: String, cancellable: <Error class: unknown class>? = null, callback: <Error class: unknown class>?)

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

canExecuteEditingCommandFinish

open fun canExecuteEditingCommandFinish(result: <Error class: unknown class>): <Error class: unknown class><Boolean>

Finish an asynchronous operation started with webkit_web_view_can_execute_editing_command().

canGoBack

open fun canGoBack(): Boolean

Determines whether @web_view has a previous history item.

canGoForward

open fun canGoForward(): Boolean

Determines whether @web_view has a next history item.

canShowMimeType

open fun canShowMimeType(mimeType: String): Boolean

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

connectAuthenticate

fun connectAuthenticate(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (request: AuthenticationRequest) -> Boolean): <Error class: unknown class>

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.

connectClose

fun connectClose(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

Emitted when closing a #WebKitWebView is requested. This occurs when a call is made from JavaScript's window.close function or after trying to close the @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.

connectContextMenu

fun connectContextMenu(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (contextMenu: ContextMenu, hitTestResult: HitTestResult) -> Boolean): <Error class: unknown class>

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. To customize the proposed menu you can use webkit_context_menu_prepend(), 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. To prevent the menu from being displayed you can just connect to this signal and return true so that the proposed menu will not be shown. To build your own menu, you can remove all items from the proposed menu with webkit_context_menu_remove_all(), add your own items and return 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. If you just want the default menu to be shown always, simply don't connect to this signal because showing the proposed context menu is the default behaviour.

connectContextMenuDismissed

fun connectContextMenuDismissed(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

Emitted after #WebKitWebView::context-menu signal, if the context menu is shown, to notify that the context menu is dismissed.

connectCreate

fun connectCreate(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (navigationAction: NavigationAction) -> <Error class: unknown class>): <Error class: unknown class>

Emitted when the creation of a new #WebKitWebView is requested. If this signal is handled the signal handler should return the newly created #WebKitWebView.

connectDecidePolicy

fun connectDecidePolicy(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (decision: PolicyDecision, decisionType: PolicyDecisionType) -> Boolean): <Error class: unknown class>

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

connectEnterFullscreen

fun connectEnterFullscreen(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Boolean): <Error class: unknown class>

Emitted when JavaScript code calls element.webkitRequestFullScreen. If the signal is not handled the #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).

connectInsecureContentDetected

fun connectInsecureContentDetected(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (event: InsecureContentEvent) -> Unit): <Error class: unknown class>

Prior to 2.46, this signal was emitted when insecure content was loaded in a secure content. Since 2.46, this signal is generally no longer emitted.

connectLeaveFullscreen

fun connectLeaveFullscreen(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Boolean): <Error class: unknown class>

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.

connectLoadChanged

fun connectLoadChanged(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (loadEvent: LoadEvent) -> Unit): <Error class: unknown class>

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.

connectLoadFailed

fun connectLoadFailed(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (loadEvent: LoadEvent, failingUri: String, <Error class: unknown class>) -> Boolean): <Error class: unknown class>

Emitted when an error occurs during a load operation. If the error happened when starting to load data for a page

connectLoadFailedWithTlsErrors

fun connectLoadFailedWithTlsErrors(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (failingUri: String, <Error class: unknown class>, <Error class: unknown class>) -> Boolean): <Error class: unknown class>

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().

connectMouseTargetChanged

fun connectMouseTargetChanged(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (hitTestResult: HitTestResult, <Error class: unknown class>) -> Unit): <Error class: unknown class>

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

connectPermissionRequest

fun connectPermissionRequest(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (request: PermissionRequest) -> Boolean): <Error class: unknown class>

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.

connectPrint

fun connectPrint(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (printOperation: PrintOperation) -> Boolean): <Error class: unknown class>

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.

connectQueryPermissionState

fun connectQueryPermissionState(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (query: PermissionStateQuery) -> Boolean): <Error class: unknown class>

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().

connectReadyToShow

fun connectReadyToShow(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

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().

connectResourceLoadStarted

fun connectResourceLoadStarted(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (resource: WebResource, request: UriRequest) -> Unit): <Error class: unknown class>

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.

connectRunAsModal

fun connectRunAsModal(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

Emitted after #WebKitWebView::ready-to-show on the newly created #WebKitWebView when JavaScript code calls window.showModalDialog. The purpose of this signal is to allow the client application to prepare the new view to behave as modal. Once the signal is emitted a new main loop will be run to block user interaction in the parent #WebKitWebView until the new dialog is closed.

connectRunColorChooser

fun connectRunColorChooser(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (request: ColorChooserRequest) -> Boolean): <Error class: unknown class>

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.

connectRunFileChooser

fun connectRunFileChooser(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (request: FileChooserRequest) -> Boolean): <Error class: unknown class>

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.

connectScriptDialog

fun connectScriptDialog(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (dialog: ScriptDialog) -> Boolean): <Error class: unknown class>

Emitted when JavaScript code calls window.alert, window.confirm or window.prompt, or when onbeforeunload event is fired. The @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.

connectShowNotification

fun connectShowNotification(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (notification: Notification) -> Boolean): <Error class: unknown class>

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.

connectShowOptionMenu

fun connectShowOptionMenu(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (menu: OptionMenu, <Error class: unknown class>) -> Boolean): <Error class: unknown class>

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.

connectSubmitForm

fun connectSubmitForm(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (request: FormSubmissionRequest) -> Unit): <Error class: unknown class>

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.

connectUserMessageReceived

fun connectUserMessageReceived(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (message: UserMessage) -> Boolean): <Error class: unknown class>

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().

connectWebProcessTerminated

fun connectWebProcessTerminated(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (reason: WebProcessTerminationReason) -> Unit): <Error class: unknown class>

This signal is emitted when the web process terminates abnormally due to @reason.

downloadUri

open fun downloadUri(uri: String): Download

Requests downloading of the specified URI string for @web_view.

evaluateJavascript

open fun evaluateJavascript(script: String, length: Long, worldName: String? = null, sourceUri: String? = null, cancellable: <Error class: unknown class>? = null, callback: <Error class: unknown class>?)

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.

evaluateJavascriptFinish

open fun evaluateJavascriptFinish(result: <Error class: unknown class>): <Error class: unknown class><<Error class: unknown class>>

Finish an asynchronous operation started with webkit_web_view_evaluate_javascript().

executeEditingCommand

open fun executeEditingCommand(command: String)

Request to execute the given @command for @web_view.

executeEditingCommandWithArgument

open fun executeEditingCommandWithArgument(command: String, argument: String)

Request to execute the given @command with @argument for @web_view.

getBackForwardList

open fun getBackForwardList(): BackForwardList

Obtains the #WebKitBackForwardList associated with the given #WebKitWebView.

getBackgroundColor

open fun getBackgroundColor(rgba: <Error class: unknown class>)

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

getContext

open fun getContext(): WebContext

Gets the web context of @web_view.

getCustomCharset

open fun getCustomCharset(): String

Returns the current custom character encoding name of @web_view.

getEditorState

open fun getEditorState(): EditorState

Gets the web editor state of @web_view.

getFindController

open fun getFindController(): FindController

Gets the #WebKitFindController.

getInputMethodContext

open fun getInputMethodContext(): InputMethodContext?

Get the #WebKitInputMethodContext currently in use by @web_view.

getInspector

open fun getInspector(): WebInspector

Get the #WebKitWebInspector associated to @web_view

getMainResource

open fun getMainResource(): WebResource

Return the main resource of @web_view.

getSessionState

open fun getSessionState(): WebViewSessionState

Gets the current session state of @web_view

getSnapshot

open fun getSnapshot(region: SnapshotRegion, options: SnapshotOptions, cancellable: <Error class: unknown class>? = null, callback: <Error class: unknown class>?)

Asynchronously retrieves a snapshot of @web_view for @region.

getSnapshotFinish

open fun getSnapshotFinish(result: <Error class: unknown class>): <Error class: unknown class><<Error class: unknown class>>

Finishes an asynchronous operation started with webkit_web_view_get_snapshot().

getWebViewSettings

open fun getWebViewSettings(): Settings

Gets the #WebKitSettings currently applied to @web_view.

getWindowProperties

open fun getWindowProperties(): WindowProperties

Get the #WebKitWindowProperties object.

goBack

open fun goBack()

Loads the previous history item.

goForward

open fun goForward()

Loads the next history item.

goToBackForwardListItem

open fun goToBackForwardListItem(listItem: BackForwardListItem)

Loads the specific history item @list_item.

isControlledByAutomation

open fun isControlledByAutomation(): Boolean

Get whether a #WebKitWebView was created with #WebKitWebView:is-controlled-by-automation property enabled.

isEditable

open fun isEditable(): Boolean

Gets whether the user is allowed to edit the HTML document.

isLoading

open fun isLoading(): Boolean

Gets the value of the #WebKitWebView:is-loading property.

isPlayingAudio

open fun isPlayingAudio(): Boolean

Gets the value of the #WebKitWebView:is-playing-audio property.

loadAlternateHtml

open fun loadAlternateHtml(content: String, contentUri: String, baseUri: String? = null)

Load the given @content string for the URI @content_uri.

loadBytes

open fun loadBytes(bytes: <Error class: unknown class>, mimeType: String? = null, encoding: String? = null, baseUri: String? = null)

Load the specified @bytes into @web_view using the given @mime_type and @encoding.

loadHtml

open fun loadHtml(content: String, baseUri: String? = null)

Load the given @content string with the specified @base_uri.

loadPlainText

open fun loadPlainText(plainText: String)

Load the specified @plain_text string into @web_view.

loadRequest

open fun loadRequest(request: UriRequest)

Requests loading of the specified #WebKitURIRequest.

loadUri

open fun loadUri(uri: String)

Requests loading of the specified URI string.

reload

open fun reload()

Reloads the current contents of @web_view.

reloadBypassCache

open fun reloadBypassCache()

Reloads the current contents of @web_view without using any cached data.

restoreSessionState

open fun restoreSessionState(state: WebViewSessionState)

Restore the @web_view session state from @state

save

open fun save(saveMode: SaveMode, cancellable: <Error class: unknown class>? = null, callback: <Error class: unknown class>?)

Asynchronously save the current web page.

saveFinish

open fun saveFinish(result: <Error class: unknown class>): <Error class: unknown class><<Error class: unknown class>>

Finish an asynchronous operation started with webkit_web_view_save().

saveToFile

open fun saveToFile(file: <Error class: unknown class>, saveMode: SaveMode, cancellable: <Error class: unknown class>? = null, callback: <Error class: unknown class>?)

Asynchronously save the current web page.

saveToFileFinish