Expand description
§Migration to GTK4 api
Upstream webkit2gtk project has a document to help with the migration to the GTK4 api: https://webkitgtk.org/reference/webkit2gtk/unstable/migrating-to-webkitgtk-6.0.html
Re-exports§
Modules§
Structs§
- Application
Info - Information about an application running in automation mode.
- Authentication
Request - Represents an authentication request.
- Automation
Session - Automation Session.
- Back
Forward List - List of visited pages.
- Back
Forward List Item - One item of the #WebKitBackForwardList.
- Clipboard
Permission Request v2_42
- A permission request for reading clipboard contents.
- Color
Chooser Request - A request to open a color chooser.
- Context
Menu - Represents the context menu in a #WebKitWebView.
- Context
Menu Item - One item of a #WebKitContextMenu.
- Cookie
Manager - Defines how to handle cookies in a #WebKitWebContext.
- Credential
- Groups information used for user authentication.
- Device
Info Permission Request - A permission request for accessing user’s audio/video devices.
- Download
- Object used to communicate with the application when downloading.
- Editor
State - Web editor state.
- Editor
Typing Attributes - Enum values with flags representing typing attributes.
- Favicon
Database - Provides access to the icons associated with web sites.
- Feature
v2_42
- Describes a web engine feature that may be toggled at runtime.
- Feature
List v2_42
- Contains a set of toggle-able web engine features.
- File
Chooser Request - A request to open a file chooser.
- Find
Controller - Controls text search in a #WebKitWebView.
- Find
Options - Enum values used to specify search options.
- Form
Submission Request - Represents a form submission request.
- Geolocation
Manager - Geolocation manager.
- Geolocation
Permission Request - A permission request for sharing the user’s location.
- Geolocation
Position - An opaque struct to provide position updates to a #WebKitGeolocationManager.
- HitTest
Result - Result of a Hit Test.
- HitTest
Result Context - Enum values with flags representing the context of a #WebKitHitTestResult.
- ITPFirst
Party - Describes a first party origin.
- ITPThird
Party - Describes a third party origin.
- Input
Hints - Enum values used to describe hints that might be taken into account by input methods.
- Input
Method Context - Base class for input method contexts.
- Input
Method Underline - Range of text in an preedit string to be shown underlined.
- Media
KeySystem Permission Request - A permission request for using an EME Content Decryption Module.
- Memory
Pressure Settings - A boxed type representing the settings for the memory pressure handler
- Navigation
Action - Provides details about interaction resulting in a resource load.
- Navigation
Policy Decision - A policy decision for navigation actions.
- Network
Proxy Settings - Configures network proxies.
- Network
Session - Manages network configuration.
- Notification
- Holds information about a notification that should be shown to the user.
- Notification
Permission Request - A permission request for displaying web notifications.
- Option
Menu - Represents the dropdown menu of a
select
element in a #WebKitWebView. - Option
Menu Item - One item of a #WebKitOptionMenu.
- Permission
Request - A permission request.
- Permission
State Query - This query represents a user’s choice to allow or deny access to “powerful features” of the platform, as specified in the Permissions W3C Specification.
- Pointer
Lock Permission Request - A permission request for locking the pointer.
- Policy
Decision - A pending policy decision.
- Print
Operation - Controls a print operation.
- Response
Policy Decision - A policy decision for resource responses.
- Script
Dialog - Carries details to be shown in user-facing dialogs.
- Script
Message Reply - A reply for a script message received. If no reply has been sent by the user, an automatically generated reply with undefined value with be sent.
- Security
Manager - Controls security settings in a #WebKitWebContext.
- Security
Origin - A security boundary for websites.
- Settings
- Control the behaviour of a #WebKitWebView.
- Snapshot
Options - Enum values used to specify options when taking a snapshot from a #WebKitWebView.
- URIRequest
- Represents a URI request.
- URIResponse
- Represents an URI response.
- URIScheme
Request - Represents a URI scheme request.
- URIScheme
Response - Represents a URI scheme response.
- User
Content Filter - A compiled set of rules which applied to resource loads.
- User
Content Filter Store - Handles storage of user content filters on disk.
- User
Content Manager - Manages user-defined content which affects web pages.
- User
Media Permission Request - A permission request for accessing user’s audio/video devices.
- User
Message - Message that can be sent between the UI process and web process extensions.
- User
Script - A JavaScript snippet which can be injected in loaded pages.
- User
Style Sheet - A CSS style sheet which can be injected in loaded pages.
- WebContext
- Manages aspects common to all #WebKitWebViews
- WebExtension
Match Pattern v2_48
- Represents a way to specify a group of URLs for use in WebExtensions.
- WebExtension
Match Pattern Options v2_48
- Enum values representing matching options.
- 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.
- WebView
Base - Implements
- WebView
Session State - Handles serialization of a web view’s browsing state.
- Website
Data - Data stored locally by a web site.
- Website
Data Access Permission Request - A permission request for accessing website data from third-party domains.
- Website
Data Manager - Manages data stored locally by web sites.
- Website
Data Types - Enum values with flags representing types of Website data.
- Website
Policies - View specific website policies.
- Window
Properties - Window properties of a #WebKitWebView.
Enums§
- Authentication
Scheme - Enum values representing the authentication scheme.
- Automation
Browsing Context Presentation - Enum values used for determining the automation browsing context presentation.
- Autoplay
Policy - Enum values used to specify autoplay policies.
- Cache
Model - Enum values used for determining the #WebKitWebContext cache model.
- Context
Menu Action - Enum values used to denote the stock actions for #WebKitContextMenuItems
- Cookie
Accept Policy - Enum values used to denote the cookie acceptance policies.
- Cookie
Persistent Storage - Enum values used to denote the cookie persistent storage types.
- Credential
Persistence - Enum values representing the duration for which a credential persists.
- Download
Error - Enum values used to denote the various download errors.
- Favicon
Database Error - Enum values used to denote the various errors related to the #WebKitFaviconDatabase.
- Feature
Status v2_42
- Describes the status of a
WebKitFeature
. - Hardware
Acceleration Policy - Enum values used for determining the hardware acceleration policy.
- Input
Purpose - Enum values used to describe the primary purpose of the active editable element.
- Insecure
Content Event Deprecated - Enum values previously used to denote the different events which can trigger the detection of insecure content. Since 2.46, WebKit generally no longer loads insecure content in secure contexts.
- Javascript
Error - Enum values used to denote errors happening when executing JavaScript
- Load
Event - Enum values used to denote the different events that happen during a #WebKitWebView load operation.
- Media
Capture State - Enum values used to specify the capture state of a media device.
- Media
Error - Enum values used to denote the various media errors.
- Navigation
Type - Enum values used to denote the various navigation types.
- Network
Error - Enum values used to denote the various network errors.
- Network
Proxy Mode - Enum values used to set the network proxy mode.
- Permission
State - Enum values representing query permission results.
- Policy
Decision Type - Enum values used for determining the type of a policy decision during #WebKitWebView::decide-policy.
- Policy
Error - Enum values used to denote the various policy errors.
- Print
Error - Enum values used to denote the various print errors.
- Print
Operation Response - Enum values representing the response of the print dialog shown with webkit_print_operation_run_dialog().
- Save
Mode - Enum values to specify the different ways in which a #WebKitWebView can save its current web page into a self-contained file.
- Script
Dialog Type - Enum values used for determining the type of #WebKitScriptDialog
- Snapshot
Error - Enum values used to denote errors happening when creating snapshots of #WebKitWebView
- Snapshot
Region - Enum values used to specify the region from which to get a #WebKitWebView snapshot
- TLSErrors
Policy - Enum values used to denote the TLS errors policy.
- User
Content Filter Error - Errors that can occur while compiling content filters.
- User
Content Injected Frames - Specifies in which frames user style sheets are to be inserted in.
- User
Message Error - Enum values used to denote errors happening when sending user messages.
- User
Script Injection Time - Specifies at which place of documents an user script will be inserted.
- User
Style Level - Specifies how to treat an user style sheet.
- WebExtension
Match Pattern Error - Enum values used to denote errors happening when creating a #WebKitWebExtensionMatchPattern
- WebExtension
Mode - Enum values used for setting if a #WebKitWebView is intended for WebExtensions.
- WebProcess
Termination Reason - Enum values used to specify the reason why the web process terminated abnormally.
Statics§
- EDITING_
COMMAND_ COPY - The copy clipboard command. Copies the current selection inside a #WebKitWebView to the clipboard. You can check whether it’s possible to execute the command with webkit_web_view_can_execute_editing_command(). In general it’s possible to copy to the clipboard when there is an active selection inside the #WebKitWebView.
- EDITING_
COMMAND_ CREATE_ LINK - The create link command. Creates a link element that is inserted at the current cursor position. If there’s a selection, the selected text will be used as the link text, otherwise the URL itself will be used. It receives the link URL as argument. This command should be executed with webkit_web_view_execute_editing_command_with_argument()
- EDITING_
COMMAND_ CUT - The cut clipboard command. Copies the current selection inside a #WebKitWebView to the clipboard and deletes the selected content. You can check whether it’s possible to execute the command with webkit_web_view_can_execute_editing_command(). In general it’s possible to cut to the clipboard when the #WebKitWebView content is editable and there is an active selection.
- EDITING_
COMMAND_ INSERT_ IMAGE - The insert image command. Creates an image element that is inserted at the current cursor position. It receives an URI as argument, that is used as the image source. This command should be executed with webkit_web_view_execute_editing_command_with_argument().
- EDITING_
COMMAND_ PASTE - The paste clipboard command. Pastes the contents of the clipboard to a #WebKitWebView. You can check whether it’s possible to execute the command with webkit_web_view_can_execute_editing_command(). In general it’s possible to paste from the clipboard when the #WebKitWebView content is editable and clipboard is not empty.
- EDITING_
COMMAND_ PASTE_ AS_ PLAIN_ TEXT - The paste as plaintext clipboard command. Pastes the contents of the clipboard to a #WebKitWebView, with formatting removed. You can check whether it’s possible to execute the command with webkit_web_view_can_execute_editing_command(). In general it’s possible to paste from the clipboard when the #WebKitWebView content is editable and clipboard is not empty.
- EDITING_
COMMAND_ REDO - The redo command. Redoes a previously undone editing command in a #WebKitWebView. You can check whether it’s possible to execute the command with webkit_web_view_can_execute_editing_command(). It’s only possible to redo a command when it has been previously undone.
- EDITING_
COMMAND_ SELECT_ ALL - The select all command. Selects all the content of the current text field in a #WebKitWebView. It is always possible to select all text, no matter whether the #WebKitWebView content is editable or not. You can still check it with webkit_web_view_can_execute_editing_command().
- EDITING_
COMMAND_ UNDO - The undo command. Undoes the last editing command in a #WebKitWebView. You can check whether it’s possible to execute the command with webkit_web_view_can_execute_editing_command(). It’s only possible to undo a command after a previously executed editing operation.