webkit-0.11.0: Binding to the Webkit library.Source codeContentsIndex
Graphics.UI.Gtk.WebKit.WebView
Portabilityportable (depends on GHC)
Stabilityprovisional
Maintainergtk2hs-users@lists.sourceforge.net
Contents
Types
Enums
Constructors
Methods
Attributes
Signals
Description

Note:

Signal `window-object-cleared` can't bidning now, because it need JavaScriptCore that haven't binding.

Signal `create-plugin-widget` can't binding now, no idea how to binding GHaskellTable

TODO:

webViewGetHitTestResult

The central class of the WebKit

Synopsis
data WebView
data NavigationResponse
= NavigationResponseAccept
| NavigationResponseIgnore
| NavigationResponseDownload
data TargetInfo
= WebViewTargetInfoHtml
| WebViewTargetInfoText
| WebViewTargetInfoImage
| WebViewTargetInfoUriList
| WebViewTargetInfoNetscapeUrl
data LoadStatus
= LoadProvisional
| LoadCommitted
| LoadFinished
| LoadFirstVisuallyNonEmptyLayout
| LoadFailed
webViewNew :: IO WebView
webViewLoadUri :: WebViewClass self => self -> String -> IO ()
webViewLoadHtmlString :: WebViewClass self => self -> String -> String -> IO ()
webViewLoadRequest :: (WebViewClass self, NetworkRequestClass request) => self -> request -> IO ()
webViewLoadString :: WebViewClass self => self -> String -> Maybe String -> Maybe String -> String -> IO ()
webViewGetTitle :: WebViewClass self => self -> IO (Maybe String)
webViewGetUri :: WebViewClass self => self -> IO (Maybe String)
webViewCanGoBack :: WebViewClass self => self -> IO Bool
webViewCanGoForward :: WebViewClass self => self -> IO Bool
webViewGoBack :: WebViewClass self => self -> IO ()
webViewGoForward :: WebViewClass self => self -> IO ()
webViewGetBackForwardList :: WebViewClass self => self -> IO WebBackForwardList
webViewSetMaintainsBackForwardList :: WebViewClass self => self -> Bool -> IO ()
webViewGoToBackForwardItem :: (WebViewClass self, WebHistoryItemClass item) => self -> item -> IO Bool
webViewCanGoBackOrForward :: WebViewClass self => self -> Int -> IO Bool
webViewGoBackOrForward :: WebViewClass self => self -> Int -> IO ()
webViewGetZoomLevel :: WebViewClass self => self -> IO Float
webViewSetZoomLevel :: WebViewClass self => self -> Float -> IO ()
webViewZoomIn :: WebViewClass self => self -> IO ()
webViewZoomOut :: WebViewClass self => self -> IO ()
webViewGetFullContentZoom :: WebViewClass self => self -> IO Bool
webViewSetFullContentZoom :: WebViewClass self => self -> Bool -> IO ()
webViewStopLoading :: WebViewClass self => self -> IO ()
webViewReload :: WebViewClass self => self -> IO ()
webViewReloadBypassCache :: WebViewClass self => self -> IO ()
webViewExecuteScript :: WebViewClass self => self -> String -> IO ()
webViewCanCutClipboard :: WebViewClass self => self -> IO Bool
webViewCanCopyClipboard :: WebViewClass self => self -> IO Bool
webViewCanPasteClipboard :: WebViewClass self => self -> IO Bool
webViewCutClipboard :: WebViewClass self => self -> IO ()
webViewCopyClipboard :: WebViewClass self => self -> IO ()
webViewPasteClipboard :: WebViewClass self => self -> IO ()
webViewCanRedo :: WebViewClass self => self -> IO Bool
webViewCanUndo :: WebViewClass self => self -> IO Bool
webViewRedo :: WebViewClass self => self -> IO ()
webViewUndo :: WebViewClass self => self -> IO ()
webViewCanShowMimeType :: WebViewClass self => self -> String -> IO Bool
webViewGetEditable :: WebViewClass self => self -> IO Bool
webViewSetEditable :: WebViewClass self => self -> Bool -> IO ()
webViewGetInspector :: WebViewClass self => self -> IO WebInspector
webViewGetTransparent :: WebViewClass self => self -> IO Bool
webViewSetTransparent :: WebViewClass self => self -> Bool -> IO ()
webViewGetViewSourceMode :: WebViewClass self => self -> IO Bool
webViewSetViewSourceMode :: WebViewClass self => self -> Bool -> IO ()
webViewDeleteSelection :: WebViewClass self => self -> IO ()
webViewHasSelection :: WebViewClass self => self -> IO Bool
webViewSelectAll :: WebViewClass self => self -> IO ()
webViewGetEncoding :: WebViewClass self => self -> IO (Maybe String)
webViewSetCustomEncoding :: WebViewClass self => self -> Maybe String -> IO ()
webViewGetCustomEncoding :: WebViewClass self => self -> IO (Maybe String)
webViewGetProgress :: WebViewClass self => self -> IO Double
webViewGetCopyTargetList :: WebViewClass self => self -> IO (Maybe TargetList)
webViewGetPasteTargetList :: WebViewClass self => self -> IO (Maybe TargetList)
webViewSearchText :: WebViewClass self => self -> String -> Bool -> Bool -> Bool -> IO Bool
webViewMarkTextMatches :: WebViewClass self => self -> String -> Bool -> Int -> IO Int
webViewUnMarkTextMatches :: WebViewClass self => self -> IO ()
webViewSetHighlightTextMatches :: WebViewClass self => self -> Bool -> IO ()
webViewMoveCursor :: WebViewClass self => self -> MovementStep -> Int -> IO ()
webViewGetMainFrame :: WebViewClass self => self -> IO WebFrame
webViewGetFocusedFrame :: WebViewClass self => self -> IO WebFrame
webViewSetWebSettings :: (WebViewClass self, WebSettingsClass settings) => self -> settings -> IO ()
webViewGetWebSettings :: WebViewClass self => self -> IO WebSettings
webViewGetWindowFeatures :: WebViewClass self => self -> IO WebWindowFeatures
webViewZoomLevel :: WebViewClass self => Attr self Float
webViewFullContentZoom :: WebViewClass self => Attr self Bool
webViewEncoding :: WebViewClass self => ReadAttr self (Maybe String)
webViewCustomEncoding :: WebViewClass self => Attr self (Maybe String)
webViewLoadStatus :: WebViewClass self => ReadAttr self LoadStatus
webViewProgress :: WebViewClass self => ReadAttr self Double
webViewTitle :: WebViewClass self => ReadAttr self (Maybe String)
webViewInspector :: WebViewClass self => ReadAttr self WebInspector
webViewWebSettings :: WebViewClass self => Attr self WebSettings
webViewViewSourceMode :: WebViewClass self => Attr self Bool
webViewTransparent :: WebViewClass self => Attr self Bool
webViewEditable :: WebViewClass self => Attr self Bool
webViewUri :: WebViewClass self => ReadAttr self (Maybe String)
webViewCopyTargetList :: WebViewClass self => ReadAttr self (Maybe TargetList)
webViewPasteTargetList :: WebViewClass self => ReadAttr self (Maybe TargetList)
webViewWindowFeatures :: WebViewClass self => Attr self WebWindowFeatures
loadStarted :: WebViewClass self => Signal self (WebFrame -> IO ())
loadCommitted :: WebViewClass self => Signal self (WebFrame -> IO ())
progressChanged :: WebViewClass self => Signal self (Int -> IO ())
loadFinished :: WebViewClass self => Signal self (WebFrame -> IO ())
loadError :: WebViewClass self => Signal self (WebFrame -> String -> GError -> IO Bool)
titleChanged :: WebViewClass self => Signal self (WebFrame -> String -> IO ())
hoveringOverLink :: WebViewClass self => Signal self (String -> String -> IO ())
createWebView :: WebViewClass self => Signal self (WebFrame -> IO WebView)
webViewReady :: WebViewClass self => Signal self (IO Bool)
closeWebView :: WebViewClass self => Signal self (IO Bool)
consoleMessage :: WebViewClass self => Signal self (String -> String -> Int -> String -> IO Bool)
copyClipboard :: WebViewClass self => Signal self (IO ())
cutClipboard :: WebViewClass self => Signal self (IO ())
pasteClipboard :: WebViewClass self => Signal self (IO ())
populatePopup :: WebViewClass self => Signal self (Menu -> IO ())
printRequested :: WebViewClass self => Signal self (WebFrame -> IO Bool)
scriptAlert :: WebViewClass self => Signal self (WebFrame -> String -> IO Bool)
scriptConfirm :: WebViewClass self => Signal self (WebFrame -> String -> IO Bool)
scriptPrompt :: WebViewClass self => Signal self (WebFrame -> String -> String -> IO Bool)
statusBarTextChanged :: WebViewClass self => Signal self (String -> IO ())
selectAll :: WebViewClass self => Signal self (IO ())
selectionChanged :: WebViewClass self => Signal self (IO ())
setScrollAdjustments :: WebViewClass self => Signal self (Adjustment -> Adjustment -> IO ())
databaseQuotaExceeded :: WebViewClass self => Signal self (WebFrame -> WebDatabase -> IO ())
documentLoadFinished :: WebViewClass self => Signal self (WebFrame -> IO ())
downloadRequested :: WebViewClass self => Signal self (Download -> IO Bool)
iconLoaded :: WebViewClass self => Signal self (IO ())
redo :: WebViewClass self => Signal self (IO ())
undo :: WebViewClass self => Signal self (IO ())
mimeTypePolicyDecisionRequested :: WebViewClass self => Signal self (WebFrame -> NetworkRequest -> String -> WebPolicyDecision -> IO Bool)
moveCursor :: WebViewClass self => Signal self (MovementStep -> Int -> IO Bool)
navigationPolicyDecisionRequested :: WebViewClass self => Signal self (WebFrame -> NetworkRequest -> WebNavigationAction -> WebPolicyDecision -> IO Bool)
newWindowPolicyDecisionRequested :: WebViewClass self => Signal self (WebFrame -> NetworkRequest -> WebNavigationAction -> WebPolicyDecision -> IO Bool)
resourceRequestStarting :: WebViewClass self => Signal self (WebFrame -> WebResource -> NetworkRequest -> NetworkResponse -> IO ())
Types
data WebView Source
Enums
data NavigationResponse Source
Constructors
NavigationResponseAccept
NavigationResponseIgnore
NavigationResponseDownload
data TargetInfo Source
Constructors
WebViewTargetInfoHtml
WebViewTargetInfoText
WebViewTargetInfoImage
WebViewTargetInfoUriList
WebViewTargetInfoNetscapeUrl
data LoadStatus Source
Constructors
LoadProvisional
LoadCommitted
LoadFinished
LoadFirstVisuallyNonEmptyLayout
LoadFailed
Constructors
webViewNew :: IO WebViewSource

Create a new WebView widget.

It is a Widget you can embed in a ScrolledWindow.

You can load any URI into the WebView or any kind of data string.

Methods
webViewLoadUriSource
:: WebViewClass self
=> selfuri - an URI string.
-> String
-> IO ()
Requests loading of the specified URI string in a WebView
webViewLoadHtmlStringSource
:: WebViewClass self
=> selfcontent - the html string
-> Stringbase_uri - the base URI
-> String
-> IO ()
Loading the content string as html. The URI passed in base_uri has to be an absolute URI.
webViewLoadRequest :: (WebViewClass self, NetworkRequestClass request) => self -> request -> IO ()Source

Requests loading of the specified asynchronous client request.

Creates a provisional data source that will transition to a committed data source once any data has been received. use webViewStopLoading to stop the load.

webViewLoadStringSource
:: WebViewClass self
=> selfcontent - the content string to be loaded.
-> Stringmime_type - the MIME type or Nothing.
-> Maybe Stringencoding - the encoding or Nothing.
-> Maybe Stringbase_uri - the base URI for relative locations.
-> String
-> IO ()

Requests loading of the given content with the specified mime_type, encoding and base_uri.

If mime_type is Nothing, text/html is assumed.

If encoding is Nothing, UTF-8 is assumed.

webViewGetTitleSource
:: WebViewClass self
=> selfthe title of WebView or Nothing in case of failed.
-> IO (Maybe String)
Returns the WebView document title
webViewGetUriSource
:: WebViewClass self
=> selfthe URI of WebView or Nothing in case of failed.
-> IO (Maybe String)
Returns the current URI of the contents displayed by the WebView
webViewCanGoBackSource
:: WebViewClass self
=> selfTrue if able to move back, False otherwise.
-> IO Bool
Determine whether WebView has a previous history item.
webViewCanGoForwardSource
:: WebViewClass self
=> selfTrue if able to move forward, False otherwise.
-> IO Bool
Determine whether WebView has a next history item.
webViewGoBack :: WebViewClass self => self -> IO ()Source
Loads the previous history item.
webViewGoForward :: WebViewClass self => self -> IO ()Source
Loads the next history item.
webViewGetBackForwardList :: WebViewClass self => self -> IO WebBackForwardListSource
Return the WebBackForwardList
webViewSetMaintainsBackForwardListSource
:: WebViewClass self
=> selfflag - to tell the view to maintain a back or forward list.
-> Bool
-> IO ()
Set the WebView to maintian a back or forward list of history items.
webViewGoToBackForwardItemSource
:: (WebViewClass self, WebHistoryItemClass item)
=> self
-> itemTrue if loading of item is successful, False if not.
-> IO Bool
Go to the specified WebHistoryItem
webViewCanGoBackOrForwardSource
:: WebViewClass self
=> selfsteps - the number of steps
-> IntTrue if able to move back or forward the given number of steps, False otherwise
-> IO Bool

Determines whether WebView has a history item of steps.

Negative values represent steps backward while positive values represent steps forward

webViewGoBackOrForward :: WebViewClass self => self -> Int -> IO ()Source

Loads the history item that is the number of steps away from the current item.

Negative values represent steps backward while positive values represent steps forward.

webViewGetZoomLevelSource
:: WebViewClass self
=> selfthe zoom level of WebView
-> IO Float

Returns the zoom level of WebView

i.e. the factor by which elements in the page are scaled with respect to their original size.

webViewSetZoomLevelSource
:: WebViewClass self
=> selfzoom_level - the new zoom level
-> Float
-> IO ()
Sets the zoom level of WebView.
webViewZoomIn :: WebViewClass self => self -> IO ()Source
Increases the zoom level of WebView.
webViewZoomOut :: WebViewClass self => self -> IO ()Source
Decreases the zoom level of WebView.
webViewGetFullContentZoomSource
:: WebViewClass self
=> selfFalse if only text should be scaled(the default) True if the full content of the view should be scaled.
-> IO Bool
Returns whether the zoom level affects only text or all elements.
webViewSetFullContentZoomSource
:: WebViewClass self
=> selffull_content_zoom - False if only text should be scaled (the default) True if the full content of the view should be scaled.
-> Bool
-> IO ()
Sets whether the zoom level affects only text or all elements.
webViewStopLoading :: WebViewClass self => self -> IO ()Source
Stops and pending loads on the given data source.
webViewReload :: WebViewClass self => self -> IO ()Source
Reloads the WebView
webViewReloadBypassCache :: WebViewClass self => self -> IO ()Source
Reloads the WebView without using any cached data.
webViewExecuteScriptSource
:: WebViewClass self
=> selfscript - script to be executed
-> String
-> IO ()
Execute the script specified by script
webViewCanCutClipboard :: WebViewClass self => self -> IO BoolSource
Determines whether can cuts the current selection inside WebView to the clipboard
webViewCanCopyClipboard :: WebViewClass self => self -> IO BoolSource
Determines whether can copies the current selection inside WebView to the clipboard
webViewCanPasteClipboard :: WebViewClass self => self -> IO BoolSource
Determines whether can pastes the current contents of the clipboard to the WebView
webViewCutClipboard :: WebViewClass self => self -> IO ()Source
Cuts the current selection inside WebView to the clipboard.
webViewCopyClipboard :: WebViewClass self => self -> IO ()Source
Copies the current selection inside WebView to the clipboard.
webViewPasteClipboard :: WebViewClass self => self -> IO ()Source
Pastes the current contents of the clipboard to the WebView
webViewCanRedo :: WebViewClass self => self -> IO BoolSource
Determines whether or not it is currently possible to redo the last editing command in the view
webViewCanUndo :: WebViewClass self => self -> IO BoolSource
Determines whether or not it is currently possible to undo the last editing command in the view
webViewRedo :: WebViewClass self => self -> IO ()Source
Redoes the last editing command in the view, if possible.
webViewUndo :: WebViewClass self => self -> IO ()Source
Undoes the last editing command in the view, if possible.
webViewCanShowMimeTypeSource
:: WebViewClass self
=> selfmimetype - a MIME type
-> StringTrue if the mimetype can be displayed, otherwise False
-> IO Bool
Returns whether or not a mimetype can be displayed using this view.
webViewGetEditable :: WebViewClass self => self -> IO BoolSource
Returns whether the user is allowed to edit the document.
webViewSetEditable :: WebViewClass self => self -> Bool -> IO ()Source
Sets whether allows the user to edit its HTML document.
webViewGetInspector :: WebViewClass self => self -> IO WebInspectorSource
Obtains the WebInspector associated with the WebView
webViewGetTransparent :: WebViewClass self => self -> IO BoolSource
Returns whether the WebView has a transparent background
webViewSetTransparent :: WebViewClass self => self -> Bool -> IO ()Source

Sets whether the WebKitWebView has a transparent background.

Pass False to have the WebView draw a solid background (the default), otherwise pass True.

webViewGetViewSourceMode :: WebViewClass self => self -> IO BoolSource
Returns whether WebView is in view source mode
webViewSetViewSourceMode :: WebViewClass self => self -> Bool -> IO ()Source

Set whether the view should be in view source mode.

Setting this mode to (!(0)) before loading a URI will display the source of the web page in a nice and readable format.

webViewDeleteSelection :: WebViewClass self => self -> IO ()Source
Deletes the current selection inside the WebView
webViewHasSelection :: WebViewClass self => self -> IO BoolSource
Determines whether text was selected
webViewSelectAll :: WebViewClass self => self -> IO ()Source
Attempts to select everything inside the WebView
webViewGetEncodingSource
:: WebViewClass self
=> selfthe default encoding or Nothing in case of failed
-> IO (Maybe String)
Returns the default encoding of the WebView
webViewSetCustomEncodingSource
:: WebViewClass self
=> selfencoding - the new encoding, or Nothing to restore the default encoding.
-> Maybe String
-> IO ()
Sets the current WebView encoding, without modifying the default one, and reloads the page
webViewGetCustomEncodingSource
:: WebViewClass self
=> selfthe current encoding string or Nothing if there is none set.
-> IO (Maybe String)
Returns the current encoding of WebView,not the default encoding.
webViewGetProgressSource
:: WebViewClass self
=> selfthe load progress
-> IO Double
Determines the current progress of the load
webViewGetCopyTargetList :: WebViewClass self => self -> IO (Maybe TargetList)Source
This function returns the list of targets this WebView can provide for clipboard copying and as DND source. The targets in the list are added with values from the WebViewTargetInfo enum, using targetListAdd and targetListAddTextTargets.
webViewGetPasteTargetList :: WebViewClass self => self -> IO (Maybe TargetList)Source
This function returns the list of targets this WebView can provide for clipboard pasteing and as DND source. The targets in the list are added with values from the WebViewTargetInfo enum, using targetListAdd and targetListAddTextTargets.
webViewSearchTextSource
:: WebViewClass self
=> selftext - a string to look for
-> Stringcase_sensitive - whether to respect the case of text
-> Boolforward - whether to find forward or not
-> Boolwrap - whether to continue looking at beginning after reaching the end
-> BoolTrue on success or False on failure
-> IO Bool
Looks for a specified string inside WebView
webViewMarkTextMatchesSource
:: WebViewClass self
=> selfstring - a string to look for
-> Stringcase_sensitive - whether to respect the case of text
-> Boollimit - the maximum number of strings to look for or 0 for all
-> Intthe number of strings highlighted
-> IO Int
Attempts to highlight all occurances of string inside WebView
webViewUnMarkTextMatches :: WebViewClass self => self -> IO ()Source
Removes highlighting previously set by webViewMarkTextMarches
webViewSetHighlightTextMatchesSource
:: WebViewClass self
=> selfhighlight - whether to highlight text matches
-> Bool
-> IO ()
Highlights text matches previously marked by webViewMarkTextMatches
webViewMoveCursor :: WebViewClass self => self -> MovementStep -> Int -> IO ()Source
Move the cursor in view as described by step and count.
webViewGetMainFrame :: WebViewClass self => self -> IO WebFrameSource
Return the main WebFrame of the given WebView.
webViewGetFocusedFrame :: WebViewClass self => self -> IO WebFrameSource
Return the focused WebFrame of the given WebView.
webViewSetWebSettings :: (WebViewClass self, WebSettingsClass settings) => self -> settings -> IO ()Source

Apply WebSettings to a given WebView

!!NOTE!!, currently lack of useful APIs of WebSettings in webkitgtk. If you want to set the encoding, font family or font size of the WebView, please use related functions.

webViewGetWebSettings :: WebViewClass self => self -> IO WebSettingsSource
Return the WebSettings currently used by WebView.
webViewGetWindowFeatures :: WebViewClass self => self -> IO WebWindowFeaturesSource
Returns the instance of WebKitWebWindowFeatures held by the given WebKitWebView.
Attributes
webViewZoomLevel :: WebViewClass self => Attr self FloatSource
Zoom level of the WebView instance
webViewFullContentZoom :: WebViewClass self => Attr self BoolSource

Whether the full content is scaled when zooming

Default value: False

webViewEncoding :: WebViewClass self => ReadAttr self (Maybe String)Source

The default encoding of the WebView instance

Default value: Nothing

webViewCustomEncoding :: WebViewClass self => Attr self (Maybe String)Source

The custom encoding of the WebView instance

Default value: Nothing

webViewLoadStatus :: WebViewClass self => ReadAttr self LoadStatusSource

Determines the current status of the load.

Default value: LoadFinished

webViewProgress :: WebViewClass self => ReadAttr self DoubleSource

Determines the current progress of the load

Default Value: 1

webViewTitle :: WebViewClass self => ReadAttr self (Maybe String)Source
Title of the WebView instance
webViewInspector :: WebViewClass self => ReadAttr self WebInspectorSource
The associated webInspector instance of the WebView
webViewWebSettings :: WebViewClass self => Attr self WebSettingsSource
The associated webSettings of the WebView instance
webViewViewSourceMode :: WebViewClass self => Attr self BoolSource
view source mode of the WebView instance
webViewTransparent :: WebViewClass self => Attr self BoolSource
transparent background of the WebView instance
webViewEditable :: WebViewClass self => Attr self BoolSource

Whether content of the WebView can be modified by the user

Default value: False

webViewUri :: WebViewClass self => ReadAttr self (Maybe String)Source

Returns the current URI of the contents displayed by the web_view.

Default value: Nothing

webViewCopyTargetList :: WebViewClass self => ReadAttr self (Maybe TargetList)Source
The list of targets this web view supports for clipboard copying.
webViewPasteTargetList :: WebViewClass self => ReadAttr self (Maybe TargetList)Source
The list of targets this web view supports for clipboard pasteing.
webViewWindowFeatures :: WebViewClass self => Attr self WebWindowFeaturesSource
An associated WebWindowFeatures instance.
Signals
loadStarted :: WebViewClass self => Signal self (WebFrame -> IO ())Source
When a WebFrame begins to load, this signal is emitted
loadCommitted :: WebViewClass self => Signal self (WebFrame -> IO ())Source
When a WebFrame loaded the first data, this signal is emitted
progressChanged :: WebViewClass self => Signal self (Int -> IO ())Source

When the global progress changed, this signal is emitted

the global progress will be passed back to user function

loadFinished :: WebViewClass self => Signal self (WebFrame -> IO ())Source
When loading finished, this signal is emitted
loadError :: WebViewClass self => Signal self (WebFrame -> String -> GError -> IO Bool)Source

When An error occurred while loading.

By default, if the signal is not handled, the WebView will display a stock error page.

You need to handle the signal if you want to provide your own error page.

The URI that triggered the error and the GError will be passed back to user function.

titleChanged :: WebViewClass self => Signal self (WebFrame -> String -> IO ())Source

When Document title changed, this signal is emitted.

It can be used to set the Application Window title.

the user function signature is (WebFrame->String->IO())

webframe - which WebFrame changes the document title.

title - current title string.

hoveringOverLink :: WebViewClass self => Signal self (String -> String -> IO ())Source

When the cursor is over a link, this signal is emitted.

the user function signature is (Maybe String -> Maybe String -> IO () )

title - the link's title or Nothing in case of failure.

uri - the URI the link points to or Nothing in case of failure.

createWebView :: WebViewClass self => Signal self (WebFrame -> IO WebView)Source
webViewReady :: WebViewClass self => Signal self (IO Bool)Source

Emitted after new WebView instance had been created in onCreateWebView user function when the new WebView should be displayed to the user.

All the information about how the window should look, including size,position,whether the location, status and scroll bars should be displayed, is ready set.

closeWebView :: WebViewClass self => Signal self (IO Bool)Source

Emitted when closing a WebView is requested.

This occurs when a call is made from JavaScript's window.close function. The default signal handler does not do anything. It is the owner's responsibility to hide or delete the WebView, if necessary.

User function should return True to stop the handlers from being invoked for the event or False to propagate the event furter

consoleMessage :: WebViewClass self => Signal self (String -> String -> Int -> String -> IO Bool)Source
A JavaScript console message was created.
copyClipboard :: WebViewClass self => Signal self (IO ())Source

The copyClipboard signal is a keybinding signal which gets emitted to copy the selection to the clipboard.

The default bindings for this signal are Ctrl-c and Ctrl-Insert.

cutClipboard :: WebViewClass self => Signal self (IO ())Source

The cutClipboard signal is a keybinding signal which gets emitted to cut the selection to the clipboard.

The default bindings for this signal are Ctrl-x and Shift-Delete.

pasteClipboard :: WebViewClass self => Signal self (IO ())Source

The pasteClipboard signal is a keybinding signal which gets emitted to paste the contents of the clipboard into the Web view.

The default bindings for this signal are Ctrl-v and Shift-Insert.

populatePopup :: WebViewClass self => Signal self (Menu -> IO ())Source
When a context menu is about to be displayed this signal is emitted.
printRequested :: WebViewClass self => Signal self (WebFrame -> IO Bool)Source

Emitted when printing is requested by the frame, usually because of a javascript call. When handling this signal you should call webFramePrintFull or webFramePrint to do the actual printing.

The default handler will present a print dialog and carry a print operation. Notice that this means that if you intend to ignore a print request you must connect to this signal, and return True.

scriptAlert :: WebViewClass self => Signal self (WebFrame -> String -> IO Bool)Source
A JavaScript alert dialog was created.
scriptConfirm :: WebViewClass self => Signal self (WebFrame -> String -> IO Bool)Source
A JavaScript confirm dialog was created, providing Yes and No buttons.
scriptPrompt :: WebViewClass self => Signal self (WebFrame -> String -> String -> IO Bool)Source
A JavaScript prompt dialog was created, providing an entry to input text.
statusBarTextChanged :: WebViewClass self => Signal self (String -> IO ())Source
When status-bar text changed, this signal will emitted.
selectAll :: WebViewClass self => Signal self (IO ())Source

The selectAll signal is a keybinding signal which gets emitted to select the complete contents of the text view.

The default bindings for this signal is Ctrl-a.

selectionChanged :: WebViewClass self => Signal self (IO ())Source
When selection changed, this signal is emitted.
setScrollAdjustments :: WebViewClass self => Signal self (Adjustment -> Adjustment -> IO ())Source
When set scroll adjustments, this signal is emitted.
databaseQuotaExceeded :: WebViewClass self => Signal self (WebFrame -> WebDatabase -> IO ())Source
The databaseQuotaExceeded signal will be emitted when a Web Database exceeds the quota of its security origin. This signal may be used to increase the size of the quota before the originating operation fails.
documentLoadFinished :: WebViewClass self => Signal self (WebFrame -> IO ())Source
When document loading finished, this signal is emitted
downloadRequested :: WebViewClass self => Signal self (Download -> IO Bool)Source

Emitted after A new Download is being requested.

By default, if the signal is not handled, the download is cancelled.

Notice that while handling this signal you must set the target URI using downloadSetDestinationUri

If you intend to handle downloads yourself, return False in user function.

iconLoaded :: WebViewClass self => Signal self (IO ())Source
Emitted after Icon loaded
redo :: WebViewClass self => Signal self (IO ())Source

The redo signal is a keybinding signal which gets emitted to redo the last editing command.

The default binding for this signal is Ctrl-Shift-z

undo :: WebViewClass self => Signal self (IO ())Source

The undo signal is a keybinding signal which gets emitted to undo the last editing command.

The default binding for this signal is Ctrl-z

mimeTypePolicyDecisionRequested :: WebViewClass self => Signal self (WebFrame -> NetworkRequest -> String -> WebPolicyDecision -> IO Bool)Source

Decide whether or not to display the given MIME type. If this signal is not handled, the default behavior is to show the content of the requested URI if WebKit can show this MIME type and the content disposition is not a download; if WebKit is not able to show the MIME type nothing happens.

Notice that if you return True, meaning that you handled the signal, you are expected to be aware of the Content-Disposition header. A value of attachment usually indicates a download regardless of the MIME type, see also soupMessageHeadersGetContentDisposition' And you must call webPolicyDecisionIgnore, webPolicyDecisionDownload, or webPolicyDecisionUse on the webPolicyDecision object.

moveCursor :: WebViewClass self => Signal self (MovementStep -> Int -> IO Bool)Source
The moveCursor will be emitted to apply the cursor movement described by its parameters to the view.
navigationPolicyDecisionRequested :: WebViewClass self => Signal self (WebFrame -> NetworkRequest -> WebNavigationAction -> WebPolicyDecision -> IO Bool)Source

Emitted when frame requests a navigation to another page. If this signal is not handled, the default behavior is to allow the navigation.

Notice that if you return True, meaning that you handled the signal, you are expected to be aware of the Content-Disposition header. A value of attachment usually indicates a download regardless of the MIME type, see also soupMessageHeadersGetContentDisposition' And you must call webPolicyDecisionIgnore, webPolicyDecisionDownload, or webPolicyDecisionUse on the webPolicyDecision object.

newWindowPolicyDecisionRequested :: WebViewClass self => Signal self (WebFrame -> NetworkRequest -> WebNavigationAction -> WebPolicyDecision -> IO Bool)Source

Emitted when frame requests opening a new window. With this signal the browser can use the context of the request to decide about the new window. If the request is not handled the default behavior is to allow opening the new window to load the URI, which will cause a createWebView signal emission where the browser handles the new window action but without information of the context that caused the navigation. The following navigationPolicyDecisionRequested emissions will load the page after the creation of the new window just with the information of this new navigation context, without any information about the action that made this new window to be opened.

Notice that if you return True, meaning that you handled the signal, you are expected to be aware of the Content-Disposition header. A value of attachment usually indicates a download regardless of the MIME type, see also soupMessageHeadersGetContentDisposition' And you must call webPolicyDecisionIgnore, webPolicyDecisionDownload, or webPolicyDecisionUse on the webPolicyDecision object.

resourceRequestStarting :: WebViewClass self => Signal self (WebFrame -> WebResource -> NetworkRequest -> NetworkResponse -> IO ())Source

Emitted when a request is about to be sent. You can modify the request while handling this signal. You can set the URI in the NetworkRequest object itself, and addremovereplace headers using the SoupMessage object it carries, if it is present. See networkRequestGetMessage. Setting the request URI to about:blank will effectively cause the request to load nothing, and can be used to disable the loading of specific resources.

Notice that information about an eventual redirect is available in response's SoupMessage, not in the SoupMessage carried by the request. If response is ((void *)0), then this is not a redirected request.

The WebResource object will be the same throughout all the lifetime of the resource, but the contents may change from inbetween signal emissions.

Produced by Haddock version 2.6.0