gi-webkit2-4.0.18: WebKit2 bindings

CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria (garetxe@gmail.com)
Safe HaskellNone
LanguageHaskell2010

GI.WebKit2.Enums

Contents

Description

 
Synopsis

Enumerations

AuthenticationScheme

data AuthenticationScheme Source #

Enum values representing the authentication scheme.

Since: 2.2

Constructors

AuthenticationSchemeDefault

The default authentication scheme of WebKit.

AuthenticationSchemeHttpBasic

Basic authentication scheme as defined in RFC 2617.

AuthenticationSchemeHttpDigest

Digest authentication scheme as defined in RFC 2617.

AuthenticationSchemeHtmlForm

HTML Form authentication.

AuthenticationSchemeNtlm

NTLM Microsoft proprietary authentication scheme.

AuthenticationSchemeNegotiate

Negotiate (or SPNEGO) authentication scheme as defined in RFC 4559.

AuthenticationSchemeClientCertificateRequested

Client Certificate Authentication (see RFC 2246).

AuthenticationSchemeServerTrustEvaluationRequested

Server Trust Authentication.

AuthenticationSchemeUnknown

Authentication scheme unknown.

AnotherAuthenticationScheme Int

Catch-all for unknown values

Instances
Enum AuthenticationScheme Source # 
Instance details
Eq AuthenticationScheme Source # 
Instance details
Ord AuthenticationScheme Source # 
Instance details
Show AuthenticationScheme Source # 
Instance details
BoxedEnum AuthenticationScheme Source # 
Instance details

CacheModel

data CacheModel Source #

Enum values used for determining the WebContext cache model.

Constructors

CacheModelDocumentViewer

Disable the cache completely, which substantially reduces memory usage. Useful for applications that only access a single local file, with no navigation to other pages. No remote resources will be cached.

CacheModelWebBrowser

Improve document load speed substantially by caching a very large number of resources and previously viewed content.

CacheModelDocumentBrowser

A cache model optimized for viewing a series of local files -- for example, a documentation viewer or a website designer. WebKit will cache a moderate number of resources.

AnotherCacheModel Int

Catch-all for unknown values

ContextMenuAction

data ContextMenuAction Source #

Enum values used to denote the stock actions for ContextMenuItem<!-- -->s

Constructors

ContextMenuActionNoAction

No action, used by separator menu items.

ContextMenuActionOpenLink

Open current link.

ContextMenuActionOpenLinkInNewWindow

Open current link in a new window.

ContextMenuActionDownloadLinkToDisk

Download link destination.

ContextMenuActionCopyLinkToClipboard

Copy link location to the clipboard.

ContextMenuActionOpenImageInNewWindow

Open current image in a new window.

ContextMenuActionDownloadImageToDisk

Download current image.

ContextMenuActionCopyImageToClipboard

Copy current image to the clipboard.

ContextMenuActionCopyImageUrlToClipboard

Copy current image location to the clipboard.

ContextMenuActionOpenFrameInNewWindow

Open current frame in a new window.

ContextMenuActionGoBack

Load the previous history item.

ContextMenuActionGoForward

Load the next history item.

ContextMenuActionStop

Stop any ongoing loading operation.

ContextMenuActionReload

Reload the contents of current view.

ContextMenuActionCopy

Copy current selection the clipboard.

ContextMenuActionCut

Cut current selection to the clipboard.

ContextMenuActionPaste

Paste clipboard contents.

ContextMenuActionDelete

Delete current selection.

ContextMenuActionSelectAll

Select all text.

ContextMenuActionInputMethods

Input methods menu.

ContextMenuActionUnicode

Unicode menu.

ContextMenuActionSpellingGuess

A proposed replacement for a misspelled word.

ContextMenuActionNoGuessesFound

An indicator that spellchecking found no proposed replacements.

ContextMenuActionIgnoreSpelling

Causes the spellchecker to ignore the word for this session.

ContextMenuActionLearnSpelling

Causes the spellchecker to add the word to the dictionary.

ContextMenuActionIgnoreGrammar

Ignore grammar.

ContextMenuActionFontMenu

Font options menu.

ContextMenuActionBold

Bold.

ContextMenuActionItalic

Italic.

ContextMenuActionUnderline

Underline.

ContextMenuActionOutline

Outline.

ContextMenuActionInspectElement

Open current element in the inspector.

ContextMenuActionOpenVideoInNewWindow

Open current video element in a new window.

ContextMenuActionOpenAudioInNewWindow

Open current audio element in a new window.

ContextMenuActionCopyVideoLinkToClipboard

Copy video link location in to the clipboard.

ContextMenuActionCopyAudioLinkToClipboard

Copy audio link location in to the clipboard.

ContextMenuActionToggleMediaControls

Enable or disable media controls.

ContextMenuActionToggleMediaLoop

Enable or disable media loop.

ContextMenuActionEnterVideoFullscreen

Show current video element in fullscreen mode.

ContextMenuActionMediaPlay

Play current media element.

ContextMenuActionMediaPause

Pause current media element.

ContextMenuActionMediaMute

Mute current media element.

ContextMenuActionDownloadVideoToDisk

Download video to disk. Since 2.2

ContextMenuActionDownloadAudioToDisk

Download audio to disk. Since 2.2

ContextMenuActionCustom

Custom action defined by applications.

AnotherContextMenuAction Int

Catch-all for unknown values

CookieAcceptPolicy

data CookieAcceptPolicy Source #

Enum values used to denote the cookie acceptance policies.

Constructors

CookieAcceptPolicyAlways

Accept all cookies unconditionally.

CookieAcceptPolicyNever

Reject all cookies unconditionally.

CookieAcceptPolicyNoThirdParty

Accept only cookies set by the main document loaded.

AnotherCookieAcceptPolicy Int

Catch-all for unknown values

Instances
Enum CookieAcceptPolicy Source # 
Instance details
Eq CookieAcceptPolicy Source # 
Instance details
Ord CookieAcceptPolicy Source # 
Instance details
Show CookieAcceptPolicy Source # 
Instance details
BoxedEnum CookieAcceptPolicy Source # 
Instance details

CookiePersistentStorage

data CookiePersistentStorage Source #

Enum values used to denote the cookie persistent storage types.

Constructors

CookiePersistentStorageText

Cookies are stored in a text file in the Mozilla "cookies.txt" format.

CookiePersistentStorageSqlite

Cookies are stored in a SQLite file in the current Mozilla format.

AnotherCookiePersistentStorage Int

Catch-all for unknown values

Instances
Enum CookiePersistentStorage Source # 
Instance details
Eq CookiePersistentStorage Source # 
Instance details
Ord CookiePersistentStorage Source # 
Instance details
Show CookiePersistentStorage Source # 
Instance details
BoxedEnum CookiePersistentStorage Source # 
Instance details

CredentialPersistence

data CredentialPersistence Source #

Enum values representing the duration for which a credential persists.

Since: 2.2

Constructors

CredentialPersistenceNone

Credential does not persist

CredentialPersistenceForSession

Credential persists for session only

CredentialPersistencePermanent

Credential persists permanently

AnotherCredentialPersistence Int

Catch-all for unknown values

Instances
Enum CredentialPersistence Source # 
Instance details
Eq CredentialPersistence Source # 
Instance details
Ord CredentialPersistence Source # 
Instance details
Show CredentialPersistence Source # 
Instance details
BoxedEnum CredentialPersistence Source # 
Instance details

DownloadError

data DownloadError Source #

Enum values used to denote the various download errors.

Constructors

DownloadErrorNetwork

Download failure due to network error

DownloadErrorCancelledByUser

Download was cancelled by user

DownloadErrorDestination

Download failure due to destination error

AnotherDownloadError Int

Catch-all for unknown values

catchDownloadError :: IO a -> (DownloadError -> GErrorMessage -> IO a) -> IO a Source #

Catch exceptions of type DownloadError. This is a specialized version of catchGErrorJustDomain.

handleDownloadError :: (DownloadError -> GErrorMessage -> IO a) -> IO a -> IO a Source #

Handle exceptions of type DownloadError. This is a specialized version of handleGErrorJustDomain.

FaviconDatabaseError

data FaviconDatabaseError Source #

Enum values used to denote the various errors related to the FaviconDatabase.

Constructors

FaviconDatabaseErrorNotInitialized

The FaviconDatabase has not been initialized yet

FaviconDatabaseErrorFaviconNotFound

There is not an icon available for the requested URL

FaviconDatabaseErrorFaviconUnknown

There might be an icon for the requested URL, but its data is unknown at the moment

AnotherFaviconDatabaseError Int

Catch-all for unknown values

Instances
Enum FaviconDatabaseError Source # 
Instance details
Eq FaviconDatabaseError Source # 
Instance details
Ord FaviconDatabaseError Source # 
Instance details
Show FaviconDatabaseError Source # 
Instance details
GErrorClass FaviconDatabaseError Source # 
Instance details
BoxedEnum FaviconDatabaseError Source # 
Instance details

catchFaviconDatabaseError :: IO a -> (FaviconDatabaseError -> GErrorMessage -> IO a) -> IO a Source #

Catch exceptions of type FaviconDatabaseError. This is a specialized version of catchGErrorJustDomain.

handleFaviconDatabaseError :: (FaviconDatabaseError -> GErrorMessage -> IO a) -> IO a -> IO a Source #

Handle exceptions of type FaviconDatabaseError. This is a specialized version of handleGErrorJustDomain.

HardwareAccelerationPolicy

data HardwareAccelerationPolicy Source #

Enum values used for determining the hardware acceleration policy.

Since: 2.16

Constructors

HardwareAccelerationPolicyOnDemand

Hardware acceleration is enabled/disabled as request by web contents.

HardwareAccelerationPolicyAlways

Hardware acceleration is always enabled, even for websites not requesting it.

HardwareAccelerationPolicyNever

Hardware acceleration is always disabled, even for websites requesting it.

AnotherHardwareAccelerationPolicy Int

Catch-all for unknown values

Instances
Enum HardwareAccelerationPolicy Source # 
Instance details
Eq HardwareAccelerationPolicy Source # 
Instance details
Ord HardwareAccelerationPolicy Source # 
Instance details
Show HardwareAccelerationPolicy Source # 
Instance details
BoxedEnum HardwareAccelerationPolicy Source # 
Instance details

InsecureContentEvent

data InsecureContentEvent Source #

Enum values used to denote the different events which can trigger the detection of insecure content.

Constructors

InsecureContentEventRun

Insecure content has been detected by trying to execute any kind of logic (e.g. a script) from an untrusted source.

InsecureContentEventDisplayed

Insecure content has been detected by trying to display any kind of resource (e.g. an image) from an untrusted source.

AnotherInsecureContentEvent Int

Catch-all for unknown values

Instances
Enum InsecureContentEvent Source # 
Instance details
Eq InsecureContentEvent Source # 
Instance details
Ord InsecureContentEvent Source # 
Instance details
Show InsecureContentEvent Source # 
Instance details
BoxedEnum InsecureContentEvent Source # 
Instance details

JavascriptError

data JavascriptError Source #

Enum values used to denote errors happening when executing JavaScript

Constructors

JavascriptErrorFailed

An exception was raised in JavaScript execution

AnotherJavascriptError Int

Catch-all for unknown values

catchJavascriptError :: IO a -> (JavascriptError -> GErrorMessage -> IO a) -> IO a Source #

Catch exceptions of type JavascriptError. This is a specialized version of catchGErrorJustDomain.

handleJavascriptError :: (JavascriptError -> GErrorMessage -> IO a) -> IO a -> IO a Source #

Handle exceptions of type JavascriptError. This is a specialized version of handleGErrorJustDomain.

LoadEvent

data LoadEvent Source #

Enum values used to denote the different events that happen during a WebView load operation.

Constructors

LoadEventStarted

A new load request has been made. No data has been received yet, empty structures have been allocated to perform the load; the load may still fail due to transport issues such as not being able to resolve a name, or connect to a port.

LoadEventRedirected

A provisional data source received a server redirect.

LoadEventCommitted

The content started arriving for a page load. The necessary transport requirements are established, and the load is being performed.

LoadEventFinished

Load completed. All resources are done loading or there was an error during the load operation.

AnotherLoadEvent Int

Catch-all for unknown values

NavigationType

data NavigationType Source #

Enum values used to denote the various navigation types.

Constructors

NavigationTypeLinkClicked

The navigation was triggered by clicking a link.

NavigationTypeFormSubmitted

The navigation was triggered by submitting a form.

NavigationTypeBackForward

The navigation was triggered by navigating forward or backward.

NavigationTypeReload

The navigation was triggered by reloading.

NavigationTypeFormResubmitted

The navigation was triggered by resubmitting a form.

NavigationTypeOther

The navigation was triggered by some other action.

AnotherNavigationType Int

Catch-all for unknown values

NetworkError

data NetworkError Source #

Enum values used to denote the various network errors.

Constructors

NetworkErrorFailed

Generic load failure

NetworkErrorTransport

Load failure due to transport error

NetworkErrorUnknownProtocol

Load failure due to unknown protocol

NetworkErrorCancelled

Load failure due to cancellation

NetworkErrorFileDoesNotExist

Load failure due to missing file

AnotherNetworkError Int

Catch-all for unknown values

catchNetworkError :: IO a -> (NetworkError -> GErrorMessage -> IO a) -> IO a Source #

Catch exceptions of type NetworkError. This is a specialized version of catchGErrorJustDomain.

handleNetworkError :: (NetworkError -> GErrorMessage -> IO a) -> IO a -> IO a Source #

Handle exceptions of type NetworkError. This is a specialized version of handleGErrorJustDomain.

NetworkProxyMode

data NetworkProxyMode Source #

Enum values used to set the network proxy mode.

Since: 2.16

Constructors

NetworkProxyModeDefault

Use the default proxy of the system.

NetworkProxyModeNoProxy

Do not use any proxy.

NetworkProxyModeCustom

Use custom proxy settings.

AnotherNetworkProxyMode Int

Catch-all for unknown values

PluginError

data PluginError Source #

Enum values used to denote the various plugin errors.

Constructors

PluginErrorFailed

Generic plugin load failure

PluginErrorCannotFindPlugin

Load failure due to missing plugin

PluginErrorCannotLoadPlugin

Load failure due to inability to load plugin

PluginErrorJavaUnavailable

Load failure due to missing Java support that is required to load plugin

PluginErrorConnectionCancelled

Load failure due to connection cancellation

PluginErrorWillHandleLoad

Load failure since plugin handles the load

AnotherPluginError Int

Catch-all for unknown values

catchPluginError :: IO a -> (PluginError -> GErrorMessage -> IO a) -> IO a Source #

Catch exceptions of type PluginError. This is a specialized version of catchGErrorJustDomain.

handlePluginError :: (PluginError -> GErrorMessage -> IO a) -> IO a -> IO a Source #

Handle exceptions of type PluginError. This is a specialized version of handleGErrorJustDomain.

PolicyDecisionType

data PolicyDecisionType Source #

Enum values used for determining the type of a policy decision during WebView::decide-policy.

Constructors

PolicyDecisionTypeNavigationAction

This type of policy decision is requested when WebKit is about to navigate to a new page in either the main frame or a subframe. Acceptable policy decisions are either policyDecisionUse or policyDecisionIgnore. This type of policy decision is always a NavigationPolicyDecision.

PolicyDecisionTypeNewWindowAction

This type of policy decision is requested when WebKit is about to create a new window. Acceptable policy decisions are either policyDecisionUse or policyDecisionIgnore. This type of policy decision is always a NavigationPolicyDecision. These decisions are useful for implementing special actions for new windows, such as forcing the new window to open in a tab when a keyboard modifier is active or handling a special target attribute on &lt;a&gt; elements.

PolicyDecisionTypeResponse

This type of decision is used when WebKit has received a response for a network resource and is about to start the load. Note that these resources include all subresources of a page such as images and stylesheets as well as main documents. Appropriate policy responses to this decision are policyDecisionUse, policyDecisionIgnore, or policyDecisionDownload. This type of policy decision is always a ResponsePolicyDecision. This decision is useful for forcing some types of resources to be downloaded rather than rendered in the WebView or to block the transfer of resources entirely.

AnotherPolicyDecisionType Int

Catch-all for unknown values

Instances
Enum PolicyDecisionType Source # 
Instance details
Eq PolicyDecisionType Source # 
Instance details
Ord PolicyDecisionType Source # 
Instance details
Show PolicyDecisionType Source # 
Instance details
BoxedEnum PolicyDecisionType Source # 
Instance details

PolicyError

data PolicyError Source #

Enum values used to denote the various policy errors.

Constructors

PolicyErrorFailed

Generic load failure due to policy error

PolicyErrorCannotShowMimeType

Load failure due to unsupported mime type

PolicyErrorCannotShowUri

Load failure due to URI that can not be shown

PolicyErrorFrameLoadInterruptedByPolicyChange

Load failure due to frame load interruption by policy change

PolicyErrorCannotUseRestrictedPort

Load failure due to port restriction

AnotherPolicyError Int

Catch-all for unknown values

catchPolicyError :: IO a -> (PolicyError -> GErrorMessage -> IO a) -> IO a Source #

Catch exceptions of type PolicyError. This is a specialized version of catchGErrorJustDomain.

handlePolicyError :: (PolicyError -> GErrorMessage -> IO a) -> IO a -> IO a Source #

Handle exceptions of type PolicyError. This is a specialized version of handleGErrorJustDomain.

PrintError

data PrintError Source #

Enum values used to denote the various print errors.

Constructors

PrintErrorGeneral

Unspecified error during a print operation

PrintErrorPrinterNotFound

Selected printer cannot be found

PrintErrorInvalidPageRange

Invalid page range

AnotherPrintError Int

Catch-all for unknown values

catchPrintError :: IO a -> (PrintError -> GErrorMessage -> IO a) -> IO a Source #

Catch exceptions of type PrintError. This is a specialized version of catchGErrorJustDomain.

handlePrintError :: (PrintError -> GErrorMessage -> IO a) -> IO a -> IO a Source #

Handle exceptions of type PrintError. This is a specialized version of handleGErrorJustDomain.

PrintOperationResponse

data PrintOperationResponse Source #

Enum values representing the response of the print dialog shown with printOperationRunDialog.

Constructors

PrintOperationResponsePrint

Print button was clicked in print dialog

PrintOperationResponseCancel

Print dialog was cancelled

AnotherPrintOperationResponse Int

Catch-all for unknown values

Instances
Enum PrintOperationResponse Source # 
Instance details
Eq PrintOperationResponse Source # 
Instance details
Ord PrintOperationResponse Source # 
Instance details
Show PrintOperationResponse Source # 
Instance details
BoxedEnum PrintOperationResponse Source # 
Instance details

ProcessModel

data ProcessModel Source #

Enum values used for determining the WebContext process model.

Since: 2.4

Constructors

ProcessModelSharedSecondaryProcess

Use a single process to perform content rendering. The process is shared among all the WebView instances created by the application: if the process hangs or crashes all the web views in the application will be affected. This is the default process model, and it should suffice for most cases.

ProcessModelMultipleSecondaryProcesses

Use one process for each WebView, while still allowing for some of them to share a process in certain situations. The main advantage of this process model is that the rendering process for a web view can crash while the rest of the views keep working normally. This process model is indicated for applications which may use a number of web views and the content of in each must not interfere with the rest — for example a full-fledged web browser with support for multiple tabs.

AnotherProcessModel Int

Catch-all for unknown values

SaveMode

data SaveMode Source #

Enum values to specify the different ways in which a WebView can save its current web page into a self-contained file.

Constructors

SaveModeMhtml

Save the current page using the MHTML format.

AnotherSaveMode Int

Catch-all for unknown values

ScriptDialogType

data ScriptDialogType Source #

Enum values used for determining the type of ScriptDialog

Constructors

ScriptDialogTypeAlert

Alert script dialog, used to show a message to the user.

ScriptDialogTypeConfirm

Confirm script dialog, used to ask confirmation to the user.

ScriptDialogTypePrompt

Prompt script dialog, used to ask information to the user.

ScriptDialogTypeBeforeUnloadConfirm

Before unload confirm dialog, used to ask confirmation to leave the current page to the user. Since 2.12

AnotherScriptDialogType Int

Catch-all for unknown values

SnapshotError

data SnapshotError Source #

Enum values used to denote errors happening when creating snapshots of WebView

Constructors

SnapshotErrorCreate

An error occurred when creating a webpage snapshot.

AnotherSnapshotError Int

Catch-all for unknown values

catchSnapshotError :: IO a -> (SnapshotError -> GErrorMessage -> IO a) -> IO a Source #

Catch exceptions of type SnapshotError. This is a specialized version of catchGErrorJustDomain.

handleSnapshotError :: (SnapshotError -> GErrorMessage -> IO a) -> IO a -> IO a Source #

Handle exceptions of type SnapshotError. This is a specialized version of handleGErrorJustDomain.

SnapshotRegion

data SnapshotRegion Source #

Enum values used to specify the region from which to get a WebView snapshot

Constructors

SnapshotRegionVisible

Specifies a snapshot only for the area that is visible in the webview

SnapshotRegionFullDocument

A snapshot of the entire document.

AnotherSnapshotRegion Int

Catch-all for unknown values

TLSErrorsPolicy

data TLSErrorsPolicy Source #

Enum values used to denote the TLS errors policy.

Constructors

TLSErrorsPolicyIgnore

Ignore TLS errors.

TLSErrorsPolicyFail

TLS errors will emit WebView::load-failed-with-tls-errors and, if the signal is handled, finish the load. In case the signal is not handled, WebView::load-failed is emitted before the load finishes.

AnotherTLSErrorsPolicy Int

Catch-all for unknown values

UserContentInjectedFrames

data UserContentInjectedFrames Source #

Specifies in which frames user style sheets are to be inserted in.

Since: 2.6

Constructors

UserContentInjectedFramesAllFrames

Insert the user style sheet in all the frames loaded by the web view, including nested frames. This is the default.

UserContentInjectedFramesTopFrame

Insert the user style sheet *only* in the top-level frame loaded by the web view, and *not* in the nested frames.

AnotherUserContentInjectedFrames Int

Catch-all for unknown values

Instances
Enum UserContentInjectedFrames Source # 
Instance details
Eq UserContentInjectedFrames Source # 
Instance details
Ord UserContentInjectedFrames Source # 
Instance details
Show UserContentInjectedFrames Source # 
Instance details
BoxedEnum UserContentInjectedFrames Source # 
Instance details

UserScriptInjectionTime

data UserScriptInjectionTime Source #

Specifies at which place of documents an user script will be inserted.

Since: 2.6

Constructors

UserScriptInjectionTimeStart

Insert the code of the user script at the beginning of loaded documents. This is the default.

UserScriptInjectionTimeEnd

Insert the code of the user script at the end of the loaded documents.

AnotherUserScriptInjectionTime Int

Catch-all for unknown values

Instances
Enum UserScriptInjectionTime Source # 
Instance details
Eq UserScriptInjectionTime Source # 
Instance details
Ord UserScriptInjectionTime Source # 
Instance details
Show UserScriptInjectionTime Source # 
Instance details
BoxedEnum UserScriptInjectionTime Source # 
Instance details

UserStyleLevel

data UserStyleLevel Source #

Specifies how to treat an user style sheet.

Since: 2.6

Constructors

UserStyleLevelUser

The style sheet is an user style sheet, its contents always override other style sheets. This is the default.

UserStyleLevelAuthor

The style sheet will be treated as if it was provided by the loaded documents. That means other user style sheets may still override it.

AnotherUserStyleLevel Int

Catch-all for unknown values

WebProcessTerminationReason

data WebProcessTerminationReason Source #

Enum values used to specify the reason why the web process terminated abnormally.

Since: 2.20

Constructors

WebProcessTerminationReasonCrashed

the web process crashed.

WebProcessTerminationReasonExceededMemoryLimit

the web process exceeded the memory limit.

AnotherWebProcessTerminationReason Int

Catch-all for unknown values

Instances
Enum WebProcessTerminationReason Source # 
Instance details
Eq WebProcessTerminationReason Source # 
Instance details
Ord WebProcessTerminationReason Source # 
Instance details
Show WebProcessTerminationReason Source # 
Instance details
BoxedEnum WebProcessTerminationReason Source # 
Instance details