Package org.gnome.webkit

Class WebView

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gobject.InitiallyUnowned

org.gnome.gtk.Widget

org.gnome.webkit.WebViewBase

org.gnome.webkit.WebView

All Implemented Interfaces:

Proxy, Accessible, Buildable, ConstraintTarget

@Generated("io.github.jwharm.JavaGI")
public class WebView
extends WebViewBase
implements Accessible, Buildable, ConstraintTarget

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	WebView.AuthenticateCallback	Functional interface declaration of the AuthenticateCallback callback.
static class	WebView.Builder<B extends WebView.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static interface	WebView.CloseCallback	Functional interface declaration of the CloseCallback callback.
static interface	WebView.ContextMenuCallback	Functional interface declaration of the ContextMenuCallback callback.
static interface	WebView.ContextMenuDismissedCallback	Functional interface declaration of the ContextMenuDismissedCallback callback.
static interface	WebView.CreateCallback	Functional interface declaration of the CreateCallback callback.
static interface	WebView.DecidePolicyCallback	Functional interface declaration of the DecidePolicyCallback callback.
static interface	WebView.EnterFullscreenCallback	Functional interface declaration of the EnterFullscreenCallback callback.
static interface	WebView.InsecureContentDetectedCallback	Deprecated.
static interface	WebView.LeaveFullscreenCallback	Functional interface declaration of the LeaveFullscreenCallback callback.
static interface	WebView.LoadChangedCallback	Functional interface declaration of the LoadChangedCallback callback.
static interface	WebView.LoadFailedCallback	Functional interface declaration of the LoadFailedCallback callback.
static interface	WebView.LoadFailedWithTlsErrorsCallback	Functional interface declaration of the LoadFailedWithTlsErrorsCallback callback.
static interface	WebView.MouseTargetChangedCallback	Functional interface declaration of the MouseTargetChangedCallback callback.
static interface	WebView.PermissionRequestCallback	Functional interface declaration of the PermissionRequestCallback callback.
static interface	WebView.PrintCallback	Functional interface declaration of the PrintCallback callback.
static interface	WebView.QueryPermissionStateCallback	Functional interface declaration of the QueryPermissionStateCallback callback.
static interface	WebView.ReadyToShowCallback	Functional interface declaration of the ReadyToShowCallback callback.
static interface	WebView.ResourceLoadStartedCallback	Functional interface declaration of the ResourceLoadStartedCallback callback.
static interface	WebView.RunAsModalCallback	Functional interface declaration of the RunAsModalCallback callback.
static interface	WebView.RunColorChooserCallback	Functional interface declaration of the RunColorChooserCallback callback.
static interface	WebView.RunFileChooserCallback	Functional interface declaration of the RunFileChooserCallback callback.
static interface	WebView.ScriptDialogCallback	Functional interface declaration of the ScriptDialogCallback callback.
static interface	WebView.ShowNotificationCallback	Functional interface declaration of the ShowNotificationCallback callback.
static interface	WebView.ShowOptionMenuCallback	Functional interface declaration of the ShowOptionMenuCallback callback.
static interface	WebView.SubmitFormCallback	Functional interface declaration of the SubmitFormCallback callback.
static interface	WebView.UserMessageReceivedCallback	Functional interface declaration of the UserMessageReceivedCallback callback.
static interface	WebView.WebProcessTerminatedCallback	Functional interface declaration of the WebProcessTerminatedCallback callback.
static class	WebView.WebViewClass

Nested classes/interfaces inherited from class org.gnome.webkit.WebViewBase

WebViewBase.WebViewBaseClass

Nested classes/interfaces inherited from class org.gnome.gtk.Widget

Widget.DestroyCallback, Widget.DirectionChangedCallback, Widget.HideCallback, Widget.KeynavFailedCallback, Widget.MapCallback, Widget.MnemonicActivateCallback, Widget.MoveFocusCallback, Widget.QueryTooltipCallback, Widget.RealizeCallback, Widget.ShowCallback, Widget.StateFlagsChangedCallback, Widget.UnmapCallback, Widget.UnrealizeCallback, Widget.WidgetClass, Widget.WidgetImpl

Nested classes/interfaces inherited from class org.gnome.gobject.InitiallyUnowned

InitiallyUnowned.InitiallyUnownedClass

Nested classes/interfaces inherited from class org.gnome.gobject.GObject

GObject.NotifyCallback, GObject.ObjectClass

Nested classes/interfaces inherited from interface org.gnome.gtk.Accessible

Accessible.AccessibleImpl, Accessible.AccessibleInterface

Nested classes/interfaces inherited from interface org.gnome.gtk.Buildable

Buildable.BuildableIface, Buildable.BuildableImpl

Nested classes/interfaces inherited from interface org.gnome.gtk.ConstraintTarget

ConstraintTarget.ConstraintTargetImpl, ConstraintTarget.ConstraintTargetInterface

Constructor Summary

Constructors

Constructor	Description
WebView()	Creates a new WebKitWebView with the default WebKitWebContext.
WebView(MemorySegment address)	Create a WebView proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected WebView	asParent()	Returns this instance as if it were its parent type.
protected boolean	authenticate(AuthenticationRequest request)
static WebView.Builder<? extends WebView.Builder>	builder()	A WebView.Builder object constructs a WebView with the specified properties.
void	callAsyncJavascriptFunction(String body, long length, @Nullable Variant arguments, @Nullable String worldName, @Nullable String sourceUri, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	Asynchronously call body with arguments in the script world with name worldName of the main frame current context in this WebView.
Value	callAsyncJavascriptFunctionFinish(AsyncResult result)	Finish an asynchronous operation started with webkit_web_view_call_async_javascript_function().
void	canExecuteEditingCommand(String command, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	Asynchronously check if it is possible to execute the given editing command.
boolean	canExecuteEditingCommandFinish(AsyncResult result)	Finish an asynchronous operation started with webkit_web_view_can_execute_editing_command().
boolean	canGoBack()	Determines whether this WebView has a previous history item.
boolean	canGoForward()	Determines whether this WebView has a next history item.
boolean	canShowMimeType(String mimeType)	Whether or not a MIME type can be displayed in this WebView.
protected void	close()
protected boolean	contextMenu(ContextMenu contextMenu, HitTestResult hitTestResult)
protected void	contextMenuDismissed()
protected Widget	create(NavigationAction navigationAction)
protected boolean	decidePolicy(PolicyDecision decision, PolicyDecisionType type)
Download	downloadUri(String uri)	Requests downloading of the specified URI string for this WebView.
boolean	emitAuthenticate(AuthenticationRequest request)	Emits the "authenticate" signal.
void	emitClose()	Emits the "close" signal.
boolean	emitContextMenu(ContextMenu contextMenu, HitTestResult hitTestResult)	Emits the "context-menu" signal.
void	emitContextMenuDismissed()	Emits the "context-menu-dismissed" signal.
Widget	emitCreate(NavigationAction navigationAction)	Emits the "create" signal.
boolean	emitDecidePolicy(PolicyDecision decision, PolicyDecisionType decisionType)	Emits the "decide-policy" signal.
boolean	emitEnterFullscreen()	Emits the "enter-fullscreen" signal.
void	emitInsecureContentDetected(InsecureContentEvent event)	Deprecated.
boolean	emitLeaveFullscreen()	Emits the "leave-fullscreen" signal.
void	emitLoadChanged(LoadEvent loadEvent)	Emits the "load-changed" signal.
boolean	emitLoadFailed(LoadEvent loadEvent, String failingUri, GError error)	Emits the "load-failed" signal.
boolean	emitLoadFailedWithTlsErrors(String failingUri, TlsCertificate certificate, Set<TlsCertificateFlags> errors)	Emits the "load-failed-with-tls-errors" signal.
void	emitMouseTargetChanged(HitTestResult hitTestResult, int modifiers)	Emits the "mouse-target-changed" signal.
boolean	emitPermissionRequest(PermissionRequest request)	Emits the "permission-request" signal.
boolean	emitPrint(PrintOperation printOperation)	Emits the "print" signal.
boolean	emitQueryPermissionState(PermissionStateQuery query)	Emits the "query-permission-state" signal.
void	emitReadyToShow()	Emits the "ready-to-show" signal.
void	emitResourceLoadStarted(WebResource resource, URIRequest request)	Emits the "resource-load-started" signal.
void	emitRunAsModal()	Emits the "run-as-modal" signal.
boolean	emitRunColorChooser(ColorChooserRequest request)	Emits the "run-color-chooser" signal.
boolean	emitRunFileChooser(FileChooserRequest request)	Emits the "run-file-chooser" signal.
boolean	emitScriptDialog(ScriptDialog dialog)	Emits the "script-dialog" signal.
boolean	emitShowNotification(Notification notification)	Emits the "show-notification" signal.
boolean	emitShowOptionMenu(OptionMenu menu, Rectangle rectangle)	Emits the "show-option-menu" signal.
void	emitSubmitForm(FormSubmissionRequest request)	Emits the "submit-form" signal.
boolean	emitUserMessageReceived(UserMessage message)	Emits the "user-message-received" signal.
void	emitWebProcessTerminated(WebProcessTerminationReason reason)	Emits the "web-process-terminated" signal.
protected boolean	enterFullscreen()
void	evaluateJavascript(String script, long length, @Nullable String worldName, @Nullable String sourceUri, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	Asynchronously evaluate script in the script world with name worldName of the main frame current context in this WebView.
Value	evaluateJavascriptFinish(AsyncResult result)	Finish an asynchronous operation started with webkit_web_view_evaluate_javascript().
void	executeEditingCommand(String command)	Request to execute the given command for this WebView.
void	executeEditingCommandWithArgument(String command, String argument)	Request to execute the given command with argument for this WebView.
AutomationBrowsingContextPresentation	getAutomationPresentationType()	Get the presentation type of WebKitWebView when created for automation.
BackForwardList	getBackForwardList()	Obtains the WebKitBackForwardList associated with the given WebKitWebView.
void	getBackgroundColor(RGBA rgba)	Gets the color that is used to draw the this WebView background.
MediaCaptureState	getCameraCaptureState()	Get the camera capture state of a WebKitWebView.
WebContext	getContext()	Gets the web context of this WebView.
String	getCustomCharset()	Returns the current custom character encoding name of this WebView.
String	getDefaultContentSecurityPolicy()	Gets the configured default Content-Security-Policy.
MediaCaptureState	getDisplayCaptureState()	Get the display capture state of a WebKitWebView.
EditorState	getEditorState()	Gets the web editor state of this WebView.
double	getEstimatedLoadProgress()	Gets the value of the WebKitWebView:estimated-load-progress property.
Texture	getFavicon()	Returns favicon currently associated to this WebView.
FindController	getFindController()	Gets the WebKitFindController.
InputMethodContext	getInputMethodContext()	Get the WebKitInputMethodContext currently in use by this WebView.
WebInspector	getInspector()	Get the WebKitWebInspector associated to this WebView
boolean	getIsMuted()	Gets the mute state of this WebView.
boolean	getIsWebProcessResponsive()	Get whether the current web process of a WebKitWebView is responsive.
WebResource	getMainResource()	Return the main resource of this WebView.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
MediaCaptureState	getMicrophoneCaptureState()	Get the microphone capture state of a WebKitWebView.
NetworkSession	getNetworkSession()	Get the WebKitNetworkSession associated to this WebView.
long	getPageId()	Get the identifier of the WebKitWebPage corresponding to the WebKitWebView
WebViewSessionState	getSessionState()	Gets the current session state of this WebView
void	getSnapshot(SnapshotRegion region, Set<SnapshotOptions> options, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	Asynchronously retrieves a snapshot of this WebView for region.
void	getSnapshot(SnapshotRegion region, SnapshotOptions options, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	Asynchronously retrieves a snapshot of this WebView for region.
Texture	getSnapshotFinish(AsyncResult result)	Finishes an asynchronous operation started with webkit_web_view_get_snapshot().
String	getTitle()	Gets the value of the WebKitWebView:title property.
boolean	getTlsInfo(Out<TlsCertificate> certificate, Out<Set<TlsCertificateFlags>> errors)	Retrieves the GTlsCertificate associated with the main resource of this WebView.
static Type	getType()	Get the GType of the WebView class
String	getUri()	Returns the current active URI of this WebView.
UserContentManager	getUserContentManager()	Gets the user content manager associated to this WebView.
WebExtensionMode	getWebExtensionMode()	Get the view's WebKitWebExtensionMode.
WebsitePolicies	getWebsitePolicies()	Gets the default website policies.
Settings	getWebViewSettings()	Gets the WebKitSettings currently applied to this WebView.
WindowProperties	getWindowProperties()	Get the WebKitWindowProperties object.
double	getZoomLevel()	Set the zoom level of this WebView.
void	goBack()	Loads the previous history item.
void	goForward()	Loads the next history item.
void	goToBackForwardListItem(BackForwardListItem listItem)	Loads the specific history item listItem.
protected void	insecureContentDetected(InsecureContentEvent event)
boolean	isControlledByAutomation()	Get whether a WebKitWebView was created with WebKitWebView:is-controlled-by-automation property enabled.
boolean	isEditable()	Gets whether the user is allowed to edit the HTML document.
boolean	isLoading()	Gets the value of the WebKitWebView:is-loading property.
boolean	isPlayingAudio()	Gets the value of the WebKitWebView:is-playing-audio property.
protected boolean	leaveFullscreen()
void	loadAlternateHtml(String content, String contentUri, @Nullable String baseUri)	Load the given content string for the URI contentUri.
void	loadBytes(Bytes bytes, @Nullable String mimeType, @Nullable String encoding, @Nullable String baseUri)	Load the specified bytes into this WebView using the given mimeType and encoding.
protected void	loadChanged(LoadEvent loadEvent)
protected boolean	loadFailed(LoadEvent loadEvent, String failingUri, GError error)
protected boolean	loadFailedWithTlsErrors(String failingUri, TlsCertificate certificate, Set<TlsCertificateFlags> errors)
void	loadHtml(String content, @Nullable String baseUri)	Load the given content string with the specified baseUri.
void	loadPlainText(String plainText)	Load the specified plainText string into this WebView.
void	loadRequest(URIRequest request)	Requests loading of the specified WebKitURIRequest.
void	loadUri(String uri)	Requests loading of the specified URI string.
protected void	mouseTargetChanged(HitTestResult hitTestResult, int modifiers)
SignalConnection<WebView.AuthenticateCallback>	onAuthenticate(WebView.AuthenticateCallback handler)	This signal is emitted when the user is challenged with HTTP authentication.
SignalConnection<WebView.CloseCallback>	onClose(WebView.CloseCallback handler)	Emitted when closing a WebKitWebView is requested.
SignalConnection<WebView.ContextMenuCallback>	onContextMenu(WebView.ContextMenuCallback handler)	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.
SignalConnection<WebView.ContextMenuDismissedCallback>	onContextMenuDismissed(WebView.ContextMenuDismissedCallback handler)	Emitted after WebKitWebView::context-menu signal, if the context menu is shown, to notify that the context menu is dismissed.
SignalConnection<WebView.CreateCallback>	onCreate(WebView.CreateCallback handler)	Emitted when the creation of a new WebKitWebView is requested.
SignalConnection<WebView.DecidePolicyCallback>	onDecidePolicy(WebView.DecidePolicyCallback handler)	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.
SignalConnection<WebView.EnterFullscreenCallback>	onEnterFullscreen(WebView.EnterFullscreenCallback handler)	Emitted when JavaScript code calls <function>element.webkitRequestFullScreen</function>.
SignalConnection<WebView.InsecureContentDetectedCallback>	onInsecureContentDetected(WebView.InsecureContentDetectedCallback handler)	Deprecated.
SignalConnection<WebView.LeaveFullscreenCallback>	onLeaveFullscreen(WebView.LeaveFullscreenCallback handler)	Emitted when the WebKitWebView is about to restore its top level window out of its full screen state.
SignalConnection<WebView.LoadChangedCallback>	onLoadChanged(WebView.LoadChangedCallback handler)	Emitted when a load operation in webView changes.
SignalConnection<WebView.LoadFailedCallback>	onLoadFailed(WebView.LoadFailedCallback handler)	Emitted when an error occurs during a load operation.
SignalConnection<WebView.LoadFailedWithTlsErrorsCallback>	onLoadFailedWithTlsErrors(WebView.LoadFailedWithTlsErrorsCallback handler)	Emitted when a TLS error occurs during a load operation.
SignalConnection<WebView.MouseTargetChangedCallback>	onMouseTargetChanged(WebView.MouseTargetChangedCallback handler)	This signal is emitted when the mouse cursor moves over an element such as a link, image or a media element.
SignalConnection<WebView.PermissionRequestCallback>	onPermissionRequest(WebView.PermissionRequestCallback handler)	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.
SignalConnection<WebView.PrintCallback>	onPrint(WebView.PrintCallback handler)	Emitted when printing is requested on webView, usually by a JavaScript call, before the print dialog is shown.
SignalConnection<WebView.QueryPermissionStateCallback>	onQueryPermissionState(WebView.QueryPermissionStateCallback handler)	This signal allows the User-Agent to respond to permission requests for powerful features, as specified by the Permissions W3C Specification.
SignalConnection<WebView.ReadyToShowCallback>	onReadyToShow(WebView.ReadyToShowCallback handler)	Emitted after WebKitWebView::create on the newly created WebKitWebView when it should be displayed to the user.
SignalConnection<WebView.ResourceLoadStartedCallback>	onResourceLoadStarted(WebView.ResourceLoadStartedCallback handler)	Emitted when a new resource is going to be loaded.
SignalConnection<WebView.RunAsModalCallback>	onRunAsModal(WebView.RunAsModalCallback handler)	Emitted after WebKitWebView::ready-to-show on the newly created WebKitWebView when JavaScript code calls <function>window.showModalDialog</function>.
SignalConnection<WebView.RunColorChooserCallback>	onRunColorChooser(WebView.RunColorChooserCallback handler)	This signal is emitted when the user interacts with a <input type='color' /> HTML element, requesting from WebKit to show a dialog to select a color.
SignalConnection<WebView.RunFileChooserCallback>	onRunFileChooser(WebView.RunFileChooserCallback handler)	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.
SignalConnection<WebView.ScriptDialogCallback>	onScriptDialog(WebView.ScriptDialogCallback handler)	Emitted when JavaScript code calls <function>window.alert</function>, <function>window.confirm</function> or <function>window.prompt</function>, or when <function>onbeforeunload</function> event is fired.
SignalConnection<WebView.ShowNotificationCallback>	onShowNotification(WebView.ShowNotificationCallback handler)	This signal is emitted when a notification should be presented to the user.
SignalConnection<WebView.ShowOptionMenuCallback>	onShowOptionMenu(WebView.ShowOptionMenuCallback handler)	This signal is emitted when a select element in webView needs to display a dropdown menu.
SignalConnection<WebView.SubmitFormCallback>	onSubmitForm(WebView.SubmitFormCallback handler)	This signal is emitted when a form is about to be submitted.
SignalConnection<WebView.UserMessageReceivedCallback>	onUserMessageReceived(WebView.UserMessageReceivedCallback handler)	This signal is emitted when a WebKitUserMessage is received from the WebKitWebPage corresponding to webView.
SignalConnection<WebView.WebProcessTerminatedCallback>	onWebProcessTerminated(WebView.WebProcessTerminatedCallback handler)	This signal is emitted when the web process terminates abnormally due to reason.
protected boolean	permissionRequest(PermissionRequest permissionRequest)
protected boolean	print(PrintOperation printOperation)
protected boolean	queryPermissionState(PermissionStateQuery query)
protected void	readyToShow()
void	reload()	Reloads the current contents of this WebView.
void	reloadBypassCache()	Reloads the current contents of this WebView without using any cached data.
protected void	resourceLoadStarted(WebResource resource, URIRequest request)
void	restoreSessionState(WebViewSessionState state)	Restore the this WebView session state from state
protected void	runAsModal()
protected boolean	runColorChooser(ColorChooserRequest request)
protected boolean	runFileChooser(FileChooserRequest request)
void	save(SaveMode saveMode, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	Asynchronously save the current web page.
InputStream	saveFinish(AsyncResult result)	Finish an asynchronous operation started with webkit_web_view_save().
void	saveToFile(File file, SaveMode saveMode, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	Asynchronously save the current web page.
boolean	saveToFileFinish(AsyncResult result)	Finish an asynchronous operation started with webkit_web_view_save_to_file().
protected boolean	scriptDialog(ScriptDialog dialog)
void	sendMessageToPage(UserMessage message, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	Send message to the WebKitWebPage corresponding to this WebView.
UserMessage	sendMessageToPageFinish(AsyncResult result)	Finish an asynchronous operation started with webkit_web_view_send_message_to_page().
void	setBackgroundColor(RGBA rgba)	Sets the color that will be used to draw the this WebView background.
void	setCameraCaptureState(MediaCaptureState state)	Set the camera capture state of a WebKitWebView.
void	setCorsAllowlist(@Nullable String[] allowlist)	Sets the allowlist for CORS.
void	setCustomCharset(@Nullable String charset)	Sets the current custom character encoding override of this WebView.
void	setDisplayCaptureState(MediaCaptureState state)	Set the display capture state of a WebKitWebView.
void	setEditable(boolean editable)	Sets whether the user is allowed to edit the HTML document.
void	setInputMethodContext(@Nullable InputMethodContext context)	Set the WebKitInputMethodContext to be used by this WebView.
void	setIsMuted(boolean muted)	Sets the mute state of this WebView.
void	setMicrophoneCaptureState(MediaCaptureState state)	Set the microphone capture state of a WebKitWebView.
void	setSettings(Settings settings)	Sets the WebKitSettings to be applied to this WebView.
void	setZoomLevel(double zoomLevel)	Set the zoom level of this WebView.
protected boolean	showNotification(Notification notification)
protected boolean	showOptionMenu(OptionMenu menu, Rectangle rectangle)
void	stopLoading()	Stops any ongoing loading operation in this WebView.
protected void	submitForm(FormSubmissionRequest request)
void	terminateWebProcess()	Terminates the web process associated to this WebView.
void	tryClose()	Tries to close the this WebView.
protected boolean	userMessageReceived(UserMessage message)
protected boolean	webProcessCrashed()
protected void	webProcessTerminated(WebProcessTerminationReason reason)

Methods inherited from class org.gnome.gtk.Widget

actionSetEnabled, activateActionIfExists, activateDefault, activateWidget, addController, addCssClass, addMnemonicLabel, addTickCallback, allocate, childFocus, computeBounds, computeExpand, computeExpand, computePoint, computeTransform, contains, createPangoContext, createPangoLayout, cssChanged, directionChanged, disposeTemplate, dragCheckThreshold, emitDestroy, emitDirectionChanged, emitHide, emitKeynavFailed, emitMap, emitMnemonicActivate, emitMoveFocus, emitQueryTooltip, emitRealize, emitShow, emitStateFlagsChanged, emitUnmap, emitUnrealize, errorBell, focus, getAllocatedBaseline, getAllocatedHeight, getAllocatedWidth, getAllocation, getAncestor, getBaseline, getCanFocus, getCanTarget, getChildVisible, getClipboard, getColor, getCssClasses, getCssName, getCursor, getDefaultDirection, getDirection, getDisplay, getFirstChild, getFocusable, getFocusChild, getFocusOnClick, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHeight, getHexpand, getHexpandSet, getLastChild, getLayoutManager, getMapped, getMarginBottom, getMarginEnd, getMarginStart, getMarginTop, getName, getNative, getNextSibling, getOpacity, getOverflow, getPangoContext, getParent, getPreferredSize, getPrevSibling, getPrimaryClipboard, getRealized, getReceivesDefault, getRequestMode, getRoot, getScaleFactor, getSensitive, getSettings, getSize, getSizeRequest, getStateFlags, getStyleContext, getTemplateChild, getTooltipMarkup, getTooltipText, getValign, getVexpand, getVexpandSet, getVisible, getWidth, grabFocus, hasCssClass, hasDefault, hasFocus, hasVisibleFocus, hide, inDestruction, initTemplate, insertActionGroup, insertAfter, insertBefore, isAncestor, isDrawable, isFocus, isSensitive, isVisible, keynavFailed, listMnemonicLabels, map, measure, mnemonicActivate, moveFocus, observeChildren, observeControllers, onDestroy, onDirectionChanged, onHide, onKeynavFailed, onMap, onMnemonicActivate, onMoveFocus, onQueryTooltip, onRealize, onShow, onStateFlagsChanged, onUnmap, onUnrealize, pick, pick, queryTooltip, queueAllocate, queueDraw, queueResize, realize, removeController, removeCssClass, removeMnemonicLabel, removeTickCallback, root, setCanFocus, setCanTarget, setChildVisible, setCssClasses, setCursor, setCursorFromName, setDefaultDirection, setDirection, setFocusable, setFocusChild, setFocusOnClick, setFontMap, setFontOptions, setHalign, setHasTooltip, setHexpand, setHexpandSet, setLayoutManager, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setName, setOpacity, setOverflow, setParent, setReceivesDefault, setSensitive, setSizeRequest, setStateFlags, setStateFlags, setTooltipMarkup, setTooltipText, setValign, setVexpand, setVexpandSet, setVisible, shouldLayout, show, sizeAllocate, sizeAllocate, snapshot, snapshotChild, stateFlagsChanged, systemSettingChanged, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unroot, unsetStateFlags, unsetStateFlags

Methods inherited from class org.gnome.gobject.GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, connect, constructed, disconnect, dispatchPropertiesChanged, dispose, dupData, dupQdata, emit, emitNotify, finalize_, forceFloating, freezeNotify, get, getData, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, newv, notify, notify, notifyByPspec, onNotify, ref, refSink, removeToggleRef, removeWeakPointer, replaceData, replaceQdata, runDispose, set, setData, setDataFull, setProperty, setProperty, setProperty, setQdata, setQdataFull, setv, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref, withProperties

Methods inherited from class org.gnome.gobject.TypeInstance

callParent, callParent, getPrivate, readGClass, writeGClass

Methods inherited from class io.github.jwharm.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.gnome.gtk.Accessible

announce, getAccessibleParent, getAccessibleRole, getAtContext, getBounds, getFirstAccessibleChild, getNextAccessibleSibling, getPlatformState, resetProperty, resetRelation, resetState, setAccessibleParent, updateNextAccessibleSibling, updateProperty, updateRelation, updateState

Methods inherited from interface org.gnome.gtk.Buildable

getBuildableId

Methods inherited from interface io.github.jwharm.javagi.base.Proxy

handle

Constructor Details

WebView

public WebView(MemorySegment address)

Create a WebView proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

WebView

public WebView()
        throws UnsupportedPlatformException

Creates a new WebKitWebView with the default WebKitWebContext.

Creates a new WebKitWebView with the default WebKitWebContext and no WebKitUserContentManager associated with it. See also webkit_web_view_new_with_context(), webkit_web_view_new_with_user_content_manager(), and webkit_web_view_new_with_settings().

Throws:

UnsupportedPlatformException - when run on a platform other than linux

Method Details

getType

public static Type getType()

Get the GType of the WebView class

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected WebView asParent()

Returns this instance as if it were its parent type. This is mostly synonymous to the Java super keyword, but will set the native typeclass function pointers to the parent type. When overriding a native virtual method in Java, "chaining up" with super.methodName() doesn't work, because it invokes the overridden function pointer again. To chain up, call asParent().methodName(). This will call the native function pointer of this virtual method in the typeclass of the parent type.

Overrides:

asParent in class WebViewBase

callAsyncJavascriptFunction

public void callAsyncJavascriptFunction(String body,
 long length,
 @Nullable
 @Nullable Variant arguments,
 @Nullable
 @Nullable String worldName,
 @Nullable
 @Nullable String sourceUri,
 @Nullable
 @Nullable Cancellable cancellable,
 @Nullable
 @Nullable AsyncReadyCallback callback)

Asynchronously call body with arguments in the script world with name worldName of the main frame current context in this WebView. 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 worldName is null, the default world is used. Any value that is not null is a distin ct world. The sourceUri will be shown in exceptions and doesn't affect the behavior of the script. When not provided, the document URL is used.

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

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

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

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

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

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

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

Parameters:

body - the function body

length - length of body, or -1 if body is a nul-terminated string

arguments - a GVariant with format a{sv} storing the function arguments, or null

worldName - the name of a WebKitScriptWorld or null to use the default

sourceUri - the source URI

cancellable - a GCancellable or null to ignore

callback - a GAsyncReadyCallback to call when the script finished

callAsyncJavascriptFunctionFinish

public Value callAsyncJavascriptFunctionFinish(AsyncResult result)
                                        throws GErrorException

Finish an asynchronous operation started with webkit_web_view_call_async_javascript_function().

Parameters:

result - a GAsyncResult

Returns:

a JSCValue with the return value of the async function or null in case of error

Throws:

GErrorException - see GError

canExecuteEditingCommand

public void canExecuteEditingCommand(String command,
 @Nullable
 @Nullable Cancellable cancellable,
 @Nullable
 @Nullable AsyncReadyCallback callback)

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

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

Parameters:

command - the command to check

cancellable - a GCancellable or null to ignore

callback - a GAsyncReadyCallback to call when the request is satisfied

canExecuteEditingCommandFinish

public boolean canExecuteEditingCommandFinish(AsyncResult result)
                                       throws GErrorException

Finish an asynchronous operation started with webkit_web_view_can_execute_editing_command().

Parameters:

result - a GAsyncResult

Returns:

true if the editing command can be executed or false otherwise

Throws:

GErrorException - see GError

canGoBack

public boolean canGoBack()

Determines whether this WebView has a previous history item.

Returns:

true if able to move back or false otherwise.

canGoForward

public boolean canGoForward()

Determines whether this WebView has a next history item.

Returns:

true if able to move forward or false otherwise.

canShowMimeType

public boolean canShowMimeType(String mimeType)

Whether or not a MIME type can be displayed in this WebView.

Parameters:

mimeType - a MIME type

Returns:

true if the MIME type mimeType can be displayed or false otherwise

downloadUri

public Download downloadUri(String uri)

Requests downloading of the specified URI string for this WebView.

Parameters:

uri - the URI to download

Returns:

a new WebKitDownload representing the download operation.

evaluateJavascript

public void evaluateJavascript(String script,
 long length,
 @Nullable
 @Nullable String worldName,
 @Nullable
 @Nullable String sourceUri,
 @Nullable
 @Nullable Cancellable cancellable,
 @Nullable
 @Nullable AsyncReadyCallback callback)

Asynchronously evaluate script in the script world with name worldName of the main frame current context in this WebView. If worldName is null, the default world is used. Any value that is not null is a distinct world. The sourceUri will be shown in exceptions and doesn't affect the behavior of the script. When not provided, the document URL is used.

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

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

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

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

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

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

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

Parameters:

script - the script to evaluate

length - length of script, or -1 if script is a nul-terminated string

worldName - the name of a WebKitScriptWorld or null to use the default

sourceUri - the source URI

cancellable - a GCancellable or null to ignore

callback - a GAsyncReadyCallback to call when the script finished

evaluateJavascriptFinish

public Value evaluateJavascriptFinish(AsyncResult result)
                               throws GErrorException

Finish an asynchronous operation started with webkit_web_view_evaluate_javascript().

Parameters:

result - a GAsyncResult

Returns:

a JSCValue with the result of the last executed statement in script or null in case of error

Throws:

GErrorException - see GError

executeEditingCommand

public void executeEditingCommand(String command)

Request to execute the given command for this WebView.

You can use webkit_web_view_can_execute_editing_command() to check whether it's possible to execute the command.

Parameters:

command - the command to execute

executeEditingCommandWithArgument

public void executeEditingCommandWithArgument(String command,
 String argument)

Request to execute the given command with argument for this WebView.

You can use webkit_web_view_can_execute_editing_command() to check whether it's possible to execute the command.

Parameters:

command - the command to execute

argument - the command argument

getAutomationPresentationType

public AutomationBrowsingContextPresentation getAutomationPresentationType()

Get the presentation type of WebKitWebView when created for automation.

Returns:

a WebKitAutomationBrowsingContextPresentation.

getBackForwardList

public BackForwardList getBackForwardList()

Obtains the WebKitBackForwardList associated with the given WebKitWebView.

The WebKitBackForwardList is owned by the WebKitWebView.

Returns:

the WebKitBackForwardList

getBackgroundColor

public void getBackgroundColor(RGBA rgba)

Gets the color that is used to draw the this WebView background.

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

Parameters:

rgba - a GdkRGBA to fill in with the background color

getCameraCaptureState

public MediaCaptureState getCameraCaptureState()

Get the camera capture state of a WebKitWebView.

Returns:

The WebKitMediaCaptureState of the camera device. If WebKitSettings:enable-mediastream is false, this method will return MediaCaptureState.NONE.

getContext

public WebContext getContext()

Gets the web context of this WebView.

Returns:

the WebKitWebContext of the view

getCustomCharset

public String getCustomCharset()

Returns the current custom character encoding name of this WebView.

Returns:

the current custom character encoding name or null if no custom character encoding has been set.

getDefaultContentSecurityPolicy

public String getDefaultContentSecurityPolicy()

Gets the configured default Content-Security-Policy.

Returns:

The default policy or null

getDisplayCaptureState

public MediaCaptureState getDisplayCaptureState()

Get the display capture state of a WebKitWebView.

Returns:

The WebKitMediaCaptureState of the display device. If WebKitSettings:enable-mediastream is false, this method will return MediaCaptureState.NONE.

getEditorState

public EditorState getEditorState()

Gets the web editor state of this WebView.

Returns:

the WebKitEditorState of the view

getEstimatedLoadProgress

public double getEstimatedLoadProgress()

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 this WebView.

Returns:

an estimate of the of the percent complete for a document load as a range from 0.0 to 1.0.

getFavicon

public Texture getFavicon()

Returns favicon currently associated to this WebView.

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

Returns:

the favicon image or null if there's no icon associated with this WebView.

getFindController

public FindController getFindController()

Gets the WebKitFindController.

Gets the WebKitFindController that will allow the caller to query the WebKitWebView for the text to look for.

Returns:

the WebKitFindController associated to this particular WebKitWebView.

getInputMethodContext

public InputMethodContext getInputMethodContext()

Get the WebKitInputMethodContext currently in use by this WebView.

Get the WebKitInputMethodContext currently in use by this WebView, or null if no input method is being used.

Returns:

a WebKitInputMethodContext, or null

getInspector

public WebInspector getInspector()

Get the WebKitWebInspector associated to this WebView

Returns:

the WebKitWebInspector of this WebView

getIsMuted

public boolean getIsMuted()

Gets the mute state of this WebView.

Returns:

true if this WebView audio is muted or false is audio is not muted.

getIsWebProcessResponsive

public boolean getIsWebProcessResponsive()

Get whether the current web process of a WebKitWebView is responsive.

Returns:

true if the web process attached to this WebView is responsive, or false otherwise.

getMainResource

public WebResource getMainResource()

Return the main resource of this WebView.

Returns:

the main WebKitWebResource of the view or null if nothing has been loaded.

getMicrophoneCaptureState

public MediaCaptureState getMicrophoneCaptureState()

Get the microphone capture state of a WebKitWebView.

Returns:

The WebKitMediaCaptureState of the microphone device. If WebKitSettings:enable-mediastream is false, this method will return MediaCaptureState.NONE.

getNetworkSession

public NetworkSession getNetworkSession()

Get the WebKitNetworkSession associated to this WebView.

Returns:

a WebKitNetworkSession

getPageId

public long getPageId()

Get the identifier of the WebKitWebPage corresponding to the WebKitWebView

Returns:

the page ID of this WebView.

getSessionState

public WebViewSessionState getSessionState()

Gets the current session state of this WebView

Returns:

a WebKitWebViewSessionState

getWebViewSettings

public Settings getWebViewSettings()

Gets the WebKitSettings currently applied to this WebView.

If no other WebKitSettings have been explicitly applied to this WebView 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 this WebView settings, you can either create a new WebKitSettings object with webkit_settings_new(), setting the desired preferences, and then replace the existing this WebView settings with webkit_web_view_set_settings() or get the existing this WebView settings and update it directly. WebKitSettings objects can be shared by multiple WebKitWebView<!-- -->s, so modifying the settings of a WebKitWebView would affect other WebKitWebView<!-- -->s using the same WebKitSettings.

Returns:

the WebKitSettings attached to this WebView

getSnapshot

public void getSnapshot(SnapshotRegion region,
 Set<SnapshotOptions> options,
 @Nullable
 @Nullable Cancellable cancellable,
 @Nullable
 @Nullable AsyncReadyCallback callback)

Asynchronously retrieves a snapshot of this WebView for region.

options specifies how the snapshot should be rendered.

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

Parameters:

region - the WebKitSnapshotRegion for this snapshot

options - WebKitSnapshotOptions for the snapshot

cancellable - a GCancellable

callback - a GAsyncReadyCallback

getSnapshot

public void getSnapshot(SnapshotRegion region,
 SnapshotOptions options,
 @Nullable
 @Nullable Cancellable cancellable,
 @Nullable
 @Nullable AsyncReadyCallback callback)

Asynchronously retrieves a snapshot of this WebView for region.

options specifies how the snapshot should be rendered.

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

Parameters:

region - the WebKitSnapshotRegion for this snapshot

options - WebKitSnapshotOptions for the snapshot

cancellable - a GCancellable

callback - a GAsyncReadyCallback

getSnapshotFinish

public Texture getSnapshotFinish(AsyncResult result)
                          throws GErrorException

Finishes an asynchronous operation started with webkit_web_view_get_snapshot().

Parameters:

result - a GAsyncResult

Returns:

an image with the retrieved snapshot, or null in case of error.

Throws:

GErrorException - see GError

getTitle

public String getTitle()

Gets the value of the WebKitWebView:title property.

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

Returns:

The main frame document title of this WebView.

getTlsInfo

public boolean getTlsInfo(Out<TlsCertificate> certificate,
 Out<Set<TlsCertificateFlags>> errors)

Retrieves the GTlsCertificate associated with the main resource of this WebView.

Retrieves the GTlsCertificate associated with the main resource of this WebView, 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 LoadEvent.COMMITTED event.

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

Parameters:

certificate - return location for a GTlsCertificate

errors - return location for a GTlsCertificateFlags the verification status of certificate

Returns:

true if the this WebView connection uses HTTPS and a response has been received from the server, or false otherwise.

getUri

public String getUri()

Returns the current active URI of this WebView.

The active URI might change during a load operation:

<orderedlist> <listitem><para> When nothing has been loaded yet on this WebView the active URI is null. </para></listitem> <listitem><para> When a new load operation starts the active URI is the requested URI: <itemizedlist> <listitem><para> If the load operation was started by webkit_web_view_load_uri(), the requested URI is the given one. </para></listitem> <listitem><para> If the load operation was started by webkit_web_view_load_html(), the requested URI is "about:blank". </para></listitem> <listitem><para> If the load operation was started by webkit_web_view_load_alternate_html(), the requested URI is content URI provided. </para></listitem> <listitem><para> If the load operation was started by webkit_web_view_go_back() or webkit_web_view_go_forward(), the requested URI is the original URI of the previous/next item in the WebKitBackForwardList of this WebView. </para></listitem> <listitem><para> If the load operation was started by webkit_web_view_go_to_back_forward_list_item(), the requested URI is the opriginal URI of the given WebKitBackForwardListItem. </para></listitem> </itemizedlist> </para></listitem> <listitem><para> If there is a server redirection during the load operation, the active URI is the redirected URI. When the signal WebKitWebView::load-changed is emitted with LoadEvent.REDIRECTED event, the active URI is already updated to the redirected URI. </para></listitem> <listitem><para> When the signal WebKitWebView::load-changed is emitted with LoadEvent.COMMITTED event, the active URI is the final one and it will not change unless a new load operation is started or a navigation action within the same page is performed. </para></listitem> </orderedlist>

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

Returns:

the current active URI of this WebView or null if nothing has been loaded yet.

getUserContentManager

public UserContentManager getUserContentManager()

Gets the user content manager associated to this WebView.

Returns:

the WebKitUserContentManager associated with the view

getWebExtensionMode

public WebExtensionMode getWebExtensionMode()

Get the view's WebKitWebExtensionMode.

Returns:

the WebKitWebExtensionMode

getWebsitePolicies

public WebsitePolicies getWebsitePolicies()

Gets the default website policies.

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

See also webkit_policy_decision_use_with_policies().

Returns:

the default WebKitWebsitePolicies associated with the view.

getWindowProperties

public WindowProperties getWindowProperties()

Get the WebKitWindowProperties object.

Get the WebKitWindowProperties object containing the properties that the window containing this WebView should have.

Returns:

the WebKitWindowProperties of this WebView

getZoomLevel

public double getZoomLevel()

Set the zoom level of this WebView.

Get the zoom level of this WebView, i.e. the factor by which the view contents are scaled with respect to their original size.

Returns:

the current zoom level of this WebView

goBack

public void goBack()

Loads the previous history item.

You can monitor the load operation by connecting to WebKitWebView::load-changed signal.

goForward

public void goForward()

Loads the next history item.

You can monitor the load operation by connecting to WebKitWebView::load-changed signal.

goToBackForwardListItem

public void goToBackForwardListItem(BackForwardListItem listItem)

Loads the specific history item listItem.

You can monitor the load operation by connecting to WebKitWebView::load-changed signal.

Parameters:

listItem - a WebKitBackForwardListItem

isControlledByAutomation

public boolean isControlledByAutomation()

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

Only WebKitWebView<!-- -->s controlled by automation can be used in an automation session.

Returns:

true if this WebView is controlled by automation, or false otherwise.

isEditable

public boolean isEditable()

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

When this WebView 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.

Returns:

true if the user is allowed to edit the HTML document, or false otherwise.

isLoading

public boolean isLoading()

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 this WebView. 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.

Returns:

true if this WebView is loading a page or false otherwise.

isPlayingAudio

public boolean isPlayingAudio()

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 this WebView. This is useful when the application wants to provide visual feedback when a page is producing sound.

Returns:

true if a page in this WebView is playing audio or false otherwise.

loadAlternateHtml

public void loadAlternateHtml(String content,
 String contentUri,
 @Nullable
 @Nullable String baseUri)

Load the given content string for the URI contentUri.

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

Parameters:

content - the new content to display as the main page of the this WebView

contentUri - the URI for the alternate page content

baseUri - the base URI for relative locations or null

loadBytes

public void loadBytes(Bytes bytes,
 @Nullable
 @Nullable String mimeType,
 @Nullable
 @Nullable String encoding,
 @Nullable
 @Nullable String baseUri)

Load the specified bytes into this WebView using the given mimeType and encoding.

When mimeType is null, it defaults to "text/html". When encoding is null, it defaults to "UTF-8". When baseUri is null, it defaults to "about:blank". You can monitor the load operation by connecting to WebKitWebView::load-changed signal.

Parameters:

bytes - input data to load

mimeType - the MIME type of bytes, or null

encoding - the character encoding of bytes, or null

baseUri - the base URI for relative locations or null

loadHtml

public void loadHtml(String content,
 @Nullable
 @Nullable String baseUri)

Load the given content string with the specified baseUri.

If baseUri is not null, relative URLs in the content will be resolved against baseUri and absolute local paths must be children of the baseUri. For security reasons absolute local paths that are not children of baseUri will cause the web process to terminate. If you need to include URLs in content that are local paths in a different directory than baseUri you can build a data URI for them. When baseUri 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.

Parameters:

content - The HTML string to load

baseUri - The base URI for relative locations or null

loadPlainText

public void loadPlainText(String plainText)

Load the specified plainText string into this WebView.

The mime type of document will be "text/plain". You can monitor the load operation by connecting to WebKitWebView::load-changed signal.

Parameters:

plainText - The plain text to load

loadRequest

public void loadRequest(URIRequest request)

Requests loading of the specified WebKitURIRequest.

You can monitor the load operation by connecting to WebKitWebView::load-changed signal.

Parameters:

request - a WebKitURIRequest to load

loadUri

public void loadUri(String uri)

Requests loading of the specified URI string.

You can monitor the load operation by connecting to WebKitWebView::load-changed signal.

Parameters:

uri - an URI string

reload

public void reload()

Reloads the current contents of this WebView.

See also webkit_web_view_reload_bypass_cache().

reloadBypassCache

public void reloadBypassCache()

Reloads the current contents of this WebView without using any cached data.

restoreSessionState

public void restoreSessionState(WebViewSessionState state)

Restore the this WebView session state from state

Parameters:

state - a WebKitWebViewSessionState

save

public void save(SaveMode saveMode,
 @Nullable
 @Nullable Cancellable cancellable,
 @Nullable
 @Nullable AsyncReadyCallback callback)

Asynchronously save the current web page.

Asynchronously save the current web page associated to the WebKitWebView into a self-contained format using the mode specified in saveMode.

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

Parameters:

saveMode - the WebKitSaveMode specifying how the web page should be saved.

cancellable - a GCancellable or null to ignore

callback - a GAsyncReadyCallback to call when the request is satisfied

saveFinish

public InputStream saveFinish(AsyncResult result)
                       throws GErrorException

Finish an asynchronous operation started with webkit_web_view_save().

Parameters:

result - a GAsyncResult

Returns:

a GInputStream with the result of saving the current web page or null in case of error.

Throws:

GErrorException - see GError

saveToFile

public void saveToFile(File file,
 SaveMode saveMode,
 @Nullable
 @Nullable Cancellable cancellable,
 @Nullable
 @Nullable AsyncReadyCallback callback)

Asynchronously save the current web page.

Asynchronously save the current web page associated to the WebKitWebView into a self-contained format using the mode specified in saveMode and writing it to file.

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

Parameters:

file - the GFile where the current web page should be saved to.

saveMode - the WebKitSaveMode specifying how the web page should be saved.

cancellable - a GCancellable or null to ignore

callback - a GAsyncReadyCallback to call when the request is satisfied

saveToFileFinish

public boolean saveToFileFinish(AsyncResult result)
                         throws GErrorException

Finish an asynchronous operation started with webkit_web_view_save_to_file().

Parameters:

result - a GAsyncResult

Returns:

true if the web page was successfully saved to a file or false otherwise.

Throws:

GErrorException - see GError

sendMessageToPage

public void sendMessageToPage(UserMessage message,
 @Nullable
 @Nullable Cancellable cancellable,
 @Nullable
 @Nullable AsyncReadyCallback callback)

Send message to the WebKitWebPage corresponding to this WebView.

If message is floating, it's consumed. If you don't expect any reply, or you simply want to ignore it, you can pass null as callback. When the operation is finished, callback will be called. You can then call webkit_web_view_send_message_to_page_finish() to get the message reply.

Parameters:

message - a WebKitUserMessage

cancellable - a GCancellable or null to ignore

callback - (nullable): A GAsyncReadyCallback to call when the request is satisfied or null

sendMessageToPageFinish

public UserMessage sendMessageToPageFinish(AsyncResult result)
                                    throws GErrorException

Finish an asynchronous operation started with webkit_web_view_send_message_to_page().

Parameters:

result - a GAsyncResult

Returns:

a WebKitUserMessage with the reply or null in case of error.

Throws:

GErrorException - see GError

setBackgroundColor

public void setBackgroundColor(RGBA rgba)

Sets the color that will be used to draw the this WebView background.

Sets the color that will be used to draw the this WebView background before the actual contents are rendered. Note that if the web page loaded in this WebView specifies a background color, it will take precedence over the rgba color. By default the this WebView background color is opaque white.

Parameters:

rgba - a GdkRGBA

setCameraCaptureState

public void setCameraCaptureState(MediaCaptureState state)

Set the camera capture state of a WebKitWebView.

If WebKitSettings:enable-mediastream is false, this method will have no visible effect. Once the state of the device has been set to MediaCaptureState.NONE it cannot be changed anymore. The page can however request capture again using the mediaDevices API.

Parameters:

state - a WebKitMediaCaptureState

setCorsAllowlist

public void setCorsAllowlist(@Nullable
 @Nullable String[] allowlist)

Sets the allowlist for CORS.

Sets the allowlist for which Cross-Origin Resource Sharing checks are disabled in this WebView. 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.

Disabling CORS checks permits resources from other origins to load allowlisted resources. It does not permit the allowlisted resources to load resources from other origins.

If this function is called multiple times, only the allowlist set by the most recent call will be effective.

Parameters:

allowlist - an allowlist of URI patterns, or null

setCustomCharset

public void setCustomCharset(@Nullable
 @Nullable String charset)

Sets the current custom character encoding override of this WebView.

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.

Parameters:

charset - a character encoding name or null

setDisplayCaptureState

public void setDisplayCaptureState(MediaCaptureState state)

Set the display capture state of a WebKitWebView.

If WebKitSettings:enable-mediastream is false, this method will have no visible effect. Once the state of the device has been set to MediaCaptureState.NONE it cannot be changed anymore. The page can however request capture again using the mediaDevices API.

Parameters:

state - a WebKitMediaCaptureState

setEditable

public void setEditable(boolean editable)

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

If editable is true, this WebView allows the user to edit the HTML document. If editable is false, an element in this WebView's 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.

Normally, a HTML document is not editable unless the elements within the document are editable. This function provides a way to make the contents of a WebKitWebView editable without altering the document or DOM structure.

Parameters:

editable - a gboolean indicating the editable state

setInputMethodContext

public void setInputMethodContext(@Nullable
 @Nullable InputMethodContext context)

Set the WebKitInputMethodContext to be used by this WebView.

Set the WebKitInputMethodContext to be used by this WebView, 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.

Parameters:

context - the WebKitInputMethodContext to set, or null

setIsMuted

public void setIsMuted(boolean muted)

Sets the mute state of this WebView.

Parameters:

muted - mute flag

setMicrophoneCaptureState

public void setMicrophoneCaptureState(MediaCaptureState state)

Set the microphone capture state of a WebKitWebView.

If WebKitSettings:enable-mediastream is false, this method will have no visible effect. Once the state of the device has been set to MediaCaptureState.NONE it cannot be changed anymore. The page can however request capture again using the mediaDevices API.

Parameters:

state - a WebKitMediaCaptureState

setSettings

public void setSettings(Settings settings)

Sets the WebKitSettings to be applied to this WebView.

The existing WebKitSettings of this WebView will be replaced by settings. New settings are applied immediately on this WebView. The same WebKitSettings object can be shared by multiple WebKitWebView<!-- -->s.

Parameters:

settings - a WebKitSettings

setZoomLevel

public void setZoomLevel(double zoomLevel)

Set the zoom level of this WebView.

Set the zoom level of this WebView, i.e. the factor by which the view contents are scaled with respect to their original size.

Parameters:

zoomLevel - the zoom level

stopLoading

public void stopLoading()

Stops any ongoing loading operation in this WebView.

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 NetworkError.CANCELLED error.

terminateWebProcess

public void terminateWebProcess()

Terminates the web process associated to this WebView.

When the web process gets terminated using this method, the WebKitWebView::web-process-terminated signal is emitted with WebProcessTerminationReason.TERMINATED_BY_API as the reason for termination.

tryClose

public void tryClose()

Tries to close the this WebView.

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.

authenticate

protected boolean authenticate(AuthenticationRequest request)

close

protected void close()

contextMenu

protected boolean contextMenu(ContextMenu contextMenu,
 HitTestResult hitTestResult)

contextMenuDismissed

protected void contextMenuDismissed()

create

protected Widget create(NavigationAction navigationAction)

decidePolicy

protected boolean decidePolicy(PolicyDecision decision,
 PolicyDecisionType type)

enterFullscreen

protected boolean enterFullscreen()

insecureContentDetected

protected void insecureContentDetected(InsecureContentEvent event)

leaveFullscreen

protected boolean leaveFullscreen()

loadChanged

protected void loadChanged(LoadEvent loadEvent)

loadFailed

protected boolean loadFailed(LoadEvent loadEvent,
 String failingUri,
 GError error)

loadFailedWithTlsErrors

protected boolean loadFailedWithTlsErrors(String failingUri,
 TlsCertificate certificate,
 Set<TlsCertificateFlags> errors)

mouseTargetChanged

protected void mouseTargetChanged(HitTestResult hitTestResult,
 int modifiers)

permissionRequest

protected boolean permissionRequest(PermissionRequest permissionRequest)

print

protected boolean print(PrintOperation printOperation)

queryPermissionState

protected boolean queryPermissionState(PermissionStateQuery query)

readyToShow

protected void readyToShow()

resourceLoadStarted

protected void resourceLoadStarted(WebResource resource,
 URIRequest request)

runAsModal

protected void runAsModal()

runColorChooser

protected boolean runColorChooser(ColorChooserRequest request)

runFileChooser

protected boolean runFileChooser(FileChooserRequest request)

scriptDialog

protected boolean scriptDialog(ScriptDialog dialog)

showNotification

protected boolean showNotification(Notification notification)

showOptionMenu

protected boolean showOptionMenu(OptionMenu menu,
 Rectangle rectangle)

submitForm

protected void submitForm(FormSubmissionRequest request)

userMessageReceived

protected boolean userMessageReceived(UserMessage message)

webProcessCrashed

protected boolean webProcessCrashed()

webProcessTerminated

protected void webProcessTerminated(WebProcessTerminationReason reason)

onAuthenticate

public SignalConnection<WebView.AuthenticateCallback> onAuthenticate(WebView.AuthenticateCallback handler)

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.

The default signal handler will run a default authentication dialog asynchronously for the user to interact with.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• WebView.AuthenticateCallback.run(org.gnome.webkit.AuthenticationRequest)

emitAuthenticate

public boolean emitAuthenticate(AuthenticationRequest request)

Emits the "authenticate" signal. See onAuthenticate(org.gnome.webkit.WebView.AuthenticateCallback).

onClose

public SignalConnection<WebView.CloseCallback> onClose(WebView.CloseCallback handler)

Emitted when closing a WebKitWebView is requested. This occurs when a call is made from JavaScript's <function>window.close</function> function or after trying to close the webView with webkit_web_view_try_close(). It is the owner's responsibility to handle this signal to hide or destroy the WebKitWebView, if necessary.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• WebView.CloseCallback.run()

emitClose

public void emitClose()

Emits the "close" signal. See onClose(org.gnome.webkit.WebView.CloseCallback).

onContextMenu

public SignalConnection<WebView.ContextMenuCallback> onContextMenu(WebView.ContextMenuCallback handler)

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. <itemizedlist> <listitem><para> To customize the proposed menu you can use webkit_context_menu_prepend(), webkit_context_menu_append() or webkit_context_menu_insert() to add new WebKitContextMenuItem<!-- -->s to contextMenu, 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 contextMenu will be shown. </para></listitem> <listitem><para> 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. </para></listitem> <listitem><para> 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. </para></listitem> <listitem><para> 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. </para></listitem> </itemizedlist>

If the signal handler returns false the context menu represented by contextMenu will be shown, if it return true the context menu will not be shown.

The proposed WebKitContextMenu passed in contextMenu argument is only valid during the signal emission.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• WebView.ContextMenuCallback.run(org.gnome.webkit.ContextMenu, org.gnome.webkit.HitTestResult)

emitContextMenu

public boolean emitContextMenu(ContextMenu contextMenu,
 HitTestResult hitTestResult)

Emits the "context-menu" signal. See onContextMenu(org.gnome.webkit.WebView.ContextMenuCallback).

onContextMenuDismissed

public SignalConnection<WebView.ContextMenuDismissedCallback> onContextMenuDismissed(WebView.ContextMenuDismissedCallback handler)

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

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• WebView.ContextMenuDismissedCallback.run()

emitContextMenuDismissed

public void emitContextMenuDismissed()

Emits the "context-menu-dismissed" signal. See onContextMenuDismissed(org.gnome.webkit.WebView.ContextMenuDismissedCallback).

onCreate

public SignalConnection<WebView.CreateCallback> onCreate(WebView.CreateCallback handler)

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

The WebKitNavigationAction parameter contains information about the navigation action that triggered this signal.

The new WebKitWebView must be related to webView, see WebKitWebView:related-view for more details.

The new WebKitWebView should not be displayed to the user until the WebKitWebView::ready-to-show signal is emitted.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• WebView.CreateCallback.run(org.gnome.webkit.NavigationAction)

emitCreate

public Widget emitCreate(NavigationAction navigationAction)

Emits the "create" signal. See onCreate(org.gnome.webkit.WebView.CreateCallback).

onDecidePolicy

public SignalConnection<WebView.DecidePolicyCallback> onDecidePolicy(WebView.DecidePolicyCallback handler)

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:

static gboolean
 decide_policy_cb (WebKitWebView *web_view,
                   WebKitPolicyDecision *decision,
                   WebKitPolicyDecisionType type)
 {
     switch (type) {
     case WEBKIT_POLICY_DECISION_TYPE_NAVIGATION_ACTION: {
         WebKitNavigationPolicyDecision *navigation_decision = WEBKIT_NAVIGATION_POLICY_DECISION (decision);
         // Make a policy decision here
         break;
     }
     case WEBKIT_POLICY_DECISION_TYPE_NEW_WINDOW_ACTION: {
         WebKitNavigationPolicyDecision *navigation_decision = WEBKIT_NAVIGATION_POLICY_DECISION (decision);
         // Make a policy decision here
         break;
     }
     case WEBKIT_POLICY_DECISION_TYPE_RESPONSE:
         WebKitResponsePolicyDecision *response = WEBKIT_RESPONSE_POLICY_DECISION (decision);
         // Make a policy decision here
         break;
     default:
         // Making no decision results in webkit_policy_decision_use()
         return FALSE;
     }
     return TRUE;
 }
 

It is possible to make policy decision asynchronously, by simply calling g_object_ref() on the decision argument and returning true to block the default signal handler. If the last reference is removed on a WebKitPolicyDecision and no decision has been made explicitly, webkit_policy_decision_use() will be the default policy decision. The default signal handler will simply call webkit_policy_decision_use(). Only the first policy decision chosen for a given WebKitPolicyDecision will have any affect.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• WebView.DecidePolicyCallback.run(org.gnome.webkit.PolicyDecision, org.gnome.webkit.PolicyDecisionType)

emitDecidePolicy

public boolean emitDecidePolicy(PolicyDecision decision,
 PolicyDecisionType decisionType)

Emits the "decide-policy" signal. See onDecidePolicy(org.gnome.webkit.WebView.DecidePolicyCallback).

onEnterFullscreen

public SignalConnection<WebView.EnterFullscreenCallback> onEnterFullscreen(WebView.EnterFullscreenCallback handler)

Emitted when JavaScript code calls <function>element.webkitRequestFullScreen</function>. 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).

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• WebView.EnterFullscreenCallback.run()

emitEnterFullscreen

public boolean emitEnterFullscreen()

Emits the "enter-fullscreen" signal. See onEnterFullscreen(org.gnome.webkit.WebView.EnterFullscreenCallback).

onInsecureContentDetected

@Deprecated
public SignalConnection<WebView.InsecureContentDetectedCallback> onInsecureContentDetected(WebView.InsecureContentDetectedCallback handler)

Deprecated.

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.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• WebView.InsecureContentDetectedCallback.run(org.gnome.webkit.InsecureContentEvent)

emitInsecureContentDetected

@Deprecated
public void emitInsecureContentDetected(InsecureContentEvent event)

Deprecated.

Emits the "insecure-content-detected" signal. See onInsecureContentDetected(org.gnome.webkit.WebView.InsecureContentDetectedCallback).

onLeaveFullscreen

public SignalConnection<WebView.LeaveFullscreenCallback> onLeaveFullscreen(WebView.LeaveFullscreenCallback handler)

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.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• WebView.LeaveFullscreenCallback.run()

emitLeaveFullscreen

public boolean emitLeaveFullscreen()

Emits the "leave-fullscreen" signal. See onLeaveFullscreen(org.gnome.webkit.WebView.LeaveFullscreenCallback).

onLoadChanged

public SignalConnection<WebView.LoadChangedCallback> onLoadChanged(WebView.LoadChangedCallback handler)

Emitted when a load operation in webView changes. The signal is always emitted with LoadEvent.STARTED when a new load request is made and LoadEvent.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 LoadEvent.FINISHED. If a redirection is received from the server, this signal is emitted with LoadEvent.REDIRECTED after the initial emission with LoadEvent.STARTED and before LoadEvent.COMMITTED. When the page content starts arriving the signal is emitted with LoadEvent.COMMITTED event.

You can handle this signal and use a switch to track any ongoing load operation.

static void web_view_load_changed (WebKitWebView  *web_view,
                                    WebKitLoadEvent load_event,
                                    gpointer        user_data)
 {
     switch (load_event) {
     case WEBKIT_LOAD_STARTED:
         // New load, we have now a provisional URI
         provisional_uri = webkit_web_view_get_uri (web_view);
         // Here we could start a spinner or update the
         // location bar with the provisional URI
         break;
     case WEBKIT_LOAD_REDIRECTED:
         redirected_uri = webkit_web_view_get_uri (web_view);
         break;
     case WEBKIT_LOAD_COMMITTED:
         // The load is being performed. Current URI is
         // the final one and it won't change unless a new
         // load is requested or a navigation within the
         // same page is performed
         uri = webkit_web_view_get_uri (web_view);
         break;
     case WEBKIT_LOAD_FINISHED:
         // Load finished, we can now stop the spinner
         break;
     }
 }
 

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• WebView.LoadChangedCallback.run(org.gnome.webkit.LoadEvent)

emitLoadChanged

public void emitLoadChanged(LoadEvent loadEvent)

Emits the "load-changed" signal. See onLoadChanged(org.gnome.webkit.WebView.LoadChangedCallback).

onLoadFailed

public SignalConnection<WebView.LoadFailedCallback> onLoadFailed(WebView.LoadFailedCallback handler)

Emitted when an error occurs during a load operation. If the error happened when starting to load data for a page loadEvent will be LoadEvent.STARTED. If it happened while loading a committed data source loadEvent will be LoadEvent.COMMITTED. Since a load error causes the load operation to finish, the signal WebKitWebView::load-changed will always be emitted with LoadEvent.FINISHED event right after this one.

By default, if the signal is not handled, a stock error page will be displayed. You need to handle the signal if you want to provide your own error page.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• WebView.LoadFailedCallback.run(org.gnome.webkit.LoadEvent, java.lang.String, org.gnome.glib.GError)

emitLoadFailed

public boolean emitLoadFailed(LoadEvent loadEvent,
 String failingUri,
 GError error)

Emits the "load-failed" signal. See onLoadFailed(org.gnome.webkit.WebView.LoadFailedCallback).

onLoadFailedWithTlsErrors

public SignalConnection<WebView.LoadFailedWithTlsErrorsCallback> onLoadFailedWithTlsErrors(WebView.LoadFailedWithTlsErrorsCallback handler)

Emitted when a TLS error occurs during a load operation. To allow an exception for this certificate and the host of failingUri use webkit_web_context_allow_tls_certificate_for_host().

To handle this signal asynchronously you should call g_object_ref() on certificate and return true.

If false is returned, WebKitWebView::load-failed will be emitted. The load will finish regardless of the returned value.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• WebView.LoadFailedWithTlsErrorsCallback.run(java.lang.String, org.gnome.gio.TlsCertificate, java.util.Set<org.gnome.gio.TlsCertificateFlags>)

emitLoadFailedWithTlsErrors

public boolean emitLoadFailedWithTlsErrors(String failingUri,
 TlsCertificate certificate,
 Set<TlsCertificateFlags> errors)

Emits the "load-failed-with-tls-errors" signal. See onLoadFailedWithTlsErrors(org.gnome.webkit.WebView.LoadFailedWithTlsErrorsCallback).

onMouseTargetChanged

public SignalConnection<WebView.MouseTargetChangedCallback> onMouseTargetChanged(WebView.MouseTargetChangedCallback handler)

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 hitTestResult 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 hitTestResult.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• WebView.MouseTargetChangedCallback.run(org.gnome.webkit.HitTestResult, int)

emitMouseTargetChanged

public void emitMouseTargetChanged(HitTestResult hitTestResult,
 int modifiers)

Emits the "mouse-target-changed" signal. See onMouseTargetChanged(org.gnome.webkit.WebView.MouseTargetChangedCallback).

onPermissionRequest

public SignalConnection<WebView.PermissionRequestCallback> onPermissionRequest(WebView.PermissionRequestCallback handler)

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.

A possible way to use this signal could be through a dialog allowing the user decide what to do with the request:

static gboolean permission_request_cb (WebKitWebView *web_view,
                                        WebKitPermissionRequest *request,
                                        GtkWindow *parent_window)
 {
     GtkWidget *dialog = gtk_message_dialog_new (parent_window,
                                                 GTK_DIALOG_MODAL,
                                                 GTK_MESSAGE_QUESTION,
                                                 GTK_BUTTONS_YES_NO,
                                                 "Allow Permission Request?");
     gtk_widget_show (dialog);
     gint result = gtk_dialog_run (GTK_DIALOG (dialog));

     switch (result) {
     case GTK_RESPONSE_YES:
         webkit_permission_request_allow (request);
         break;
     default:
         webkit_permission_request_deny (request);
         break;
     }
     gtk_widget_destroy (dialog);

     return TRUE;
 }
 

It is possible to handle permission requests asynchronously, by simply calling g_object_ref() on the request argument and returning true to block the default signal handler. If the last reference is removed on a WebKitPermissionRequest and the request has not been handled, webkit_permission_request_deny() will be the default action.

If the signal is not handled, the request will be completed automatically by the specific WebKitPermissionRequest that could allow or deny it. Check the documentation of classes implementing WebKitPermissionRequest interface to know their default action.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• WebView.PermissionRequestCallback.run(org.gnome.webkit.PermissionRequest)

emitPermissionRequest

public boolean emitPermissionRequest(PermissionRequest request)

Emits the "permission-request" signal. See onPermissionRequest(org.gnome.webkit.WebView.PermissionRequestCallback).

onPrint

public SignalConnection<WebView.PrintCallback> onPrint(WebView.PrintCallback handler)

Emitted when printing is requested on webView, 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 printOperation 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.

You can connect to this signal and return true to cancel the print operation or implement your own print dialog.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• WebView.PrintCallback.run(org.gnome.webkit.PrintOperation)

emitPrint

public boolean emitPrint(PrintOperation printOperation)

Emits the "print" signal. See onPrint(org.gnome.webkit.WebView.PrintCallback).

onQueryPermissionState

public SignalConnection<WebView.QueryPermissionStateCallback> onQueryPermissionState(WebView.QueryPermissionStateCallback handler)

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

You can handle the query asynchronously by calling webkit_permission_state_query_ref() on query and returning true. If the last reference of query is removed and the query has not been handled, the query result will be set to WEBKIT_QUERY_PERMISSION_PROMPT.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• WebView.QueryPermissionStateCallback.run(org.gnome.webkit.PermissionStateQuery)

emitQueryPermissionState

public boolean emitQueryPermissionState(PermissionStateQuery query)

Emits the "query-permission-state" signal. See onQueryPermissionState(org.gnome.webkit.WebView.QueryPermissionStateCallback).

onReadyToShow

public SignalConnection<WebView.ReadyToShowCallback> onReadyToShow(WebView.ReadyToShowCallback handler)

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 webView. See also webkit_web_view_get_window_properties().

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• WebView.ReadyToShowCallback.run()

emitReadyToShow

public void emitReadyToShow()

Emits the "ready-to-show" signal. See onReadyToShow(org.gnome.webkit.WebView.ReadyToShowCallback).

onResourceLoadStarted

public SignalConnection<WebView.ResourceLoadStartedCallback> onResourceLoadStarted(WebView.ResourceLoadStartedCallback handler)

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.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• WebView.ResourceLoadStartedCallback.run(org.gnome.webkit.WebResource, org.gnome.webkit.URIRequest)

emitResourceLoadStarted

public void emitResourceLoadStarted(WebResource resource,
 URIRequest request)

Emits the "resource-load-started" signal. See onResourceLoadStarted(org.gnome.webkit.WebView.ResourceLoadStartedCallback).

onRunAsModal

public SignalConnection<WebView.RunAsModalCallback> onRunAsModal(WebView.RunAsModalCallback handler)

Emitted after WebKitWebView::ready-to-show on the newly created WebKitWebView when JavaScript code calls <function>window.showModalDialog</function>. 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.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• WebView.RunAsModalCallback.run()

emitRunAsModal

public void emitRunAsModal()

Emits the "run-as-modal" signal. See onRunAsModal(org.gnome.webkit.WebView.RunAsModalCallback).

onRunColorChooser

public SignalConnection<WebView.RunColorChooserCallback> onRunColorChooser(WebView.RunColorChooserCallback handler)

This signal is emitted when the user interacts with a <input type='color' /> 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.

It is possible to handle this request asynchronously by increasing the reference count of the request.

The default signal handler will asynchronously run a regular GtkColorChooser for the user to interact with.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• WebView.RunColorChooserCallback.run(org.gnome.webkit.ColorChooserRequest)

emitRunColorChooser

public boolean emitRunColorChooser(ColorChooserRequest request)

Emits the "run-color-chooser" signal. See onRunColorChooser(org.gnome.webkit.WebView.RunColorChooserCallback).

onRunFileChooser

public SignalConnection<WebView.RunFileChooserCallback> onRunFileChooser(WebView.RunFileChooserCallback handler)

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.

The default signal handler will asynchronously run a regular GtkFileChooserDialog for the user to interact with.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• WebView.RunFileChooserCallback.run(org.gnome.webkit.FileChooserRequest)

emitRunFileChooser

public boolean emitRunFileChooser(FileChooserRequest request)

Emits the "run-file-chooser" signal. See onRunFileChooser(org.gnome.webkit.WebView.RunFileChooserCallback).

onScriptDialog

public SignalConnection<WebView.ScriptDialogCallback> onScriptDialog(WebView.ScriptDialogCallback handler)

Emitted when JavaScript code calls <function>window.alert</function>, <function>window.confirm</function> or <function>window.prompt</function>, or when <function>onbeforeunload</function> 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: <itemizedlist> <listitem><para> ScriptDialogType.ALERT: message dialog with a single Close button. </para></listitem> <listitem><para> ScriptDialogType.CONFIRM: message dialog with OK and Cancel buttons. </para></listitem> <listitem><para> ScriptDialogType.PROMPT: message dialog with OK and Cancel buttons and a text entry with the default text. </para></listitem> <listitem><para> ScriptDialogType.BEFORE_UNLOAD_CONFIRM: message dialog with Stay and Leave buttons. </para></listitem> </itemizedlist>

It is possible to handle the script dialog request asynchronously, by simply caling webkit_script_dialog_ref() on the dialog argument and calling webkit_script_dialog_close() when done. If the last reference is removed on a WebKitScriptDialog and the dialog has not been closed, webkit_script_dialog_close() will be called.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• WebView.ScriptDialogCallback.run(org.gnome.webkit.ScriptDialog)

emitScriptDialog

public boolean emitScriptDialog(ScriptDialog dialog)

Emits the "script-dialog" signal. See onScriptDialog(org.gnome.webkit.WebView.ScriptDialogCallback).

onShowNotification

public SignalConnection<WebView.ShowNotificationCallback> onShowNotification(WebView.ShowNotificationCallback handler)

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.

The default handler will emit a notification using libnotify, if built with support for it.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• WebView.ShowNotificationCallback.run(org.gnome.webkit.Notification)

emitShowNotification

public boolean emitShowNotification(Notification notification)

Emits the "show-notification" signal. See onShowNotification(org.gnome.webkit.WebView.ShowNotificationCallback).

onShowOptionMenu

public SignalConnection<WebView.ShowOptionMenuCallback> onShowOptionMenu(WebView.ShowOptionMenuCallback handler)

This signal is emitted when a select element in webView 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.

The default signal handler will pop up a GtkMenu.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• WebView.ShowOptionMenuCallback.run(org.gnome.webkit.OptionMenu, org.gnome.gdk.Rectangle)

emitShowOptionMenu

public boolean emitShowOptionMenu(OptionMenu menu,
 Rectangle rectangle)

Emits the "show-option-menu" signal. See onShowOptionMenu(org.gnome.webkit.WebView.ShowOptionMenuCallback).

onSubmitForm

public SignalConnection<WebView.SubmitFormCallback> onSubmitForm(WebView.SubmitFormCallback handler)

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.

It is possible to handle the form submission request asynchronously, by simply calling g_object_ref() on the request argument and calling webkit_form_submission_request_submit() when done to continue with the form submission. If the last reference is removed on a WebKitFormSubmissionRequest and the form has not been submitted, webkit_form_submission_request_submit() will be called.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• WebView.SubmitFormCallback.run(org.gnome.webkit.FormSubmissionRequest)

emitSubmitForm

public void emitSubmitForm(FormSubmissionRequest request)

Emits the "submit-form" signal. See onSubmitForm(org.gnome.webkit.WebView.SubmitFormCallback).

onUserMessageReceived

public SignalConnection<WebView.UserMessageReceivedCallback> onUserMessageReceived(WebView.UserMessageReceivedCallback handler)

This signal is emitted when a WebKitUserMessage is received from the WebKitWebPage corresponding to webView. You can reply to the message using webkit_user_message_send_reply().

You can handle the user message asynchronously by calling g_object_ref() on message and returning true. If the last reference of message is removed and the message has not been replied to, the operation in the WebKitWebPage will finish with error UserMessageError.MESSAGE.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• WebView.UserMessageReceivedCallback.run(org.gnome.webkit.UserMessage)

emitUserMessageReceived

public boolean emitUserMessageReceived(UserMessage message)

Emits the "user-message-received" signal. See onUserMessageReceived(org.gnome.webkit.WebView.UserMessageReceivedCallback).

onWebProcessTerminated

public SignalConnection<WebView.WebProcessTerminatedCallback> onWebProcessTerminated(WebView.WebProcessTerminatedCallback handler)

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

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• WebView.WebProcessTerminatedCallback.run(org.gnome.webkit.WebProcessTerminationReason)

emitWebProcessTerminated

public void emitWebProcessTerminated(WebProcessTerminationReason reason)

Emits the "web-process-terminated" signal. See onWebProcessTerminated(org.gnome.webkit.WebView.WebProcessTerminatedCallback).

builder

public static WebView.Builder<? extends WebView.Builder> builder()

A WebView.Builder object constructs a WebView with the specified properties. Use the various set...() methods to set properties, and finish construction with WebView.Builder.build().