|
Graphics.UI.Gtk.WebKit.WebView | Portability | portable (depends on GHC) | Stability | provisional | Maintainer | gtk2hs-users@lists.sourceforge.net |
|
|
|
|
|
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 |
|
|
|
|
Types
|
|
|
|
Enums
|
|
data NavigationResponse | Source |
|
Constructors | NavigationResponseAccept | | NavigationResponseIgnore | | NavigationResponseDownload | |
|
|
|
|
Constructors | WebViewTargetInfoHtml | | WebViewTargetInfoText | | WebViewTargetInfoImage | | WebViewTargetInfoUriList | | WebViewTargetInfoNetscapeUrl | |
|
|
|
|
Constructors | LoadProvisional | | LoadCommitted | | LoadFinished | | LoadFirstVisuallyNonEmptyLayout | | LoadFailed | |
|
|
|
Constructors
|
|
|
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
|
|
|
:: WebViewClass self | | => self | uri - an URI string.
| -> String | | -> IO () | | Requests loading of the specified URI string in a WebView
|
|
|
|
:: WebViewClass self | | => self | content - the html string
| -> String | base_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.
|
|
|
:: WebViewClass self | | => self | content - the content string to be loaded.
| -> String | mime_type - the MIME type or Nothing.
| -> Maybe String | encoding - the encoding or Nothing.
| -> Maybe String | base_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.
|
|
|
|
|
|
|
:: WebViewClass self | | => self | the URI of WebView or Nothing in case of failed.
| -> IO (Maybe String) | | Returns the current URI of the contents displayed by the WebView
|
|
|
|
:: WebViewClass self | | => self | True if able to move back, False otherwise.
| -> IO Bool | | Determine whether WebView has a previous history item.
|
|
|
|
:: WebViewClass self | | => self | True 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.
|
|
|
Return the WebBackForwardList
|
|
webViewSetMaintainsBackForwardList | Source |
|
:: WebViewClass self | | => self | flag - 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.
|
|
|
webViewGoToBackForwardItem | Source |
|
:: (WebViewClass self, WebHistoryItemClass item) | | => self | | -> item | True if loading of item is successful, False if not.
| -> IO Bool | | Go to the specified WebHistoryItem
|
|
|
webViewCanGoBackOrForward | Source |
|
:: WebViewClass self | | => self | steps - the number of steps
| -> Int | True 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.
|
|
|
:: WebViewClass self | | => self | the 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.
|
|
|
|
:: WebViewClass self | | => self | zoom_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.
|
|
webViewGetFullContentZoom | Source |
|
:: WebViewClass self | | => self | False 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.
|
|
|
webViewSetFullContentZoom | Source |
|
:: WebViewClass self | | => self | full_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.
|
|
|
:: WebViewClass self | | => self | script - script to be executed
| -> String | | -> IO () | | Execute the script specified by script
|
|
|
webViewCanCutClipboard :: WebViewClass self => self -> IO Bool | Source |
|
Determines whether can cuts the current selection
inside WebView to the clipboard
|
|
webViewCanCopyClipboard :: WebViewClass self => self -> IO Bool | Source |
|
Determines whether can copies the current selection
inside WebView to the clipboard
|
|
webViewCanPasteClipboard :: WebViewClass self => self -> IO Bool | Source |
|
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 Bool | Source |
|
Determines whether or not it is currently possible to redo the last editing command in the view
|
|
webViewCanUndo :: WebViewClass self => self -> IO Bool | Source |
|
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.
|
|
|
:: WebViewClass self | | => self | mimetype - a MIME type
| -> String | True 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 Bool | Source |
|
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.
|
|
|
Obtains the WebInspector associated with the WebView
|
|
webViewGetTransparent :: WebViewClass self => self -> IO Bool | Source |
|
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 Bool | Source |
|
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 Bool | Source |
|
Determines whether text was selected
|
|
webViewSelectAll :: WebViewClass self => self -> IO () | Source |
|
Attempts to select everything inside the WebView
|
|
|
:: WebViewClass self | | => self | the default encoding or Nothing in case of failed
| -> IO (Maybe String) | | Returns the default encoding of the WebView
|
|
|
webViewSetCustomEncoding | Source |
|
:: WebViewClass self | | => self | encoding - 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
|
|
|
webViewGetCustomEncoding | Source |
|
:: WebViewClass self | | => self | the current encoding string
or Nothing if there is none set.
| -> IO (Maybe String) | | Returns the current encoding of WebView,not the default encoding.
|
|
|
|
:: WebViewClass self | | => self | the load progress
| -> IO Double | | Determines the current progress of the load
|
|
|
|
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.
|
|
|
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.
|
|
|
:: WebViewClass self | | => self | text - a string to look for
| -> String | case_sensitive - whether to respect the case of text
| -> Bool | forward - whether to find forward or not
| -> Bool | wrap - whether to continue looking at beginning
after reaching the end
| -> Bool | True on success or False on failure
| -> IO Bool | | Looks for a specified string inside WebView
|
|
|
|
:: WebViewClass self | | => self | string - a string to look for
| -> String | case_sensitive - whether to respect the case of text
| -> Bool | limit - the maximum number of strings to look for or 0 for all
| -> Int | the 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
|
|
webViewSetHighlightTextMatches | Source |
|
:: WebViewClass self | | => self | highlight - whether to highlight text matches
| -> Bool | | -> IO () | | Highlights text matches previously marked by webViewMarkTextMatches
|
|
|
|
Move the cursor in view as described by step and count.
|
|
|
Return the main WebFrame of the given WebView.
|
|
|
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.
|
|
|
Return the WebSettings currently used by WebView.
|
|
|
Returns the instance of WebKitWebWindowFeatures held by the given WebKitWebView.
|
|
Attributes
|
|
|
Zoom level of the WebView instance
|
|
|
Whether the full content is scaled when zooming
Default value: False
|
|
|
The default encoding of the WebView instance
Default value: Nothing
|
|
|
The custom encoding of the WebView instance
Default value: Nothing
|
|
|
Determines the current status of the load.
Default value: LoadFinished
|
|
|
Determines the current progress of the load
Default Value: 1
|
|
|
Title of the WebView instance
|
|
|
The associated webInspector instance of the WebView
|
|
|
The associated webSettings of the WebView instance
|
|
|
view source mode of the WebView instance
|
|
|
transparent background of the WebView instance
|
|
|
Whether content of the WebView can be modified by the user
Default value: False
|
|
|
Returns the current URI of the contents displayed by the web_view.
Default value: Nothing
|
|
|
The list of targets this web view supports for clipboard copying.
|
|
|
The list of targets this web view supports for clipboard pasteing.
|
|
|
An associated WebWindowFeatures instance.
|
|
Signals
|
|
|
When a WebFrame begins to load, this signal is emitted
|
|
|
When a WebFrame loaded the first data, this signal is emitted
|
|
|
When the global progress changed, this signal is emitted
the global progress will be passed back to user function
|
|
|
When loading finished, this signal is emitted
|
|
|
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.
|
|
|
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.
|
|
|
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.
|
|
|
|
|
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.
|
|
|
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
|
|
|
A JavaScript console message was created.
|
|
|
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.
|
|
|
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.
|
|
|
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.
|
|
|
When a context menu is about to be displayed this signal is emitted.
|
|
|
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.
|
|
|
A JavaScript alert dialog was created.
|
|
|
A JavaScript confirm dialog was created, providing Yes and No buttons.
|
|
|
A JavaScript prompt dialog was created, providing an entry to input text.
|
|
|
When status-bar text changed, this signal will emitted.
|
|
|
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.
|
|
|
When selection changed, this signal is emitted.
|
|
|
When set scroll adjustments, this signal is emitted.
|
|
|
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.
|
|
|
When document loading finished, this signal is emitted
|
|
|
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.
|
|
|
Emitted after Icon loaded
|
|
|
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
|
|
|
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
|
|
|
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.
|
|
|
The moveCursor will be emitted to apply the cursor movement described by its parameters to the view.
|
|
|
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.
|
|
|
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.
|
|
|
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 |