WebKit – webkit2gtk-5.0 Reference Manual
Packages
webkit2gtk-5.0
WebKit
AuthenticationScheme
AutomationBrowsingContextPresentation
AutoplayPolicy
CacheModel
ContextMenuAction
CookieAcceptPolicy
CookiePersistentStorage
CredentialPersistence
EditorTypingAttributes
FindOptions
HardwareAccelerationPolicy
HitTestResultContext
InputHints
InputPurpose
InsecureContentEvent
LoadEvent
MediaCaptureState
NavigationType
NetworkProxyMode
PolicyDecisionType
PrintOperationResponse
ProcessModel
SaveMode
ScriptDialogType
SnapshotOptions
SnapshotRegion
TLSErrorsPolicy
UserContentInjectedFrames
UserScriptInjectionTime
UserStyleLevel
WebExtensionMode
WebProcessTerminationReason
WebsiteDataTypes
PermissionRequest
ApplicationInfo
AuthenticationRequest
AutomationSession
BackForwardList
BackForwardListItem
ColorChooserRequest
ContextMenu
ContextMenuItem
CookieManager
Credential
DeviceInfoPermissionRequest
Download
EditorState
FaviconDatabase
FileChooserRequest
FindController
FormSubmissionRequest
GeolocationManager
GeolocationPermissionRequest
GeolocationPosition
HitTestResult
ITPFirstParty
ITPThirdParty
InputMethodContext
InputMethodUnderline
InstallMissingMediaPluginsPermissionRequest
JavascriptResult
MediaKeySystemPermissionRequest
MemoryPressureSettings
MimeInfo
NavigationAction
NavigationPolicyDecision
NetworkProxySettings
Notification
NotificationPermissionRequest
OptionMenu
OptionMenuItem
Plugin
PointerLockPermissionRequest
PolicyDecision
PrintCustomWidget
PrintOperation
ResponsePolicyDecision
ScriptDialog
SecurityManager
SecurityOrigin
Settings
URIRequest
URIResponse
URISchemeRequest
URISchemeResponse
UserContentFilter
UserContentFilterStore
UserContentManager
UserMediaPermissionRequest
UserMessage
UserScript
UserStyleSheet
WebContext
WebInspector
WebResource
WebView
WebViewBase
WebViewSessionState
WebsiteData
WebsiteDataAccessPermissionRequest
WebsiteDataManager
WebsitePolicies
WindowProperties
EDITING_COMMAND_COPY
EDITING_COMMAND_CREATE_LINK
EDITING_COMMAND_CUT
EDITING_COMMAND_INSERT_IMAGE
EDITING_COMMAND_PASTE
EDITING_COMMAND_PASTE_AS_PLAIN_TEXT
EDITING_COMMAND_REDO
EDITING_COMMAND_SELECT_ALL
EDITING_COMMAND_UNDO
MAJOR_VERSION
MICRO_VERSION
MINOR_VERSION
URISchemeRequestCallback
download_error_quark
favicon_database_error_quark
get_major_version
get_micro_version
get_minor_version
javascript_error_quark
media_key_system_permission_get_name
network_error_quark
plugin_error_quark
policy_error_quark
print_error_quark
snapshot_error_quark
uri_for_display
user_content_filter_error_quark
user_media_permission_is_for_audio_device
user_media_permission_is_for_display_device
user_media_permission_is_for_video_device
user_message_error_quark
WebKit
Description:
Content:
Interfaces:
PermissionRequest
-
A permission request.
Classes:
ApplicationInfo
-
Information about an application running in automation mode.
AuthenticationRequest
-
Represents an authentication request.
AutomationSession
-
Automation Session.
BackForwardList
-
List of visited pages.
BackForwardListItem
-
One item of the
BackForwardList
.
ColorChooserRequest
-
A request to open a color chooser.
ContextMenu
-
Represents the context menu in a
WebView
.
ContextMenuItem
-
One item of a
ContextMenu
.
CookieManager
-
Defines how to handle cookies in a
WebContext
.
Credential
-
Groups information used for user authentication.
DeviceInfoPermissionRequest
-
A permission request for enumerating the user's media devices
Download
-
Object used to communicate with the application when downloading.
EditorState
-
Web editor state.
FaviconDatabase
-
Provides access to the icons associated with web sites.
FileChooserRequest
-
A request to open a file chooser.
FindController
-
Controls text search in a
WebView
.
FormSubmissionRequest
-
Represents a form submission request.
GeolocationManager
-
Geolocation manager.
GeolocationPermissionRequest
-
A permission request for sharing the user's location.
GeolocationPosition
-
An opaque struct to provide position updates to a
GeolocationManager
.
HitTestResult
-
Result of a Hit Test.
ITPFirstParty
-
Describes a first party origin.
ITPThirdParty
-
Describes a third party origin.
InputMethodContext
-
Base class for input method contexts.
InputMethodUnderline
-
Range of text in an preedit string to be shown underlined.
InstallMissingMediaPluginsPermissionRequest
-
Previously, a permission request for installing missing media plugins.
JavascriptResult
-
Result of JavaScript evaluation in a web view.
MediaKeySystemPermissionRequest
-
A permission request for using an EME Content Decryption Module.
MemoryPressureSettings
-
A boxed type representing the settings for the memory pressure handler
MimeInfo
-
Information about a MIME type.
NavigationAction
-
Provides details about interaction resulting in a resource load.
NavigationPolicyDecision
-
A policy decision for navigation actions.
NetworkProxySettings
-
Configures network proxies.
Notification
-
Holds information about a notification that should be shown to the user.
NotificationPermissionRequest
-
A permission request for displaying web notifications.
OptionMenu
-
Represents the dropdown menu of a `select` element in a
WebView
.
OptionMenuItem
-
One item of a
OptionMenu
.
Plugin
-
Represents a plugin, enabling fine-grained control.
PointerLockPermissionRequest
-
A permission request for locking the pointer.
PolicyDecision
-
A pending policy decision.
PrintCustomWidget
-
Allows to embed a custom widget in print dialog.
PrintOperation
-
Controls a print operation.
ResponsePolicyDecision
-
A policy decision for resource responses.
ScriptDialog
-
Carries details to be shown in user-facing dialogs.
SecurityManager
-
Controls security settings in a
WebContext
.
SecurityOrigin
-
A security boundary for websites.
Settings
-
Control the behaviour of a
WebView
.
URIRequest
-
Represents a URI request.
URIResponse
-
Represents an URI response.
URISchemeRequest
-
Represents a URI scheme request.
URISchemeResponse
-
Represents a URI scheme response.
UserContentFilter
-
A compiled set of rules which applied to resource loads.
UserContentFilterStore
-
Handles storage of user content filters on disk.
UserContentManager
-
Manages user-defined content which affects web pages.
UserMediaPermissionRequest
-
A permission request for accessing user's audio/video devices.
UserMessage
-
Message that can be sent between the UI process and web process extensions.
UserScript
-
A JavaScript snippet which can be injected in loaded pages.
UserStyleSheet
-
A CSS style sheet which can be injected in loaded pages.
WebContext
-
Manages aspects common to all
WebView
<!-- -->s
WebInspector
-
Access to the WebKit inspector.
WebResource
-
Represents a resource at the end of a URI.
WebView
-
The central class of the WPE WebKit and WebKitGTK APIs.
WebViewBase
WebViewSessionState
-
Handles serialization of a web view's browsing state.
WebsiteData
-
Data stored locally by a web site.
WebsiteDataAccessPermissionRequest
-
A permission request for accessing website data from third-party domains.
WebsiteDataManager
-
Manages data stored locally by web sites.
WebsitePolicies
-
View specific website policies.
WindowProperties
-
Window properties of a
WebView
.
Enums:
AuthenticationScheme
-
Enum values representing the authentication scheme.
AutomationBrowsingContextPresentation
-
Enum values used for determining the automation browsing context presentation.
AutoplayPolicy
-
Enum values used to specify autoplay policies.
CacheModel
-
Enum values used for determining the
WebContext
cache model.
ContextMenuAction
-
Enum values used to denote the stock actions for
ContextMenuItem
<!-- -->s
CookieAcceptPolicy
-
Enum values used to denote the cookie acceptance policies.
CookiePersistentStorage
-
Enum values used to denote the cookie persistent storage types.
CredentialPersistence
-
Enum values representing the duration for which a credential persists.
EditorTypingAttributes
-
Enum values with flags representing typing attributes.
FindOptions
-
Enum values used to specify search options.
HardwareAccelerationPolicy
-
Enum values used for determining the hardware acceleration policy.
HitTestResultContext
-
Enum values with flags representing the context of a
HitTestResult
.
InputHints
-
Enum values used to describe hints that might be taken into account by input methods.
InputPurpose
-
Enum values used to describe the primary purpose of the active editable element.
InsecureContentEvent
-
Enum values previously used to denote the different events which can trigger the detection of insecure content.
LoadEvent
-
Enum values used to denote the different events that happen during a
WebView
load operation.
MediaCaptureState
-
Enum values used to specify the capture state of a media device.
NavigationType
-
Enum values used to denote the various navigation types.
NetworkProxyMode
-
Enum values used to set the network proxy mode.
PolicyDecisionType
-
Enum values used for determining the type of a policy decision during
decide_policy
.
PrintOperationResponse
-
Enum values representing the response of the print dialog shown with
run_dialog
.
ProcessModel
-
Enum values used for determining the
WebContext
process model.
SaveMode
-
Enum values to specify the different ways in which a
WebView
can save its current web page into a self-contained file.
ScriptDialogType
-
Enum values used for determining the type of
ScriptDialog
SnapshotOptions
-
Enum values used to specify options when taking a snapshot from a
WebView
.
SnapshotRegion
-
Enum values used to specify the region from which to get a
WebView
snapshot
TLSErrorsPolicy
-
Enum values used to denote the TLS errors policy.
UserContentInjectedFrames
-
Specifies in which frames user style sheets are to be inserted in.
UserScriptInjectionTime
-
Specifies at which place of documents an user script will be inserted.
UserStyleLevel
-
Specifies how to treat an user style sheet.
WebExtensionMode
-
Enum values used for setting if a
WebView
is intended for WebExtensions.
WebProcessTerminationReason
-
Enum values used to specify the reason why the web process terminated abnormally.
WebsiteDataTypes
-
Enum values with flags representing types of Website data.
Error domains:
DownloadError
-
Enum values used to denote the various download errors.
FaviconDatabaseError
-
Enum values used to denote the various errors related to the
FaviconDatabase
.
JavascriptError
-
Enum values used to denote errors happening when executing JavaScript
NetworkError
-
Enum values used to denote the various network errors.
PluginError
-
Enum values used to denote the various plugin and media errors.
PolicyError
-
Enum values used to denote the various policy errors.
PrintError
-
Enum values used to denote the various print errors.
SnapshotError
-
Enum values used to denote errors happening when creating snapshots of
WebView
UserContentFilterError
-
Errors that can occur while compiling content filters.
UserMessageError
-
Enum values used to denote errors happening when sending user messages.
Constants:
public
const
string
EDITING_COMMAND_COPY
The copy clipboard command.
public
const
string
EDITING_COMMAND_CREATE_LINK
The create link command.
public
const
string
EDITING_COMMAND_CUT
The cut clipboard command.
public
const
string
EDITING_COMMAND_INSERT_IMAGE
The insert image command.
public
const
string
EDITING_COMMAND_PASTE
The paste clipboard command.
public
const
string
EDITING_COMMAND_PASTE_AS_PLAIN_TEXT
The paste as plaintext clipboard command.
public
const
string
EDITING_COMMAND_REDO
The redo command.
public
const
string
EDITING_COMMAND_SELECT_ALL
The select all command.
public
const
string
EDITING_COMMAND_UNDO
The undo command.
public
const
int
MAJOR_VERSION
Like
get_major_version
, but from the headers used at application compile time, rather than from the library linked against at application run time.
public
const
int
MICRO_VERSION
Like
get_micro_version
, but from the headers used at application compile time, rather than from the library linked against at application run time.
public
const
int
MINOR_VERSION
Like
get_minor_version
, but from the headers used at application compile time, rather than from the library linked against at application run time.
Delegates:
public
delegate
void
URISchemeRequestCallback
(
URISchemeRequest
request)
Type definition for a function that will be called back when an URI request is made for a user registered URI scheme.
Functions:
public
Quark
download_error_quark
()
public
Quark
favicon_database_error_quark
()
public
uint
get_major_version
()
Returns the major version number of the WebKit library.
public
uint
get_micro_version
()
Returns the micro version number of the WebKit library.
public
uint
get_minor_version
()
Returns the minor version number of the WebKit library.
public
Quark
javascript_error_quark
()
public
unowned
string
media_key_system_permission_get_name
(
MediaKeySystemPermissionRequest
request)
Get the key system for which access permission is being requested.
public
Quark
network_error_quark
()
public
Quark
plugin_error_quark
()
public
Quark
policy_error_quark
()
public
Quark
print_error_quark
()
public
Quark
snapshot_error_quark
()
public
string
?
uri_for_display
(
string
uri)
Use this function to format a URI for display.
public
Quark
user_content_filter_error_quark
()
public
bool
user_media_permission_is_for_audio_device
(
UserMediaPermissionRequest
request)
Check whether the permission request is for an audio device.
public
bool
user_media_permission_is_for_display_device
(
UserMediaPermissionRequest
request)
Check whether the permission request is for a display device.
public
bool
user_media_permission_is_for_video_device
(
UserMediaPermissionRequest
request)
Check whether the permission request is for a video device.
public
Quark
user_message_error_quark
()